Job class

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

Job(String name, {JobArgs? args, CustomResourceOptions? options})

Creates a new Job. name The Pulumi resource name. args Arguments used to configure this Job. The set of arguments for Job. options Resource options controlling this resource's behavior.

Properties

childResources → Set<Resource>

final, inherited

clientRequestId ↔ Output<String>

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.

late, final

completionSources ↔ Map<String, IOutputCompletionSource>

late, final, inherited

createdFromSnapshotId ↔ Output<String>

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

late, final

createTime ↔ Output<String>

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

late, final

currentState ↔ Output<String>

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.

late, final

currentStateTime ↔ Output<String>

The timestamp associated with the current state.

late, final

environment ↔ Output<EnvironmentResponse>

The environment for the job.

late, final

executionInfo ↔ Output<JobExecutionInfoResponse>

Deprecated.

late, final

hashCode → int

The hash code for this object.

no setter, inherited

id ↔ Output<String>

getter/setter pair, inherited

isCustom → bool

Returns whether this resource is provider-managed.

no setter, inherited

isProtected → bool

Returns whether this resource is protected from deletion.

no setter, inherited

isRemote → bool

Whether this resource is registered as remote.

no setter, inherited

isResourceReference → bool

Whether this instance represents a resource value returned over RPC.

final, inherited

jobMetadata ↔ Output<JobMetadataResponse>

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.

late, final

labels ↔ Output<Map<String, String>>

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.

late, final

location ↔ Output<String>

late, final

name ↔ Output<String>

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])?

late, final

pipelineDescription ↔ Output<PipelineDescriptionResponse>

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.

late, final

project ↔ Output<String>

late, final

replacedByJobId ↔ Output<String>

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.

late, final

replaceJobId ↔ Output<String>

Deprecated. This field is now in the Job message.

late, final

requestedState ↔ Output<String>

The job's requested state. Applies to UpdateJob requests. Set requested_state with UpdateJob requests to switch between the states JOB_STATE_STOPPED and JOB_STATE_RUNNING. You can also use UpdateJob requests to change a job's state from JOB_STATE_RUNNING to JOB_STATE_CANCELLED, JOB_STATE_DONE, or JOB_STATE_DRAINED. These states irrevocably terminate the job if it hasn't already reached a terminal state. This field has no effect on CreateJob requests.

late, final

resourceTransforms → List<ResourceTransform>

Inherited/explicit async transforms.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

runtimeUpdatableParams ↔ Output<RuntimeUpdatableParamsResponse>

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.

late, final

satisfiesPzi ↔ Output<bool>

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

late, final

satisfiesPzs ↔ Output<bool>

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

late, final

stageStates ↔ Output<List<Map<String, dynamic>>>

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

late, final

startTime ↔ Output<String>

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.

late, final

steps ↔ Output<List<Map<String, dynamic>>>

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.

late, final

stepsLocation ↔ Output<String>

The Cloud Storage location where the steps are stored.

late, final

tempFiles ↔ Output<List<String>>

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}

late, final

transformations → List<ResourceTransformation>

Inherited/explicit legacy transformations.

no setter, inherited

transformNameMapping ↔ Output<Map<String, String>>

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

late, final

type ↔ Output<String>

The type of Cloud Dataflow job.

late, final

urn ↔ Output<String>

late, final, inherited

view ↔ Output<String?>

The level of information requested in response.

late, final

Methods

failId(Object error) → void

Completes this resource ID with an error when registration fails.

inherited

failOutputs(Object error) → void

Completes all output properties with error.

inherited

failUrn(Object error) → void

Completes this resource URN with an error when registration fails.

inherited

getProvider(String moduleMember) → ProviderResource?

Returns provider for moduleMember's package, if configured.

inherited

getResourceName() → String

Returns this resource's logical name.

inherited

getResourceType() → String

Returns this resource's Pulumi type token.

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>

Registers a dynamic output property for this resource.

inherited

resolveId(String? value, {required bool isKnown}) → void

Resolves the provider-assigned ID for this resource.

inherited

resolveOutputs(Struct outputs) → void

Resolves all output properties from a monitor response payload.

inherited

resolveUrn(String value) → void

Resolves this resource's URN once assigned by the engine.

inherited

serializeProperties(Map<String, dynamic> properties) → Future<Struct>

Serializes resource properties for RPC transmission.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited