All Downloads are FREE. Search and download functionalities are using the official Maven repository.

target.apidocs.com.google.api.services.dataflow.model.Job.html Maven / Gradle / Ivy

There is a newer version: v1b4-rev7-1.20.0
Show newest version






Job (Dataflow API v1b3-rev20231112-2.0.0)












com.google.api.services.dataflow.model

Class Job

  • All Implemented Interfaces:
    Cloneable, Map<String,Object>


    public final class Job
    extends com.google.api.client.json.GenericJson
    Defines a job to be run by the Cloud Dataflow service. Do not enter confidential information when you supply string values using the API.

    This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Dataflow API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

    Author:
    Google, Inc.
    • Constructor Detail

      • Job

        public Job()
    • Method Detail

      • 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.
        Returns:
        value or null for none
      • setClientRequestId

        public Job setClientRequestId(String 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.
        Parameters:
        clientRequestId - clientRequestId or null for none
      • getCreateTime

        public String getCreateTime()
        The timestamp when the job was initially created. Immutable and set by the Cloud Dataflow service.
        Returns:
        value or null for none
      • setCreateTime

        public Job setCreateTime(String createTime)
        The timestamp when the job was initially created. Immutable and set by the Cloud Dataflow service.
        Parameters:
        createTime - createTime or null for none
      • getCreatedFromSnapshotId

        public String getCreatedFromSnapshotId()
        If this is specified, the job's initial state is populated from the given snapshot.
        Returns:
        value or null for none
      • setCreatedFromSnapshotId

        public Job setCreatedFromSnapshotId(String createdFromSnapshotId)
        If this is specified, the job's initial state is populated from the given snapshot.
        Parameters:
        createdFromSnapshotId - createdFromSnapshotId or null for none
      • getCurrentState

        public String 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.
        Returns:
        value or null for none
      • setCurrentState

        public Job setCurrentState(String 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.
        Parameters:
        currentState - currentState or null for none
      • getCurrentStateTime

        public String getCurrentStateTime()
        The timestamp associated with the current state.
        Returns:
        value or null for none
      • setCurrentStateTime

        public Job setCurrentStateTime(String currentStateTime)
        The timestamp associated with the current state.
        Parameters:
        currentStateTime - currentStateTime or null for none
      • getEnvironment

        public Environment getEnvironment()
        The environment for the job.
        Returns:
        value or null for none
      • setEnvironment

        public Job setEnvironment(Environment environment)
        The environment for the job.
        Parameters:
        environment - environment or null for none
      • getExecutionInfo

        public JobExecutionInfo getExecutionInfo()
        Deprecated.
        Returns:
        value or null for none
      • setExecutionInfo

        public Job setExecutionInfo(JobExecutionInfo executionInfo)
        Deprecated.
        Parameters:
        executionInfo - executionInfo or null for none
      • getId

        public 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.
        Returns:
        value or null for none
      • setId

        public Job setId(String id)
        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.
        Parameters:
        id - id or null for none
      • 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.
        Returns:
        value or null for none
      • setJobMetadata

        public Job setJobMetadata(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.
        Parameters:
        jobMetadata - jobMetadata or null for none
      • getLabels

        public Map<String,String> getLabels()
        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.
        Returns:
        value or null for none
      • setLabels

        public Job setLabels(Map<String,String> 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.
        Parameters:
        labels - labels or null for none
      • getLocation

        public String getLocation()
        The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains this job.
        Returns:
        value or null for none
      • setLocation

        public Job setLocation(String location)
        The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains this job.
        Parameters:
        location - location or null for none
      • getName

        public String getName()
        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])?`
        Returns:
        value or null for none
      • setName

        public Job setName(String 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])?`
        Parameters:
        name - name or null for none
      • 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.
        Returns:
        value or null for none
      • setPipelineDescription

        public Job setPipelineDescription(PipelineDescription 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.
        Parameters:
        pipelineDescription - pipelineDescription or null for none
      • getProjectId

        public String getProjectId()
        The ID of the Cloud Platform project that the job belongs to.
        Returns:
        value or null for none
      • setProjectId

        public Job setProjectId(String projectId)
        The ID of the Cloud Platform project that the job belongs to.
        Parameters:
        projectId - projectId or null for none
      • 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.
        Returns:
        value or null for none
      • setReplaceJobId

        public Job setReplaceJobId(String 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.
        Parameters:
        replaceJobId - replaceJobId or null for none
      • 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.
        Returns:
        value or null for none
      • setReplacedByJobId

        public Job setReplacedByJobId(String 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.
        Parameters:
        replacedByJobId - replacedByJobId or null for none
      • getRequestedState

        public String 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.
        Returns:
        value or null for none
      • setRequestedState

        public Job setRequestedState(String 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.
        Parameters:
        requestedState - requestedState or null for none
      • 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.
        Returns:
        value or null for none
      • setRuntimeUpdatableParams

        public Job setRuntimeUpdatableParams(RuntimeUpdatableParams 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.
        Parameters:
        runtimeUpdatableParams - runtimeUpdatableParams or null for none
      • 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.
        Returns:
        value or null for none
      • setSatisfiesPzi

        public Job setSatisfiesPzi(Boolean satisfiesPzi)
        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.
        Parameters:
        satisfiesPzi - satisfiesPzi or null for none
      • 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.
        Returns:
        value or null for none
      • setSatisfiesPzs

        public Job setSatisfiesPzs(Boolean 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.
        Parameters:
        satisfiesPzs - satisfiesPzs or null for none
      • getStageStates

        public List<ExecutionStageState> getStageStates()
        This field may be mutated by the Cloud Dataflow service; callers cannot mutate it.
        Returns:
        value or null for none
      • setStageStates

        public Job setStageStates(List<ExecutionStageState> stageStates)
        This field may be mutated by the Cloud Dataflow service; callers cannot mutate it.
        Parameters:
        stageStates - stageStates or null for none
      • getStartTime

        public String 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.
        Returns:
        value or null for none
      • setStartTime

        public Job setStartTime(String 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.
        Parameters:
        startTime - startTime or null for none
      • getSteps

        public List<Step> getSteps()
        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.
        Returns:
        value or null for none
      • setSteps

        public Job setSteps(List<Step> 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.
        Parameters:
        steps - steps or null for none
      • getStepsLocation

        public String getStepsLocation()
        The Cloud Storage location where the steps are stored.
        Returns:
        value or null for none
      • setStepsLocation

        public Job setStepsLocation(String stepsLocation)
        The Cloud Storage location where the steps are stored.
        Parameters:
        stepsLocation - stepsLocation or null for none
      • getTempFiles

        public List<String> getTempFiles()
        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}
        Returns:
        value or null for none
      • setTempFiles

        public Job setTempFiles(List<String> 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}
        Parameters:
        tempFiles - tempFiles or null for none
      • getTransformNameMapping

        public Map<String,String> getTransformNameMapping()
        The map of transform name prefixes of the job to be replaced to the corresponding name prefixes of the new job.
        Returns:
        value or null for none
      • setTransformNameMapping

        public Job setTransformNameMapping(Map<String,String> transformNameMapping)
        The map of transform name prefixes of the job to be replaced to the corresponding name prefixes of the new job.
        Parameters:
        transformNameMapping - transformNameMapping or null for none
      • getType

        public String getType()
        The type of Cloud Dataflow job.
        Returns:
        value or null for none
      • setType

        public Job setType(String type)
        The type of Cloud Dataflow job.
        Parameters:
        type - type or null for none
      • set

        public Job set(String fieldName,
                       Object value)
        Overrides:
        set in class com.google.api.client.json.GenericJson
      • clone

        public Job clone()
        Overrides:
        clone in class com.google.api.client.json.GenericJson

Copyright © 2011–2023 Google. All rights reserved.





© 2015 - 2024 Weber Informatics LLC | Privacy Policy