Package com.google.cloud.aiplatform.v1beta1

Class RaySpec

  • All Implemented Interfaces:
    RaySpecOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class RaySpec
extends com.google.protobuf.GeneratedMessageV3
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.v1beta1.RaySpec
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  RaySpec.Builder
      Configuration information for the Ray cluster.

      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,​BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,​BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • Field Detail

      • RESOURCE_POOL_IMAGES_FIELD_NUMBER

        public static final int RESOURCE_POOL_IMAGES_FIELD_NUMBER
        See Also:
        Constant Field Values

      • HEAD_NODE_RESOURCE_POOL_ID_FIELD_NUMBER

        public static final int HEAD_NODE_RESOURCE_POOL_ID_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

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

      • internalGetMapField

        protected com.google.protobuf.MapField internalGetMapField​(int number)
        Overrides:
        internalGetMapField in class com.google.protobuf.GeneratedMessageV3

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • getImageUri

        public String getImageUri()
         Optional. Default image for user to choose a preferred ML framework(e.g.
 tensorflow or Pytorch) by choosing from Vertex prebuild
 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(e.g.
 tensorflow or Pytorch) by choosing from Vertex prebuild
 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.

      • getResourcePoolImagesCount

        public int getResourcePoolImagesCount()
        Description copied from interface: RaySpecOrBuilder
         Optional. Required if image_uri is not 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 is not 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

      • getResourcePoolImagesMap

        public Map<String,​String> getResourcePoolImagesMap()
         Optional. Required if image_uri is not 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 is not 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 is not 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

      • 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 is not
 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 is not
 set.
        string head_node_resource_pool_id = 7 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getHeadNodeResourcePoolIdBytes in interface RaySpecOrBuilder
        Returns:
        The bytes for headNodeResourcePoolId.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static RaySpec parseFrom​(ByteBuffer data)
                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static RaySpec parseFrom​(ByteBuffer data,
                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static RaySpec parseFrom​(com.google.protobuf.ByteString data)
                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static RaySpec parseFrom​(com.google.protobuf.ByteString data,
                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static RaySpec parseFrom​(byte[] data)
                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static RaySpec parseFrom​(byte[] data,
                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static RaySpec parseFrom​(com.google.protobuf.CodedInputStream input,
                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                         throws IOException
        Throws:
        IOException

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

        protected RaySpec.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstance

        public static RaySpec getDefaultInstance()

      • parser

        public static com.google.protobuf.Parser<RaySpec> parser()

      • getParserForType

        public com.google.protobuf.Parser<RaySpec> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

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