Job class

Defines a job to be run by the Cloud Dataflow service. Do not enter confidential information when you supply string values using the API. Fields stripped from source Job proto:

  • steps
  • pipeline_description
  • transform_name_mapping
Inheritance

Constructors

Job({String? id, String? projectId, String? name, JobType? type, Environment? environment, JobState? currentState, Timestamp? currentStateTime, JobState? requestedState, JobExecutionInfo? executionInfo, Timestamp? createTime, String? replaceJobId, String? clientRequestId, String? replacedByJobId, Iterable<String>? tempFiles, Map<String, String>? labels, String? location, Iterable<ExecutionStageState>? stageStates, JobMetadata? jobMetadata, Timestamp? startTime, String? createdFromSnapshotId, String? stepsLocation, bool? satisfiesPzs})
factory
Job.fromBuffer(List<int> i, [ExtensionRegistry r = $pb.ExtensionRegistry.EMPTY])
factory
Job.fromJson(String i, [ExtensionRegistry r = $pb.ExtensionRegistry.EMPTY])
factory

Properties

clientRequestId ↔ 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.
getter/setter pair
createdFromSnapshotId ↔ String
If this is specified, the job's initial state is populated from the given snapshot.
getter/setter pair
createTime ↔ Timestamp
The timestamp when the job was initially created. Immutable and set by the Cloud Dataflow service.
getter/setter pair
currentState ↔ JobState
The current state of the job.
getter/setter pair
currentStateTime ↔ Timestamp
The timestamp associated with the current state.
getter/setter pair
environment ↔ Environment
The environment for the job.
getter/setter pair
eventPlugin → EventPlugin?
Subclasses can override this getter to be notified of changes to protobuf fields.
no setterinherited
executionInfo ↔ JobExecutionInfo
Deprecated.
getter/setter pair
hashCode → int
Calculates a hash code based on the contents of the protobuf.
no setterinherited
id ↔ String
The unique ID of this job.
getter/setter pair
info_ → BuilderInfo
no setteroverride
isFrozen → bool
Returns true if this message is marked read-only. Otherwise false.
no setterinherited
jobMetadata ↔ JobMetadata
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.
getter/setter pair
labels → Map<String, String>
User-defined labels for this job.
no setter
location ↔ String
The regional endpoint (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains this job.
getter/setter pair
name ↔ String
The user-specified Cloud Dataflow job name.
getter/setter pair
projectId ↔ String
The ID of the Cloud Platform project that the job belongs to.
getter/setter pair
replacedByJobId ↔ 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.
getter/setter pair
replaceJobId ↔ String
If this job is an update of an existing job, this field is the job ID of the job it replaced.
getter/setter pair
requestedState ↔ JobState
The job's requested state.
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
satisfiesPzs ↔ 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.
getter/setter pair
stageStates → List<ExecutionStageState>
This field may be mutated by the Cloud Dataflow service; callers cannot mutate it.
no setter
startTime ↔ Timestamp
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.
getter/setter pair
stepsLocation ↔ String
The Cloud Storage location where the steps are stored.
getter/setter pair
tempFiles → 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.
no setter
type ↔ JobType
The type of Cloud Dataflow job.
getter/setter pair
unknownFields → UnknownFieldSet
no setterinherited

Methods

addExtension(Extension extension, Object? value) → void
Adds an extension field value to a repeated field.
inherited
check() → void
inherited
clear() → void
Clears all data that was set in this message.
inherited
clearClientRequestId() → void
clearCreatedFromSnapshotId() → void
clearCreateTime() → void
clearCurrentState() → void
clearCurrentStateTime() → void
clearEnvironment() → void
clearExecutionInfo() → void
clearExtension(Extension extension) → void
Clears an extension field and also removes the extension.
inherited
clearField(int tagNumber) → void
Clears the contents of a given field.
inherited
clearId() → void
clearJobMetadata() → void
clearLocation() → void
clearName() → void
clearProjectId() → void
clearReplacedByJobId() → void
clearReplaceJobId() → void
clearRequestedState() → void
clearSatisfiesPzs() → void
clearStartTime() → void
clearStepsLocation() → void
clearType() → void
clone() → Job
Creates a deep copy of the fields in this message. (The generated code uses mergeFromMessage.)
override
copyWith(void updates(Job)) → Job
Apply updates to a copy of this message.
override
createEmptyInstance() → Job
Creates an empty instance of the same message type as this.
override
createMapField<K, V>(int tagNumber, MapFieldInfo<K, V> fi) → Map<K, V>
Creates a Map representing a map field.
inherited
createRepeatedField<T>(int tagNumber, FieldInfo<T> fi) → List<T>
Creates List implementing a mutable repeated field.
inherited
ensureCreateTime() → Timestamp
ensureCurrentStateTime() → Timestamp
ensureEnvironment() → Environment
ensureExecutionInfo() → JobExecutionInfo
ensureJobMetadata() → JobMetadata
ensureStartTime() → Timestamp
extensionsAreInitialized() → bool
inherited
freeze() → GeneratedMessage
Make this message read-only.
inherited
getDefaultForField(int tagNumber) → dynamic
Returns the default value for the given field.
inherited
getExtension(Extension extension) → dynamic
Returns the value of extension.
inherited
getField(int tagNumber) → dynamic
Returns the value of the field associated with tagNumber, or the default value if it is not set.
inherited
getFieldOrNull(int tagNumber) → dynamic
Returns the value of a field, ignoring any defaults.
inherited
getTagNumber(String fieldName) → int?
inherited
hasClientRequestId() → bool
hasCreatedFromSnapshotId() → bool
hasCreateTime() → bool
hasCurrentState() → bool
hasCurrentStateTime() → bool
hasEnvironment() → bool
hasExecutionInfo() → bool
hasExtension(Extension extension) → bool
Returns true if a value of extension is present.
inherited
hasField(int tagNumber) → bool
Whether this message has a field associated with tagNumber.
inherited
hasId() → bool
hasJobMetadata() → bool
hasLocation() → bool
hasName() → bool
hasProjectId() → bool
hasReplacedByJobId() → bool
hasReplaceJobId() → bool
hasRequestedState() → bool
hasRequiredFields() → bool
Whether the message has required fields.
inherited
hasSatisfiesPzs() → bool
hasStartTime() → bool
hasStepsLocation() → bool
hasType() → bool
isInitialized() → bool
Whether all required fields in the message and embedded messages are set.
inherited
mergeFromBuffer(List<int> input, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void
Merges serialized protocol buffer data into this message.
inherited
mergeFromCodedBufferReader(CodedBufferReader input, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void
inherited
mergeFromJson(String data, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void
Merges field values from data, a JSON object, encoded as described by GeneratedMessage.writeToJson.
inherited
mergeFromJsonMap(Map<String, dynamic> json, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void
Merges field values from a JSON object represented as a Dart map.
inherited
mergeFromMessage(GeneratedMessage other) → void
Merges the contents of the other into this message.
inherited
mergeFromProto3Json(Object? json, {TypeRegistry typeRegistry = const TypeRegistry.empty(), bool ignoreUnknownFields = false, bool supportNamesWithUnderscores = true, bool permissiveEnums = false}) → void
Merges field values from json, a JSON object using proto3 encoding.
inherited
mergeUnknownFields(UnknownFieldSet unknownFieldSet) → void
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
setExtension(Extension extension, Object value) → void
Sets the value of a non-repeated extension field to value.
inherited
setField(int tagNumber, Object value) → void
Sets the value of a field by its tagNumber.
inherited
toBuilder() → GeneratedMessage
Creates a writable, shallow copy of this message.
inherited
toDebugString() → String
Returns a String representation of this message.
inherited
toProto3Json({TypeRegistry typeRegistry = const TypeRegistry.empty()}) → Object?
Returns an Object representing Proto3 JSON serialization of this.
inherited
toString() → String
Returns a String representation of this message.
inherited
writeToBuffer() → Uint8List
inherited
writeToCodedBufferWriter(CodedBufferWriter output) → void
inherited
writeToJson() → String
Returns a JSON string that encodes this message.
inherited
writeToJsonMap() → Map<String, dynamic>
Returns the JSON encoding of this message as a Dart Map.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

create() → Job
createRepeated() → PbList<Job>
getDefault() → Job