Class RaySpec (3.28.0)

public final class RaySpec extends 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

Implements

RaySpecOrBuilder

Static Fields

HEAD_NODE_RESOURCE_POOL_ID_FIELD_NUMBER

public static final int HEAD_NODE_RESOURCE_POOL_ID_FIELD_NUMBER
Field Value
TypeDescription
int

IMAGE_URI_FIELD_NUMBER

public static final int IMAGE_URI_FIELD_NUMBER
Field Value
TypeDescription
int

RESOURCE_POOL_IMAGES_FIELD_NUMBER

public static final int RESOURCE_POOL_IMAGES_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static RaySpec getDefaultInstance()
Returns
TypeDescription
RaySpec

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static RaySpec.Builder newBuilder()
Returns
TypeDescription
RaySpec.Builder

newBuilder(RaySpec prototype)

public static RaySpec.Builder newBuilder(RaySpec prototype)
Parameter
NameDescription
prototypeRaySpec
Returns
TypeDescription
RaySpec.Builder

parseDelimitedFrom(InputStream input)

public static RaySpec parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
RaySpec
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RaySpec parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RaySpec
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static RaySpec parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
RaySpec
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static RaySpec parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RaySpec
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static RaySpec parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
RaySpec
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static RaySpec parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RaySpec
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static RaySpec parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
RaySpec
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static RaySpec parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RaySpec
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static RaySpec parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
RaySpec
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RaySpec parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RaySpec
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static RaySpec parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
RaySpec
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static RaySpec parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RaySpec
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<RaySpec> parser()
Returns
TypeDescription
Parser<RaySpec>

Methods

containsResourcePoolImages(String key)

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];

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public RaySpec getDefaultInstanceForType()
Returns
TypeDescription
RaySpec

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];

Returns
TypeDescription
String

The headNodeResourcePoolId.

getHeadNodeResourcePoolIdBytes()

public 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];

Returns
TypeDescription
ByteString

The bytes for headNodeResourcePoolId.

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];

Returns
TypeDescription
String

The imageUri.

getImageUriBytes()

public 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];

Returns
TypeDescription
ByteString

The bytes for imageUri.

getParserForType()

public Parser<RaySpec> getParserForType()
Returns
TypeDescription
Parser<RaySpec>
Overrides

getResourcePoolImages()

public Map<String,String> getResourcePoolImages()
Returns
TypeDescription
Map<String,String>

getResourcePoolImagesCount()

public int getResourcePoolImagesCount()

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];

Returns
TypeDescription
int

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];

Returns
TypeDescription
Map<String,String>

getResourcePoolImagesOrDefault(String key, String defaultValue)

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];

Parameters
NameDescription
keyString
defaultValueString
Returns
TypeDescription
String

getResourcePoolImagesOrThrow(String key)

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];

Parameter
NameDescription
keyString
Returns
TypeDescription
String

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public RaySpec.Builder newBuilderForType()
Returns
TypeDescription
RaySpec.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected RaySpec.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
RaySpec.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public RaySpec.Builder toBuilder()
Returns
TypeDescription
RaySpec.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException