Class RaySpec (3.45.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
Type Description
int

IMAGE_URI_FIELD_NUMBER

public static final int IMAGE_URI_FIELD_NUMBER
Field Value
Type Description
int

RAY_METRIC_SPEC_FIELD_NUMBER

public static final int RAY_METRIC_SPEC_FIELD_NUMBER
Field Value
Type Description
int

RESOURCE_POOL_IMAGES_FIELD_NUMBER

public static final int RESOURCE_POOL_IMAGES_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static RaySpec getDefaultInstance()
Returns
Type Description
RaySpec

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static RaySpec.Builder newBuilder()
Returns
Type Description
RaySpec.Builder

newBuilder(RaySpec prototype)

public static RaySpec.Builder newBuilder(RaySpec prototype)
Parameter
Name Description
prototype RaySpec
Returns
Type Description
RaySpec.Builder

parseDelimitedFrom(InputStream input)

public static RaySpec parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
RaySpec
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RaySpec parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RaySpec
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static RaySpec parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
RaySpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static RaySpec parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RaySpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static RaySpec parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
RaySpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static RaySpec parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RaySpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static RaySpec parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
RaySpec
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static RaySpec parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RaySpec
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static RaySpec parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
RaySpec
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RaySpec parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RaySpec
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static RaySpec parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
RaySpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static RaySpec parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RaySpec
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<RaySpec> parser()
Returns
Type Description
Parser<RaySpec>

Methods

containsResourcePoolImages(String key)

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

Parameter
Name Description
key String
Returns
Type Description
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public RaySpec getDefaultInstanceForType()
Returns
Type Description
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 isn't set.

string head_node_resource_pool_id = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
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 isn't set.

string head_node_resource_pool_id = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for headNodeResourcePoolId.

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. 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
Type Description
String

The imageUri.

getImageUriBytes()

public ByteString getImageUriBytes()

Optional. Default image for user to choose a preferred ML framework (for example, TensorFlow or Pytorch) by choosing from Vertex prebuilt images. 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
Type Description
ByteString

The bytes for imageUri.

getParserForType()

public Parser<RaySpec> getParserForType()
Returns
Type Description
Parser<RaySpec>
Overrides

getRayMetricSpec()

public RayMetricSpec getRayMetricSpec()

Optional. Ray metrics configurations.

.google.cloud.aiplatform.v1beta1.RayMetricSpec ray_metric_spec = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
RayMetricSpec

The rayMetricSpec.

getRayMetricSpecOrBuilder()

public RayMetricSpecOrBuilder getRayMetricSpecOrBuilder()

Optional. Ray metrics configurations.

.google.cloud.aiplatform.v1beta1.RayMetricSpec ray_metric_spec = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
RayMetricSpecOrBuilder

getResourcePoolImages() (deprecated)

public Map<String,String> getResourcePoolImages()
Returns
Type Description
Map<String,String>

getResourcePoolImagesCount()

public int getResourcePoolImagesCount()

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

Returns
Type Description
int

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

Returns
Type Description
Map<String,String>

getResourcePoolImagesOrDefault(String key, String defaultValue)

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

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getResourcePoolImagesOrThrow(String key)

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

Parameter
Name Description
key String
Returns
Type Description
String

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasRayMetricSpec()

public boolean hasRayMetricSpec()

Optional. Ray metrics configurations.

.google.cloud.aiplatform.v1beta1.RayMetricSpec ray_metric_spec = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the rayMetricSpec field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public RaySpec.Builder newBuilderForType()
Returns
Type Description
RaySpec.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected RaySpec.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
RaySpec.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public RaySpec.Builder toBuilder()
Returns
Type Description
RaySpec.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException