Class CustomJob.Builder (3.50.0)

public static final class CustomJob.Builder extends GeneratedMessageV3.Builder<CustomJob.Builder> 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

Implements

CustomJobOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public CustomJob.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
CustomJob.Builder
Overrides

build()

public CustomJob build()
Returns
Type Description
CustomJob

buildPartial()

public CustomJob buildPartial()
Returns
Type Description
CustomJob

clear()

public CustomJob.Builder clear()
Returns
Type Description
CustomJob.Builder
Overrides

clearCreateTime()

public CustomJob.Builder clearCreateTime()

Output only. Time when the CustomJob was created.

.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
CustomJob.Builder

clearDisplayName()

public CustomJob.Builder clearDisplayName()

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
CustomJob.Builder

This builder for chaining.

clearEncryptionSpec()

public CustomJob.Builder clearEncryptionSpec()

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
CustomJob.Builder

clearEndTime()

public CustomJob.Builder clearEndTime()

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
CustomJob.Builder

clearError()

public CustomJob.Builder clearError()

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
CustomJob.Builder

clearField(Descriptors.FieldDescriptor field)

public CustomJob.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
CustomJob.Builder
Overrides

clearJobSpec()

public CustomJob.Builder clearJobSpec()

Required. Job spec.

.google.cloud.aiplatform.v1.CustomJobSpec job_spec = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
CustomJob.Builder

clearLabels()

public CustomJob.Builder clearLabels()
Returns
Type Description
CustomJob.Builder

clearName()

public CustomJob.Builder clearName()

Output only. Resource name of a CustomJob.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
CustomJob.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public CustomJob.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
CustomJob.Builder
Overrides

clearSatisfiesPzi()

public CustomJob.Builder clearSatisfiesPzi()

Output only. Reserved for future use.

bool satisfies_pzi = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
CustomJob.Builder

This builder for chaining.

clearSatisfiesPzs()

public CustomJob.Builder clearSatisfiesPzs()

Output only. Reserved for future use.

bool satisfies_pzs = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
CustomJob.Builder

This builder for chaining.

clearStartTime()

public CustomJob.Builder clearStartTime()

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
CustomJob.Builder

clearState()

public CustomJob.Builder clearState()

Output only. The detailed state of the job.

.google.cloud.aiplatform.v1.JobState state = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
CustomJob.Builder

This builder for chaining.

clearUpdateTime()

public CustomJob.Builder clearUpdateTime()

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
CustomJob.Builder

clearWebAccessUris()

public CustomJob.Builder clearWebAccessUris()
Returns
Type Description
CustomJob.Builder

clone()

public CustomJob.Builder clone()
Returns
Type Description
CustomJob.Builder
Overrides

containsLabels(String key)

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
Returns
Type Description
boolean

containsWebAccessUris(String key)

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
Returns
Type Description
boolean

getCreateTime()

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.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

Output only. Time when the CustomJob was created.

.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Builder

getCreateTimeOrBuilder()

public 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

getDefaultInstanceForType()

public CustomJob getDefaultInstanceForType()
Returns
Type Description
CustomJob

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getDisplayName()

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.

getDisplayNameBytes()

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.

getEncryptionSpec()

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;

Returns
Type Description
EncryptionSpec

The encryptionSpec.

getEncryptionSpecBuilder()

public EncryptionSpec.Builder getEncryptionSpecBuilder()

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
EncryptionSpec.Builder

getEncryptionSpecOrBuilder()

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;

Returns
Type Description
EncryptionSpecOrBuilder

getEndTime()

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];

Returns
Type Description
Timestamp

The endTime.

getEndTimeBuilder()

public Timestamp.Builder getEndTimeBuilder()

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
Builder

getEndTimeOrBuilder()

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];

Returns
Type Description
TimestampOrBuilder

getError()

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

getErrorBuilder()

public Status.Builder getErrorBuilder()

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

getErrorOrBuilder()

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

getJobSpec()

public CustomJobSpec getJobSpec()

Required. Job spec.

.google.cloud.aiplatform.v1.CustomJobSpec job_spec = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
CustomJobSpec

The jobSpec.

getJobSpecBuilder()

public CustomJobSpec.Builder getJobSpecBuilder()

Required. Job spec.

.google.cloud.aiplatform.v1.CustomJobSpec job_spec = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
CustomJobSpec.Builder

getJobSpecOrBuilder()

public CustomJobSpecOrBuilder getJobSpecOrBuilder()

Required. Job spec.

.google.cloud.aiplatform.v1.CustomJobSpec job_spec = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
CustomJobSpecOrBuilder

getLabels() (deprecated)

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

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

getLabelsMap()

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;

Returns
Type Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

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;

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getLabelsOrThrow(String key)

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
Returns
Type Description
String

getMutableLabels() (deprecated)

public Map<String,String> getMutableLabels()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,String>

getMutableWebAccessUris() (deprecated)

public Map<String,String> getMutableWebAccessUris()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,String>

getName()

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

getStartTimeBuilder()

public Timestamp.Builder getStartTimeBuilder()

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
Builder

getStartTimeOrBuilder()

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];

Returns
Type Description
TimestampOrBuilder

getState()

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.

getStateValue()

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.

getUpdateTime()

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.

getUpdateTimeBuilder()

public Timestamp.Builder getUpdateTimeBuilder()

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
Builder

getUpdateTimeOrBuilder()

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];

Returns
Type Description
TimestampOrBuilder

getWebAccessUris() (deprecated)

public Map<String,String> getWebAccessUris()
Returns
Type Description
Map<String,String>

getWebAccessUrisCount()

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

getWebAccessUrisMap()

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];

Returns
Type Description
Map<String,String>

getWebAccessUrisOrDefault(String key, String defaultValue)

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];

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getWebAccessUrisOrThrow(String key)

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
Returns
Type Description
String

hasCreateTime()

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.

hasEncryptionSpec()

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.

hasEndTime()

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.

hasError()

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.

hasJobSpec()

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.

hasStartTime()

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.

hasUpdateTime()

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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeCreateTime(Timestamp value)

public CustomJob.Builder mergeCreateTime(Timestamp value)

Output only. Time when the CustomJob was created.

.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
CustomJob.Builder

mergeEncryptionSpec(EncryptionSpec value)

public CustomJob.Builder mergeEncryptionSpec(EncryptionSpec value)

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;

Parameter
Name Description
value EncryptionSpec
Returns
Type Description
CustomJob.Builder

mergeEndTime(Timestamp value)

public CustomJob.Builder mergeEndTime(Timestamp value)

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];

Parameter
Name Description
value Timestamp
Returns
Type Description
CustomJob.Builder

mergeError(Status value)

public CustomJob.Builder mergeError(Status value)

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];

Parameter
Name Description
value com.google.rpc.Status
Returns
Type Description
CustomJob.Builder

mergeFrom(CustomJob other)

public CustomJob.Builder mergeFrom(CustomJob other)
Parameter
Name Description
other CustomJob
Returns
Type Description
CustomJob.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public CustomJob.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CustomJob.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public CustomJob.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
CustomJob.Builder
Overrides

mergeJobSpec(CustomJobSpec value)

public CustomJob.Builder mergeJobSpec(CustomJobSpec value)

Required. Job spec.

.google.cloud.aiplatform.v1.CustomJobSpec job_spec = 4 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value CustomJobSpec
Returns
Type Description
CustomJob.Builder

mergeStartTime(Timestamp value)

public CustomJob.Builder mergeStartTime(Timestamp value)

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];

Parameter
Name Description
value Timestamp
Returns
Type Description
CustomJob.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final CustomJob.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
CustomJob.Builder
Overrides

mergeUpdateTime(Timestamp value)

public CustomJob.Builder mergeUpdateTime(Timestamp value)

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

.google.protobuf.Timestamp update_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
CustomJob.Builder

putAllLabels(Map<String,String> values)

public CustomJob.Builder putAllLabels(Map<String,String> values)

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
values Map<String,String>
Returns
Type Description
CustomJob.Builder

putAllWebAccessUris(Map<String,String> values)

public CustomJob.Builder putAllWebAccessUris(Map<String,String> values)

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
values Map<String,String>
Returns
Type Description
CustomJob.Builder

putLabels(String key, String value)

public CustomJob.Builder putLabels(String key, String value)

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
value String
Returns
Type Description
CustomJob.Builder

putWebAccessUris(String key, String value)

public CustomJob.Builder putWebAccessUris(String key, String value)

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
value String
Returns
Type Description
CustomJob.Builder

removeLabels(String key)

public CustomJob.Builder removeLabels(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
CustomJob.Builder

removeWebAccessUris(String key)

public CustomJob.Builder removeWebAccessUris(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
CustomJob.Builder

setCreateTime(Timestamp value)

public CustomJob.Builder setCreateTime(Timestamp value)

Output only. Time when the CustomJob was created.

.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
CustomJob.Builder

setCreateTime(Timestamp.Builder builderForValue)

public CustomJob.Builder setCreateTime(Timestamp.Builder builderForValue)

Output only. Time when the CustomJob was created.

.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
CustomJob.Builder

setDisplayName(String value)

public CustomJob.Builder setDisplayName(String value)

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];

Parameter
Name Description
value String

The displayName to set.

Returns
Type Description
CustomJob.Builder

This builder for chaining.

setDisplayNameBytes(ByteString value)

public CustomJob.Builder setDisplayNameBytes(ByteString value)

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];

Parameter
Name Description
value ByteString

The bytes for displayName to set.

Returns
Type Description
CustomJob.Builder

This builder for chaining.

setEncryptionSpec(EncryptionSpec value)

public CustomJob.Builder setEncryptionSpec(EncryptionSpec value)

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;

Parameter
Name Description
value EncryptionSpec
Returns
Type Description
CustomJob.Builder

setEncryptionSpec(EncryptionSpec.Builder builderForValue)

public CustomJob.Builder setEncryptionSpec(EncryptionSpec.Builder builderForValue)

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;

Parameter
Name Description
builderForValue EncryptionSpec.Builder
Returns
Type Description
CustomJob.Builder

setEndTime(Timestamp value)

public CustomJob.Builder setEndTime(Timestamp value)

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];

Parameter
Name Description
value Timestamp
Returns
Type Description
CustomJob.Builder

setEndTime(Timestamp.Builder builderForValue)

public CustomJob.Builder setEndTime(Timestamp.Builder builderForValue)

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];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
CustomJob.Builder

setError(Status value)

public CustomJob.Builder setError(Status value)

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];

Parameter
Name Description
value com.google.rpc.Status
Returns
Type Description
CustomJob.Builder

setError(Status.Builder builderForValue)

public CustomJob.Builder setError(Status.Builder builderForValue)

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];

Parameter
Name Description
builderForValue com.google.rpc.Status.Builder
Returns
Type Description
CustomJob.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public CustomJob.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
CustomJob.Builder
Overrides

setJobSpec(CustomJobSpec value)

public CustomJob.Builder setJobSpec(CustomJobSpec value)

Required. Job spec.

.google.cloud.aiplatform.v1.CustomJobSpec job_spec = 4 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value CustomJobSpec
Returns
Type Description
CustomJob.Builder

setJobSpec(CustomJobSpec.Builder builderForValue)

public CustomJob.Builder setJobSpec(CustomJobSpec.Builder builderForValue)

Required. Job spec.

.google.cloud.aiplatform.v1.CustomJobSpec job_spec = 4 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
builderForValue CustomJobSpec.Builder
Returns
Type Description
CustomJob.Builder

setName(String value)

public CustomJob.Builder setName(String value)

Output only. Resource name of a CustomJob.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The name to set.

Returns
Type Description
CustomJob.Builder

This builder for chaining.

setNameBytes(ByteString value)

public CustomJob.Builder setNameBytes(ByteString value)

Output only. Resource name of a CustomJob.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
CustomJob.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public CustomJob.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
CustomJob.Builder
Overrides

setSatisfiesPzi(boolean value)

public CustomJob.Builder setSatisfiesPzi(boolean value)

Output only. Reserved for future use.

bool satisfies_pzi = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value boolean

The satisfiesPzi to set.

Returns
Type Description
CustomJob.Builder

This builder for chaining.

setSatisfiesPzs(boolean value)

public CustomJob.Builder setSatisfiesPzs(boolean value)

Output only. Reserved for future use.

bool satisfies_pzs = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value boolean

The satisfiesPzs to set.

Returns
Type Description
CustomJob.Builder

This builder for chaining.

setStartTime(Timestamp value)

public CustomJob.Builder setStartTime(Timestamp value)

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];

Parameter
Name Description
value Timestamp
Returns
Type Description
CustomJob.Builder

setStartTime(Timestamp.Builder builderForValue)

public CustomJob.Builder setStartTime(Timestamp.Builder builderForValue)

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];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
CustomJob.Builder

setState(JobState value)

public CustomJob.Builder setState(JobState value)

Output only. The detailed state of the job.

.google.cloud.aiplatform.v1.JobState state = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value JobState

The state to set.

Returns
Type Description
CustomJob.Builder

This builder for chaining.

setStateValue(int value)

public CustomJob.Builder setStateValue(int value)

Output only. The detailed state of the job.

.google.cloud.aiplatform.v1.JobState state = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value int

The enum numeric value on the wire for state to set.

Returns
Type Description
CustomJob.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final CustomJob.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
CustomJob.Builder
Overrides

setUpdateTime(Timestamp value)

public CustomJob.Builder setUpdateTime(Timestamp value)

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

.google.protobuf.Timestamp update_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
CustomJob.Builder

setUpdateTime(Timestamp.Builder builderForValue)

public CustomJob.Builder setUpdateTime(Timestamp.Builder builderForValue)

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

.google.protobuf.Timestamp update_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
CustomJob.Builder