GetJobResult class

Result data returned by getJob.

Constructors

GetJobResult({required String clientRequestId, required String createTime, required String createdFromSnapshotId, required String currentState, required String currentStateTime, required EnvironmentResponse environment, required JobExecutionInfoResponse executionInfo, required JobMetadataResponse jobMetadata, required Map<String, String> labels, required String location, required String name, required PipelineDescriptionResponse pipelineDescription, required String project, required String replaceJobId, required String replacedByJobId, required String requestedState, required RuntimeUpdatableParamsResponse runtimeUpdatableParams, required bool satisfiesPzi, required bool satisfiesPzs, required List<ExecutionStageStateResponse> stageStates, required String startTime, required List<StepResponse> steps, required String stepsLocation, required List<String> tempFiles, required Map<String, String> transformNameMapping, required String type})
Creates a new GetJobResult. clientRequestId 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. createTime The timestamp when the job was initially created. Immutable and set by the Cloud Dataflow service. createdFromSnapshotId If this is specified, the job's initial state is populated from the given snapshot. currentState 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. currentStateTime The timestamp associated with the current state. environment The environment for the job. executionInfo Deprecated. 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. labels 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. location The regional endpoint (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains this job. name 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])? pipelineDescription 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. project The ID of the Cloud Platform project that the job belongs to. replaceJobId 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. replacedByJobId 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. requestedState 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. runtimeUpdatableParams 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. satisfiesPzi Reserved for future use. This field is set only in responses from the server; it is ignored if it is set in any requests. satisfiesPzs Reserved for future use. This field is set only in responses from the server; it is ignored if it is set in any requests. stageStates This field may be mutated by the Cloud Dataflow service; callers cannot mutate it. startTime 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. steps 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. stepsLocation The Cloud Storage location where the steps are stored. tempFiles 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} transformNameMapping The map of transform name prefixes of the job to be replaced to the corresponding name prefixes of the new job. type The type of Cloud Dataflow job.
const
GetJobResult.fromMap(Map<String, dynamic> map)
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.
final
createdFromSnapshotId → String
If this is specified, the job's initial state is populated from the given snapshot.
final
createTime → String
The timestamp when the job was initially created. Immutable and set by the Cloud Dataflow service.
final
currentState → 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.
final
currentStateTime → String
The timestamp associated with the current state.
final
environment → EnvironmentResponse
The environment for the job.
final
executionInfo → JobExecutionInfoResponse
Deprecated.
final
hashCode → int
The hash code for this object.
no setterinherited
jobMetadata → 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.
final
labels → 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.
final
location → String
The regional endpoint (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains this job.
final
name → 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])?
final
pipelineDescription → 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.
final
project → String
The ID of the Cloud Platform project that the job belongs to.
final
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.
final
replaceJobId → String
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.
final
requestedState → 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.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
runtimeUpdatableParams → 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.
final
satisfiesPzi → 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.
final
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.
final
stageStates → List<ExecutionStageStateResponse>
This field may be mutated by the Cloud Dataflow service; callers cannot mutate it.
final
startTime → 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.
final
steps → List<StepResponse>
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.
final
stepsLocation → String
The Cloud Storage location where the steps are stored.
final
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. The supported files are: Google Cloud Storage: storage.googleapis.com/{bucket}/{object} bucket.storage.googleapis.com/{object}
final
transformNameMapping → Map<String, String>
The map of transform name prefixes of the job to be replaced to the corresponding name prefixes of the new job.
final
type → String
The type of Cloud Dataflow job.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

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