public final class CustomJob extends GeneratedMessageV3 implements CustomJobOrBuilder
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).
Protobuf type google.cloud.aiplatform.v1.CustomJob
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
Static Fields
public static final int CREATE_TIME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int DISPLAY_NAME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int ENCRYPTION_SPEC_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int END_TIME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int ERROR_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int JOB_SPEC_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int LABELS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int NAME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int START_TIME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int STATE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int UPDATE_TIME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int WEB_ACCESS_URIS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
public static CustomJob getDefaultInstance()
public static final Descriptors.Descriptor getDescriptor()
public static CustomJob.Builder newBuilder()
public static CustomJob.Builder newBuilder(CustomJob prototype)
public static CustomJob parseDelimitedFrom(InputStream input)
public static CustomJob parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static CustomJob parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
public static CustomJob parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static CustomJob parseFrom(ByteString data)
public static CustomJob parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static CustomJob parseFrom(CodedInputStream input)
public static CustomJob parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static CustomJob parseFrom(InputStream input)
public static CustomJob parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static CustomJob parseFrom(ByteBuffer data)
public static CustomJob parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Parser<CustomJob> parser()
Methods
public boolean containsLabels(String key)
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.
map<string, string> labels = 11;
| Parameter |
|---|
| Name | Description |
key | String
|
public boolean containsWebAccessUris(String key)
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.
map<string, string> web_access_uris = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter |
|---|
| Name | Description |
key | String
|
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
Overrides
public Timestamp getCreateTime()
Output only. Time when the CustomJob was created.
.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
Timestamp | The createTime.
|
public TimestampOrBuilder getCreateTimeOrBuilder()
Output only. Time when the CustomJob was created.
.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
public CustomJob getDefaultInstanceForType()
public String getDisplayName()
Required. The display name of the CustomJob.
The name can be up to 128 characters long and can consist of any UTF-8
characters.
string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns |
|---|
| Type | Description |
String | The displayName.
|
public ByteString getDisplayNameBytes()
Required. The display name of the CustomJob.
The name can be up to 128 characters long and can consist of any UTF-8
characters.
string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns |
|---|
| Type | Description |
ByteString | The bytes for displayName.
|
public EncryptionSpec getEncryptionSpec()
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.
.google.cloud.aiplatform.v1.EncryptionSpec encryption_spec = 12;
public EncryptionSpecOrBuilder getEncryptionSpecOrBuilder()
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.
.google.cloud.aiplatform.v1.EncryptionSpec encryption_spec = 12;
public Timestamp getEndTime()
Output only. Time when the CustomJob entered any of the following states:
JOB_STATE_SUCCEEDED, JOB_STATE_FAILED, JOB_STATE_CANCELLED.
.google.protobuf.Timestamp end_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
public TimestampOrBuilder getEndTimeOrBuilder()
Output only. Time when the CustomJob entered any of the following states:
JOB_STATE_SUCCEEDED, JOB_STATE_FAILED, JOB_STATE_CANCELLED.
.google.protobuf.Timestamp end_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
Output only. Only populated when job's state is JOB_STATE_FAILED or
JOB_STATE_CANCELLED.
.google.rpc.Status error = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
com.google.rpc.Status | The error.
|
public StatusOrBuilder getErrorOrBuilder()
Output only. Only populated when job's state is JOB_STATE_FAILED or
JOB_STATE_CANCELLED.
.google.rpc.Status error = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
com.google.rpc.StatusOrBuilder | |
public CustomJobSpec getJobSpec()
Required. Job spec.
.google.cloud.aiplatform.v1.CustomJobSpec job_spec = 4 [(.google.api.field_behavior) = REQUIRED];
public CustomJobSpecOrBuilder getJobSpecOrBuilder()
Required. Job spec.
.google.cloud.aiplatform.v1.CustomJobSpec job_spec = 4 [(.google.api.field_behavior) = REQUIRED];
public Map<String,String> getLabels()
public int getLabelsCount()
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.
map<string, string> labels = 11;
| Returns |
|---|
| Type | Description |
int | |
public Map<String,String> getLabelsMap()
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.
map<string, string> labels = 11;
public String getLabelsOrDefault(String key, String defaultValue)
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.
map<string, string> labels = 11;
public String getLabelsOrThrow(String key)
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.
map<string, string> labels = 11;
| Parameter |
|---|
| Name | Description |
key | String
|
Output only. Resource name of a CustomJob.
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
String | The name.
|
public ByteString getNameBytes()
Output only. Resource name of a CustomJob.
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
ByteString | The bytes for name.
|
public Parser<CustomJob> getParserForType()
Overrides
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
Overrides
public Timestamp getStartTime()
Output only. Time when the CustomJob for the first time entered the
JOB_STATE_RUNNING state.
.google.protobuf.Timestamp start_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
Timestamp | The startTime.
|
public TimestampOrBuilder getStartTimeOrBuilder()
Output only. Time when the CustomJob for the first time entered the
JOB_STATE_RUNNING state.
.google.protobuf.Timestamp start_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
public JobState getState()
Output only. The detailed state of the job.
.google.cloud.aiplatform.v1.JobState state = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
JobState | The state.
|
public int getStateValue()
Output only. The detailed state of the job.
.google.cloud.aiplatform.v1.JobState state = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
int | The enum numeric value on the wire for state.
|
public final UnknownFieldSet getUnknownFields()
Overrides
public Timestamp getUpdateTime()
Output only. Time when the CustomJob was most recently updated.
.google.protobuf.Timestamp update_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
Timestamp | The updateTime.
|
public TimestampOrBuilder getUpdateTimeOrBuilder()
Output only. Time when the CustomJob was most recently updated.
.google.protobuf.Timestamp update_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
public Map<String,String> getWebAccessUris()
public int getWebAccessUrisCount()
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.
map<string, string> web_access_uris = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
int | |
public Map<String,String> getWebAccessUrisMap()
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.
map<string, string> web_access_uris = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
public String getWebAccessUrisOrDefault(String key, String defaultValue)
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.
map<string, string> web_access_uris = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
public String getWebAccessUrisOrThrow(String key)
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.
map<string, string> web_access_uris = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter |
|---|
| Name | Description |
key | String
|
public boolean hasCreateTime()
Output only. Time when the CustomJob was created.
.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
boolean | Whether the createTime field is set.
|
public boolean hasEncryptionSpec()
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.
.google.cloud.aiplatform.v1.EncryptionSpec encryption_spec = 12;
| Returns |
|---|
| Type | Description |
boolean | Whether the encryptionSpec field is set.
|
public boolean hasEndTime()
Output only. Time when the CustomJob entered any of the following states:
JOB_STATE_SUCCEEDED, JOB_STATE_FAILED, JOB_STATE_CANCELLED.
.google.protobuf.Timestamp end_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
boolean | Whether the endTime field is set.
|
public boolean hasError()
Output only. Only populated when job's state is JOB_STATE_FAILED or
JOB_STATE_CANCELLED.
.google.rpc.Status error = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
boolean | Whether the error field is set.
|
public boolean hasJobSpec()
Required. Job spec.
.google.cloud.aiplatform.v1.CustomJobSpec job_spec = 4 [(.google.api.field_behavior) = REQUIRED];
| Returns |
|---|
| Type | Description |
boolean | Whether the jobSpec field is set.
|
public boolean hasStartTime()
Output only. Time when the CustomJob for the first time entered the
JOB_STATE_RUNNING state.
.google.protobuf.Timestamp start_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
boolean | Whether the startTime field is set.
|
public boolean hasUpdateTime()
Output only. Time when the CustomJob was most recently updated.
.google.protobuf.Timestamp update_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
boolean | Whether the updateTime field is set.
|
| Returns |
|---|
| Type | Description |
int | |
Overrides
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
protected MapField internalGetMapField(int number)
| Parameter |
|---|
| Name | Description |
number | int
|
Overrides
public final boolean isInitialized()
Overrides
public CustomJob.Builder newBuilderForType()
protected CustomJob.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
public CustomJob.Builder toBuilder()
public void writeTo(CodedOutputStream output)
Overrides
