Class CustomJob (0.4.0)

CustomJob(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Represents a job that runs custom workloads such as a Docker container or a Python package. A CustomJob can have multiple worker pools and each worker pool can have its own machine and input spec. A CustomJob will be cleaned up once the job enters terminal state (failed or succeeded).


name str
Output only. Resource name of a CustomJob.
display_name str
Required. The display name of the CustomJob. The name can be up to 128 characters long and can be consist of any UTF-8 characters.
job_spec `.custom_job.CustomJobSpec`
Required. Job spec.
state `.job_state.JobState`
Output only. The detailed state of the job.
create_time `.timestamp.Timestamp`
Output only. Time when the CustomJob was created.
start_time `.timestamp.Timestamp`
Output only. Time when the CustomJob for the first time entered the ``JOB_STATE_RUNNING`` state.
end_time `.timestamp.Timestamp`
Output only. Time when the CustomJob entered any of the following states: ``JOB_STATE_SUCCEEDED``, ``JOB_STATE_FAILED``, ``JOB_STATE_CANCELLED``.
update_time `.timestamp.Timestamp`
Output only. Time when the CustomJob was most recently updated.
error `.status.Status`
Output only. Only populated when job's state is ``JOB_STATE_FAILED`` or ``JOB_STATE_CANCELLED``.
labels Sequence[`.custom_job.CustomJob.LabelsEntry`]
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 for more information and examples of labels.


builtins.object > proto.message.Message > CustomJob



LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The abstract base class for a message.

kwargs dict

Keys and values corresponding to the fields of the message.

mapping Union[dict, `.Message`]

A dictionary or message to be used to determine the values for this message.

ignore_unknown_fields Optional(bool)

If True, do not raise errors for unknown fields. Only applied if mapping is a mapping type or there are keyword parameters.