Sign in

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-132661,4471.5 MB
projects

Creates a CustomJob. A created CustomJob right away will be attempted to be run.

post/v1/{+parent}/customJobs

Path parameters

parentstring required

Required. The resource name of the Location to create the CustomJob in. Format: projects/{project}/locations/{location}

Request body

displayNamestring

Required. The display name of the CustomJob. The name can be up to 128 characters long and can consist of any UTF-8 characters.

satisfiesPziboolean

Output only. Reserved for future use.

namestring

Output only. Resource name of a CustomJob.

endTimestring google-datetime

Output only. Time when the CustomJob entered any of the following states: JOB_STATE_SUCCEEDED, JOB_STATE_FAILED, JOB_STATE_CANCELLED.

satisfiesPzsboolean

Output only. Reserved for future use.

startTimestring google-datetime

Output only. Time when the CustomJob for the first time entered the JOB_STATE_RUNNING state.

webAccessUrisobject

Output only. URIs for accessing interactive shells (one URI for each training node). Only available if job_spec.enable_web_access is true. The keys are names of each node in the training job; for example, workerpool0-0 for the primary node, workerpool1-0 for the first node in the second worker pool, and workerpool1-1 for the second node in the second worker pool. The values are the URIs for each node's interactive shell.

state'JOB_STATE_UNSPECIFIED' | 'JOB_STATE_QUEUED' | 'JOB_STATE_PENDING' | 'JOB_STATE_RUNNING' | 'JOB_STATE_SUCCEEDED' | 'JOB_STATE_FAILED' | 'JOB_STATE_CANCELLING' | 'JOB_STATE_CANCELLED' | 'JOB_STATE_PAUSED' | 'JOB_STATE_EXPIRED' | 'JOB_STATE_UPDATING' | 'JOB_STATE_PARTIALLY_SUCCEEDED'

Output only. The detailed state of the job.

createTimestring google-datetime

Output only. Time when the CustomJob was created.

labelsobject

The labels with user-defined metadata to organize CustomJobs. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels.

updateTimestring google-datetime

Output only. Time when the CustomJob was most recently updated.

Response

Successful response