Package com.google.cloud.aiplatform.v1

Class RaySpec.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<RaySpec.Builder>
com.google.cloud.aiplatform.v1.RaySpec.Builder
All Implemented Interfaces:
RaySpecOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
RaySpec
public static final class RaySpec.Builder extends com.google.protobuf.GeneratedMessage.Builder<RaySpec.Builder> implements RaySpecOrBuilder
 Configuration information for the Ray cluster.
 For experimental launch, Ray cluster creation and Persistent
 cluster creation are 1:1 mapping: We will provision all the nodes within the
 Persistent cluster as Ray nodes.
Protobuf type google.cloud.aiplatform.v1.RaySpec

  • Method Details

    • getDescriptor

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

    • internalGetMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
      Overrides:
      internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessage.Builder<RaySpec.Builder>

    • internalGetMutableMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
      Overrides:
      internalGetMutableMapFieldReflection in class com.google.protobuf.GeneratedMessage.Builder<RaySpec.Builder>

    • internalGetFieldAccessorTable

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

    • clear

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

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • mergeFrom

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

    • mergeFrom

      public RaySpec.Builder mergeFrom(RaySpec other)

    • isInitialized

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

    • mergeFrom

      public RaySpec.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<RaySpec.Builder>
      Throws:
      IOException

    • getImageUri

      public String getImageUri()
       Optional. Default image for user to choose a preferred ML framework
 (for example, TensorFlow or Pytorch) by choosing from [Vertex prebuilt
 images](https://cloud.google.com/vertex-ai/docs/training/pre-built-containers).
 Either this or the resource_pool_images is required. Use this field if
 you need all the resource pools to have the same Ray image. Otherwise, use
 the {@code resource_pool_images} field.
      string image_uri = 1 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getImageUri in interface RaySpecOrBuilder
      Returns:
      The imageUri.

    • getImageUriBytes

      public com.google.protobuf.ByteString getImageUriBytes()
       Optional. Default image for user to choose a preferred ML framework
 (for example, TensorFlow or Pytorch) by choosing from [Vertex prebuilt
 images](https://cloud.google.com/vertex-ai/docs/training/pre-built-containers).
 Either this or the resource_pool_images is required. Use this field if
 you need all the resource pools to have the same Ray image. Otherwise, use
 the {@code resource_pool_images} field.
      string image_uri = 1 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getImageUriBytes in interface RaySpecOrBuilder
      Returns:
      The bytes for imageUri.

    • setImageUri

      public RaySpec.Builder setImageUri(String value)
       Optional. Default image for user to choose a preferred ML framework
 (for example, TensorFlow or Pytorch) by choosing from [Vertex prebuilt
 images](https://cloud.google.com/vertex-ai/docs/training/pre-built-containers).
 Either this or the resource_pool_images is required. Use this field if
 you need all the resource pools to have the same Ray image. Otherwise, use
 the {@code resource_pool_images} field.
      string image_uri = 1 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The imageUri to set.
      Returns:
      This builder for chaining.

    • clearImageUri

      public RaySpec.Builder clearImageUri()
       Optional. Default image for user to choose a preferred ML framework
 (for example, TensorFlow or Pytorch) by choosing from [Vertex prebuilt
 images](https://cloud.google.com/vertex-ai/docs/training/pre-built-containers).
 Either this or the resource_pool_images is required. Use this field if
 you need all the resource pools to have the same Ray image. Otherwise, use
 the {@code resource_pool_images} field.
      string image_uri = 1 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      This builder for chaining.

    • setImageUriBytes

      public RaySpec.Builder setImageUriBytes(com.google.protobuf.ByteString value)
       Optional. Default image for user to choose a preferred ML framework
 (for example, TensorFlow or Pytorch) by choosing from [Vertex prebuilt
 images](https://cloud.google.com/vertex-ai/docs/training/pre-built-containers).
 Either this or the resource_pool_images is required. Use this field if
 you need all the resource pools to have the same Ray image. Otherwise, use
 the {@code resource_pool_images} field.
      string image_uri = 1 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The bytes for imageUri to set.
      Returns:
      This builder for chaining.

    • getResourcePoolImagesCount

      public int getResourcePoolImagesCount()
      Description copied from interface: RaySpecOrBuilder
       Optional. Required if image_uri isn't set. A map of resource_pool_id to
 prebuild Ray image if user need to use different images for different
 head/worker pools. This map needs to cover all the resource pool ids.
 Example:
 {
 "ray_head_node_pool": "head image"
 "ray_worker_node_pool1": "worker image"
 "ray_worker_node_pool2": "another worker image"
 }
      map<string, string> resource_pool_images = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getResourcePoolImagesCount in interface RaySpecOrBuilder

    • containsResourcePoolImages

      public boolean containsResourcePoolImages(String key)
       Optional. Required if image_uri isn't set. A map of resource_pool_id to
 prebuild Ray image if user need to use different images for different
 head/worker pools. This map needs to cover all the resource pool ids.
 Example:
 {
 "ray_head_node_pool": "head image"
 "ray_worker_node_pool1": "worker image"
 "ray_worker_node_pool2": "another worker image"
 }
      map<string, string> resource_pool_images = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      containsResourcePoolImages in interface RaySpecOrBuilder

    • getResourcePoolImages

      @Deprecated public Map<String,String> getResourcePoolImages()
      Deprecated.
      Use getResourcePoolImagesMap() instead.
      Specified by:
      getResourcePoolImages in interface RaySpecOrBuilder

    • getResourcePoolImagesMap

      public Map<String,String> getResourcePoolImagesMap()
       Optional. Required if image_uri isn't set. A map of resource_pool_id to
 prebuild Ray image if user need to use different images for different
 head/worker pools. This map needs to cover all the resource pool ids.
 Example:
 {
 "ray_head_node_pool": "head image"
 "ray_worker_node_pool1": "worker image"
 "ray_worker_node_pool2": "another worker image"
 }
      map<string, string> resource_pool_images = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getResourcePoolImagesMap in interface RaySpecOrBuilder

    • getResourcePoolImagesOrDefault

      public String getResourcePoolImagesOrDefault(String key, String defaultValue)
       Optional. Required if image_uri isn't set. A map of resource_pool_id to
 prebuild Ray image if user need to use different images for different
 head/worker pools. This map needs to cover all the resource pool ids.
 Example:
 {
 "ray_head_node_pool": "head image"
 "ray_worker_node_pool1": "worker image"
 "ray_worker_node_pool2": "another worker image"
 }
      map<string, string> resource_pool_images = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getResourcePoolImagesOrDefault in interface RaySpecOrBuilder

    • getResourcePoolImagesOrThrow

      public String getResourcePoolImagesOrThrow(String key)
       Optional. Required if image_uri isn't set. A map of resource_pool_id to
 prebuild Ray image if user need to use different images for different
 head/worker pools. This map needs to cover all the resource pool ids.
 Example:
 {
 "ray_head_node_pool": "head image"
 "ray_worker_node_pool1": "worker image"
 "ray_worker_node_pool2": "another worker image"
 }
      map<string, string> resource_pool_images = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getResourcePoolImagesOrThrow in interface RaySpecOrBuilder

    • clearResourcePoolImages

      public RaySpec.Builder clearResourcePoolImages()

    • removeResourcePoolImages

      public RaySpec.Builder removeResourcePoolImages(String key)
       Optional. Required if image_uri isn't set. A map of resource_pool_id to
 prebuild Ray image if user need to use different images for different
 head/worker pools. This map needs to cover all the resource pool ids.
 Example:
 {
 "ray_head_node_pool": "head image"
 "ray_worker_node_pool1": "worker image"
 "ray_worker_node_pool2": "another worker image"
 }
      map<string, string> resource_pool_images = 6 [(.google.api.field_behavior) = OPTIONAL];

    • getMutableResourcePoolImages

      @Deprecated public Map<String,String> getMutableResourcePoolImages()
      Deprecated.
      Use alternate mutation accessors instead.

    • putResourcePoolImages

      public RaySpec.Builder putResourcePoolImages(String key, String value)
       Optional. Required if image_uri isn't set. A map of resource_pool_id to
 prebuild Ray image if user need to use different images for different
 head/worker pools. This map needs to cover all the resource pool ids.
 Example:
 {
 "ray_head_node_pool": "head image"
 "ray_worker_node_pool1": "worker image"
 "ray_worker_node_pool2": "another worker image"
 }
      map<string, string> resource_pool_images = 6 [(.google.api.field_behavior) = OPTIONAL];

    • putAllResourcePoolImages

      public RaySpec.Builder putAllResourcePoolImages(Map<String,String> values)
       Optional. Required if image_uri isn't set. A map of resource_pool_id to
 prebuild Ray image if user need to use different images for different
 head/worker pools. This map needs to cover all the resource pool ids.
 Example:
 {
 "ray_head_node_pool": "head image"
 "ray_worker_node_pool1": "worker image"
 "ray_worker_node_pool2": "another worker image"
 }
      map<string, string> resource_pool_images = 6 [(.google.api.field_behavior) = OPTIONAL];

    • getHeadNodeResourcePoolId

      public String getHeadNodeResourcePoolId()
       Optional. This will be used to indicate which resource pool will serve as
 the Ray head node(the first node within that pool). Will use the machine
 from the first workerpool as the head node by default if this field isn't
 set.
      string head_node_resource_pool_id = 7 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getHeadNodeResourcePoolId in interface RaySpecOrBuilder
      Returns:
      The headNodeResourcePoolId.

    • getHeadNodeResourcePoolIdBytes

      public com.google.protobuf.ByteString getHeadNodeResourcePoolIdBytes()
       Optional. This will be used to indicate which resource pool will serve as
 the Ray head node(the first node within that pool). Will use the machine
 from the first workerpool as the head node by default if this field isn't
 set.
      string head_node_resource_pool_id = 7 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getHeadNodeResourcePoolIdBytes in interface RaySpecOrBuilder
      Returns:
      The bytes for headNodeResourcePoolId.

    • setHeadNodeResourcePoolId

      public RaySpec.Builder setHeadNodeResourcePoolId(String value)
       Optional. This will be used to indicate which resource pool will serve as
 the Ray head node(the first node within that pool). Will use the machine
 from the first workerpool as the head node by default if this field isn't
 set.
      string head_node_resource_pool_id = 7 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The headNodeResourcePoolId to set.
      Returns:
      This builder for chaining.

    • clearHeadNodeResourcePoolId

      public RaySpec.Builder clearHeadNodeResourcePoolId()
       Optional. This will be used to indicate which resource pool will serve as
 the Ray head node(the first node within that pool). Will use the machine
 from the first workerpool as the head node by default if this field isn't
 set.
      string head_node_resource_pool_id = 7 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      This builder for chaining.

    • setHeadNodeResourcePoolIdBytes

      public RaySpec.Builder setHeadNodeResourcePoolIdBytes(com.google.protobuf.ByteString value)
       Optional. This will be used to indicate which resource pool will serve as
 the Ray head node(the first node within that pool). Will use the machine
 from the first workerpool as the head node by default if this field isn't
 set.
      string head_node_resource_pool_id = 7 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The bytes for headNodeResourcePoolId to set.
      Returns:
      This builder for chaining.

    • hasRayMetricSpec

      public boolean hasRayMetricSpec()
       Optional. Ray metrics configurations.
      .google.cloud.aiplatform.v1.RayMetricSpec ray_metric_spec = 8 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasRayMetricSpec in interface RaySpecOrBuilder
      Returns:
      Whether the rayMetricSpec field is set.

    • getRayMetricSpec

      public RayMetricSpec getRayMetricSpec()
       Optional. Ray metrics configurations.
      .google.cloud.aiplatform.v1.RayMetricSpec ray_metric_spec = 8 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getRayMetricSpec in interface RaySpecOrBuilder
      Returns:
      The rayMetricSpec.

    • setRayMetricSpec

      public RaySpec.Builder setRayMetricSpec(RayMetricSpec value)
       Optional. Ray metrics configurations.
      .google.cloud.aiplatform.v1.RayMetricSpec ray_metric_spec = 8 [(.google.api.field_behavior) = OPTIONAL];

    • setRayMetricSpec

      public RaySpec.Builder setRayMetricSpec(RayMetricSpec.Builder builderForValue)
       Optional. Ray metrics configurations.
      .google.cloud.aiplatform.v1.RayMetricSpec ray_metric_spec = 8 [(.google.api.field_behavior) = OPTIONAL];

    • mergeRayMetricSpec

      public RaySpec.Builder mergeRayMetricSpec(RayMetricSpec value)
       Optional. Ray metrics configurations.
      .google.cloud.aiplatform.v1.RayMetricSpec ray_metric_spec = 8 [(.google.api.field_behavior) = OPTIONAL];

    • clearRayMetricSpec

      public RaySpec.Builder clearRayMetricSpec()
       Optional. Ray metrics configurations.
      .google.cloud.aiplatform.v1.RayMetricSpec ray_metric_spec = 8 [(.google.api.field_behavior) = OPTIONAL];

    • getRayMetricSpecBuilder

      public RayMetricSpec.Builder getRayMetricSpecBuilder()
       Optional. Ray metrics configurations.
      .google.cloud.aiplatform.v1.RayMetricSpec ray_metric_spec = 8 [(.google.api.field_behavior) = OPTIONAL];

    • getRayMetricSpecOrBuilder

      public RayMetricSpecOrBuilder getRayMetricSpecOrBuilder()
       Optional. Ray metrics configurations.
      .google.cloud.aiplatform.v1.RayMetricSpec ray_metric_spec = 8 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getRayMetricSpecOrBuilder in interface RaySpecOrBuilder

    • hasRayLogsSpec

      public boolean hasRayLogsSpec()
       Optional. OSS Ray logging configurations.
      .google.cloud.aiplatform.v1.RayLogsSpec ray_logs_spec = 10 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasRayLogsSpec in interface RaySpecOrBuilder
      Returns:
      Whether the rayLogsSpec field is set.

    • getRayLogsSpec

      public RayLogsSpec getRayLogsSpec()
       Optional. OSS Ray logging configurations.
      .google.cloud.aiplatform.v1.RayLogsSpec ray_logs_spec = 10 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getRayLogsSpec in interface RaySpecOrBuilder
      Returns:
      The rayLogsSpec.

    • setRayLogsSpec

      public RaySpec.Builder setRayLogsSpec(RayLogsSpec value)
       Optional. OSS Ray logging configurations.
      .google.cloud.aiplatform.v1.RayLogsSpec ray_logs_spec = 10 [(.google.api.field_behavior) = OPTIONAL];

    • setRayLogsSpec

      public RaySpec.Builder setRayLogsSpec(RayLogsSpec.Builder builderForValue)
       Optional. OSS Ray logging configurations.
      .google.cloud.aiplatform.v1.RayLogsSpec ray_logs_spec = 10 [(.google.api.field_behavior) = OPTIONAL];

    • mergeRayLogsSpec

      public RaySpec.Builder mergeRayLogsSpec(RayLogsSpec value)
       Optional. OSS Ray logging configurations.
      .google.cloud.aiplatform.v1.RayLogsSpec ray_logs_spec = 10 [(.google.api.field_behavior) = OPTIONAL];

    • clearRayLogsSpec

      public RaySpec.Builder clearRayLogsSpec()
       Optional. OSS Ray logging configurations.
      .google.cloud.aiplatform.v1.RayLogsSpec ray_logs_spec = 10 [(.google.api.field_behavior) = OPTIONAL];

    • getRayLogsSpecBuilder

      public RayLogsSpec.Builder getRayLogsSpecBuilder()
       Optional. OSS Ray logging configurations.
      .google.cloud.aiplatform.v1.RayLogsSpec ray_logs_spec = 10 [(.google.api.field_behavior) = OPTIONAL];

    • getRayLogsSpecOrBuilder

      public RayLogsSpecOrBuilder getRayLogsSpecOrBuilder()
       Optional. OSS Ray logging configurations.
      .google.cloud.aiplatform.v1.RayLogsSpec ray_logs_spec = 10 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getRayLogsSpecOrBuilder in interface RaySpecOrBuilder