Console
    Contact Us Start free

    REST Resource: projects.locations.lakes.tasks.jobs

    Resource: Job

    A job represents an instance of a task.

    JSON representation 
     { 
 "name" 
 : 
 string 
 , 
 "uid" 
 : 
 string 
 , 
 "startTime" 
 : 
 string 
 , 
 "endTime" 
 : 
 string 
 , 
 "state" 
 : 
 enum (  State 
 
) 
 , 
 "retryCount" 
 : 
 integer 
 , 
 "service" 
 : 
 enum (  Service 
 
) 
 , 
 "serviceJob" 
 : 
 string 
 , 
 "message" 
 : 
 string 
 , 
 "labels" 
 : 
 { 
 string 
 : 
 string 
 , 
 ... 
 } 
 , 
 "trigger" 
 : 
 enum (  Trigger 
 
) 
 , 
 "executionSpec" 
 : 
 { 
 object (  ExecutionSpec 
 
) 
 } 
 }
    Fields
    name

    string

    Output only. The relative resource name of the job, of the form: projects/{project_number}/locations/{locationId}/lakes/{lakeId}/tasks/{taskId}/jobs/{jobId} .
    uid

    string

    Output only. System generated globally unique ID for the job.
    startTime

    string ( Timestamp format)

    Output only. The time when the job was started.

    Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30" .
    endTime

    string ( Timestamp format)

    Output only. The time when the job ended.

    Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30" .
    state

    enum ( State )

    Output only. Execution state for the job.
    retryCount

    integer ( uint32 format)

    Output only. The number of times the job has been retried (excluding the initial attempt).
    service

    enum ( Service )

    Output only. The underlying service running a job.
    serviceJob

    string

    Output only. The full resource name for the job run under a particular service.
    message

    string

    Output only. Additional information about the current state.
    labels

    map (key: string, value: string)

    Output only. User-defined labels for the task.

    An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" } .
    trigger

    enum ( Trigger )

    Output only. Job execution trigger.
    executionSpec

    object ( ExecutionSpec )

    Output only. Spec related to how a task is executed.

    State

    Enums
    STATE_UNSPECIFIED The job state is unknown.
    RUNNING The job is running.
    CANCELLING The job is cancelling.
    CANCELLED The job cancellation was successful.
    SUCCEEDED The job completed successfully.
    FAILED The job is no longer running due to an error.
    ABORTED The job was cancelled outside of Dataplex Universal Catalog.

    Service

    Enums
    SERVICE_UNSPECIFIED Service used to run the job is unspecified.
    DATAPROC Dataproc service is used to run this job.

    Trigger

    Job execution trigger.

    Enums
    TRIGGER_UNSPECIFIED The trigger is unspecified.
    TASK_CONFIG The job was triggered by Dataplex Universal Catalog based on trigger spec from task definition.
    RUN_REQUEST The job was triggered by the explicit call of Task API.

    Methods

    cancel

    		Cancel jobs running for the task resource.

    get

    		Get job resource.

    list

    		Lists Jobs under the given task.
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: