com.google.cloud.aiplatform.v1

Class CustomJobSpec.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderType>

com.google.protobuf.GeneratedMessageV3.Builder<CustomJobSpec.Builder>

com.google.cloud.aiplatform.v1.CustomJobSpec.Builder

All Implemented Interfaces:

CustomJobSpecOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:

CustomJobSpec

public static final class CustomJobSpec.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<CustomJobSpec.Builder>
implements CustomJobSpecOrBuilder

 Represents the spec of a CustomJob.
 

Protobuf type google.cloud.aiplatform.v1.CustomJobSpec

Method Summary

Modifier and Type	Method and Description
CustomJobSpec.Builder	addAllWorkerPoolSpecs(Iterable<? extends WorkerPoolSpec> values) Required.
CustomJobSpec.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
CustomJobSpec.Builder	addWorkerPoolSpecs(int index, WorkerPoolSpec.Builder builderForValue) Required.
CustomJobSpec.Builder	addWorkerPoolSpecs(int index, WorkerPoolSpec value) Required.
CustomJobSpec.Builder	addWorkerPoolSpecs(WorkerPoolSpec.Builder builderForValue) Required.
CustomJobSpec.Builder	addWorkerPoolSpecs(WorkerPoolSpec value) Required.
WorkerPoolSpec.Builder	addWorkerPoolSpecsBuilder() Required.
WorkerPoolSpec.Builder	addWorkerPoolSpecsBuilder(int index) Required.
CustomJobSpec	build()
CustomJobSpec	buildPartial()
CustomJobSpec.Builder	clear()
CustomJobSpec.Builder	clearBaseOutputDirectory() The Cloud Storage location to store the output of this CustomJob or HyperparameterTuningJob.
CustomJobSpec.Builder	clearEnableWebAccess() Optional.
CustomJobSpec.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
CustomJobSpec.Builder	clearNetwork() The full name of the Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to which the Job should be peered.
CustomJobSpec.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
CustomJobSpec.Builder	clearScheduling() Scheduling options for a CustomJob.
CustomJobSpec.Builder	clearServiceAccount() Specifies the service account for workload run-as account.
CustomJobSpec.Builder	clearWorkerPoolSpecs() Required.
CustomJobSpec.Builder	clone()
GcsDestination	getBaseOutputDirectory() The Cloud Storage location to store the output of this CustomJob or HyperparameterTuningJob.
GcsDestination.Builder	getBaseOutputDirectoryBuilder() The Cloud Storage location to store the output of this CustomJob or HyperparameterTuningJob.
GcsDestinationOrBuilder	getBaseOutputDirectoryOrBuilder() The Cloud Storage location to store the output of this CustomJob or HyperparameterTuningJob.
CustomJobSpec	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
boolean	getEnableWebAccess() Optional.
String	getNetwork() The full name of the Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to which the Job should be peered.
com.google.protobuf.ByteString	getNetworkBytes() The full name of the Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to which the Job should be peered.
Scheduling	getScheduling() Scheduling options for a CustomJob.
Scheduling.Builder	getSchedulingBuilder() Scheduling options for a CustomJob.
SchedulingOrBuilder	getSchedulingOrBuilder() Scheduling options for a CustomJob.
String	getServiceAccount() Specifies the service account for workload run-as account.
com.google.protobuf.ByteString	getServiceAccountBytes() Specifies the service account for workload run-as account.
WorkerPoolSpec	getWorkerPoolSpecs(int index) Required.
WorkerPoolSpec.Builder	getWorkerPoolSpecsBuilder(int index) Required.
List<WorkerPoolSpec.Builder>	getWorkerPoolSpecsBuilderList() Required.
int	getWorkerPoolSpecsCount() Required.
List<WorkerPoolSpec>	getWorkerPoolSpecsList() Required.
WorkerPoolSpecOrBuilder	getWorkerPoolSpecsOrBuilder(int index) Required.
List<? extends WorkerPoolSpecOrBuilder>	getWorkerPoolSpecsOrBuilderList() Required.
boolean	hasBaseOutputDirectory() The Cloud Storage location to store the output of this CustomJob or HyperparameterTuningJob.
boolean	hasScheduling() Scheduling options for a CustomJob.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
CustomJobSpec.Builder	mergeBaseOutputDirectory(GcsDestination value) The Cloud Storage location to store the output of this CustomJob or HyperparameterTuningJob.
CustomJobSpec.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
CustomJobSpec.Builder	mergeFrom(CustomJobSpec other)
CustomJobSpec.Builder	mergeFrom(com.google.protobuf.Message other)
CustomJobSpec.Builder	mergeScheduling(Scheduling value) Scheduling options for a CustomJob.
CustomJobSpec.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
CustomJobSpec.Builder	removeWorkerPoolSpecs(int index) Required.
CustomJobSpec.Builder	setBaseOutputDirectory(GcsDestination.Builder builderForValue) The Cloud Storage location to store the output of this CustomJob or HyperparameterTuningJob.
CustomJobSpec.Builder	setBaseOutputDirectory(GcsDestination value) The Cloud Storage location to store the output of this CustomJob or HyperparameterTuningJob.
CustomJobSpec.Builder	setEnableWebAccess(boolean value) Optional.
CustomJobSpec.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
CustomJobSpec.Builder	setNetwork(String value) The full name of the Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to which the Job should be peered.
CustomJobSpec.Builder	setNetworkBytes(com.google.protobuf.ByteString value) The full name of the Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to which the Job should be peered.
CustomJobSpec.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
CustomJobSpec.Builder	setScheduling(Scheduling.Builder builderForValue) Scheduling options for a CustomJob.
CustomJobSpec.Builder	setScheduling(Scheduling value) Scheduling options for a CustomJob.
CustomJobSpec.Builder	setServiceAccount(String value) Specifies the service account for workload run-as account.
CustomJobSpec.Builder	setServiceAccountBytes(com.google.protobuf.ByteString value) Specifies the service account for workload run-as account.
CustomJobSpec.Builder	setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
CustomJobSpec.Builder	setWorkerPoolSpecs(int index, WorkerPoolSpec.Builder builderForValue) Required.
CustomJobSpec.Builder	setWorkerPoolSpecs(int index, WorkerPoolSpec value) Required.

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite.Builder

mergeFrom

Method Detail

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<CustomJobSpec.Builder>

clear

public CustomJobSpec.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessageV3.Builder<CustomJobSpec.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<CustomJobSpec.Builder>

getDefaultInstanceForType

public CustomJobSpec getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public CustomJobSpec build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public CustomJobSpec buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

clone

public CustomJobSpec.Builder clone()

Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<CustomJobSpec.Builder>

setField

public CustomJobSpec.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                      Object value)

Specified by:

setField in interface com.google.protobuf.Message.Builder

Overrides:

setField in class com.google.protobuf.GeneratedMessageV3.Builder<CustomJobSpec.Builder>

clearField

public CustomJobSpec.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)

Specified by:

clearField in interface com.google.protobuf.Message.Builder

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<CustomJobSpec.Builder>

clearOneof

public CustomJobSpec.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)

Specified by:

clearOneof in interface com.google.protobuf.Message.Builder

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<CustomJobSpec.Builder>

setRepeatedField

public CustomJobSpec.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                              int index,
                                              Object value)

Specified by:

setRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<CustomJobSpec.Builder>

addRepeatedField

public CustomJobSpec.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                              Object value)

Specified by:

addRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<CustomJobSpec.Builder>

mergeFrom

public CustomJobSpec.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<CustomJobSpec.Builder>

mergeFrom

public CustomJobSpec.Builder mergeFrom(CustomJobSpec other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<CustomJobSpec.Builder>

mergeFrom

public CustomJobSpec.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws IOException

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<CustomJobSpec.Builder>

Throws:

IOException

getWorkerPoolSpecsList

public List<WorkerPoolSpec> getWorkerPoolSpecsList()

 Required. The spec of the worker pools including machine type and Docker image.
 All worker pools except the first one are optional and can be skipped by
 providing an empty value.
 

repeated .google.cloud.aiplatform.v1.WorkerPoolSpec worker_pool_specs = 1 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getWorkerPoolSpecsList in interface CustomJobSpecOrBuilder

getWorkerPoolSpecsCount

public int getWorkerPoolSpecsCount()

 Required. The spec of the worker pools including machine type and Docker image.
 All worker pools except the first one are optional and can be skipped by
 providing an empty value.
 

repeated .google.cloud.aiplatform.v1.WorkerPoolSpec worker_pool_specs = 1 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getWorkerPoolSpecsCount in interface CustomJobSpecOrBuilder

getWorkerPoolSpecs

public WorkerPoolSpec getWorkerPoolSpecs(int index)

 Required. The spec of the worker pools including machine type and Docker image.
 All worker pools except the first one are optional and can be skipped by
 providing an empty value.
 

repeated .google.cloud.aiplatform.v1.WorkerPoolSpec worker_pool_specs = 1 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getWorkerPoolSpecs in interface CustomJobSpecOrBuilder

setWorkerPoolSpecs

public CustomJobSpec.Builder setWorkerPoolSpecs(int index,
                                                WorkerPoolSpec value)

 Required. The spec of the worker pools including machine type and Docker image.
 All worker pools except the first one are optional and can be skipped by
 providing an empty value.
 

repeated .google.cloud.aiplatform.v1.WorkerPoolSpec worker_pool_specs = 1 [(.google.api.field_behavior) = REQUIRED];

setWorkerPoolSpecs

public CustomJobSpec.Builder setWorkerPoolSpecs(int index,
                                                WorkerPoolSpec.Builder builderForValue)

 Required. The spec of the worker pools including machine type and Docker image.
 All worker pools except the first one are optional and can be skipped by
 providing an empty value.
 

repeated .google.cloud.aiplatform.v1.WorkerPoolSpec worker_pool_specs = 1 [(.google.api.field_behavior) = REQUIRED];

addWorkerPoolSpecs

public CustomJobSpec.Builder addWorkerPoolSpecs(WorkerPoolSpec value)

 Required. The spec of the worker pools including machine type and Docker image.
 All worker pools except the first one are optional and can be skipped by
 providing an empty value.
 

repeated .google.cloud.aiplatform.v1.WorkerPoolSpec worker_pool_specs = 1 [(.google.api.field_behavior) = REQUIRED];

addWorkerPoolSpecs

public CustomJobSpec.Builder addWorkerPoolSpecs(int index,
                                                WorkerPoolSpec value)

 Required. The spec of the worker pools including machine type and Docker image.
 All worker pools except the first one are optional and can be skipped by
 providing an empty value.
 

repeated .google.cloud.aiplatform.v1.WorkerPoolSpec worker_pool_specs = 1 [(.google.api.field_behavior) = REQUIRED];

addWorkerPoolSpecs

public CustomJobSpec.Builder addWorkerPoolSpecs(WorkerPoolSpec.Builder builderForValue)

 Required. The spec of the worker pools including machine type and Docker image.
 All worker pools except the first one are optional and can be skipped by
 providing an empty value.
 

repeated .google.cloud.aiplatform.v1.WorkerPoolSpec worker_pool_specs = 1 [(.google.api.field_behavior) = REQUIRED];

addWorkerPoolSpecs

public CustomJobSpec.Builder addWorkerPoolSpecs(int index,
                                                WorkerPoolSpec.Builder builderForValue)

 Required. The spec of the worker pools including machine type and Docker image.
 All worker pools except the first one are optional and can be skipped by
 providing an empty value.
 

repeated .google.cloud.aiplatform.v1.WorkerPoolSpec worker_pool_specs = 1 [(.google.api.field_behavior) = REQUIRED];

addAllWorkerPoolSpecs

public CustomJobSpec.Builder addAllWorkerPoolSpecs(Iterable<? extends WorkerPoolSpec> values)

 Required. The spec of the worker pools including machine type and Docker image.
 All worker pools except the first one are optional and can be skipped by
 providing an empty value.
 

repeated .google.cloud.aiplatform.v1.WorkerPoolSpec worker_pool_specs = 1 [(.google.api.field_behavior) = REQUIRED];

clearWorkerPoolSpecs

public CustomJobSpec.Builder clearWorkerPoolSpecs()

 Required. The spec of the worker pools including machine type and Docker image.
 All worker pools except the first one are optional and can be skipped by
 providing an empty value.
 

repeated .google.cloud.aiplatform.v1.WorkerPoolSpec worker_pool_specs = 1 [(.google.api.field_behavior) = REQUIRED];

removeWorkerPoolSpecs

public CustomJobSpec.Builder removeWorkerPoolSpecs(int index)

 Required. The spec of the worker pools including machine type and Docker image.
 All worker pools except the first one are optional and can be skipped by
 providing an empty value.
 

repeated .google.cloud.aiplatform.v1.WorkerPoolSpec worker_pool_specs = 1 [(.google.api.field_behavior) = REQUIRED];

getWorkerPoolSpecsBuilder

public WorkerPoolSpec.Builder getWorkerPoolSpecsBuilder(int index)

 Required. The spec of the worker pools including machine type and Docker image.
 All worker pools except the first one are optional and can be skipped by
 providing an empty value.
 

repeated .google.cloud.aiplatform.v1.WorkerPoolSpec worker_pool_specs = 1 [(.google.api.field_behavior) = REQUIRED];

getWorkerPoolSpecsOrBuilder

public WorkerPoolSpecOrBuilder getWorkerPoolSpecsOrBuilder(int index)

 Required. The spec of the worker pools including machine type and Docker image.
 All worker pools except the first one are optional and can be skipped by
 providing an empty value.
 

repeated .google.cloud.aiplatform.v1.WorkerPoolSpec worker_pool_specs = 1 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getWorkerPoolSpecsOrBuilder in interface CustomJobSpecOrBuilder

getWorkerPoolSpecsOrBuilderList

public List<? extends WorkerPoolSpecOrBuilder> getWorkerPoolSpecsOrBuilderList()

 Required. The spec of the worker pools including machine type and Docker image.
 All worker pools except the first one are optional and can be skipped by
 providing an empty value.
 

repeated .google.cloud.aiplatform.v1.WorkerPoolSpec worker_pool_specs = 1 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getWorkerPoolSpecsOrBuilderList in interface CustomJobSpecOrBuilder

addWorkerPoolSpecsBuilder

public WorkerPoolSpec.Builder addWorkerPoolSpecsBuilder()

 Required. The spec of the worker pools including machine type and Docker image.
 All worker pools except the first one are optional and can be skipped by
 providing an empty value.
 

repeated .google.cloud.aiplatform.v1.WorkerPoolSpec worker_pool_specs = 1 [(.google.api.field_behavior) = REQUIRED];

addWorkerPoolSpecsBuilder

public WorkerPoolSpec.Builder addWorkerPoolSpecsBuilder(int index)

 Required. The spec of the worker pools including machine type and Docker image.
 All worker pools except the first one are optional and can be skipped by
 providing an empty value.
 

repeated .google.cloud.aiplatform.v1.WorkerPoolSpec worker_pool_specs = 1 [(.google.api.field_behavior) = REQUIRED];

getWorkerPoolSpecsBuilderList

public List<WorkerPoolSpec.Builder> getWorkerPoolSpecsBuilderList()

 Required. The spec of the worker pools including machine type and Docker image.
 All worker pools except the first one are optional and can be skipped by
 providing an empty value.
 

repeated .google.cloud.aiplatform.v1.WorkerPoolSpec worker_pool_specs = 1 [(.google.api.field_behavior) = REQUIRED];

hasScheduling

public boolean hasScheduling()

 Scheduling options for a CustomJob.
 

.google.cloud.aiplatform.v1.Scheduling scheduling = 3;

Specified by:

hasScheduling in interface CustomJobSpecOrBuilder

Returns:

Whether the scheduling field is set.

getScheduling

public Scheduling getScheduling()

 Scheduling options for a CustomJob.
 

.google.cloud.aiplatform.v1.Scheduling scheduling = 3;

Specified by:

getScheduling in interface CustomJobSpecOrBuilder

Returns:

The scheduling.

setScheduling

public CustomJobSpec.Builder setScheduling(Scheduling value)

 Scheduling options for a CustomJob.
 

.google.cloud.aiplatform.v1.Scheduling scheduling = 3;

setScheduling

public CustomJobSpec.Builder setScheduling(Scheduling.Builder builderForValue)

 Scheduling options for a CustomJob.
 

.google.cloud.aiplatform.v1.Scheduling scheduling = 3;

mergeScheduling

public CustomJobSpec.Builder mergeScheduling(Scheduling value)

 Scheduling options for a CustomJob.
 

.google.cloud.aiplatform.v1.Scheduling scheduling = 3;

clearScheduling

public CustomJobSpec.Builder clearScheduling()

 Scheduling options for a CustomJob.
 

.google.cloud.aiplatform.v1.Scheduling scheduling = 3;

getSchedulingBuilder

public Scheduling.Builder getSchedulingBuilder()

 Scheduling options for a CustomJob.
 

.google.cloud.aiplatform.v1.Scheduling scheduling = 3;

getSchedulingOrBuilder

public SchedulingOrBuilder getSchedulingOrBuilder()

 Scheduling options for a CustomJob.
 

.google.cloud.aiplatform.v1.Scheduling scheduling = 3;

Specified by:

getSchedulingOrBuilder in interface CustomJobSpecOrBuilder

getServiceAccount

public String getServiceAccount()

 Specifies the service account for workload run-as account.
 Users submitting jobs must have act-as permission on this run-as account.
 If unspecified, the [Vertex AI Custom Code Service
 Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents)
 for the CustomJob's project is used.
 

string service_account = 4;

Specified by:

getServiceAccount in interface CustomJobSpecOrBuilder

Returns:

The serviceAccount.

getServiceAccountBytes

public com.google.protobuf.ByteString getServiceAccountBytes()

 Specifies the service account for workload run-as account.
 Users submitting jobs must have act-as permission on this run-as account.
 If unspecified, the [Vertex AI Custom Code Service
 Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents)
 for the CustomJob's project is used.
 

string service_account = 4;

Specified by:

getServiceAccountBytes in interface CustomJobSpecOrBuilder

Returns:

The bytes for serviceAccount.

setServiceAccount

public CustomJobSpec.Builder setServiceAccount(String value)

 Specifies the service account for workload run-as account.
 Users submitting jobs must have act-as permission on this run-as account.
 If unspecified, the [Vertex AI Custom Code Service
 Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents)
 for the CustomJob's project is used.
 

string service_account = 4;

Parameters:

value - The serviceAccount to set.

Returns:

This builder for chaining.

clearServiceAccount

public CustomJobSpec.Builder clearServiceAccount()

 Specifies the service account for workload run-as account.
 Users submitting jobs must have act-as permission on this run-as account.
 If unspecified, the [Vertex AI Custom Code Service
 Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents)
 for the CustomJob's project is used.
 

string service_account = 4;

Returns:

This builder for chaining.

setServiceAccountBytes

public CustomJobSpec.Builder setServiceAccountBytes(com.google.protobuf.ByteString value)

 Specifies the service account for workload run-as account.
 Users submitting jobs must have act-as permission on this run-as account.
 If unspecified, the [Vertex AI Custom Code Service
 Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents)
 for the CustomJob's project is used.
 

string service_account = 4;

Parameters:

value - The bytes for serviceAccount to set.

Returns:

This builder for chaining.

getNetwork

public String getNetwork()

 The full name of the Compute Engine
 [network](/compute/docs/networks-and-firewalls#networks) to which the Job
 should be peered. For example, `projects/12345/global/networks/myVPC`.
 [Format](/compute/docs/reference/rest/v1/networks/insert)
 is of the form `projects/{project}/global/networks/{network}`.
 Where {project} is a project number, as in `12345`, and {network} is a
 network name.
 Private services access must already be configured for the network. If left
 unspecified, the job is not peered with any network.
 

string network = 5 [(.google.api.resource_reference) = { ... }

Specified by:

getNetwork in interface CustomJobSpecOrBuilder

Returns:

The network.

getNetworkBytes

public com.google.protobuf.ByteString getNetworkBytes()

 The full name of the Compute Engine
 [network](/compute/docs/networks-and-firewalls#networks) to which the Job
 should be peered. For example, `projects/12345/global/networks/myVPC`.
 [Format](/compute/docs/reference/rest/v1/networks/insert)
 is of the form `projects/{project}/global/networks/{network}`.
 Where {project} is a project number, as in `12345`, and {network} is a
 network name.
 Private services access must already be configured for the network. If left
 unspecified, the job is not peered with any network.
 

string network = 5 [(.google.api.resource_reference) = { ... }

Specified by:

getNetworkBytes in interface CustomJobSpecOrBuilder

Returns:

The bytes for network.

setNetwork

public CustomJobSpec.Builder setNetwork(String value)

 The full name of the Compute Engine
 [network](/compute/docs/networks-and-firewalls#networks) to which the Job
 should be peered. For example, `projects/12345/global/networks/myVPC`.
 [Format](/compute/docs/reference/rest/v1/networks/insert)
 is of the form `projects/{project}/global/networks/{network}`.
 Where {project} is a project number, as in `12345`, and {network} is a
 network name.
 Private services access must already be configured for the network. If left
 unspecified, the job is not peered with any network.
 

string network = 5 [(.google.api.resource_reference) = { ... }

Parameters:

value - The network to set.

Returns:

This builder for chaining.

clearNetwork

public CustomJobSpec.Builder clearNetwork()

 The full name of the Compute Engine
 [network](/compute/docs/networks-and-firewalls#networks) to which the Job
 should be peered. For example, `projects/12345/global/networks/myVPC`.
 [Format](/compute/docs/reference/rest/v1/networks/insert)
 is of the form `projects/{project}/global/networks/{network}`.
 Where {project} is a project number, as in `12345`, and {network} is a
 network name.
 Private services access must already be configured for the network. If left
 unspecified, the job is not peered with any network.
 

string network = 5 [(.google.api.resource_reference) = { ... }

Returns:

This builder for chaining.

setNetworkBytes

public CustomJobSpec.Builder setNetworkBytes(com.google.protobuf.ByteString value)

 The full name of the Compute Engine
 [network](/compute/docs/networks-and-firewalls#networks) to which the Job
 should be peered. For example, `projects/12345/global/networks/myVPC`.
 [Format](/compute/docs/reference/rest/v1/networks/insert)
 is of the form `projects/{project}/global/networks/{network}`.
 Where {project} is a project number, as in `12345`, and {network} is a
 network name.
 Private services access must already be configured for the network. If left
 unspecified, the job is not peered with any network.
 

string network = 5 [(.google.api.resource_reference) = { ... }

Parameters:

value - The bytes for network to set.

Returns:

This builder for chaining.

hasBaseOutputDirectory

public boolean hasBaseOutputDirectory()

 The Cloud Storage location to store the output of this CustomJob or
 HyperparameterTuningJob. For HyperparameterTuningJob,
 the baseOutputDirectory of
 each child CustomJob backing a Trial is set to a subdirectory of name
 [id][google.cloud.aiplatform.v1.Trial.id] under its parent HyperparameterTuningJob's
 baseOutputDirectory.
 The following Vertex AI environment variables will be passed to
 containers or python modules when this field is set:
   For CustomJob:
   * AIP_MODEL_DIR = `<base_output_directory>/model/`
   * AIP_CHECKPOINT_DIR = `<base_output_directory>/checkpoints/`
   * AIP_TENSORBOARD_LOG_DIR = `<base_output_directory>/logs/`
   For CustomJob backing a Trial of HyperparameterTuningJob:
   * AIP_MODEL_DIR = `<base_output_directory>/<trial_id>/model/`
   * AIP_CHECKPOINT_DIR = `<base_output_directory>/<trial_id>/checkpoints/`
   * AIP_TENSORBOARD_LOG_DIR = `<base_output_directory>/<trial_id>/logs/`
 

.google.cloud.aiplatform.v1.GcsDestination base_output_directory = 6;

Specified by:

hasBaseOutputDirectory in interface CustomJobSpecOrBuilder

Returns:

Whether the baseOutputDirectory field is set.

getBaseOutputDirectory

public GcsDestination getBaseOutputDirectory()

 The Cloud Storage location to store the output of this CustomJob or
 HyperparameterTuningJob. For HyperparameterTuningJob,
 the baseOutputDirectory of
 each child CustomJob backing a Trial is set to a subdirectory of name
 [id][google.cloud.aiplatform.v1.Trial.id] under its parent HyperparameterTuningJob's
 baseOutputDirectory.
 The following Vertex AI environment variables will be passed to
 containers or python modules when this field is set:
   For CustomJob:
   * AIP_MODEL_DIR = `<base_output_directory>/model/`
   * AIP_CHECKPOINT_DIR = `<base_output_directory>/checkpoints/`
   * AIP_TENSORBOARD_LOG_DIR = `<base_output_directory>/logs/`
   For CustomJob backing a Trial of HyperparameterTuningJob:
   * AIP_MODEL_DIR = `<base_output_directory>/<trial_id>/model/`
   * AIP_CHECKPOINT_DIR = `<base_output_directory>/<trial_id>/checkpoints/`
   * AIP_TENSORBOARD_LOG_DIR = `<base_output_directory>/<trial_id>/logs/`
 

.google.cloud.aiplatform.v1.GcsDestination base_output_directory = 6;

Specified by:

getBaseOutputDirectory in interface CustomJobSpecOrBuilder

Returns:

The baseOutputDirectory.

setBaseOutputDirectory

public CustomJobSpec.Builder setBaseOutputDirectory(GcsDestination value)

 The Cloud Storage location to store the output of this CustomJob or
 HyperparameterTuningJob. For HyperparameterTuningJob,
 the baseOutputDirectory of
 each child CustomJob backing a Trial is set to a subdirectory of name
 [id][google.cloud.aiplatform.v1.Trial.id] under its parent HyperparameterTuningJob's
 baseOutputDirectory.
 The following Vertex AI environment variables will be passed to
 containers or python modules when this field is set:
   For CustomJob:
   * AIP_MODEL_DIR = `<base_output_directory>/model/`
   * AIP_CHECKPOINT_DIR = `<base_output_directory>/checkpoints/`
   * AIP_TENSORBOARD_LOG_DIR = `<base_output_directory>/logs/`
   For CustomJob backing a Trial of HyperparameterTuningJob:
   * AIP_MODEL_DIR = `<base_output_directory>/<trial_id>/model/`
   * AIP_CHECKPOINT_DIR = `<base_output_directory>/<trial_id>/checkpoints/`
   * AIP_TENSORBOARD_LOG_DIR = `<base_output_directory>/<trial_id>/logs/`
 

.google.cloud.aiplatform.v1.GcsDestination base_output_directory = 6;

setBaseOutputDirectory

public CustomJobSpec.Builder setBaseOutputDirectory(GcsDestination.Builder builderForValue)

 The Cloud Storage location to store the output of this CustomJob or
 HyperparameterTuningJob. For HyperparameterTuningJob,
 the baseOutputDirectory of
 each child CustomJob backing a Trial is set to a subdirectory of name
 [id][google.cloud.aiplatform.v1.Trial.id] under its parent HyperparameterTuningJob's
 baseOutputDirectory.
 The following Vertex AI environment variables will be passed to
 containers or python modules when this field is set:
   For CustomJob:
   * AIP_MODEL_DIR = `<base_output_directory>/model/`
   * AIP_CHECKPOINT_DIR = `<base_output_directory>/checkpoints/`
   * AIP_TENSORBOARD_LOG_DIR = `<base_output_directory>/logs/`
   For CustomJob backing a Trial of HyperparameterTuningJob:
   * AIP_MODEL_DIR = `<base_output_directory>/<trial_id>/model/`
   * AIP_CHECKPOINT_DIR = `<base_output_directory>/<trial_id>/checkpoints/`
   * AIP_TENSORBOARD_LOG_DIR = `<base_output_directory>/<trial_id>/logs/`
 

.google.cloud.aiplatform.v1.GcsDestination base_output_directory = 6;

mergeBaseOutputDirectory

public CustomJobSpec.Builder mergeBaseOutputDirectory(GcsDestination value)

 The Cloud Storage location to store the output of this CustomJob or
 HyperparameterTuningJob. For HyperparameterTuningJob,
 the baseOutputDirectory of
 each child CustomJob backing a Trial is set to a subdirectory of name
 [id][google.cloud.aiplatform.v1.Trial.id] under its parent HyperparameterTuningJob's
 baseOutputDirectory.
 The following Vertex AI environment variables will be passed to
 containers or python modules when this field is set:
   For CustomJob:
   * AIP_MODEL_DIR = `<base_output_directory>/model/`
   * AIP_CHECKPOINT_DIR = `<base_output_directory>/checkpoints/`
   * AIP_TENSORBOARD_LOG_DIR = `<base_output_directory>/logs/`
   For CustomJob backing a Trial of HyperparameterTuningJob:
   * AIP_MODEL_DIR = `<base_output_directory>/<trial_id>/model/`
   * AIP_CHECKPOINT_DIR = `<base_output_directory>/<trial_id>/checkpoints/`
   * AIP_TENSORBOARD_LOG_DIR = `<base_output_directory>/<trial_id>/logs/`
 

.google.cloud.aiplatform.v1.GcsDestination base_output_directory = 6;

clearBaseOutputDirectory

public CustomJobSpec.Builder clearBaseOutputDirectory()

 The Cloud Storage location to store the output of this CustomJob or
 HyperparameterTuningJob. For HyperparameterTuningJob,
 the baseOutputDirectory of
 each child CustomJob backing a Trial is set to a subdirectory of name
 [id][google.cloud.aiplatform.v1.Trial.id] under its parent HyperparameterTuningJob's
 baseOutputDirectory.
 The following Vertex AI environment variables will be passed to
 containers or python modules when this field is set:
   For CustomJob:
   * AIP_MODEL_DIR = `<base_output_directory>/model/`
   * AIP_CHECKPOINT_DIR = `<base_output_directory>/checkpoints/`
   * AIP_TENSORBOARD_LOG_DIR = `<base_output_directory>/logs/`
   For CustomJob backing a Trial of HyperparameterTuningJob:
   * AIP_MODEL_DIR = `<base_output_directory>/<trial_id>/model/`
   * AIP_CHECKPOINT_DIR = `<base_output_directory>/<trial_id>/checkpoints/`
   * AIP_TENSORBOARD_LOG_DIR = `<base_output_directory>/<trial_id>/logs/`
 

.google.cloud.aiplatform.v1.GcsDestination base_output_directory = 6;

getBaseOutputDirectoryBuilder

public GcsDestination.Builder getBaseOutputDirectoryBuilder()

 The Cloud Storage location to store the output of this CustomJob or
 HyperparameterTuningJob. For HyperparameterTuningJob,
 the baseOutputDirectory of
 each child CustomJob backing a Trial is set to a subdirectory of name
 [id][google.cloud.aiplatform.v1.Trial.id] under its parent HyperparameterTuningJob's
 baseOutputDirectory.
 The following Vertex AI environment variables will be passed to
 containers or python modules when this field is set:
   For CustomJob:
   * AIP_MODEL_DIR = `<base_output_directory>/model/`
   * AIP_CHECKPOINT_DIR = `<base_output_directory>/checkpoints/`
   * AIP_TENSORBOARD_LOG_DIR = `<base_output_directory>/logs/`
   For CustomJob backing a Trial of HyperparameterTuningJob:
   * AIP_MODEL_DIR = `<base_output_directory>/<trial_id>/model/`
   * AIP_CHECKPOINT_DIR = `<base_output_directory>/<trial_id>/checkpoints/`
   * AIP_TENSORBOARD_LOG_DIR = `<base_output_directory>/<trial_id>/logs/`
 

.google.cloud.aiplatform.v1.GcsDestination base_output_directory = 6;

getBaseOutputDirectoryOrBuilder

public GcsDestinationOrBuilder getBaseOutputDirectoryOrBuilder()

 The Cloud Storage location to store the output of this CustomJob or
 HyperparameterTuningJob. For HyperparameterTuningJob,
 the baseOutputDirectory of
 each child CustomJob backing a Trial is set to a subdirectory of name
 [id][google.cloud.aiplatform.v1.Trial.id] under its parent HyperparameterTuningJob's
 baseOutputDirectory.
 The following Vertex AI environment variables will be passed to
 containers or python modules when this field is set:
   For CustomJob:
   * AIP_MODEL_DIR = `<base_output_directory>/model/`
   * AIP_CHECKPOINT_DIR = `<base_output_directory>/checkpoints/`
   * AIP_TENSORBOARD_LOG_DIR = `<base_output_directory>/logs/`
   For CustomJob backing a Trial of HyperparameterTuningJob:
   * AIP_MODEL_DIR = `<base_output_directory>/<trial_id>/model/`
   * AIP_CHECKPOINT_DIR = `<base_output_directory>/<trial_id>/checkpoints/`
   * AIP_TENSORBOARD_LOG_DIR = `<base_output_directory>/<trial_id>/logs/`
 

.google.cloud.aiplatform.v1.GcsDestination base_output_directory = 6;

Specified by:

getBaseOutputDirectoryOrBuilder in interface CustomJobSpecOrBuilder

getEnableWebAccess

public boolean getEnableWebAccess()

 Optional. Whether you want Vertex AI to enable [interactive shell
 access](https://cloud.google.com/vertex-ai/docs/training/monitor-debug-interactive-shell)
 to training containers.
 If set to `true`, you can access interactive shells at the URIs given
 by [CustomJob.web_access_uris][google.cloud.aiplatform.v1.CustomJob.web_access_uris] or [Trial.web_access_uris][google.cloud.aiplatform.v1.Trial.web_access_uris] (within
 [HyperparameterTuningJob.trials][google.cloud.aiplatform.v1.HyperparameterTuningJob.trials]).
 

bool enable_web_access = 10 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getEnableWebAccess in interface CustomJobSpecOrBuilder

Returns:

The enableWebAccess.

setEnableWebAccess

public CustomJobSpec.Builder setEnableWebAccess(boolean value)

 Optional. Whether you want Vertex AI to enable [interactive shell
 access](https://cloud.google.com/vertex-ai/docs/training/monitor-debug-interactive-shell)
 to training containers.
 If set to `true`, you can access interactive shells at the URIs given
 by [CustomJob.web_access_uris][google.cloud.aiplatform.v1.CustomJob.web_access_uris] or [Trial.web_access_uris][google.cloud.aiplatform.v1.Trial.web_access_uris] (within
 [HyperparameterTuningJob.trials][google.cloud.aiplatform.v1.HyperparameterTuningJob.trials]).
 

bool enable_web_access = 10 [(.google.api.field_behavior) = OPTIONAL];

Parameters:

value - The enableWebAccess to set.

Returns:

This builder for chaining.

clearEnableWebAccess

public CustomJobSpec.Builder clearEnableWebAccess()

 Optional. Whether you want Vertex AI to enable [interactive shell
 access](https://cloud.google.com/vertex-ai/docs/training/monitor-debug-interactive-shell)
 to training containers.
 If set to `true`, you can access interactive shells at the URIs given
 by [CustomJob.web_access_uris][google.cloud.aiplatform.v1.CustomJob.web_access_uris] or [Trial.web_access_uris][google.cloud.aiplatform.v1.Trial.web_access_uris] (within
 [HyperparameterTuningJob.trials][google.cloud.aiplatform.v1.HyperparameterTuningJob.trials]).
 

bool enable_web_access = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns:

This builder for chaining.

setUnknownFields

public final CustomJobSpec.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

setUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<CustomJobSpec.Builder>

mergeUnknownFields

public final CustomJobSpec.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

mergeUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<CustomJobSpec.Builder>