Class CustomJobSpec.Builder
- java.lang.Object
-
- com.google.protobuf.AbstractMessageLite.Builder
-
- com.google.protobuf.AbstractMessage.Builder<BuilderT>
-
- com.google.protobuf.GeneratedMessageV3.Builder<CustomJobSpec.Builder>
-
- com.google.cloud.aiplatform.v1beta1.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 typegoogle.cloud.aiplatform.v1beta1.CustomJobSpec
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description CustomJobSpec.BuilderaddAllReservedIpRanges(Iterable<String> values)Optional.CustomJobSpec.BuilderaddAllWorkerPoolSpecs(Iterable<? extends WorkerPoolSpec> values)Required.CustomJobSpec.BuilderaddRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)CustomJobSpec.BuilderaddReservedIpRanges(String value)Optional.CustomJobSpec.BuilderaddReservedIpRangesBytes(com.google.protobuf.ByteString value)Optional.CustomJobSpec.BuilderaddWorkerPoolSpecs(int index, WorkerPoolSpec value)Required.CustomJobSpec.BuilderaddWorkerPoolSpecs(int index, WorkerPoolSpec.Builder builderForValue)Required.CustomJobSpec.BuilderaddWorkerPoolSpecs(WorkerPoolSpec value)Required.CustomJobSpec.BuilderaddWorkerPoolSpecs(WorkerPoolSpec.Builder builderForValue)Required.WorkerPoolSpec.BuilderaddWorkerPoolSpecsBuilder()Required.WorkerPoolSpec.BuilderaddWorkerPoolSpecsBuilder(int index)Required.CustomJobSpecbuild()CustomJobSpecbuildPartial()CustomJobSpec.Builderclear()CustomJobSpec.BuilderclearBaseOutputDirectory()The Cloud Storage location to store the output of this CustomJob or HyperparameterTuningJob.CustomJobSpec.BuilderclearEnableDashboardAccess()Optional.CustomJobSpec.BuilderclearEnableWebAccess()Optional.CustomJobSpec.BuilderclearExperiment()Optional.CustomJobSpec.BuilderclearExperimentRun()Optional.CustomJobSpec.BuilderclearField(com.google.protobuf.Descriptors.FieldDescriptor field)CustomJobSpec.BuilderclearNetwork()Optional.CustomJobSpec.BuilderclearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)CustomJobSpec.BuilderclearPersistentResourceId()Optional.CustomJobSpec.BuilderclearReservedIpRanges()Optional.CustomJobSpec.BuilderclearScheduling()Scheduling options for a CustomJob.CustomJobSpec.BuilderclearServiceAccount()Specifies the service account for workload run-as account.CustomJobSpec.BuilderclearTensorboard()Optional.CustomJobSpec.BuilderclearWorkerPoolSpecs()Required.CustomJobSpec.Builderclone()GcsDestinationgetBaseOutputDirectory()The Cloud Storage location to store the output of this CustomJob or HyperparameterTuningJob.GcsDestination.BuildergetBaseOutputDirectoryBuilder()The Cloud Storage location to store the output of this CustomJob or HyperparameterTuningJob.GcsDestinationOrBuildergetBaseOutputDirectoryOrBuilder()The Cloud Storage location to store the output of this CustomJob or HyperparameterTuningJob.CustomJobSpecgetDefaultInstanceForType()static com.google.protobuf.Descriptors.DescriptorgetDescriptor()com.google.protobuf.Descriptors.DescriptorgetDescriptorForType()booleangetEnableDashboardAccess()Optional.booleangetEnableWebAccess()Optional.StringgetExperiment()Optional.com.google.protobuf.ByteStringgetExperimentBytes()Optional.StringgetExperimentRun()Optional.com.google.protobuf.ByteStringgetExperimentRunBytes()Optional.StringgetNetwork()Optional.com.google.protobuf.ByteStringgetNetworkBytes()Optional.StringgetPersistentResourceId()Optional.com.google.protobuf.ByteStringgetPersistentResourceIdBytes()Optional.StringgetReservedIpRanges(int index)Optional.com.google.protobuf.ByteStringgetReservedIpRangesBytes(int index)Optional.intgetReservedIpRangesCount()Optional.com.google.protobuf.ProtocolStringListgetReservedIpRangesList()Optional.SchedulinggetScheduling()Scheduling options for a CustomJob.Scheduling.BuildergetSchedulingBuilder()Scheduling options for a CustomJob.SchedulingOrBuildergetSchedulingOrBuilder()Scheduling options for a CustomJob.StringgetServiceAccount()Specifies the service account for workload run-as account.com.google.protobuf.ByteStringgetServiceAccountBytes()Specifies the service account for workload run-as account.StringgetTensorboard()Optional.com.google.protobuf.ByteStringgetTensorboardBytes()Optional.WorkerPoolSpecgetWorkerPoolSpecs(int index)Required.WorkerPoolSpec.BuildergetWorkerPoolSpecsBuilder(int index)Required.List<WorkerPoolSpec.Builder>getWorkerPoolSpecsBuilderList()Required.intgetWorkerPoolSpecsCount()Required.List<WorkerPoolSpec>getWorkerPoolSpecsList()Required.WorkerPoolSpecOrBuildergetWorkerPoolSpecsOrBuilder(int index)Required.List<? extends WorkerPoolSpecOrBuilder>getWorkerPoolSpecsOrBuilderList()Required.booleanhasBaseOutputDirectory()The Cloud Storage location to store the output of this CustomJob or HyperparameterTuningJob.booleanhasScheduling()Scheduling options for a CustomJob.protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()booleanisInitialized()CustomJobSpec.BuildermergeBaseOutputDirectory(GcsDestination value)The Cloud Storage location to store the output of this CustomJob or HyperparameterTuningJob.CustomJobSpec.BuildermergeFrom(CustomJobSpec other)CustomJobSpec.BuildermergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)CustomJobSpec.BuildermergeFrom(com.google.protobuf.Message other)CustomJobSpec.BuildermergeScheduling(Scheduling value)Scheduling options for a CustomJob.CustomJobSpec.BuildermergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)CustomJobSpec.BuilderremoveWorkerPoolSpecs(int index)Required.CustomJobSpec.BuildersetBaseOutputDirectory(GcsDestination value)The Cloud Storage location to store the output of this CustomJob or HyperparameterTuningJob.CustomJobSpec.BuildersetBaseOutputDirectory(GcsDestination.Builder builderForValue)The Cloud Storage location to store the output of this CustomJob or HyperparameterTuningJob.CustomJobSpec.BuildersetEnableDashboardAccess(boolean value)Optional.CustomJobSpec.BuildersetEnableWebAccess(boolean value)Optional.CustomJobSpec.BuildersetExperiment(String value)Optional.CustomJobSpec.BuildersetExperimentBytes(com.google.protobuf.ByteString value)Optional.CustomJobSpec.BuildersetExperimentRun(String value)Optional.CustomJobSpec.BuildersetExperimentRunBytes(com.google.protobuf.ByteString value)Optional.CustomJobSpec.BuildersetField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)CustomJobSpec.BuildersetNetwork(String value)Optional.CustomJobSpec.BuildersetNetworkBytes(com.google.protobuf.ByteString value)Optional.CustomJobSpec.BuildersetPersistentResourceId(String value)Optional.CustomJobSpec.BuildersetPersistentResourceIdBytes(com.google.protobuf.ByteString value)Optional.CustomJobSpec.BuildersetRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)CustomJobSpec.BuildersetReservedIpRanges(int index, String value)Optional.CustomJobSpec.BuildersetScheduling(Scheduling value)Scheduling options for a CustomJob.CustomJobSpec.BuildersetScheduling(Scheduling.Builder builderForValue)Scheduling options for a CustomJob.CustomJobSpec.BuildersetServiceAccount(String value)Specifies the service account for workload run-as account.CustomJobSpec.BuildersetServiceAccountBytes(com.google.protobuf.ByteString value)Specifies the service account for workload run-as account.CustomJobSpec.BuildersetTensorboard(String value)Optional.CustomJobSpec.BuildersetTensorboardBytes(com.google.protobuf.ByteString value)Optional.CustomJobSpec.BuildersetUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)CustomJobSpec.BuildersetWorkerPoolSpecs(int index, WorkerPoolSpec value)Required.CustomJobSpec.BuildersetWorkerPoolSpecs(int index, WorkerPoolSpec.Builder builderForValue)Required.-
Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3
-
Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString
-
Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException
-
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
-
-
-
Method Detail
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
-
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessageV3.Builder<CustomJobSpec.Builder>
-
clear
public CustomJobSpec.Builder clear()
- Specified by:
clearin interfacecom.google.protobuf.Message.Builder- Specified by:
clearin interfacecom.google.protobuf.MessageLite.Builder- Overrides:
clearin classcom.google.protobuf.GeneratedMessageV3.Builder<CustomJobSpec.Builder>
-
getDescriptorForType
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.Message.Builder- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.MessageOrBuilder- Overrides:
getDescriptorForTypein classcom.google.protobuf.GeneratedMessageV3.Builder<CustomJobSpec.Builder>
-
getDefaultInstanceForType
public CustomJobSpec getDefaultInstanceForType()
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-
build
public CustomJobSpec build()
- Specified by:
buildin interfacecom.google.protobuf.Message.Builder- Specified by:
buildin interfacecom.google.protobuf.MessageLite.Builder
-
buildPartial
public CustomJobSpec buildPartial()
- Specified by:
buildPartialin interfacecom.google.protobuf.Message.Builder- Specified by:
buildPartialin interfacecom.google.protobuf.MessageLite.Builder
-
clone
public CustomJobSpec.Builder clone()
- Specified by:
clonein interfacecom.google.protobuf.Message.Builder- Specified by:
clonein interfacecom.google.protobuf.MessageLite.Builder- Overrides:
clonein classcom.google.protobuf.GeneratedMessageV3.Builder<CustomJobSpec.Builder>
-
setField
public CustomJobSpec.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
- Specified by:
setFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
setFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<CustomJobSpec.Builder>
-
clearField
public CustomJobSpec.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
- Specified by:
clearFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
clearFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<CustomJobSpec.Builder>
-
clearOneof
public CustomJobSpec.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
- Specified by:
clearOneofin interfacecom.google.protobuf.Message.Builder- Overrides:
clearOneofin classcom.google.protobuf.GeneratedMessageV3.Builder<CustomJobSpec.Builder>
-
setRepeatedField
public CustomJobSpec.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
- Specified by:
setRepeatedFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
setRepeatedFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<CustomJobSpec.Builder>
-
addRepeatedField
public CustomJobSpec.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
- Specified by:
addRepeatedFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
addRepeatedFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<CustomJobSpec.Builder>
-
mergeFrom
public CustomJobSpec.Builder mergeFrom(com.google.protobuf.Message other)
- Specified by:
mergeFromin interfacecom.google.protobuf.Message.Builder- Overrides:
mergeFromin classcom.google.protobuf.AbstractMessage.Builder<CustomJobSpec.Builder>
-
mergeFrom
public CustomJobSpec.Builder mergeFrom(CustomJobSpec other)
-
isInitialized
public final boolean isInitialized()
- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.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:
mergeFromin interfacecom.google.protobuf.Message.Builder- Specified by:
mergeFromin interfacecom.google.protobuf.MessageLite.Builder- Overrides:
mergeFromin classcom.google.protobuf.AbstractMessage.Builder<CustomJobSpec.Builder>- Throws:
IOException
-
getPersistentResourceId
public 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) = { ... }- Specified by:
getPersistentResourceIdin interfaceCustomJobSpecOrBuilder- Returns:
- The persistentResourceId.
-
getPersistentResourceIdBytes
public 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) = { ... }- Specified by:
getPersistentResourceIdBytesin interfaceCustomJobSpecOrBuilder- Returns:
- The bytes for persistentResourceId.
-
setPersistentResourceId
public 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) = { ... }- Parameters:
value- The persistentResourceId to set.- Returns:
- This builder for chaining.
-
clearPersistentResourceId
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) = { ... }- Returns:
- This builder for chaining.
-
setPersistentResourceIdBytes
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) = { ... }- Parameters:
value- The bytes for persistentResourceId to set.- Returns:
- This builder for chaining.
-
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.v1beta1.WorkerPoolSpec worker_pool_specs = 1 [(.google.api.field_behavior) = REQUIRED];- Specified by:
getWorkerPoolSpecsListin interfaceCustomJobSpecOrBuilder
-
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.v1beta1.WorkerPoolSpec worker_pool_specs = 1 [(.google.api.field_behavior) = REQUIRED];- Specified by:
getWorkerPoolSpecsCountin interfaceCustomJobSpecOrBuilder
-
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.v1beta1.WorkerPoolSpec worker_pool_specs = 1 [(.google.api.field_behavior) = REQUIRED];- Specified by:
getWorkerPoolSpecsin interfaceCustomJobSpecOrBuilder
-
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.v1beta1.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.v1beta1.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.v1beta1.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.v1beta1.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.v1beta1.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.v1beta1.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.v1beta1.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.v1beta1.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.v1beta1.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.v1beta1.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.v1beta1.WorkerPoolSpec worker_pool_specs = 1 [(.google.api.field_behavior) = REQUIRED];- Specified by:
getWorkerPoolSpecsOrBuilderin interfaceCustomJobSpecOrBuilder
-
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.v1beta1.WorkerPoolSpec worker_pool_specs = 1 [(.google.api.field_behavior) = REQUIRED];- Specified by:
getWorkerPoolSpecsOrBuilderListin interfaceCustomJobSpecOrBuilder
-
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.v1beta1.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.v1beta1.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.v1beta1.WorkerPoolSpec worker_pool_specs = 1 [(.google.api.field_behavior) = REQUIRED];
-
hasScheduling
public boolean hasScheduling()
Scheduling options for a CustomJob.
.google.cloud.aiplatform.v1beta1.Scheduling scheduling = 3;- Specified by:
hasSchedulingin interfaceCustomJobSpecOrBuilder- Returns:
- Whether the scheduling field is set.
-
getScheduling
public Scheduling getScheduling()
Scheduling options for a CustomJob.
.google.cloud.aiplatform.v1beta1.Scheduling scheduling = 3;- Specified by:
getSchedulingin interfaceCustomJobSpecOrBuilder- Returns:
- The scheduling.
-
setScheduling
public CustomJobSpec.Builder setScheduling(Scheduling value)
Scheduling options for a CustomJob.
.google.cloud.aiplatform.v1beta1.Scheduling scheduling = 3;
-
setScheduling
public CustomJobSpec.Builder setScheduling(Scheduling.Builder builderForValue)
Scheduling options for a CustomJob.
.google.cloud.aiplatform.v1beta1.Scheduling scheduling = 3;
-
mergeScheduling
public CustomJobSpec.Builder mergeScheduling(Scheduling value)
Scheduling options for a CustomJob.
.google.cloud.aiplatform.v1beta1.Scheduling scheduling = 3;
-
clearScheduling
public CustomJobSpec.Builder clearScheduling()
Scheduling options for a CustomJob.
.google.cloud.aiplatform.v1beta1.Scheduling scheduling = 3;
-
getSchedulingBuilder
public Scheduling.Builder getSchedulingBuilder()
Scheduling options for a CustomJob.
.google.cloud.aiplatform.v1beta1.Scheduling scheduling = 3;
-
getSchedulingOrBuilder
public SchedulingOrBuilder getSchedulingOrBuilder()
Scheduling options for a CustomJob.
.google.cloud.aiplatform.v1beta1.Scheduling scheduling = 3;- Specified by:
getSchedulingOrBuilderin interfaceCustomJobSpecOrBuilder
-
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:
getServiceAccountin interfaceCustomJobSpecOrBuilder- 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:
getServiceAccountBytesin interfaceCustomJobSpecOrBuilder- 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()
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) = { ... }- Specified by:
getNetworkin interfaceCustomJobSpecOrBuilder- Returns:
- The network.
-
getNetworkBytes
public 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) = { ... }- Specified by:
getNetworkBytesin interfaceCustomJobSpecOrBuilder- Returns:
- The bytes for network.
-
setNetwork
public 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) = { ... }- Parameters:
value- The network to set.- Returns:
- This builder for chaining.
-
clearNetwork
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) = { ... }- Returns:
- This builder for chaining.
-
setNetworkBytes
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) = { ... }- Parameters:
value- The bytes for network to set.- Returns:
- This builder for chaining.
-
getReservedIpRangesList
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];- Specified by:
getReservedIpRangesListin interfaceCustomJobSpecOrBuilder- Returns:
- A list containing the reservedIpRanges.
-
getReservedIpRangesCount
public 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];- Specified by:
getReservedIpRangesCountin interfaceCustomJobSpecOrBuilder- Returns:
- The count of reservedIpRanges.
-
getReservedIpRanges
public 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];- Specified by:
getReservedIpRangesin interfaceCustomJobSpecOrBuilder- Parameters:
index- The index of the element to return.- Returns:
- The reservedIpRanges at the given index.
-
getReservedIpRangesBytes
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];- Specified by:
getReservedIpRangesBytesin interfaceCustomJobSpecOrBuilder- Parameters:
index- The index of the value to return.- Returns:
- The bytes of the reservedIpRanges at the given index.
-
setReservedIpRanges
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];- Parameters:
index- The index to set the value at.value- The reservedIpRanges to set.- Returns:
- This builder for chaining.
-
addReservedIpRanges
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];- Parameters:
value- The reservedIpRanges to add.- Returns:
- This builder for chaining.
-
addAllReservedIpRanges
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];- Parameters:
values- The reservedIpRanges to add.- Returns:
- This builder for chaining.
-
clearReservedIpRanges
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];- Returns:
- This builder for chaining.
-
addReservedIpRangesBytes
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];- Parameters:
value- The bytes of the reservedIpRanges to add.- 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.v1beta1.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.v1beta1.GcsDestination base_output_directory = 6;- Specified by:
hasBaseOutputDirectoryin interfaceCustomJobSpecOrBuilder- 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.v1beta1.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.v1beta1.GcsDestination base_output_directory = 6;- Specified by:
getBaseOutputDirectoryin interfaceCustomJobSpecOrBuilder- 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.v1beta1.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.v1beta1.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.v1beta1.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.v1beta1.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.v1beta1.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.v1beta1.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.v1beta1.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.v1beta1.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.v1beta1.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.v1beta1.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.v1beta1.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.v1beta1.GcsDestination base_output_directory = 6;- Specified by:
getBaseOutputDirectoryOrBuilderin interfaceCustomJobSpecOrBuilder
-
getTensorboard
public String getTensorboard()
Optional. The name of a Vertex AI [Tensorboard][google.cloud.aiplatform.v1beta1.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) = { ... }- Specified by:
getTensorboardin interfaceCustomJobSpecOrBuilder- Returns:
- The tensorboard.
-
getTensorboardBytes
public com.google.protobuf.ByteString getTensorboardBytes()
Optional. The name of a Vertex AI [Tensorboard][google.cloud.aiplatform.v1beta1.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) = { ... }- Specified by:
getTensorboardBytesin interfaceCustomJobSpecOrBuilder- Returns:
- The bytes for tensorboard.
-
setTensorboard
public CustomJobSpec.Builder setTensorboard(String value)
Optional. The name of a Vertex AI [Tensorboard][google.cloud.aiplatform.v1beta1.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) = { ... }- Parameters:
value- The tensorboard to set.- Returns:
- This builder for chaining.
-
clearTensorboard
public CustomJobSpec.Builder clearTensorboard()
Optional. The name of a Vertex AI [Tensorboard][google.cloud.aiplatform.v1beta1.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) = { ... }- Returns:
- This builder for chaining.
-
setTensorboardBytes
public CustomJobSpec.Builder setTensorboardBytes(com.google.protobuf.ByteString value)
Optional. The name of a Vertex AI [Tensorboard][google.cloud.aiplatform.v1beta1.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) = { ... }- Parameters:
value- The bytes for tensorboard to set.- Returns:
- This builder for chaining.
-
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.v1beta1.CustomJob.web_access_uris] or [Trial.web_access_uris][google.cloud.aiplatform.v1beta1.Trial.web_access_uris] (within [HyperparameterTuningJob.trials][google.cloud.aiplatform.v1beta1.HyperparameterTuningJob.trials]).
bool enable_web_access = 10 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getEnableWebAccessin interfaceCustomJobSpecOrBuilder- 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.v1beta1.CustomJob.web_access_uris] or [Trial.web_access_uris][google.cloud.aiplatform.v1beta1.Trial.web_access_uris] (within [HyperparameterTuningJob.trials][google.cloud.aiplatform.v1beta1.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.v1beta1.CustomJob.web_access_uris] or [Trial.web_access_uris][google.cloud.aiplatform.v1beta1.Trial.web_access_uris] (within [HyperparameterTuningJob.trials][google.cloud.aiplatform.v1beta1.HyperparameterTuningJob.trials]).
bool enable_web_access = 10 [(.google.api.field_behavior) = OPTIONAL];- Returns:
- This builder for chaining.
-
getEnableDashboardAccess
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.v1beta1.CustomJob.web_access_uris] or [Trial.web_access_uris][google.cloud.aiplatform.v1beta1.Trial.web_access_uris] (within [HyperparameterTuningJob.trials][google.cloud.aiplatform.v1beta1.HyperparameterTuningJob.trials]).
bool enable_dashboard_access = 16 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getEnableDashboardAccessin interfaceCustomJobSpecOrBuilder- Returns:
- The enableDashboardAccess.
-
setEnableDashboardAccess
public 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.v1beta1.CustomJob.web_access_uris] or [Trial.web_access_uris][google.cloud.aiplatform.v1beta1.Trial.web_access_uris] (within [HyperparameterTuningJob.trials][google.cloud.aiplatform.v1beta1.HyperparameterTuningJob.trials]).
bool enable_dashboard_access = 16 [(.google.api.field_behavior) = OPTIONAL];- Parameters:
value- The enableDashboardAccess to set.- Returns:
- This builder for chaining.
-
clearEnableDashboardAccess
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.v1beta1.CustomJob.web_access_uris] or [Trial.web_access_uris][google.cloud.aiplatform.v1beta1.Trial.web_access_uris] (within [HyperparameterTuningJob.trials][google.cloud.aiplatform.v1beta1.HyperparameterTuningJob.trials]).
bool enable_dashboard_access = 16 [(.google.api.field_behavior) = OPTIONAL];- Returns:
- This builder for chaining.
-
getExperiment
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) = { ... }- Specified by:
getExperimentin interfaceCustomJobSpecOrBuilder- Returns:
- The experiment.
-
getExperimentBytes
public 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) = { ... }- Specified by:
getExperimentBytesin interfaceCustomJobSpecOrBuilder- Returns:
- The bytes for experiment.
-
setExperiment
public 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) = { ... }- Parameters:
value- The experiment to set.- Returns:
- This builder for chaining.
-
clearExperiment
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) = { ... }- Returns:
- This builder for chaining.
-
setExperimentBytes
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) = { ... }- Parameters:
value- The bytes for experiment to set.- Returns:
- This builder for chaining.
-
getExperimentRun
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) = { ... }- Specified by:
getExperimentRunin interfaceCustomJobSpecOrBuilder- Returns:
- The experimentRun.
-
getExperimentRunBytes
public 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) = { ... }- Specified by:
getExperimentRunBytesin interfaceCustomJobSpecOrBuilder- Returns:
- The bytes for experimentRun.
-
setExperimentRun
public 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) = { ... }- Parameters:
value- The experimentRun to set.- Returns:
- This builder for chaining.
-
clearExperimentRun
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) = { ... }- Returns:
- This builder for chaining.
-
setExperimentRunBytes
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) = { ... }- Parameters:
value- The bytes for experimentRun to set.- Returns:
- This builder for chaining.
-
setUnknownFields
public final CustomJobSpec.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
- Specified by:
setUnknownFieldsin interfacecom.google.protobuf.Message.Builder- Overrides:
setUnknownFieldsin classcom.google.protobuf.GeneratedMessageV3.Builder<CustomJobSpec.Builder>
-
mergeUnknownFields
public final CustomJobSpec.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
- Specified by:
mergeUnknownFieldsin interfacecom.google.protobuf.Message.Builder- Overrides:
mergeUnknownFieldsin classcom.google.protobuf.GeneratedMessageV3.Builder<CustomJobSpec.Builder>
-
-