JobArgs

data class JobArgs(val clientRequestId: Output<String>? = null, val createTime: Output<String>? = null, val createdFromSnapshotId: Output<String>? = null, val currentState: Output<JobCurrentState>? = null, val currentStateTime: Output<String>? = null, val environment: Output<EnvironmentArgs>? = null, val executionInfo: Output<JobExecutionInfoArgs>? = null, val id: Output<String>? = null, val jobMetadata: Output<JobMetadataArgs>? = null, val labels: Output<Map<String, String>>? = null, val location: Output<String>? = null, val name: Output<String>? = null, val pipelineDescription: Output<PipelineDescriptionArgs>? = null, val project: Output<String>? = null, val replaceJobId: Output<String>? = null, val replacedByJobId: Output<String>? = null, val requestedState: Output<JobRequestedState>? = null, val runtimeUpdatableParams: Output<RuntimeUpdatableParamsArgs>? = null, val satisfiesPzs: Output<Boolean>? = null, val stageStates: Output<List<ExecutionStageStateArgs>>? = null, val startTime: Output<String>? = null, val steps: Output<List<StepArgs>>? = null, val stepsLocation: Output<String>? = null, val tempFiles: Output<List<String>>? = null, val transformNameMapping: Output<Map<String, String>>? = null, val type: Output<JobType>? = null, val view: Output<String>? = null) : ConvertibleToJava<JobArgs>

Creates a Cloud Dataflow job. To create a job, we recommend using projects.locations.jobs.create with a regional endpoint (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using projects.jobs.create is not recommended, as your job will always start in us-central1. Do not enter confidential information when you supply string values using the API. Note - this resource's API doesn't support deletion. When deleted, the resource will persist on Google Cloud even though it will be deleted from Pulumi state.

Constructors

Link copied to clipboard
fun JobArgs(clientRequestId: Output<String>? = null, createTime: Output<String>? = null, createdFromSnapshotId: Output<String>? = null, currentState: Output<JobCurrentState>? = null, currentStateTime: Output<String>? = null, environment: Output<EnvironmentArgs>? = null, executionInfo: Output<JobExecutionInfoArgs>? = null, id: Output<String>? = null, jobMetadata: Output<JobMetadataArgs>? = null, labels: Output<Map<String, String>>? = null, location: Output<String>? = null, name: Output<String>? = null, pipelineDescription: Output<PipelineDescriptionArgs>? = null, project: Output<String>? = null, replaceJobId: Output<String>? = null, replacedByJobId: Output<String>? = null, requestedState: Output<JobRequestedState>? = null, runtimeUpdatableParams: Output<RuntimeUpdatableParamsArgs>? = null, satisfiesPzs: Output<Boolean>? = null, stageStates: Output<List<ExecutionStageStateArgs>>? = null, startTime: Output<String>? = null, steps: Output<List<StepArgs>>? = null, stepsLocation: Output<String>? = null, tempFiles: Output<List<String>>? = null, transformNameMapping: Output<Map<String, String>>? = null, type: Output<JobType>? = null, view: Output<String>? = null)

Functions

Link copied to clipboard
open override fun toJava(): JobArgs

Properties

Link copied to clipboard
val clientRequestId: Output<String>? = null

The client's unique identifier of the job, re-used across retried attempts. If this field is set, the service will ensure its uniqueness. The request to create a job will fail if the service has knowledge of a previously submitted job with the same client's ID and job name. The caller may use this field to ensure idempotence of job creation across retried attempts to create a job. By default, the field is empty and, in that case, the service ignores it.

Link copied to clipboard
val createdFromSnapshotId: Output<String>? = null

If this is specified, the job's initial state is populated from the given snapshot.

Link copied to clipboard
val createTime: Output<String>? = null

The timestamp when the job was initially created. Immutable and set by the Cloud Dataflow service.

Link copied to clipboard
val currentState: Output<JobCurrentState>? = null

The current state of the job. Jobs are created in the JOB_STATE_STOPPED state unless otherwise specified. A job in the JOB_STATE_RUNNING state may asynchronously enter a terminal state. After a job has reached a terminal state, no further state updates may be made. This field may be mutated by the Cloud Dataflow service; callers cannot mutate it.

Link copied to clipboard
val currentStateTime: Output<String>? = null

The timestamp associated with the current state.

Link copied to clipboard
val environment: Output<EnvironmentArgs>? = null

The environment for the job.

Link copied to clipboard
val executionInfo: Output<JobExecutionInfoArgs>? = null

Deprecated.

Link copied to clipboard
val id: Output<String>? = null

The unique ID of this job. This field is set by the Cloud Dataflow service when the Job is created, and is immutable for the life of the job.

Link copied to clipboard
val jobMetadata: Output<JobMetadataArgs>? = null

This field is populated by the Dataflow service to support filtering jobs by the metadata values provided here. Populated for ListJobs and all GetJob views SUMMARY and higher.

Link copied to clipboard
val labels: Output<Map<String, String>>? = null

User-defined labels for this job. The labels map can contain no more than 64 entries. Entries of the labels map are UTF8 strings that comply with the following restrictions: * Keys must conform to regexp: \p{Ll}\p{Lo}{0,62} * Values must conform to regexp: \p{Ll}\p{Lo}\p{N}_-{0,63} * Both keys and values are additionally constrained to be <= 128 bytes in size.

Link copied to clipboard
val location: Output<String>? = null

The regional endpoint (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains this job.

Link copied to clipboard
val name: Output<String>? = null

The user-specified Cloud Dataflow job name. Only one Job with a given name can exist in a project within one region at any given time. Jobs in different regions can have the same name. If a caller attempts to create a Job with the same name as an already-existing Job, the attempt returns the existing Job. The name must match the regular expression [a-z]([-a-z0-9]{0,1022}[a-z0-9])?

Link copied to clipboard

Preliminary field: The format of this data may change at any time. A description of the user pipeline and stages through which it is executed. Created by Cloud Dataflow service. Only retrieved with JOB_VIEW_DESCRIPTION or JOB_VIEW_ALL.

Link copied to clipboard
val project: Output<String>? = null

The ID of the Cloud Platform project that the job belongs to.

Link copied to clipboard
val replacedByJobId: Output<String>? = null

If another job is an update of this job (and thus, this job is in JOB_STATE_UPDATED), this field contains the ID of that job.

Link copied to clipboard
val replaceJobId: Output<String>? = null

If this job is an update of an existing job, this field is the job ID of the job it replaced. When sending a CreateJobRequest, you can update a job by specifying it here. The job named here is stopped, and its intermediate state is transferred to this job.

Link copied to clipboard
val requestedState: Output<JobRequestedState>? = null

The job's requested state. UpdateJob may be used to switch between the JOB_STATE_STOPPED and JOB_STATE_RUNNING states, by setting requested_state. UpdateJob may also be used to directly set a job's requested state to JOB_STATE_CANCELLED or JOB_STATE_DONE, irrevocably terminating the job if it has not already reached a terminal state.

Link copied to clipboard

This field may ONLY be modified at runtime using the projects.jobs.update method to adjust job behavior. This field has no effect when specified at job creation.

Link copied to clipboard
val satisfiesPzs: Output<Boolean>? = null

Reserved for future use. This field is set only in responses from the server; it is ignored if it is set in any requests.

Link copied to clipboard

This field may be mutated by the Cloud Dataflow service; callers cannot mutate it.

Link copied to clipboard
val startTime: Output<String>? = null

The timestamp when the job was started (transitioned to JOB_STATE_PENDING). Flexible resource scheduling jobs are started with some delay after job creation, so start_time is unset before start and is updated when the job is started by the Cloud Dataflow service. For other jobs, start_time always equals to create_time and is immutable and set by the Cloud Dataflow service.

Link copied to clipboard
val steps: Output<List<StepArgs>>? = null

Exactly one of step or steps_location should be specified. The top-level steps that constitute the entire job. Only retrieved with JOB_VIEW_ALL.

Link copied to clipboard
val stepsLocation: Output<String>? = null

The Cloud Storage location where the steps are stored.

Link copied to clipboard
val tempFiles: Output<List<String>>? = null

A set of files the system should be aware of that are used for temporary storage. These temporary files will be removed on job completion. No duplicates are allowed. No file patterns are supported. The supported files are: Google Cloud Storage: storage.googleapis.com/{bucket}/{object} bucket.storage.googleapis.com/{object}

Link copied to clipboard
val transformNameMapping: Output<Map<String, String>>? = null

The map of transform name prefixes of the job to be replaced to the corresponding name prefixes of the new job.

Link copied to clipboard
val type: Output<JobType>? = null

The type of Cloud Dataflow job.

Link copied to clipboard
val view: Output<String>? = null

The level of information requested in response.