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| Modifier and Type | Method and Description |
|---|---|
CustomJobSpec.Builder |
addAllModels(Iterable<String> values)
Optional.
|
CustomJobSpec.Builder |
addAllReservedIpRanges(Iterable<String> values)
Optional.
|
CustomJobSpec.Builder |
addAllWorkerPoolSpecs(Iterable<? extends WorkerPoolSpec> values)
Required.
|
CustomJobSpec.Builder |
addModels(String value)
Optional.
|
CustomJobSpec.Builder |
addModelsBytes(com.google.protobuf.ByteString value)
Optional.
|
CustomJobSpec.Builder |
addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
CustomJobSpec.Builder |
addReservedIpRanges(String value)
Optional.
|
CustomJobSpec.Builder |
addReservedIpRangesBytes(com.google.protobuf.ByteString value)
Optional.
|
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 |
clearEnableDashboardAccess()
Optional.
|
CustomJobSpec.Builder |
clearEnableWebAccess()
Optional.
|
CustomJobSpec.Builder |
clearExperiment()
Optional.
|
CustomJobSpec.Builder |
clearExperimentRun()
Optional.
|
CustomJobSpec.Builder |
clearField(com.google.protobuf.Descriptors.FieldDescriptor field) |
CustomJobSpec.Builder |
clearModels()
Optional.
|
CustomJobSpec.Builder |
clearNetwork()
Optional.
|
CustomJobSpec.Builder |
clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof) |
CustomJobSpec.Builder |
clearPersistentResourceId()
Optional.
|
CustomJobSpec.Builder |
clearProtectedArtifactLocationId()
The ID of the location to store protected artifacts. e.g. us-central1.
|
CustomJobSpec.Builder |
clearReservedIpRanges()
Optional.
|
CustomJobSpec.Builder |
clearScheduling()
Scheduling options for a CustomJob.
|
CustomJobSpec.Builder |
clearServiceAccount()
Specifies the service account for workload run-as account.
|
CustomJobSpec.Builder |
clearTensorboard()
Optional.
|
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 |
getEnableDashboardAccess()
Optional.
|
boolean |
getEnableWebAccess()
Optional.
|
String |
getExperiment()
Optional.
|
com.google.protobuf.ByteString |
getExperimentBytes()
Optional.
|
String |
getExperimentRun()
Optional.
|
com.google.protobuf.ByteString |
getExperimentRunBytes()
Optional.
|
String |
getModels(int index)
Optional.
|
com.google.protobuf.ByteString |
getModelsBytes(int index)
Optional.
|
int |
getModelsCount()
Optional.
|
com.google.protobuf.ProtocolStringList |
getModelsList()
Optional.
|
String |
getNetwork()
Optional.
|
com.google.protobuf.ByteString |
getNetworkBytes()
Optional.
|
String |
getPersistentResourceId()
Optional.
|
com.google.protobuf.ByteString |
getPersistentResourceIdBytes()
Optional.
|
String |
getProtectedArtifactLocationId()
The ID of the location to store protected artifacts. e.g. us-central1.
|
com.google.protobuf.ByteString |
getProtectedArtifactLocationIdBytes()
The ID of the location to store protected artifacts. e.g. us-central1.
|
String |
getReservedIpRanges(int index)
Optional.
|
com.google.protobuf.ByteString |
getReservedIpRangesBytes(int index)
Optional.
|
int |
getReservedIpRangesCount()
Optional.
|
com.google.protobuf.ProtocolStringList |
getReservedIpRangesList()
Optional.
|
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.
|
String |
getTensorboard()
Optional.
|
com.google.protobuf.ByteString |
getTensorboardBytes()
Optional.
|
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 |
setEnableDashboardAccess(boolean value)
Optional.
|
CustomJobSpec.Builder |
setEnableWebAccess(boolean value)
Optional.
|
CustomJobSpec.Builder |
setExperiment(String value)
Optional.
|
CustomJobSpec.Builder |
setExperimentBytes(com.google.protobuf.ByteString value)
Optional.
|
CustomJobSpec.Builder |
setExperimentRun(String value)
Optional.
|
CustomJobSpec.Builder |
setExperimentRunBytes(com.google.protobuf.ByteString value)
Optional.
|
CustomJobSpec.Builder |
setField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
CustomJobSpec.Builder |
setModels(int index,
String value)
Optional.
|
CustomJobSpec.Builder |
setNetwork(String value)
Optional.
|
CustomJobSpec.Builder |
setNetworkBytes(com.google.protobuf.ByteString value)
Optional.
|
CustomJobSpec.Builder |
setPersistentResourceId(String value)
Optional.
|
CustomJobSpec.Builder |
setPersistentResourceIdBytes(com.google.protobuf.ByteString value)
Optional.
|
CustomJobSpec.Builder |
setProtectedArtifactLocationId(String value)
The ID of the location to store protected artifacts. e.g. us-central1.
|
CustomJobSpec.Builder |
setProtectedArtifactLocationIdBytes(com.google.protobuf.ByteString value)
The ID of the location to store protected artifacts. e.g. us-central1.
|
CustomJobSpec.Builder |
setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
int index,
Object value) |
CustomJobSpec.Builder |
setReservedIpRanges(int index,
String value)
Optional.
|
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 |
setTensorboard(String value)
Optional.
|
CustomJobSpec.Builder |
setTensorboardBytes(com.google.protobuf.ByteString value)
Optional.
|
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.
|
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringaddAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, newUninitializedMessageExceptionequals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitpublic static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<CustomJobSpec.Builder>public CustomJobSpec.Builder clear()
clear in interface com.google.protobuf.Message.Builderclear in interface com.google.protobuf.MessageLite.Builderclear in class com.google.protobuf.GeneratedMessageV3.Builder<CustomJobSpec.Builder>public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
getDescriptorForType in interface com.google.protobuf.Message.BuildergetDescriptorForType in interface com.google.protobuf.MessageOrBuildergetDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<CustomJobSpec.Builder>public CustomJobSpec getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderpublic CustomJobSpec build()
build in interface com.google.protobuf.Message.Builderbuild in interface com.google.protobuf.MessageLite.Builderpublic CustomJobSpec buildPartial()
buildPartial in interface com.google.protobuf.Message.BuilderbuildPartial in interface com.google.protobuf.MessageLite.Builderpublic CustomJobSpec.Builder clone()
clone in interface com.google.protobuf.Message.Builderclone in interface com.google.protobuf.MessageLite.Builderclone in class com.google.protobuf.GeneratedMessageV3.Builder<CustomJobSpec.Builder>public CustomJobSpec.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
setField in interface com.google.protobuf.Message.BuildersetField in class com.google.protobuf.GeneratedMessageV3.Builder<CustomJobSpec.Builder>public CustomJobSpec.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
clearField in interface com.google.protobuf.Message.BuilderclearField in class com.google.protobuf.GeneratedMessageV3.Builder<CustomJobSpec.Builder>public CustomJobSpec.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
clearOneof in interface com.google.protobuf.Message.BuilderclearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<CustomJobSpec.Builder>public CustomJobSpec.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
setRepeatedField in interface com.google.protobuf.Message.BuildersetRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<CustomJobSpec.Builder>public CustomJobSpec.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
addRepeatedField in interface com.google.protobuf.Message.BuilderaddRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<CustomJobSpec.Builder>public CustomJobSpec.Builder mergeFrom(com.google.protobuf.Message other)
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<CustomJobSpec.Builder>public CustomJobSpec.Builder mergeFrom(CustomJobSpec other)
public final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<CustomJobSpec.Builder>public CustomJobSpec.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in interface com.google.protobuf.MessageLite.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<CustomJobSpec.Builder>IOExceptionpublic String getPersistentResourceId()
Optional. The ID of the PersistentResource in the same Project and Location which to run If this is specified, the job will be run on existing machines held by the PersistentResource instead of on-demand short-live machines. The network and CMEK configs on the job should be consistent with those on the PersistentResource, otherwise, the job will be rejected.
string persistent_resource_id = 14 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
getPersistentResourceId in interface CustomJobSpecOrBuilderpublic com.google.protobuf.ByteString getPersistentResourceIdBytes()
Optional. The ID of the PersistentResource in the same Project and Location which to run If this is specified, the job will be run on existing machines held by the PersistentResource instead of on-demand short-live machines. The network and CMEK configs on the job should be consistent with those on the PersistentResource, otherwise, the job will be rejected.
string persistent_resource_id = 14 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
getPersistentResourceIdBytes in interface CustomJobSpecOrBuilderpublic CustomJobSpec.Builder setPersistentResourceId(String value)
Optional. The ID of the PersistentResource in the same Project and Location which to run If this is specified, the job will be run on existing machines held by the PersistentResource instead of on-demand short-live machines. The network and CMEK configs on the job should be consistent with those on the PersistentResource, otherwise, the job will be rejected.
string persistent_resource_id = 14 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
value - The persistentResourceId to set.public CustomJobSpec.Builder clearPersistentResourceId()
Optional. The ID of the PersistentResource in the same Project and Location which to run If this is specified, the job will be run on existing machines held by the PersistentResource instead of on-demand short-live machines. The network and CMEK configs on the job should be consistent with those on the PersistentResource, otherwise, the job will be rejected.
string persistent_resource_id = 14 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
public CustomJobSpec.Builder setPersistentResourceIdBytes(com.google.protobuf.ByteString value)
Optional. The ID of the PersistentResource in the same Project and Location which to run If this is specified, the job will be run on existing machines held by the PersistentResource instead of on-demand short-live machines. The network and CMEK configs on the job should be consistent with those on the PersistentResource, otherwise, the job will be rejected.
string persistent_resource_id = 14 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
value - The bytes for persistentResourceId to set.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];
getWorkerPoolSpecsList in interface CustomJobSpecOrBuilderpublic 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];
getWorkerPoolSpecsCount in interface CustomJobSpecOrBuilderpublic 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];
getWorkerPoolSpecs in interface CustomJobSpecOrBuilderpublic 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];
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];
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];
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];
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];
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];
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];
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];
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];
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];
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];
getWorkerPoolSpecsOrBuilder in interface CustomJobSpecOrBuilderpublic 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];
getWorkerPoolSpecsOrBuilderList in interface CustomJobSpecOrBuilderpublic 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];
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];
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];
public boolean hasScheduling()
Scheduling options for a CustomJob.
.google.cloud.aiplatform.v1.Scheduling scheduling = 3;hasScheduling in interface CustomJobSpecOrBuilderpublic Scheduling getScheduling()
Scheduling options for a CustomJob.
.google.cloud.aiplatform.v1.Scheduling scheduling = 3;getScheduling in interface CustomJobSpecOrBuilderpublic CustomJobSpec.Builder setScheduling(Scheduling value)
Scheduling options for a CustomJob.
.google.cloud.aiplatform.v1.Scheduling scheduling = 3;public CustomJobSpec.Builder setScheduling(Scheduling.Builder builderForValue)
Scheduling options for a CustomJob.
.google.cloud.aiplatform.v1.Scheduling scheduling = 3;public CustomJobSpec.Builder mergeScheduling(Scheduling value)
Scheduling options for a CustomJob.
.google.cloud.aiplatform.v1.Scheduling scheduling = 3;public CustomJobSpec.Builder clearScheduling()
Scheduling options for a CustomJob.
.google.cloud.aiplatform.v1.Scheduling scheduling = 3;public Scheduling.Builder getSchedulingBuilder()
Scheduling options for a CustomJob.
.google.cloud.aiplatform.v1.Scheduling scheduling = 3;public SchedulingOrBuilder getSchedulingOrBuilder()
Scheduling options for a CustomJob.
.google.cloud.aiplatform.v1.Scheduling scheduling = 3;getSchedulingOrBuilder in interface CustomJobSpecOrBuilderpublic 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;getServiceAccount in interface CustomJobSpecOrBuilderpublic 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;getServiceAccountBytes in interface CustomJobSpecOrBuilderpublic 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;value - The serviceAccount to set.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;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;value - The bytes for serviceAccount to set.public String getNetwork()
Optional. 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.
To specify this field, you must have already [configured VPC Network
Peering for Vertex
AI](https://cloud.google.com/vertex-ai/docs/general/vpc-peering).
If this field is left unspecified, the job is not peered with any network.
string network = 5 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
getNetwork in interface CustomJobSpecOrBuilderpublic com.google.protobuf.ByteString getNetworkBytes()
Optional. 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.
To specify this field, you must have already [configured VPC Network
Peering for Vertex
AI](https://cloud.google.com/vertex-ai/docs/general/vpc-peering).
If this field is left unspecified, the job is not peered with any network.
string network = 5 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
getNetworkBytes in interface CustomJobSpecOrBuilderpublic CustomJobSpec.Builder setNetwork(String value)
Optional. 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.
To specify this field, you must have already [configured VPC Network
Peering for Vertex
AI](https://cloud.google.com/vertex-ai/docs/general/vpc-peering).
If this field is left unspecified, the job is not peered with any network.
string network = 5 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
value - The network to set.public CustomJobSpec.Builder clearNetwork()
Optional. 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.
To specify this field, you must have already [configured VPC Network
Peering for Vertex
AI](https://cloud.google.com/vertex-ai/docs/general/vpc-peering).
If this field is left unspecified, the job is not peered with any network.
string network = 5 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
public CustomJobSpec.Builder setNetworkBytes(com.google.protobuf.ByteString value)
Optional. 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.
To specify this field, you must have already [configured VPC Network
Peering for Vertex
AI](https://cloud.google.com/vertex-ai/docs/general/vpc-peering).
If this field is left unspecified, the job is not peered with any network.
string network = 5 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
value - The bytes for network to set.public com.google.protobuf.ProtocolStringList getReservedIpRangesList()
Optional. A list of names for the reserved ip ranges under the VPC network that can be used for this job. If set, we will deploy the job within the provided ip ranges. Otherwise, the job will be deployed to any ip ranges under the provided VPC network. Example: ['vertex-ai-ip-range'].
repeated string reserved_ip_ranges = 13 [(.google.api.field_behavior) = OPTIONAL];
getReservedIpRangesList in interface CustomJobSpecOrBuilderpublic int getReservedIpRangesCount()
Optional. A list of names for the reserved ip ranges under the VPC network that can be used for this job. If set, we will deploy the job within the provided ip ranges. Otherwise, the job will be deployed to any ip ranges under the provided VPC network. Example: ['vertex-ai-ip-range'].
repeated string reserved_ip_ranges = 13 [(.google.api.field_behavior) = OPTIONAL];
getReservedIpRangesCount in interface CustomJobSpecOrBuilderpublic String getReservedIpRanges(int index)
Optional. A list of names for the reserved ip ranges under the VPC network that can be used for this job. If set, we will deploy the job within the provided ip ranges. Otherwise, the job will be deployed to any ip ranges under the provided VPC network. Example: ['vertex-ai-ip-range'].
repeated string reserved_ip_ranges = 13 [(.google.api.field_behavior) = OPTIONAL];
getReservedIpRanges in interface CustomJobSpecOrBuilderindex - The index of the element to return.public com.google.protobuf.ByteString getReservedIpRangesBytes(int index)
Optional. A list of names for the reserved ip ranges under the VPC network that can be used for this job. If set, we will deploy the job within the provided ip ranges. Otherwise, the job will be deployed to any ip ranges under the provided VPC network. Example: ['vertex-ai-ip-range'].
repeated string reserved_ip_ranges = 13 [(.google.api.field_behavior) = OPTIONAL];
getReservedIpRangesBytes in interface CustomJobSpecOrBuilderindex - The index of the value to return.public CustomJobSpec.Builder setReservedIpRanges(int index, String value)
Optional. A list of names for the reserved ip ranges under the VPC network that can be used for this job. If set, we will deploy the job within the provided ip ranges. Otherwise, the job will be deployed to any ip ranges under the provided VPC network. Example: ['vertex-ai-ip-range'].
repeated string reserved_ip_ranges = 13 [(.google.api.field_behavior) = OPTIONAL];
index - The index to set the value at.value - The reservedIpRanges to set.public CustomJobSpec.Builder addReservedIpRanges(String value)
Optional. A list of names for the reserved ip ranges under the VPC network that can be used for this job. If set, we will deploy the job within the provided ip ranges. Otherwise, the job will be deployed to any ip ranges under the provided VPC network. Example: ['vertex-ai-ip-range'].
repeated string reserved_ip_ranges = 13 [(.google.api.field_behavior) = OPTIONAL];
value - The reservedIpRanges to add.public CustomJobSpec.Builder addAllReservedIpRanges(Iterable<String> values)
Optional. A list of names for the reserved ip ranges under the VPC network that can be used for this job. If set, we will deploy the job within the provided ip ranges. Otherwise, the job will be deployed to any ip ranges under the provided VPC network. Example: ['vertex-ai-ip-range'].
repeated string reserved_ip_ranges = 13 [(.google.api.field_behavior) = OPTIONAL];
values - The reservedIpRanges to add.public CustomJobSpec.Builder clearReservedIpRanges()
Optional. A list of names for the reserved ip ranges under the VPC network that can be used for this job. If set, we will deploy the job within the provided ip ranges. Otherwise, the job will be deployed to any ip ranges under the provided VPC network. Example: ['vertex-ai-ip-range'].
repeated string reserved_ip_ranges = 13 [(.google.api.field_behavior) = OPTIONAL];
public CustomJobSpec.Builder addReservedIpRangesBytes(com.google.protobuf.ByteString value)
Optional. A list of names for the reserved ip ranges under the VPC network that can be used for this job. If set, we will deploy the job within the provided ip ranges. Otherwise, the job will be deployed to any ip ranges under the provided VPC network. Example: ['vertex-ai-ip-range'].
repeated string reserved_ip_ranges = 13 [(.google.api.field_behavior) = OPTIONAL];
value - The bytes of the reservedIpRanges to add.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;hasBaseOutputDirectory in interface CustomJobSpecOrBuilderpublic 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;getBaseOutputDirectory in interface CustomJobSpecOrBuilderpublic 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;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;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;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;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;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;getBaseOutputDirectoryOrBuilder in interface CustomJobSpecOrBuilderpublic String getProtectedArtifactLocationId()
The ID of the location to store protected artifacts. e.g. us-central1. Populate only when the location is different than CustomJob location. List of supported locations: https://cloud.google.com/vertex-ai/docs/general/locations
string protected_artifact_location_id = 19;getProtectedArtifactLocationId in interface CustomJobSpecOrBuilderpublic com.google.protobuf.ByteString getProtectedArtifactLocationIdBytes()
The ID of the location to store protected artifacts. e.g. us-central1. Populate only when the location is different than CustomJob location. List of supported locations: https://cloud.google.com/vertex-ai/docs/general/locations
string protected_artifact_location_id = 19;getProtectedArtifactLocationIdBytes in interface CustomJobSpecOrBuilderpublic CustomJobSpec.Builder setProtectedArtifactLocationId(String value)
The ID of the location to store protected artifacts. e.g. us-central1. Populate only when the location is different than CustomJob location. List of supported locations: https://cloud.google.com/vertex-ai/docs/general/locations
string protected_artifact_location_id = 19;value - The protectedArtifactLocationId to set.public CustomJobSpec.Builder clearProtectedArtifactLocationId()
The ID of the location to store protected artifacts. e.g. us-central1. Populate only when the location is different than CustomJob location. List of supported locations: https://cloud.google.com/vertex-ai/docs/general/locations
string protected_artifact_location_id = 19;public CustomJobSpec.Builder setProtectedArtifactLocationIdBytes(com.google.protobuf.ByteString value)
The ID of the location to store protected artifacts. e.g. us-central1. Populate only when the location is different than CustomJob location. List of supported locations: https://cloud.google.com/vertex-ai/docs/general/locations
string protected_artifact_location_id = 19;value - The bytes for protectedArtifactLocationId to set.public String getTensorboard()
Optional. The name of a Vertex AI
[Tensorboard][google.cloud.aiplatform.v1.Tensorboard] resource to which
this CustomJob will upload Tensorboard logs. Format:
`projects/{project}/locations/{location}/tensorboards/{tensorboard}`
string tensorboard = 7 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
getTensorboard in interface CustomJobSpecOrBuilderpublic com.google.protobuf.ByteString getTensorboardBytes()
Optional. The name of a Vertex AI
[Tensorboard][google.cloud.aiplatform.v1.Tensorboard] resource to which
this CustomJob will upload Tensorboard logs. Format:
`projects/{project}/locations/{location}/tensorboards/{tensorboard}`
string tensorboard = 7 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
getTensorboardBytes in interface CustomJobSpecOrBuilderpublic CustomJobSpec.Builder setTensorboard(String value)
Optional. The name of a Vertex AI
[Tensorboard][google.cloud.aiplatform.v1.Tensorboard] resource to which
this CustomJob will upload Tensorboard logs. Format:
`projects/{project}/locations/{location}/tensorboards/{tensorboard}`
string tensorboard = 7 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
value - The tensorboard to set.public CustomJobSpec.Builder clearTensorboard()
Optional. The name of a Vertex AI
[Tensorboard][google.cloud.aiplatform.v1.Tensorboard] resource to which
this CustomJob will upload Tensorboard logs. Format:
`projects/{project}/locations/{location}/tensorboards/{tensorboard}`
string tensorboard = 7 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
public CustomJobSpec.Builder setTensorboardBytes(com.google.protobuf.ByteString value)
Optional. The name of a Vertex AI
[Tensorboard][google.cloud.aiplatform.v1.Tensorboard] resource to which
this CustomJob will upload Tensorboard logs. Format:
`projects/{project}/locations/{location}/tensorboards/{tensorboard}`
string tensorboard = 7 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
value - The bytes for tensorboard to set.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];getEnableWebAccess in interface CustomJobSpecOrBuilderpublic 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];value - The enableWebAccess to set.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];public boolean getEnableDashboardAccess()
Optional. Whether you want Vertex AI to enable access to the customized dashboard in training chief container. If set to `true`, you can access the dashboard 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_dashboard_access = 16 [(.google.api.field_behavior) = OPTIONAL];getEnableDashboardAccess in interface CustomJobSpecOrBuilderpublic CustomJobSpec.Builder setEnableDashboardAccess(boolean value)
Optional. Whether you want Vertex AI to enable access to the customized dashboard in training chief container. If set to `true`, you can access the dashboard 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_dashboard_access = 16 [(.google.api.field_behavior) = OPTIONAL];value - The enableDashboardAccess to set.public CustomJobSpec.Builder clearEnableDashboardAccess()
Optional. Whether you want Vertex AI to enable access to the customized dashboard in training chief container. If set to `true`, you can access the dashboard 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_dashboard_access = 16 [(.google.api.field_behavior) = OPTIONAL];public String getExperiment()
Optional. The Experiment associated with this job.
Format:
`projects/{project}/locations/{location}/metadataStores/{metadataStores}/contexts/{experiment-name}`
string experiment = 17 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
getExperiment in interface CustomJobSpecOrBuilderpublic com.google.protobuf.ByteString getExperimentBytes()
Optional. The Experiment associated with this job.
Format:
`projects/{project}/locations/{location}/metadataStores/{metadataStores}/contexts/{experiment-name}`
string experiment = 17 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
getExperimentBytes in interface CustomJobSpecOrBuilderpublic CustomJobSpec.Builder setExperiment(String value)
Optional. The Experiment associated with this job.
Format:
`projects/{project}/locations/{location}/metadataStores/{metadataStores}/contexts/{experiment-name}`
string experiment = 17 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
value - The experiment to set.public CustomJobSpec.Builder clearExperiment()
Optional. The Experiment associated with this job.
Format:
`projects/{project}/locations/{location}/metadataStores/{metadataStores}/contexts/{experiment-name}`
string experiment = 17 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
public CustomJobSpec.Builder setExperimentBytes(com.google.protobuf.ByteString value)
Optional. The Experiment associated with this job.
Format:
`projects/{project}/locations/{location}/metadataStores/{metadataStores}/contexts/{experiment-name}`
string experiment = 17 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
value - The bytes for experiment to set.public String getExperimentRun()
Optional. The Experiment Run associated with this job.
Format:
`projects/{project}/locations/{location}/metadataStores/{metadataStores}/contexts/{experiment-name}-{experiment-run-name}`
string experiment_run = 18 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
getExperimentRun in interface CustomJobSpecOrBuilderpublic com.google.protobuf.ByteString getExperimentRunBytes()
Optional. The Experiment Run associated with this job.
Format:
`projects/{project}/locations/{location}/metadataStores/{metadataStores}/contexts/{experiment-name}-{experiment-run-name}`
string experiment_run = 18 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
getExperimentRunBytes in interface CustomJobSpecOrBuilderpublic CustomJobSpec.Builder setExperimentRun(String value)
Optional. The Experiment Run associated with this job.
Format:
`projects/{project}/locations/{location}/metadataStores/{metadataStores}/contexts/{experiment-name}-{experiment-run-name}`
string experiment_run = 18 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
value - The experimentRun to set.public CustomJobSpec.Builder clearExperimentRun()
Optional. The Experiment Run associated with this job.
Format:
`projects/{project}/locations/{location}/metadataStores/{metadataStores}/contexts/{experiment-name}-{experiment-run-name}`
string experiment_run = 18 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
public CustomJobSpec.Builder setExperimentRunBytes(com.google.protobuf.ByteString value)
Optional. The Experiment Run associated with this job.
Format:
`projects/{project}/locations/{location}/metadataStores/{metadataStores}/contexts/{experiment-name}-{experiment-run-name}`
string experiment_run = 18 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
value - The bytes for experimentRun to set.public com.google.protobuf.ProtocolStringList getModelsList()
Optional. The name of the Model resources for which to generate a mapping
to artifact URIs. Applicable only to some of the Google-provided custom
jobs. Format: `projects/{project}/locations/{location}/models/{model}`
In order to retrieve a specific version of the model, also provide
the version ID or version alias.
Example: `projects/{project}/locations/{location}/models/{model}@2`
or
`projects/{project}/locations/{location}/models/{model}@golden`
If no version ID or alias is specified, the "default" version will be
returned. The "default" version alias is created for the first version of
the model, and can be moved to other versions later on. There will be
exactly one default version.
repeated string models = 20 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
getModelsList in interface CustomJobSpecOrBuilderpublic int getModelsCount()
Optional. The name of the Model resources for which to generate a mapping
to artifact URIs. Applicable only to some of the Google-provided custom
jobs. Format: `projects/{project}/locations/{location}/models/{model}`
In order to retrieve a specific version of the model, also provide
the version ID or version alias.
Example: `projects/{project}/locations/{location}/models/{model}@2`
or
`projects/{project}/locations/{location}/models/{model}@golden`
If no version ID or alias is specified, the "default" version will be
returned. The "default" version alias is created for the first version of
the model, and can be moved to other versions later on. There will be
exactly one default version.
repeated string models = 20 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
getModelsCount in interface CustomJobSpecOrBuilderpublic String getModels(int index)
Optional. The name of the Model resources for which to generate a mapping
to artifact URIs. Applicable only to some of the Google-provided custom
jobs. Format: `projects/{project}/locations/{location}/models/{model}`
In order to retrieve a specific version of the model, also provide
the version ID or version alias.
Example: `projects/{project}/locations/{location}/models/{model}@2`
or
`projects/{project}/locations/{location}/models/{model}@golden`
If no version ID or alias is specified, the "default" version will be
returned. The "default" version alias is created for the first version of
the model, and can be moved to other versions later on. There will be
exactly one default version.
repeated string models = 20 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
getModels in interface CustomJobSpecOrBuilderindex - The index of the element to return.public com.google.protobuf.ByteString getModelsBytes(int index)
Optional. The name of the Model resources for which to generate a mapping
to artifact URIs. Applicable only to some of the Google-provided custom
jobs. Format: `projects/{project}/locations/{location}/models/{model}`
In order to retrieve a specific version of the model, also provide
the version ID or version alias.
Example: `projects/{project}/locations/{location}/models/{model}@2`
or
`projects/{project}/locations/{location}/models/{model}@golden`
If no version ID or alias is specified, the "default" version will be
returned. The "default" version alias is created for the first version of
the model, and can be moved to other versions later on. There will be
exactly one default version.
repeated string models = 20 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
getModelsBytes in interface CustomJobSpecOrBuilderindex - The index of the value to return.public CustomJobSpec.Builder setModels(int index, String value)
Optional. The name of the Model resources for which to generate a mapping
to artifact URIs. Applicable only to some of the Google-provided custom
jobs. Format: `projects/{project}/locations/{location}/models/{model}`
In order to retrieve a specific version of the model, also provide
the version ID or version alias.
Example: `projects/{project}/locations/{location}/models/{model}@2`
or
`projects/{project}/locations/{location}/models/{model}@golden`
If no version ID or alias is specified, the "default" version will be
returned. The "default" version alias is created for the first version of
the model, and can be moved to other versions later on. There will be
exactly one default version.
repeated string models = 20 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
index - The index to set the value at.value - The models to set.public CustomJobSpec.Builder addModels(String value)
Optional. The name of the Model resources for which to generate a mapping
to artifact URIs. Applicable only to some of the Google-provided custom
jobs. Format: `projects/{project}/locations/{location}/models/{model}`
In order to retrieve a specific version of the model, also provide
the version ID or version alias.
Example: `projects/{project}/locations/{location}/models/{model}@2`
or
`projects/{project}/locations/{location}/models/{model}@golden`
If no version ID or alias is specified, the "default" version will be
returned. The "default" version alias is created for the first version of
the model, and can be moved to other versions later on. There will be
exactly one default version.
repeated string models = 20 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
value - The models to add.public CustomJobSpec.Builder addAllModels(Iterable<String> values)
Optional. The name of the Model resources for which to generate a mapping
to artifact URIs. Applicable only to some of the Google-provided custom
jobs. Format: `projects/{project}/locations/{location}/models/{model}`
In order to retrieve a specific version of the model, also provide
the version ID or version alias.
Example: `projects/{project}/locations/{location}/models/{model}@2`
or
`projects/{project}/locations/{location}/models/{model}@golden`
If no version ID or alias is specified, the "default" version will be
returned. The "default" version alias is created for the first version of
the model, and can be moved to other versions later on. There will be
exactly one default version.
repeated string models = 20 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
values - The models to add.public CustomJobSpec.Builder clearModels()
Optional. The name of the Model resources for which to generate a mapping
to artifact URIs. Applicable only to some of the Google-provided custom
jobs. Format: `projects/{project}/locations/{location}/models/{model}`
In order to retrieve a specific version of the model, also provide
the version ID or version alias.
Example: `projects/{project}/locations/{location}/models/{model}@2`
or
`projects/{project}/locations/{location}/models/{model}@golden`
If no version ID or alias is specified, the "default" version will be
returned. The "default" version alias is created for the first version of
the model, and can be moved to other versions later on. There will be
exactly one default version.
repeated string models = 20 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
public CustomJobSpec.Builder addModelsBytes(com.google.protobuf.ByteString value)
Optional. The name of the Model resources for which to generate a mapping
to artifact URIs. Applicable only to some of the Google-provided custom
jobs. Format: `projects/{project}/locations/{location}/models/{model}`
In order to retrieve a specific version of the model, also provide
the version ID or version alias.
Example: `projects/{project}/locations/{location}/models/{model}@2`
or
`projects/{project}/locations/{location}/models/{model}@golden`
If no version ID or alias is specified, the "default" version will be
returned. The "default" version alias is created for the first version of
the model, and can be moved to other versions later on. There will be
exactly one default version.
repeated string models = 20 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
value - The bytes of the models to add.public final CustomJobSpec.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
setUnknownFields in interface com.google.protobuf.Message.BuildersetUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<CustomJobSpec.Builder>public final CustomJobSpec.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
mergeUnknownFields in interface com.google.protobuf.Message.BuildermergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<CustomJobSpec.Builder>Copyright © 2025 Google LLC. All rights reserved.