Package com.google.dataflow.v1beta3

Class Job

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.dataflow.v1beta3.Job
All Implemented Interfaces:
JobOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class Job extends com.google.protobuf.GeneratedMessage implements JobOrBuilder
 Defines a job to be run by the Cloud Dataflow service. Do not enter
 confidential information when you supply string values using the API.
Protobuf type google.dataflow.v1beta3.Job
See Also:

  • Field Details

    • ID_FIELD_NUMBER

      public static final int ID_FIELD_NUMBER
      See Also:

    • PROJECT_ID_FIELD_NUMBER

      public static final int PROJECT_ID_FIELD_NUMBER
      See Also:

    • NAME_FIELD_NUMBER

      public static final int NAME_FIELD_NUMBER
      See Also:

    • TYPE_FIELD_NUMBER

      public static final int TYPE_FIELD_NUMBER
      See Also:

    • ENVIRONMENT_FIELD_NUMBER

      public static final int ENVIRONMENT_FIELD_NUMBER
      See Also:

    • STEPS_FIELD_NUMBER

      public static final int STEPS_FIELD_NUMBER
      See Also:

    • STEPS_LOCATION_FIELD_NUMBER

      public static final int STEPS_LOCATION_FIELD_NUMBER
      See Also:

    • CURRENT_STATE_FIELD_NUMBER

      public static final int CURRENT_STATE_FIELD_NUMBER
      See Also:

    • CURRENT_STATE_TIME_FIELD_NUMBER

      public static final int CURRENT_STATE_TIME_FIELD_NUMBER
      See Also:

    • REQUESTED_STATE_FIELD_NUMBER

      public static final int REQUESTED_STATE_FIELD_NUMBER
      See Also:

    • EXECUTION_INFO_FIELD_NUMBER

      public static final int EXECUTION_INFO_FIELD_NUMBER
      See Also:

    • CREATE_TIME_FIELD_NUMBER

      public static final int CREATE_TIME_FIELD_NUMBER
      See Also:

    • REPLACE_JOB_ID_FIELD_NUMBER

      public static final int REPLACE_JOB_ID_FIELD_NUMBER
      See Also:

    • TRANSFORM_NAME_MAPPING_FIELD_NUMBER

      public static final int TRANSFORM_NAME_MAPPING_FIELD_NUMBER
      See Also:

    • CLIENT_REQUEST_ID_FIELD_NUMBER

      public static final int CLIENT_REQUEST_ID_FIELD_NUMBER
      See Also:

    • REPLACED_BY_JOB_ID_FIELD_NUMBER

      public static final int REPLACED_BY_JOB_ID_FIELD_NUMBER
      See Also:

    • TEMP_FILES_FIELD_NUMBER

      public static final int TEMP_FILES_FIELD_NUMBER
      See Also:

    • LABELS_FIELD_NUMBER

      public static final int LABELS_FIELD_NUMBER
      See Also:

    • LOCATION_FIELD_NUMBER

      public static final int LOCATION_FIELD_NUMBER
      See Also:

    • PIPELINE_DESCRIPTION_FIELD_NUMBER

      public static final int PIPELINE_DESCRIPTION_FIELD_NUMBER
      See Also:

    • STAGE_STATES_FIELD_NUMBER

      public static final int STAGE_STATES_FIELD_NUMBER
      See Also:

    • JOB_METADATA_FIELD_NUMBER

      public static final int JOB_METADATA_FIELD_NUMBER
      See Also:

    • START_TIME_FIELD_NUMBER

      public static final int START_TIME_FIELD_NUMBER
      See Also:

    • CREATED_FROM_SNAPSHOT_ID_FIELD_NUMBER

      public static final int CREATED_FROM_SNAPSHOT_ID_FIELD_NUMBER
      See Also:

    • SATISFIES_PZS_FIELD_NUMBER

      public static final int SATISFIES_PZS_FIELD_NUMBER
      See Also:

    • RUNTIME_UPDATABLE_PARAMS_FIELD_NUMBER

      public static final int RUNTIME_UPDATABLE_PARAMS_FIELD_NUMBER
      See Also:

    • SATISFIES_PZI_FIELD_NUMBER

      public static final int SATISFIES_PZI_FIELD_NUMBER
      See Also:

    • SERVICE_RESOURCES_FIELD_NUMBER

      public static final int SERVICE_RESOURCES_FIELD_NUMBER
      See Also:

    • PAUSABLE_FIELD_NUMBER

      public static final int PAUSABLE_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
      Overrides:
      internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessage

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • getId

      public String getId()
       The unique ID of this job.

 This field is set by the Dataflow service when the job is
 created, and is immutable for the life of the job.
      string id = 1;
      Specified by:
      getId in interface JobOrBuilder
      Returns:
      The id.

    • getIdBytes

      public com.google.protobuf.ByteString getIdBytes()
       The unique ID of this job.

 This field is set by the Dataflow service when the job is
 created, and is immutable for the life of the job.
      string id = 1;
      Specified by:
      getIdBytes in interface JobOrBuilder
      Returns:
      The bytes for id.

    • getProjectId

      public String getProjectId()
       The ID of the Google Cloud project that the job belongs to.
      string project_id = 2;
      Specified by:
      getProjectId in interface JobOrBuilder
      Returns:
      The projectId.

    • getProjectIdBytes

      public com.google.protobuf.ByteString getProjectIdBytes()
       The ID of the Google Cloud project that the job belongs to.
      string project_id = 2;
      Specified by:
      getProjectIdBytes in interface JobOrBuilder
      Returns:
      The bytes for projectId.

    • getName

      public String getName()
       Optional. The user-specified Dataflow job name.

 Only one active 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 active job that already exists, the attempt returns the
 existing job.

 The name must match the regular expression
 `[a-z]([-a-z0-9]{0,1022}[a-z0-9])?`
      string name = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getName in interface JobOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
       Optional. The user-specified Dataflow job name.

 Only one active 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 active job that already exists, the attempt returns the
 existing job.

 The name must match the regular expression
 `[a-z]([-a-z0-9]{0,1022}[a-z0-9])?`
      string name = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getNameBytes in interface JobOrBuilder
      Returns:
      The bytes for name.

    • getTypeValue

      public int getTypeValue()
       Optional. The type of Dataflow job.
      .google.dataflow.v1beta3.JobType type = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getTypeValue in interface JobOrBuilder
      Returns:
      The enum numeric value on the wire for type.

    • getType

      public JobType getType()
       Optional. The type of Dataflow job.
      .google.dataflow.v1beta3.JobType type = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getType in interface JobOrBuilder
      Returns:
      The type.

    • hasEnvironment

      public boolean hasEnvironment()
       Optional. The environment for the job.
      .google.dataflow.v1beta3.Environment environment = 5 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasEnvironment in interface JobOrBuilder
      Returns:
      Whether the environment field is set.

    • getEnvironment

      public Environment getEnvironment()
       Optional. The environment for the job.
      .google.dataflow.v1beta3.Environment environment = 5 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getEnvironment in interface JobOrBuilder
      Returns:
      The environment.

    • getEnvironmentOrBuilder

      public EnvironmentOrBuilder getEnvironmentOrBuilder()
       Optional. The environment for the job.
      .google.dataflow.v1beta3.Environment environment = 5 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getEnvironmentOrBuilder in interface JobOrBuilder

    • getStepsList

      public List<Step> getStepsList()
       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.
      repeated .google.dataflow.v1beta3.Step steps = 6;
      Specified by:
      getStepsList in interface JobOrBuilder

    • getStepsOrBuilderList

      public List<? extends StepOrBuilder> getStepsOrBuilderList()
       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.
      repeated .google.dataflow.v1beta3.Step steps = 6;
      Specified by:
      getStepsOrBuilderList in interface JobOrBuilder

    • getStepsCount

      public int getStepsCount()
       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.
      repeated .google.dataflow.v1beta3.Step steps = 6;
      Specified by:
      getStepsCount in interface JobOrBuilder

    • getSteps

      public Step getSteps(int index)
       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.
      repeated .google.dataflow.v1beta3.Step steps = 6;
      Specified by:
      getSteps in interface JobOrBuilder

    • getStepsOrBuilder

      public StepOrBuilder getStepsOrBuilder(int index)
       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.
      repeated .google.dataflow.v1beta3.Step steps = 6;
      Specified by:
      getStepsOrBuilder in interface JobOrBuilder

    • getStepsLocation

      public String getStepsLocation()
       The Cloud Storage location where the steps are stored.
      string steps_location = 24;
      Specified by:
      getStepsLocation in interface JobOrBuilder
      Returns:
      The stepsLocation.

    • getStepsLocationBytes

      public com.google.protobuf.ByteString getStepsLocationBytes()
       The Cloud Storage location where the steps are stored.
      string steps_location = 24;
      Specified by:
      getStepsLocationBytes in interface JobOrBuilder
      Returns:
      The bytes for stepsLocation.

    • getCurrentStateValue

      public int getCurrentStateValue()
       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 might be mutated by the Dataflow service;
 callers cannot mutate it.
      .google.dataflow.v1beta3.JobState current_state = 7;
      Specified by:
      getCurrentStateValue in interface JobOrBuilder
      Returns:
      The enum numeric value on the wire for currentState.

    • getCurrentState

      public JobState getCurrentState()
       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 might be mutated by the Dataflow service;
 callers cannot mutate it.
      .google.dataflow.v1beta3.JobState current_state = 7;
      Specified by:
      getCurrentState in interface JobOrBuilder
      Returns:
      The currentState.

    • hasCurrentStateTime

      public boolean hasCurrentStateTime()
       The timestamp associated with the current state.
      .google.protobuf.Timestamp current_state_time = 8;
      Specified by:
      hasCurrentStateTime in interface JobOrBuilder
      Returns:
      Whether the currentStateTime field is set.

    • getCurrentStateTime

      public com.google.protobuf.Timestamp getCurrentStateTime()
       The timestamp associated with the current state.
      .google.protobuf.Timestamp current_state_time = 8;
      Specified by:
      getCurrentStateTime in interface JobOrBuilder
      Returns:
      The currentStateTime.

    • getCurrentStateTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getCurrentStateTimeOrBuilder()
       The timestamp associated with the current state.
      .google.protobuf.Timestamp current_state_time = 8;
      Specified by:
      getCurrentStateTimeOrBuilder in interface JobOrBuilder

    • getRequestedStateValue

      public int getRequestedStateValue()
       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.
      .google.dataflow.v1beta3.JobState requested_state = 9;
      Specified by:
      getRequestedStateValue in interface JobOrBuilder
      Returns:
      The enum numeric value on the wire for requestedState.

    • getRequestedState

      public JobState getRequestedState()
       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.
      .google.dataflow.v1beta3.JobState requested_state = 9;
      Specified by:
      getRequestedState in interface JobOrBuilder
      Returns:
      The requestedState.

    • hasExecutionInfo

      public boolean hasExecutionInfo()
       Deprecated.
      .google.dataflow.v1beta3.JobExecutionInfo execution_info = 10;
      Specified by:
      hasExecutionInfo in interface JobOrBuilder
      Returns:
      Whether the executionInfo field is set.

    • getExecutionInfo

      public JobExecutionInfo getExecutionInfo()
       Deprecated.
      .google.dataflow.v1beta3.JobExecutionInfo execution_info = 10;
      Specified by:
      getExecutionInfo in interface JobOrBuilder
      Returns:
      The executionInfo.

    • getExecutionInfoOrBuilder

      public JobExecutionInfoOrBuilder getExecutionInfoOrBuilder()
       Deprecated.
      .google.dataflow.v1beta3.JobExecutionInfo execution_info = 10;
      Specified by:
      getExecutionInfoOrBuilder in interface JobOrBuilder

    • hasCreateTime

      public boolean hasCreateTime()
       The timestamp when the job was initially created. Immutable and set by the
 Cloud Dataflow service.
      .google.protobuf.Timestamp create_time = 11;
      Specified by:
      hasCreateTime in interface JobOrBuilder
      Returns:
      Whether the createTime field is set.

    • getCreateTime

      public com.google.protobuf.Timestamp getCreateTime()
       The timestamp when the job was initially created. Immutable and set by the
 Cloud Dataflow service.
      .google.protobuf.Timestamp create_time = 11;
      Specified by:
      getCreateTime in interface JobOrBuilder
      Returns:
      The createTime.

    • getCreateTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
       The timestamp when the job was initially created. Immutable and set by the
 Cloud Dataflow service.
      .google.protobuf.Timestamp create_time = 11;
      Specified by:
      getCreateTimeOrBuilder in interface JobOrBuilder

    • getReplaceJobId

      public String getReplaceJobId()
       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.
      string replace_job_id = 12;
      Specified by:
      getReplaceJobId in interface JobOrBuilder
      Returns:
      The replaceJobId.

    • getReplaceJobIdBytes

      public com.google.protobuf.ByteString getReplaceJobIdBytes()
       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.
      string replace_job_id = 12;
      Specified by:
      getReplaceJobIdBytes in interface JobOrBuilder
      Returns:
      The bytes for replaceJobId.

    • getTransformNameMappingCount

      public int getTransformNameMappingCount()
      Description copied from interface: JobOrBuilder
       Optional. The map of transform name prefixes of the job to be replaced to
 the corresponding name prefixes of the new job.
      map<string, string> transform_name_mapping = 13 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getTransformNameMappingCount in interface JobOrBuilder

    • containsTransformNameMapping

      public boolean containsTransformNameMapping(String key)
       Optional. The map of transform name prefixes of the job to be replaced to
 the corresponding name prefixes of the new job.
      map<string, string> transform_name_mapping = 13 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      containsTransformNameMapping in interface JobOrBuilder

    • getTransformNameMapping

      @Deprecated public Map<String,String> getTransformNameMapping()
      Deprecated.
      Use getTransformNameMappingMap() instead.
      Specified by:
      getTransformNameMapping in interface JobOrBuilder

    • getTransformNameMappingMap

      public Map<String,String> getTransformNameMappingMap()
       Optional. The map of transform name prefixes of the job to be replaced to
 the corresponding name prefixes of the new job.
      map<string, string> transform_name_mapping = 13 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getTransformNameMappingMap in interface JobOrBuilder

    • getTransformNameMappingOrDefault

      public String getTransformNameMappingOrDefault(String key, String defaultValue)
       Optional. The map of transform name prefixes of the job to be replaced to
 the corresponding name prefixes of the new job.
      map<string, string> transform_name_mapping = 13 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getTransformNameMappingOrDefault in interface JobOrBuilder

    • getTransformNameMappingOrThrow

      public String getTransformNameMappingOrThrow(String key)
       Optional. The map of transform name prefixes of the job to be replaced to
 the corresponding name prefixes of the new job.
      map<string, string> transform_name_mapping = 13 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getTransformNameMappingOrThrow in interface JobOrBuilder

    • getClientRequestId

      public String getClientRequestId()
       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.
      string client_request_id = 14;
      Specified by:
      getClientRequestId in interface JobOrBuilder
      Returns:
      The clientRequestId.

    • getClientRequestIdBytes

      public com.google.protobuf.ByteString getClientRequestIdBytes()
       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.
      string client_request_id = 14;
      Specified by:
      getClientRequestIdBytes in interface JobOrBuilder
      Returns:
      The bytes for clientRequestId.

    • getReplacedByJobId

      public String getReplacedByJobId()
       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.
      string replaced_by_job_id = 15;
      Specified by:
      getReplacedByJobId in interface JobOrBuilder
      Returns:
      The replacedByJobId.

    • getReplacedByJobIdBytes

      public com.google.protobuf.ByteString getReplacedByJobIdBytes()
       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.
      string replaced_by_job_id = 15;
      Specified by:
      getReplacedByJobIdBytes in interface JobOrBuilder
      Returns:
      The bytes for replacedByJobId.

    • getTempFilesList

      public com.google.protobuf.ProtocolStringList getTempFilesList()
       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}
      repeated string temp_files = 16;
      Specified by:
      getTempFilesList in interface JobOrBuilder
      Returns:
      A list containing the tempFiles.

    • getTempFilesCount

      public int getTempFilesCount()
       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}
      repeated string temp_files = 16;
      Specified by:
      getTempFilesCount in interface JobOrBuilder
      Returns:
      The count of tempFiles.

    • getTempFiles

      public String getTempFiles(int index)
       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}
      repeated string temp_files = 16;
      Specified by:
      getTempFiles in interface JobOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The tempFiles at the given index.

    • getTempFilesBytes

      public com.google.protobuf.ByteString getTempFilesBytes(int index)
       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}
      repeated string temp_files = 16;
      Specified by:
      getTempFilesBytes in interface JobOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the tempFiles at the given index.

    • getLabelsCount

      public int getLabelsCount()
      Description copied from interface: JobOrBuilder
       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}][\p{Ll}\p{Lo}\p{N}_-]{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.
      map<string, string> labels = 17;
      Specified by:
      getLabelsCount in interface JobOrBuilder

    • containsLabels

      public boolean containsLabels(String key)
       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}][\p{Ll}\p{Lo}\p{N}_-]{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.
      map<string, string> labels = 17;
      Specified by:
      containsLabels in interface JobOrBuilder

    • getLabels

      @Deprecated public Map<String,String> getLabels()
      Deprecated.
      Use getLabelsMap() instead.
      Specified by:
      getLabels in interface JobOrBuilder

    • getLabelsMap

      public Map<String,String> getLabelsMap()
       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}][\p{Ll}\p{Lo}\p{N}_-]{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.
      map<string, string> labels = 17;
      Specified by:
      getLabelsMap in interface JobOrBuilder

    • getLabelsOrDefault

      public String getLabelsOrDefault(String key, String defaultValue)
       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}][\p{Ll}\p{Lo}\p{N}_-]{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.
      map<string, string> labels = 17;
      Specified by:
      getLabelsOrDefault in interface JobOrBuilder

    • getLabelsOrThrow

      public String getLabelsOrThrow(String key)
       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}][\p{Ll}\p{Lo}\p{N}_-]{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.
      map<string, string> labels = 17;
      Specified by:
      getLabelsOrThrow in interface JobOrBuilder

    • getLocation

      public String getLocation()
       Optional. The [regional endpoint]
 (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that
 contains this job.
      string location = 18 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getLocation in interface JobOrBuilder
      Returns:
      The location.

    • getLocationBytes

      public com.google.protobuf.ByteString getLocationBytes()
       Optional. The [regional endpoint]
 (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that
 contains this job.
      string location = 18 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getLocationBytes in interface JobOrBuilder
      Returns:
      The bytes for location.

    • hasPipelineDescription

      public boolean hasPipelineDescription()
       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.
      .google.dataflow.v1beta3.PipelineDescription pipeline_description = 19;
      Specified by:
      hasPipelineDescription in interface JobOrBuilder
      Returns:
      Whether the pipelineDescription field is set.

    • getPipelineDescription

      public PipelineDescription getPipelineDescription()
       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.
      .google.dataflow.v1beta3.PipelineDescription pipeline_description = 19;
      Specified by:
      getPipelineDescription in interface JobOrBuilder
      Returns:
      The pipelineDescription.

    • getPipelineDescriptionOrBuilder

      public PipelineDescriptionOrBuilder getPipelineDescriptionOrBuilder()
       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.
      .google.dataflow.v1beta3.PipelineDescription pipeline_description = 19;
      Specified by:
      getPipelineDescriptionOrBuilder in interface JobOrBuilder

    • getStageStatesList

      public List<ExecutionStageState> getStageStatesList()
       This field may be mutated by the Cloud Dataflow service;
 callers cannot mutate it.
      repeated .google.dataflow.v1beta3.ExecutionStageState stage_states = 20;
      Specified by:
      getStageStatesList in interface JobOrBuilder

    • getStageStatesOrBuilderList

      public List<? extends ExecutionStageStateOrBuilder> getStageStatesOrBuilderList()
       This field may be mutated by the Cloud Dataflow service;
 callers cannot mutate it.
      repeated .google.dataflow.v1beta3.ExecutionStageState stage_states = 20;
      Specified by:
      getStageStatesOrBuilderList in interface JobOrBuilder

    • getStageStatesCount

      public int getStageStatesCount()
       This field may be mutated by the Cloud Dataflow service;
 callers cannot mutate it.
      repeated .google.dataflow.v1beta3.ExecutionStageState stage_states = 20;
      Specified by:
      getStageStatesCount in interface JobOrBuilder

    • getStageStates

      public ExecutionStageState getStageStates(int index)
       This field may be mutated by the Cloud Dataflow service;
 callers cannot mutate it.
      repeated .google.dataflow.v1beta3.ExecutionStageState stage_states = 20;
      Specified by:
      getStageStates in interface JobOrBuilder

    • getStageStatesOrBuilder

      public ExecutionStageStateOrBuilder getStageStatesOrBuilder(int index)
       This field may be mutated by the Cloud Dataflow service;
 callers cannot mutate it.
      repeated .google.dataflow.v1beta3.ExecutionStageState stage_states = 20;
      Specified by:
      getStageStatesOrBuilder in interface JobOrBuilder

    • hasJobMetadata

      public boolean hasJobMetadata()
       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.
      .google.dataflow.v1beta3.JobMetadata job_metadata = 21;
      Specified by:
      hasJobMetadata in interface JobOrBuilder
      Returns:
      Whether the jobMetadata field is set.

    • getJobMetadata

      public JobMetadata getJobMetadata()
       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.
      .google.dataflow.v1beta3.JobMetadata job_metadata = 21;
      Specified by:
      getJobMetadata in interface JobOrBuilder
      Returns:
      The jobMetadata.

    • getJobMetadataOrBuilder

      public JobMetadataOrBuilder getJobMetadataOrBuilder()
       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.
      .google.dataflow.v1beta3.JobMetadata job_metadata = 21;
      Specified by:
      getJobMetadataOrBuilder in interface JobOrBuilder

    • hasStartTime

      public boolean hasStartTime()
       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.
      .google.protobuf.Timestamp start_time = 22;
      Specified by:
      hasStartTime in interface JobOrBuilder
      Returns:
      Whether the startTime field is set.

    • getStartTime

      public com.google.protobuf.Timestamp getStartTime()
       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.
      .google.protobuf.Timestamp start_time = 22;
      Specified by:
      getStartTime in interface JobOrBuilder
      Returns:
      The startTime.

    • getStartTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getStartTimeOrBuilder()
       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.
      .google.protobuf.Timestamp start_time = 22;
      Specified by:
      getStartTimeOrBuilder in interface JobOrBuilder

    • getCreatedFromSnapshotId

      public String getCreatedFromSnapshotId()
       If this is specified, the job's initial state is populated from the given
 snapshot.
      string created_from_snapshot_id = 23;
      Specified by:
      getCreatedFromSnapshotId in interface JobOrBuilder
      Returns:
      The createdFromSnapshotId.

    • getCreatedFromSnapshotIdBytes

      public com.google.protobuf.ByteString getCreatedFromSnapshotIdBytes()
       If this is specified, the job's initial state is populated from the given
 snapshot.
      string created_from_snapshot_id = 23;
      Specified by:
      getCreatedFromSnapshotIdBytes in interface JobOrBuilder
      Returns:
      The bytes for createdFromSnapshotId.

    • getSatisfiesPzs

      public boolean getSatisfiesPzs()
       Reserved for future use. This field is set only in responses from the
 server; it is ignored if it is set in any requests.
      bool satisfies_pzs = 25;
      Specified by:
      getSatisfiesPzs in interface JobOrBuilder
      Returns:
      The satisfiesPzs.

    • hasRuntimeUpdatableParams

      public boolean hasRuntimeUpdatableParams()
       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.
      optional .google.dataflow.v1beta3.RuntimeUpdatableParams runtime_updatable_params = 26;
      Specified by:
      hasRuntimeUpdatableParams in interface JobOrBuilder
      Returns:
      Whether the runtimeUpdatableParams field is set.

    • getRuntimeUpdatableParams

      public RuntimeUpdatableParams getRuntimeUpdatableParams()
       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.
      optional .google.dataflow.v1beta3.RuntimeUpdatableParams runtime_updatable_params = 26;
      Specified by:
      getRuntimeUpdatableParams in interface JobOrBuilder
      Returns:
      The runtimeUpdatableParams.

    • getRuntimeUpdatableParamsOrBuilder

      public RuntimeUpdatableParamsOrBuilder getRuntimeUpdatableParamsOrBuilder()
       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.
      optional .google.dataflow.v1beta3.RuntimeUpdatableParams runtime_updatable_params = 26;
      Specified by:
      getRuntimeUpdatableParamsOrBuilder in interface JobOrBuilder

    • hasSatisfiesPzi

      public boolean hasSatisfiesPzi()
       Output only. Reserved for future use. This field is set only in responses
 from the server; it is ignored if it is set in any requests.
      optional bool satisfies_pzi = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasSatisfiesPzi in interface JobOrBuilder
      Returns:
      Whether the satisfiesPzi field is set.

    • getSatisfiesPzi

      public boolean getSatisfiesPzi()
       Output only. Reserved for future use. This field is set only in responses
 from the server; it is ignored if it is set in any requests.
      optional bool satisfies_pzi = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getSatisfiesPzi in interface JobOrBuilder
      Returns:
      The satisfiesPzi.

    • hasServiceResources

      public boolean hasServiceResources()
       Output only. Resources used by the Dataflow Service to run the job.
      optional .google.dataflow.v1beta3.ServiceResources service_resources = 28 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasServiceResources in interface JobOrBuilder
      Returns:
      Whether the serviceResources field is set.

    • getServiceResources

      public ServiceResources getServiceResources()
       Output only. Resources used by the Dataflow Service to run the job.
      optional .google.dataflow.v1beta3.ServiceResources service_resources = 28 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getServiceResources in interface JobOrBuilder
      Returns:
      The serviceResources.

    • getServiceResourcesOrBuilder

      public ServiceResourcesOrBuilder getServiceResourcesOrBuilder()
       Output only. Resources used by the Dataflow Service to run the job.
      optional .google.dataflow.v1beta3.ServiceResources service_resources = 28 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getServiceResourcesOrBuilder in interface JobOrBuilder

    • getPausable

      public boolean getPausable()
       Output only. Indicates whether the job can be paused.
      bool pausable = 29 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getPausable in interface JobOrBuilder
      Returns:
      The pausable.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static Job parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Job parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Job parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Job parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Job parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Job parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Job parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Job parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Job parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Job parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Job parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Job parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public Job.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static Job.Builder newBuilder()

    • newBuilder

      public static Job.Builder newBuilder(Job prototype)

    • toBuilder

      public Job.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected Job.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static Job getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<Job> parser()

    • getParserForType

      public com.google.protobuf.Parser<Job> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public Job getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder