Package com.google.dataflow.v1beta3

Interface JobOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    Job, Job.Builder
    public interface JobOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • getId

        String getId()
         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.
        string id = 1;
        Returns:
        The id.

      • getIdBytes

        com.google.protobuf.ByteString getIdBytes()
         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.
        string id = 1;
        Returns:
        The bytes for id.

      • getProjectId

        String getProjectId()
         The ID of the Cloud Platform project that the job belongs to.
        string project_id = 2;
        Returns:
        The projectId.

      • getProjectIdBytes

        com.google.protobuf.ByteString getProjectIdBytes()
         The ID of the Cloud Platform project that the job belongs to.
        string project_id = 2;
        Returns:
        The bytes for projectId.

      • getName

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

 Only one Job with a given name may exist in a project at any
 given time. 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])?`
        string name = 3;
        Returns:
        The name.

      • getNameBytes

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

 Only one Job with a given name may exist in a project at any
 given time. 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])?`
        string name = 3;
        Returns:
        The bytes for name.

      • getTypeValue

        int getTypeValue()
         The type of Cloud Dataflow job.
        .google.dataflow.v1beta3.JobType type = 4;
        Returns:
        The enum numeric value on the wire for type.

      • getType

        JobType getType()
         The type of Cloud Dataflow job.
        .google.dataflow.v1beta3.JobType type = 4;
        Returns:
        The type.

      • hasEnvironment

        boolean hasEnvironment()
         The environment for the job.
        .google.dataflow.v1beta3.Environment environment = 5;
        Returns:
        Whether the environment field is set.

      • getEnvironment

        Environment getEnvironment()
         The environment for the job.
        .google.dataflow.v1beta3.Environment environment = 5;
        Returns:
        The environment.

      • getEnvironmentOrBuilder

        EnvironmentOrBuilder getEnvironmentOrBuilder()
         The environment for the job.
        .google.dataflow.v1beta3.Environment environment = 5;

      • getStepsList

        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;

      • getSteps

        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;

      • getStepsCount

        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;

      • getStepsOrBuilderList

        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;

      • getStepsOrBuilder

        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;

      • getStepsLocation

        String getStepsLocation()
         The Cloud Storage location where the steps are stored.
        string steps_location = 24;
        Returns:
        The stepsLocation.

      • getStepsLocationBytes

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

      • getCurrentStateValue

        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 may be mutated by the Cloud Dataflow service;
 callers cannot mutate it.
        .google.dataflow.v1beta3.JobState current_state = 7;
        Returns:
        The enum numeric value on the wire for currentState.

      • getCurrentState

        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 may be mutated by the Cloud Dataflow service;
 callers cannot mutate it.
        .google.dataflow.v1beta3.JobState current_state = 7;
        Returns:
        The currentState.

      • hasCurrentStateTime

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

      • getCurrentStateTime

        com.google.protobuf.Timestamp getCurrentStateTime()
         The timestamp associated with the current state.
        .google.protobuf.Timestamp current_state_time = 8;
        Returns:
        The currentStateTime.

      • getCurrentStateTimeOrBuilder

        com.google.protobuf.TimestampOrBuilder getCurrentStateTimeOrBuilder()
         The timestamp associated with the current state.
        .google.protobuf.Timestamp current_state_time = 8;

      • getRequestedStateValue

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

      • getRequestedState

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

      • hasExecutionInfo

        boolean hasExecutionInfo()
         Deprecated.
        .google.dataflow.v1beta3.JobExecutionInfo execution_info = 10;
        Returns:
        Whether the executionInfo field is set.

      • getExecutionInfo

        JobExecutionInfo getExecutionInfo()
         Deprecated.
        .google.dataflow.v1beta3.JobExecutionInfo execution_info = 10;
        Returns:
        The executionInfo.

      • getExecutionInfoOrBuilder

        JobExecutionInfoOrBuilder getExecutionInfoOrBuilder()
         Deprecated.
        .google.dataflow.v1beta3.JobExecutionInfo execution_info = 10;

      • hasCreateTime

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

      • getCreateTime

        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;
        Returns:
        The createTime.

      • getCreateTimeOrBuilder

        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;

      • getReplaceJobId

        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;
        Returns:
        The replaceJobId.

      • getReplaceJobIdBytes

        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;
        Returns:
        The bytes for replaceJobId.

      • getTransformNameMappingCount

        int getTransformNameMappingCount()
         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;

      • containsTransformNameMapping

        boolean containsTransformNameMapping​(String key)
         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;

      • getTransformNameMappingMap

        Map<String,​String> getTransformNameMappingMap()
         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;

      • getTransformNameMappingOrDefault

        String getTransformNameMappingOrDefault​(String key,
                                        String defaultValue)
         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;

      • getTransformNameMappingOrThrow

        String getTransformNameMappingOrThrow​(String key)
         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;

      • getClientRequestId

        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;
        Returns:
        The clientRequestId.

      • getClientRequestIdBytes

        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;
        Returns:
        The bytes for clientRequestId.

      • getReplacedByJobId

        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;
        Returns:
        The replacedByJobId.

      • getReplacedByJobIdBytes

        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;
        Returns:
        The bytes for replacedByJobId.

      • getTempFilesList

        List<String> 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;
        Returns:
        A list containing the tempFiles.

      • getTempFilesCount

        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;
        Returns:
        The count of tempFiles.

      • getTempFiles

        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;
        Parameters:
        index - The index of the element to return.
        Returns:
        The tempFiles at the given index.

      • getTempFilesBytes

        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;
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the tempFiles at the given index.

      • getLabelsCount

        int getLabelsCount()
         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;

      • containsLabels

        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;

      • getLabelsMap

        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;

      • getLabelsOrDefault

        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;

      • getLabelsOrThrow

        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;

      • getLocation

        String getLocation()
         The [regional endpoint]
 (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that
 contains this job.
        string location = 18;
        Returns:
        The location.

      • getLocationBytes

        com.google.protobuf.ByteString getLocationBytes()
         The [regional endpoint]
 (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that
 contains this job.
        string location = 18;
        Returns:
        The bytes for location.

      • hasPipelineDescription

        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;
        Returns:
        Whether the pipelineDescription field is set.

      • getPipelineDescription

        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;
        Returns:
        The pipelineDescription.

      • getPipelineDescriptionOrBuilder

        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;

      • getStageStatesList

        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;

      • getStageStates

        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;

      • getStageStatesCount

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

      • getStageStatesOrBuilderList

        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;

      • getStageStatesOrBuilder

        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;

      • hasJobMetadata

        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;
        Returns:
        Whether the jobMetadata field is set.

      • getJobMetadata

        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;
        Returns:
        The jobMetadata.

      • getJobMetadataOrBuilder

        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;

      • hasStartTime

        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;
        Returns:
        Whether the startTime field is set.

      • getStartTime

        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;
        Returns:
        The startTime.

      • getStartTimeOrBuilder

        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;

      • getCreatedFromSnapshotId

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

      • getCreatedFromSnapshotIdBytes

        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;
        Returns:
        The bytes for createdFromSnapshotId.

      • getSatisfiesPzs

        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;
        Returns:
        The satisfiesPzs.