Package com.google.cloud.aiplatform.v1

Class CustomJobSpec.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<CustomJobSpec.Builder>
com.google.cloud.aiplatform.v1.CustomJobSpec.Builder
All Implemented Interfaces:
CustomJobSpecOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
CustomJobSpec
public static final class CustomJobSpec.Builder extends com.google.protobuf.GeneratedMessage.Builder<CustomJobSpec.Builder> implements CustomJobSpecOrBuilder
 Represents the spec of a CustomJob.
Protobuf type google.cloud.aiplatform.v1.CustomJobSpec

  • Method Details

    • getDescriptor

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

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<CustomJobSpec.Builder>

    • clear

      public CustomJobSpec.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessage.Builder<CustomJobSpec.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<CustomJobSpec.Builder>

    • getDefaultInstanceForType

      public CustomJobSpec getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

    • build

      public CustomJobSpec build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder

    • buildPartial

      public CustomJobSpec buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder

    • mergeFrom

      public CustomJobSpec.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<CustomJobSpec.Builder>

    • mergeFrom

      public CustomJobSpec.Builder mergeFrom(CustomJobSpec other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.Builder<CustomJobSpec.Builder>

    • mergeFrom

      public CustomJobSpec.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<CustomJobSpec.Builder>
      Throws:
      IOException

    • 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:
      getPersistentResourceId in interface CustomJobSpecOrBuilder
      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:
      getPersistentResourceIdBytes in interface CustomJobSpecOrBuilder
      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.v1.WorkerPoolSpec worker_pool_specs = 1 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getWorkerPoolSpecsList in interface CustomJobSpecOrBuilder

    • getWorkerPoolSpecsCount

      public int getWorkerPoolSpecsCount()
       Required. The spec of the worker pools including machine type and Docker
 image. All worker pools except the first one are optional and can be
 skipped by providing an empty value.
      repeated .google.cloud.aiplatform.v1.WorkerPoolSpec worker_pool_specs = 1 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getWorkerPoolSpecsCount in interface CustomJobSpecOrBuilder

    • getWorkerPoolSpecs

      public WorkerPoolSpec getWorkerPoolSpecs(int index)
       Required. The spec of the worker pools including machine type and Docker
 image. All worker pools except the first one are optional and can be
 skipped by providing an empty value.
      repeated .google.cloud.aiplatform.v1.WorkerPoolSpec worker_pool_specs = 1 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getWorkerPoolSpecs in interface CustomJobSpecOrBuilder

    • setWorkerPoolSpecs

      public CustomJobSpec.Builder setWorkerPoolSpecs(int index, WorkerPoolSpec value)
       Required. The spec of the worker pools including machine type and Docker
 image. All worker pools except the first one are optional and can be
 skipped by providing an empty value.
      repeated .google.cloud.aiplatform.v1.WorkerPoolSpec worker_pool_specs = 1 [(.google.api.field_behavior) = REQUIRED];

    • setWorkerPoolSpecs

      public CustomJobSpec.Builder setWorkerPoolSpecs(int index, WorkerPoolSpec.Builder builderForValue)
       Required. The spec of the worker pools including machine type and Docker
 image. All worker pools except the first one are optional and can be
 skipped by providing an empty value.
      repeated .google.cloud.aiplatform.v1.WorkerPoolSpec worker_pool_specs = 1 [(.google.api.field_behavior) = REQUIRED];

    • addWorkerPoolSpecs

      public CustomJobSpec.Builder addWorkerPoolSpecs(WorkerPoolSpec value)
       Required. The spec of the worker pools including machine type and Docker
 image. All worker pools except the first one are optional and can be
 skipped by providing an empty value.
      repeated .google.cloud.aiplatform.v1.WorkerPoolSpec worker_pool_specs = 1 [(.google.api.field_behavior) = REQUIRED];

    • addWorkerPoolSpecs

      public CustomJobSpec.Builder addWorkerPoolSpecs(int index, WorkerPoolSpec value)
       Required. The spec of the worker pools including machine type and Docker
 image. All worker pools except the first one are optional and can be
 skipped by providing an empty value.
      repeated .google.cloud.aiplatform.v1.WorkerPoolSpec worker_pool_specs = 1 [(.google.api.field_behavior) = REQUIRED];

    • addWorkerPoolSpecs

      public CustomJobSpec.Builder addWorkerPoolSpecs(WorkerPoolSpec.Builder builderForValue)
       Required. The spec of the worker pools including machine type and Docker
 image. All worker pools except the first one are optional and can be
 skipped by providing an empty value.
      repeated .google.cloud.aiplatform.v1.WorkerPoolSpec worker_pool_specs = 1 [(.google.api.field_behavior) = REQUIRED];

    • addWorkerPoolSpecs

      public CustomJobSpec.Builder addWorkerPoolSpecs(int index, WorkerPoolSpec.Builder builderForValue)
       Required. The spec of the worker pools including machine type and Docker
 image. All worker pools except the first one are optional and can be
 skipped by providing an empty value.
      repeated .google.cloud.aiplatform.v1.WorkerPoolSpec worker_pool_specs = 1 [(.google.api.field_behavior) = REQUIRED];

    • addAllWorkerPoolSpecs

      public CustomJobSpec.Builder addAllWorkerPoolSpecs(Iterable<? extends WorkerPoolSpec> values)
       Required. The spec of the worker pools including machine type and Docker
 image. All worker pools except the first one are optional and can be
 skipped by providing an empty value.
      repeated .google.cloud.aiplatform.v1.WorkerPoolSpec worker_pool_specs = 1 [(.google.api.field_behavior) = REQUIRED];

    • clearWorkerPoolSpecs

      public CustomJobSpec.Builder clearWorkerPoolSpecs()
       Required. The spec of the worker pools including machine type and Docker
 image. All worker pools except the first one are optional and can be
 skipped by providing an empty value.
      repeated .google.cloud.aiplatform.v1.WorkerPoolSpec worker_pool_specs = 1 [(.google.api.field_behavior) = REQUIRED];

    • removeWorkerPoolSpecs

      public CustomJobSpec.Builder removeWorkerPoolSpecs(int index)
       Required. The spec of the worker pools including machine type and Docker
 image. All worker pools except the first one are optional and can be
 skipped by providing an empty value.
      repeated .google.cloud.aiplatform.v1.WorkerPoolSpec worker_pool_specs = 1 [(.google.api.field_behavior) = REQUIRED];

    • getWorkerPoolSpecsBuilder

      public WorkerPoolSpec.Builder getWorkerPoolSpecsBuilder(int index)
       Required. The spec of the worker pools including machine type and Docker
 image. All worker pools except the first one are optional and can be
 skipped by providing an empty value.
      repeated .google.cloud.aiplatform.v1.WorkerPoolSpec worker_pool_specs = 1 [(.google.api.field_behavior) = REQUIRED];

    • getWorkerPoolSpecsOrBuilder

      public WorkerPoolSpecOrBuilder getWorkerPoolSpecsOrBuilder(int index)
       Required. The spec of the worker pools including machine type and Docker
 image. All worker pools except the first one are optional and can be
 skipped by providing an empty value.
      repeated .google.cloud.aiplatform.v1.WorkerPoolSpec worker_pool_specs = 1 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getWorkerPoolSpecsOrBuilder in interface CustomJobSpecOrBuilder

    • getWorkerPoolSpecsOrBuilderList

      public List<? extends WorkerPoolSpecOrBuilder> getWorkerPoolSpecsOrBuilderList()
       Required. The spec of the worker pools including machine type and Docker
 image. All worker pools except the first one are optional and can be
 skipped by providing an empty value.
      repeated .google.cloud.aiplatform.v1.WorkerPoolSpec worker_pool_specs = 1 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getWorkerPoolSpecsOrBuilderList in interface CustomJobSpecOrBuilder

    • addWorkerPoolSpecsBuilder

      public WorkerPoolSpec.Builder addWorkerPoolSpecsBuilder()
       Required. The spec of the worker pools including machine type and Docker
 image. All worker pools except the first one are optional and can be
 skipped by providing an empty value.
      repeated .google.cloud.aiplatform.v1.WorkerPoolSpec worker_pool_specs = 1 [(.google.api.field_behavior) = REQUIRED];

    • addWorkerPoolSpecsBuilder

      public WorkerPoolSpec.Builder addWorkerPoolSpecsBuilder(int index)
       Required. The spec of the worker pools including machine type and Docker
 image. All worker pools except the first one are optional and can be
 skipped by providing an empty value.
      repeated .google.cloud.aiplatform.v1.WorkerPoolSpec worker_pool_specs = 1 [(.google.api.field_behavior) = REQUIRED];

    • getWorkerPoolSpecsBuilderList

      public List<WorkerPoolSpec.Builder> getWorkerPoolSpecsBuilderList()
       Required. The spec of the worker pools including machine type and Docker
 image. All worker pools except the first one are optional and can be
 skipped by providing an empty value.
      repeated .google.cloud.aiplatform.v1.WorkerPoolSpec worker_pool_specs = 1 [(.google.api.field_behavior) = REQUIRED];

    • hasScheduling

      public boolean hasScheduling()
       Scheduling options for a CustomJob.
      .google.cloud.aiplatform.v1.Scheduling scheduling = 3;
      Specified by:
      hasScheduling in interface CustomJobSpecOrBuilder
      Returns:
      Whether the scheduling field is set.

    • getScheduling

      public Scheduling getScheduling()
       Scheduling options for a CustomJob.
      .google.cloud.aiplatform.v1.Scheduling scheduling = 3;
      Specified by:
      getScheduling in interface CustomJobSpecOrBuilder
      Returns:
      The scheduling.

    • setScheduling

      public CustomJobSpec.Builder setScheduling(Scheduling value)
       Scheduling options for a CustomJob.
      .google.cloud.aiplatform.v1.Scheduling scheduling = 3;

    • setScheduling

      public CustomJobSpec.Builder setScheduling(Scheduling.Builder builderForValue)
       Scheduling options for a CustomJob.
      .google.cloud.aiplatform.v1.Scheduling scheduling = 3;

    • mergeScheduling

      public CustomJobSpec.Builder mergeScheduling(Scheduling value)
       Scheduling options for a CustomJob.
      .google.cloud.aiplatform.v1.Scheduling scheduling = 3;

    • clearScheduling

      public CustomJobSpec.Builder clearScheduling()
       Scheduling options for a CustomJob.
      .google.cloud.aiplatform.v1.Scheduling scheduling = 3;

    • getSchedulingBuilder

      public Scheduling.Builder getSchedulingBuilder()
       Scheduling options for a CustomJob.
      .google.cloud.aiplatform.v1.Scheduling scheduling = 3;

    • getSchedulingOrBuilder

      public SchedulingOrBuilder getSchedulingOrBuilder()
       Scheduling options for a CustomJob.
      .google.cloud.aiplatform.v1.Scheduling scheduling = 3;
      Specified by:
      getSchedulingOrBuilder in interface CustomJobSpecOrBuilder

    • getServiceAccount

      public String getServiceAccount()
       Specifies the service account for workload run-as account.
 Users submitting jobs must have act-as permission on this run-as account.
 If unspecified, the [Vertex AI Custom Code Service
 Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents)
 for the CustomJob's project is used.
      string service_account = 4;
      Specified by:
      getServiceAccount in interface CustomJobSpecOrBuilder
      Returns:
      The serviceAccount.

    • getServiceAccountBytes

      public com.google.protobuf.ByteString getServiceAccountBytes()
       Specifies the service account for workload run-as account.
 Users submitting jobs must have act-as permission on this run-as account.
 If unspecified, the [Vertex AI Custom Code Service
 Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents)
 for the CustomJob's project is used.
      string service_account = 4;
      Specified by:
      getServiceAccountBytes in interface CustomJobSpecOrBuilder
      Returns:
      The bytes for serviceAccount.

    • setServiceAccount

      public CustomJobSpec.Builder setServiceAccount(String value)
       Specifies the service account for workload run-as account.
 Users submitting jobs must have act-as permission on this run-as account.
 If unspecified, the [Vertex AI Custom Code Service
 Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents)
 for the CustomJob's project is used.
      string service_account = 4;
      Parameters:
      value - The serviceAccount to set.
      Returns:
      This builder for chaining.

    • clearServiceAccount

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

    • setServiceAccountBytes

      public CustomJobSpec.Builder setServiceAccountBytes(com.google.protobuf.ByteString value)
       Specifies the service account for workload run-as account.
 Users submitting jobs must have act-as permission on this run-as account.
 If unspecified, the [Vertex AI Custom Code Service
 Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents)
 for the CustomJob's project is used.
      string service_account = 4;
      Parameters:
      value - The bytes for serviceAccount to set.
      Returns:
      This builder for chaining.

    • getNetwork

      public String getNetwork()
       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:
      getNetwork in interface CustomJobSpecOrBuilder
      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:
      getNetworkBytes in interface CustomJobSpecOrBuilder
      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:
      getReservedIpRangesList in interface CustomJobSpecOrBuilder
      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:
      getReservedIpRangesCount in interface CustomJobSpecOrBuilder
      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:
      getReservedIpRanges in interface CustomJobSpecOrBuilder
      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:
      getReservedIpRangesBytes in interface CustomJobSpecOrBuilder
      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.

    • hasPscInterfaceConfig

      public boolean hasPscInterfaceConfig()
       Optional. Configuration for PSC-I for CustomJob.
      .google.cloud.aiplatform.v1.PscInterfaceConfig psc_interface_config = 21 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasPscInterfaceConfig in interface CustomJobSpecOrBuilder
      Returns:
      Whether the pscInterfaceConfig field is set.

    • getPscInterfaceConfig

      public PscInterfaceConfig getPscInterfaceConfig()
       Optional. Configuration for PSC-I for CustomJob.
      .google.cloud.aiplatform.v1.PscInterfaceConfig psc_interface_config = 21 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getPscInterfaceConfig in interface CustomJobSpecOrBuilder
      Returns:
      The pscInterfaceConfig.

    • setPscInterfaceConfig

      public CustomJobSpec.Builder setPscInterfaceConfig(PscInterfaceConfig value)
       Optional. Configuration for PSC-I for CustomJob.
      .google.cloud.aiplatform.v1.PscInterfaceConfig psc_interface_config = 21 [(.google.api.field_behavior) = OPTIONAL];

    • setPscInterfaceConfig

      public CustomJobSpec.Builder setPscInterfaceConfig(PscInterfaceConfig.Builder builderForValue)
       Optional. Configuration for PSC-I for CustomJob.
      .google.cloud.aiplatform.v1.PscInterfaceConfig psc_interface_config = 21 [(.google.api.field_behavior) = OPTIONAL];

    • mergePscInterfaceConfig

      public CustomJobSpec.Builder mergePscInterfaceConfig(PscInterfaceConfig value)
       Optional. Configuration for PSC-I for CustomJob.
      .google.cloud.aiplatform.v1.PscInterfaceConfig psc_interface_config = 21 [(.google.api.field_behavior) = OPTIONAL];

    • clearPscInterfaceConfig

      public CustomJobSpec.Builder clearPscInterfaceConfig()
       Optional. Configuration for PSC-I for CustomJob.
      .google.cloud.aiplatform.v1.PscInterfaceConfig psc_interface_config = 21 [(.google.api.field_behavior) = OPTIONAL];

    • getPscInterfaceConfigBuilder

      public PscInterfaceConfig.Builder getPscInterfaceConfigBuilder()
       Optional. Configuration for PSC-I for CustomJob.
      .google.cloud.aiplatform.v1.PscInterfaceConfig psc_interface_config = 21 [(.google.api.field_behavior) = OPTIONAL];

    • getPscInterfaceConfigOrBuilder

      public PscInterfaceConfigOrBuilder getPscInterfaceConfigOrBuilder()
       Optional. Configuration for PSC-I for CustomJob.
      .google.cloud.aiplatform.v1.PscInterfaceConfig psc_interface_config = 21 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getPscInterfaceConfigOrBuilder in interface CustomJobSpecOrBuilder

    • hasBaseOutputDirectory

      public boolean hasBaseOutputDirectory()
       The Cloud Storage location to store the output of this CustomJob or
 HyperparameterTuningJob. For HyperparameterTuningJob,
 the baseOutputDirectory of
 each child CustomJob backing a Trial is set to a subdirectory of name
 [id][google.cloud.aiplatform.v1.Trial.id] under its parent
 HyperparameterTuningJob's baseOutputDirectory.

 The following Vertex AI environment variables will be passed to
 containers or python modules when this field is set:

 For CustomJob:

 * AIP_MODEL_DIR = `<base_output_directory>/model/`
 * AIP_CHECKPOINT_DIR = `<base_output_directory>/checkpoints/`
 * AIP_TENSORBOARD_LOG_DIR = `<base_output_directory>/logs/`

 For CustomJob backing a Trial of HyperparameterTuningJob:

 * AIP_MODEL_DIR = `<base_output_directory>/<trial_id>/model/`
 * AIP_CHECKPOINT_DIR = `<base_output_directory>/<trial_id>/checkpoints/`
 * AIP_TENSORBOARD_LOG_DIR = `<base_output_directory>/<trial_id>/logs/`
      .google.cloud.aiplatform.v1.GcsDestination base_output_directory = 6;
      Specified by:
      hasBaseOutputDirectory in interface CustomJobSpecOrBuilder
      Returns:
      Whether the baseOutputDirectory field is set.

    • getBaseOutputDirectory

      public GcsDestination getBaseOutputDirectory()
       The Cloud Storage location to store the output of this CustomJob or
 HyperparameterTuningJob. For HyperparameterTuningJob,
 the baseOutputDirectory of
 each child CustomJob backing a Trial is set to a subdirectory of name
 [id][google.cloud.aiplatform.v1.Trial.id] under its parent
 HyperparameterTuningJob's baseOutputDirectory.

 The following Vertex AI environment variables will be passed to
 containers or python modules when this field is set:

 For CustomJob:

 * AIP_MODEL_DIR = `<base_output_directory>/model/`
 * AIP_CHECKPOINT_DIR = `<base_output_directory>/checkpoints/`
 * AIP_TENSORBOARD_LOG_DIR = `<base_output_directory>/logs/`

 For CustomJob backing a Trial of HyperparameterTuningJob:

 * AIP_MODEL_DIR = `<base_output_directory>/<trial_id>/model/`
 * AIP_CHECKPOINT_DIR = `<base_output_directory>/<trial_id>/checkpoints/`
 * AIP_TENSORBOARD_LOG_DIR = `<base_output_directory>/<trial_id>/logs/`
      .google.cloud.aiplatform.v1.GcsDestination base_output_directory = 6;
      Specified by:
      getBaseOutputDirectory in interface CustomJobSpecOrBuilder
      Returns:
      The baseOutputDirectory.

    • setBaseOutputDirectory

      public CustomJobSpec.Builder setBaseOutputDirectory(GcsDestination value)
       The Cloud Storage location to store the output of this CustomJob or
 HyperparameterTuningJob. For HyperparameterTuningJob,
 the baseOutputDirectory of
 each child CustomJob backing a Trial is set to a subdirectory of name
 [id][google.cloud.aiplatform.v1.Trial.id] under its parent
 HyperparameterTuningJob's baseOutputDirectory.

 The following Vertex AI environment variables will be passed to
 containers or python modules when this field is set:

 For CustomJob:

 * AIP_MODEL_DIR = `<base_output_directory>/model/`
 * AIP_CHECKPOINT_DIR = `<base_output_directory>/checkpoints/`
 * AIP_TENSORBOARD_LOG_DIR = `<base_output_directory>/logs/`

 For CustomJob backing a Trial of HyperparameterTuningJob:

 * AIP_MODEL_DIR = `<base_output_directory>/<trial_id>/model/`
 * AIP_CHECKPOINT_DIR = `<base_output_directory>/<trial_id>/checkpoints/`
 * AIP_TENSORBOARD_LOG_DIR = `<base_output_directory>/<trial_id>/logs/`
      .google.cloud.aiplatform.v1.GcsDestination base_output_directory = 6;

    • setBaseOutputDirectory

      public CustomJobSpec.Builder setBaseOutputDirectory(GcsDestination.Builder builderForValue)
       The Cloud Storage location to store the output of this CustomJob or
 HyperparameterTuningJob. For HyperparameterTuningJob,
 the baseOutputDirectory of
 each child CustomJob backing a Trial is set to a subdirectory of name
 [id][google.cloud.aiplatform.v1.Trial.id] under its parent
 HyperparameterTuningJob's baseOutputDirectory.

 The following Vertex AI environment variables will be passed to
 containers or python modules when this field is set:

 For CustomJob:

 * AIP_MODEL_DIR = `<base_output_directory>/model/`
 * AIP_CHECKPOINT_DIR = `<base_output_directory>/checkpoints/`
 * AIP_TENSORBOARD_LOG_DIR = `<base_output_directory>/logs/`

 For CustomJob backing a Trial of HyperparameterTuningJob:

 * AIP_MODEL_DIR = `<base_output_directory>/<trial_id>/model/`
 * AIP_CHECKPOINT_DIR = `<base_output_directory>/<trial_id>/checkpoints/`
 * AIP_TENSORBOARD_LOG_DIR = `<base_output_directory>/<trial_id>/logs/`
      .google.cloud.aiplatform.v1.GcsDestination base_output_directory = 6;

    • mergeBaseOutputDirectory

      public CustomJobSpec.Builder mergeBaseOutputDirectory(GcsDestination value)
       The Cloud Storage location to store the output of this CustomJob or
 HyperparameterTuningJob. For HyperparameterTuningJob,
 the baseOutputDirectory of
 each child CustomJob backing a Trial is set to a subdirectory of name
 [id][google.cloud.aiplatform.v1.Trial.id] under its parent
 HyperparameterTuningJob's baseOutputDirectory.

 The following Vertex AI environment variables will be passed to
 containers or python modules when this field is set:

 For CustomJob:

 * AIP_MODEL_DIR = `<base_output_directory>/model/`
 * AIP_CHECKPOINT_DIR = `<base_output_directory>/checkpoints/`
 * AIP_TENSORBOARD_LOG_DIR = `<base_output_directory>/logs/`

 For CustomJob backing a Trial of HyperparameterTuningJob:

 * AIP_MODEL_DIR = `<base_output_directory>/<trial_id>/model/`
 * AIP_CHECKPOINT_DIR = `<base_output_directory>/<trial_id>/checkpoints/`
 * AIP_TENSORBOARD_LOG_DIR = `<base_output_directory>/<trial_id>/logs/`
      .google.cloud.aiplatform.v1.GcsDestination base_output_directory = 6;

    • clearBaseOutputDirectory

      public CustomJobSpec.Builder clearBaseOutputDirectory()
       The Cloud Storage location to store the output of this CustomJob or
 HyperparameterTuningJob. For HyperparameterTuningJob,
 the baseOutputDirectory of
 each child CustomJob backing a Trial is set to a subdirectory of name
 [id][google.cloud.aiplatform.v1.Trial.id] under its parent
 HyperparameterTuningJob's baseOutputDirectory.

 The following Vertex AI environment variables will be passed to
 containers or python modules when this field is set:

 For CustomJob:

 * AIP_MODEL_DIR = `<base_output_directory>/model/`
 * AIP_CHECKPOINT_DIR = `<base_output_directory>/checkpoints/`
 * AIP_TENSORBOARD_LOG_DIR = `<base_output_directory>/logs/`

 For CustomJob backing a Trial of HyperparameterTuningJob:

 * AIP_MODEL_DIR = `<base_output_directory>/<trial_id>/model/`
 * AIP_CHECKPOINT_DIR = `<base_output_directory>/<trial_id>/checkpoints/`
 * AIP_TENSORBOARD_LOG_DIR = `<base_output_directory>/<trial_id>/logs/`
      .google.cloud.aiplatform.v1.GcsDestination base_output_directory = 6;

    • getBaseOutputDirectoryBuilder

      public GcsDestination.Builder getBaseOutputDirectoryBuilder()
       The Cloud Storage location to store the output of this CustomJob or
 HyperparameterTuningJob. For HyperparameterTuningJob,
 the baseOutputDirectory of
 each child CustomJob backing a Trial is set to a subdirectory of name
 [id][google.cloud.aiplatform.v1.Trial.id] under its parent
 HyperparameterTuningJob's baseOutputDirectory.

 The following Vertex AI environment variables will be passed to
 containers or python modules when this field is set:

 For CustomJob:

 * AIP_MODEL_DIR = `<base_output_directory>/model/`
 * AIP_CHECKPOINT_DIR = `<base_output_directory>/checkpoints/`
 * AIP_TENSORBOARD_LOG_DIR = `<base_output_directory>/logs/`

 For CustomJob backing a Trial of HyperparameterTuningJob:

 * AIP_MODEL_DIR = `<base_output_directory>/<trial_id>/model/`
 * AIP_CHECKPOINT_DIR = `<base_output_directory>/<trial_id>/checkpoints/`
 * AIP_TENSORBOARD_LOG_DIR = `<base_output_directory>/<trial_id>/logs/`
      .google.cloud.aiplatform.v1.GcsDestination base_output_directory = 6;

    • getBaseOutputDirectoryOrBuilder

      public GcsDestinationOrBuilder getBaseOutputDirectoryOrBuilder()
       The Cloud Storage location to store the output of this CustomJob or
 HyperparameterTuningJob. For HyperparameterTuningJob,
 the baseOutputDirectory of
 each child CustomJob backing a Trial is set to a subdirectory of name
 [id][google.cloud.aiplatform.v1.Trial.id] under its parent
 HyperparameterTuningJob's baseOutputDirectory.

 The following Vertex AI environment variables will be passed to
 containers or python modules when this field is set:

 For CustomJob:

 * AIP_MODEL_DIR = `<base_output_directory>/model/`
 * AIP_CHECKPOINT_DIR = `<base_output_directory>/checkpoints/`
 * AIP_TENSORBOARD_LOG_DIR = `<base_output_directory>/logs/`

 For CustomJob backing a Trial of HyperparameterTuningJob:

 * AIP_MODEL_DIR = `<base_output_directory>/<trial_id>/model/`
 * AIP_CHECKPOINT_DIR = `<base_output_directory>/<trial_id>/checkpoints/`
 * AIP_TENSORBOARD_LOG_DIR = `<base_output_directory>/<trial_id>/logs/`
      .google.cloud.aiplatform.v1.GcsDestination base_output_directory = 6;
      Specified by:
      getBaseOutputDirectoryOrBuilder in interface CustomJobSpecOrBuilder

    • getProtectedArtifactLocationId

      public 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;
      Specified by:
      getProtectedArtifactLocationId in interface CustomJobSpecOrBuilder
      Returns:
      The protectedArtifactLocationId.

    • getProtectedArtifactLocationIdBytes

      public 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;
      Specified by:
      getProtectedArtifactLocationIdBytes in interface CustomJobSpecOrBuilder
      Returns:
      The bytes for protectedArtifactLocationId.

    • setProtectedArtifactLocationId

      public 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;
      Parameters:
      value - The protectedArtifactLocationId to set.
      Returns:
      This builder for chaining.

    • clearProtectedArtifactLocationId

      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;
      Returns:
      This builder for chaining.

    • setProtectedArtifactLocationIdBytes

      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;
      Parameters:
      value - The bytes for protectedArtifactLocationId to set.
      Returns:
      This builder for chaining.

    • getTensorboard

      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) = { ... }
      Specified by:
      getTensorboard in interface CustomJobSpecOrBuilder
      Returns:
      The tensorboard.

    • getTensorboardBytes

      public 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) = { ... }
      Specified by:
      getTensorboardBytes in interface CustomJobSpecOrBuilder
      Returns:
      The bytes for tensorboard.

    • setTensorboard

      public 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) = { ... }
      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.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) = { ... }
      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.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) = { ... }
      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.v1.CustomJob.web_access_uris]
 or
 [Trial.web_access_uris][google.cloud.aiplatform.v1.Trial.web_access_uris]
 (within
 [HyperparameterTuningJob.trials][google.cloud.aiplatform.v1.HyperparameterTuningJob.trials]).
      bool enable_web_access = 10 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getEnableWebAccess in interface CustomJobSpecOrBuilder
      Returns:
      The enableWebAccess.

    • setEnableWebAccess

      public CustomJobSpec.Builder setEnableWebAccess(boolean value)
       Optional. Whether you want Vertex AI to enable [interactive shell
 access](https://cloud.google.com/vertex-ai/docs/training/monitor-debug-interactive-shell)
 to training containers.

 If set to `true`, you can access interactive shells at the URIs given
 by
 [CustomJob.web_access_uris][google.cloud.aiplatform.v1.CustomJob.web_access_uris]
 or
 [Trial.web_access_uris][google.cloud.aiplatform.v1.Trial.web_access_uris]
 (within
 [HyperparameterTuningJob.trials][google.cloud.aiplatform.v1.HyperparameterTuningJob.trials]).
      bool enable_web_access = 10 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The enableWebAccess to set.
      Returns:
      This builder for chaining.

    • clearEnableWebAccess

      public CustomJobSpec.Builder clearEnableWebAccess()
       Optional. Whether you want Vertex AI to enable [interactive shell
 access](https://cloud.google.com/vertex-ai/docs/training/monitor-debug-interactive-shell)
 to training containers.

 If set to `true`, you can access interactive shells at the URIs given
 by
 [CustomJob.web_access_uris][google.cloud.aiplatform.v1.CustomJob.web_access_uris]
 or
 [Trial.web_access_uris][google.cloud.aiplatform.v1.Trial.web_access_uris]
 (within
 [HyperparameterTuningJob.trials][google.cloud.aiplatform.v1.HyperparameterTuningJob.trials]).
      bool enable_web_access = 10 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      This builder for chaining.

    • 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.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];
      Specified by:
      getEnableDashboardAccess in interface CustomJobSpecOrBuilder
      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.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];
      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.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];
      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:
      getExperiment in interface CustomJobSpecOrBuilder
      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:
      getExperimentBytes in interface CustomJobSpecOrBuilder
      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:
      getExperimentRun in interface CustomJobSpecOrBuilder
      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:
      getExperimentRunBytes in interface CustomJobSpecOrBuilder
      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.

    • getModelsList

      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) = { ... }
      Specified by:
      getModelsList in interface CustomJobSpecOrBuilder
      Returns:
      A list containing the models.

    • getModelsCount

      public 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) = { ... }
      Specified by:
      getModelsCount in interface CustomJobSpecOrBuilder
      Returns:
      The count of models.

    • getModels

      public 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) = { ... }
      Specified by:
      getModels in interface CustomJobSpecOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The models at the given index.

    • getModelsBytes

      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) = { ... }
      Specified by:
      getModelsBytes in interface CustomJobSpecOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the models at the given index.

    • setModels

      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) = { ... }
      Parameters:
      index - The index to set the value at.
      value - The models to set.
      Returns:
      This builder for chaining.

    • addModels

      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) = { ... }
      Parameters:
      value - The models to add.
      Returns:
      This builder for chaining.

    • addAllModels

      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) = { ... }
      Parameters:
      values - The models to add.
      Returns:
      This builder for chaining.

    • clearModels

      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) = { ... }
      Returns:
      This builder for chaining.

    • addModelsBytes

      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) = { ... }
      Parameters:
      value - The bytes of the models to add.
      Returns:
      This builder for chaining.