- 3.54.0 (latest)
- 3.53.0
- 3.52.0
- 3.50.0
- 3.49.0
- 3.48.0
- 3.47.0
- 3.46.0
- 3.45.0
- 3.44.0
- 3.43.0
- 3.42.0
- 3.41.0
- 3.40.0
- 3.38.0
- 3.37.0
- 3.36.0
- 3.35.0
- 3.34.0
- 3.33.0
- 3.32.0
- 3.31.0
- 3.30.0
- 3.29.0
- 3.28.0
- 3.25.0
- 3.24.0
- 3.23.0
- 3.22.0
- 3.21.0
- 3.20.0
- 3.19.0
- 3.18.0
- 3.17.0
- 3.16.0
- 3.15.0
- 3.14.0
- 3.13.0
- 3.12.0
- 3.11.0
- 3.10.0
- 3.9.0
- 3.8.0
- 3.7.0
- 3.6.0
- 3.5.0
- 3.4.2
- 3.3.0
- 3.2.0
- 3.0.0
- 2.9.8
- 2.8.9
- 2.7.4
- 2.5.3
- 2.4.0
public interface CustomJobOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
containsLabels(String key)
public abstract 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 |
| Returns | |
|---|---|
| Type | Description |
boolean |
|
containsWebAccessUris(String key)
public abstract 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 |
| Returns | |
|---|---|
| Type | Description |
boolean |
|
getCreateTime()
public abstract 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. |
getCreateTimeOrBuilder()
public abstract TimestampOrBuilder getCreateTimeOrBuilder()Output only. Time when the CustomJob was created.
.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder |
|
getDisplayName()
public abstract 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. |
getDisplayNameBytes()
public abstract 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. |
getEncryptionSpec()
public abstract 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.v1beta1.EncryptionSpec encryption_spec = 12;
| Returns | |
|---|---|
| Type | Description |
EncryptionSpec |
The encryptionSpec. |
getEncryptionSpecOrBuilder()
public abstract 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.v1beta1.EncryptionSpec encryption_spec = 12;
| Returns | |
|---|---|
| Type | Description |
EncryptionSpecOrBuilder |
|
getEndTime()
public abstract 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];
| Returns | |
|---|---|
| Type | Description |
Timestamp |
The endTime. |
getEndTimeOrBuilder()
public abstract 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];
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder |
|
getError()
public abstract Status getError() 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. |
getErrorOrBuilder()
public abstract 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 |
|
getJobSpec()
public abstract CustomJobSpec getJobSpec()Required. Job spec.
.google.cloud.aiplatform.v1beta1.CustomJobSpec job_spec = 4 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
CustomJobSpec |
The jobSpec. |
getJobSpecOrBuilder()
public abstract CustomJobSpecOrBuilder getJobSpecOrBuilder()Required. Job spec.
.google.cloud.aiplatform.v1beta1.CustomJobSpec job_spec = 4 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
CustomJobSpecOrBuilder |
|
getLabels() (deprecated)
public abstract Map<String,String> getLabels()Use #getLabelsMap() instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getLabelsCount()
public abstract 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 |
|
getLabelsMap()
public abstract 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;
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getLabelsOrDefault(String key, String defaultValue)
public abstract 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;
| Parameters | |
|---|---|
| Name | Description |
key |
String |
defaultValue |
String |
| Returns | |
|---|---|
| Type | Description |
String |
|
getLabelsOrThrow(String key)
public abstract 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 |
| Returns | |
|---|---|
| Type | Description |
String |
|
getName()
public abstract String getName()Output only. Resource name of a CustomJob.
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
String |
The name. |
getNameBytes()
public abstract 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. |
getSatisfiesPzi()
public abstract boolean getSatisfiesPzi()Output only. Reserved for future use.
bool satisfies_pzi = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
The satisfiesPzi. |
getSatisfiesPzs()
public abstract boolean getSatisfiesPzs()Output only. Reserved for future use.
bool satisfies_pzs = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
The satisfiesPzs. |
getStartTime()
public abstract 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. |
getStartTimeOrBuilder()
public abstract 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];
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder |
|
getState()
public abstract JobState getState()Output only. The detailed state of the job.
.google.cloud.aiplatform.v1beta1.JobState state = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
JobState |
The state. |
getStateValue()
public abstract int getStateValue()Output only. The detailed state of the job.
.google.cloud.aiplatform.v1beta1.JobState state = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for state. |
getUpdateTime()
public abstract 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. |
getUpdateTimeOrBuilder()
public abstract TimestampOrBuilder getUpdateTimeOrBuilder()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 |
TimestampOrBuilder |
|
getWebAccessUris() (deprecated)
public abstract Map<String,String> getWebAccessUris()Use #getWebAccessUrisMap() instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getWebAccessUrisCount()
public abstract 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 |
|
getWebAccessUrisMap()
public abstract 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];
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getWebAccessUrisOrDefault(String key, String defaultValue)
public abstract 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];
| Parameters | |
|---|---|
| Name | Description |
key |
String |
defaultValue |
String |
| Returns | |
|---|---|
| Type | Description |
String |
|
getWebAccessUrisOrThrow(String key)
public abstract 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 |
| Returns | |
|---|---|
| Type | Description |
String |
|
hasCreateTime()
public abstract 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. |
hasEncryptionSpec()
public abstract 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.v1beta1.EncryptionSpec encryption_spec = 12;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the encryptionSpec field is set. |
hasEndTime()
public abstract 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. |
hasError()
public abstract 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. |
hasJobSpec()
public abstract boolean hasJobSpec()Required. Job spec.
.google.cloud.aiplatform.v1beta1.CustomJobSpec job_spec = 4 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the jobSpec field is set. |
hasStartTime()
public abstract 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. |
hasUpdateTime()
public abstract 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. |