Class CustomJob (1.5.0)

Version 1.5.0

• 1.47.0 (latest)
• 1.46.0
• 1.45.0
• 1.44.0
• 1.43.0
• 1.39.0
• 1.38.1
• 1.37.0
• 1.36.4
• 1.35.0
• 1.34.0
• 1.33.1
• 1.32.0
• 1.31.1
• 1.30.1
• 1.29.0
• 1.28.1
• 1.27.1
• 1.26.1
• 1.25.0
• 1.24.1
• 1.23.0
• 1.22.1
• 1.21.0
• 1.20.0
• 1.19.1
• 1.18.3
• 1.17.1
• 1.16.1
• 1.15.1
• 1.14.0
• 1.13.1
• 1.12.1
• 1.11.0
• 1.10.0
• 1.9.0
• 1.8.1
• 1.7.1
• 1.6.2
• 1.5.0
• 1.4.3
• 1.3.0
• 1.2.0
• 1.1.1
• 1.0.1
• 0.9.0
• 0.8.0
• 0.7.1
• 0.6.0
• 0.5.1
• 0.4.0
• 0.3.1

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).

Attributes

Name	Description
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	google.cloud.aiplatform_v1.types.CustomJobSpec Required. Job spec.
state	google.cloud.aiplatform_v1.types.JobState Output only. The detailed state of the job.
create_time	google.protobuf.timestamp_pb2.Timestamp Output only. Time when the CustomJob was created.
start_time	google.protobuf.timestamp_pb2.Timestamp Output only. Time when the CustomJob for the first time entered the ``JOB_STATE_RUNNING`` state.
end_time	google.protobuf.timestamp_pb2.Timestamp Output only. Time when the CustomJob entered any of the following states: ``JOB_STATE_SUCCEEDED``, ``JOB_STATE_FAILED``, ``JOB_STATE_CANCELLED``.
update_time	google.protobuf.timestamp_pb2.Timestamp Output only. Time when the CustomJob was most recently updated.
error	google.rpc.status_pb2.Status Output only. Only populated when job's state is ``JOB_STATE_FAILED`` or ``JOB_STATE_CANCELLED``.
labels	Sequence[google.cloud.aiplatform_v1.types.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 https://goo.gl/xmQnxf for more information and examples of labels.
encryption_spec	google.cloud.aiplatform_v1.types.EncryptionSpec Customer-managed encryption key options for a CustomJob. If this is set, then all resources created by the CustomJob will be encrypted with the provided encryption key.
web_access_uris	Sequence[google.cloud.aiplatform_v1.types.CustomJob.WebAccessUrisEntry] Output only. URIs for accessing `interactive shells

Inheritance

builtins.object > proto.message.Message > CustomJob

Classes

LabelsEntry

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

The abstract base class for a message.

Parameters

Name	Description
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.

WebAccessUrisEntry

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

The abstract base class for a message.

Parameters

Name	Description
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.