com.google.cloud.aiplatform.v1

Class RaySpec

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.aiplatform.v1.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.v1.RaySpec

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and 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 Summary

Fields

Modifier and Type	Field and Description
static int	HEAD_NODE_RESOURCE_POOL_ID_FIELD_NUMBER
static int	IMAGE_URI_FIELD_NUMBER
static int	RAY_LOGS_SPEC_FIELD_NUMBER
static int	RAY_METRIC_SPEC_FIELD_NUMBER
static int	RESOURCE_POOL_IMAGES_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	containsResourcePoolImages(String key) Optional.
boolean	equals(Object obj)
static RaySpec	getDefaultInstance()
RaySpec	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
String	getHeadNodeResourcePoolId() Optional.
com.google.protobuf.ByteString	getHeadNodeResourcePoolIdBytes() Optional.
String	getImageUri() Optional.
com.google.protobuf.ByteString	getImageUriBytes() Optional.
com.google.protobuf.Parser<RaySpec>	getParserForType()
RayLogsSpec	getRayLogsSpec() Optional.
RayLogsSpecOrBuilder	getRayLogsSpecOrBuilder() Optional.
RayMetricSpec	getRayMetricSpec() Optional.
RayMetricSpecOrBuilder	getRayMetricSpecOrBuilder() Optional.
Map<String,String>	getResourcePoolImages() Deprecated.
int	getResourcePoolImagesCount() Optional.
Map<String,String>	getResourcePoolImagesMap() Optional.
String	getResourcePoolImagesOrDefault(String key, String defaultValue) Optional.
String	getResourcePoolImagesOrThrow(String key) Optional.
int	getSerializedSize()
int	hashCode()
boolean	hasRayLogsSpec() Optional.
boolean	hasRayMetricSpec() Optional.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
protected com.google.protobuf.MapFieldReflectionAccessor	internalGetMapFieldReflection(int number)
boolean	isInitialized()
static RaySpec.Builder	newBuilder()
static RaySpec.Builder	newBuilder(RaySpec prototype)
RaySpec.Builder	newBuilderForType()
protected RaySpec.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static RaySpec	parseDelimitedFrom(InputStream input)
static RaySpec	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RaySpec	parseFrom(byte[] data)
static RaySpec	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RaySpec	parseFrom(ByteBuffer data)
static RaySpec	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RaySpec	parseFrom(com.google.protobuf.ByteString data)
static RaySpec	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RaySpec	parseFrom(com.google.protobuf.CodedInputStream input)
static RaySpec	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RaySpec	parseFrom(InputStream input)
static RaySpec	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<RaySpec>	parser()
RaySpec.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

IMAGE_URI_FIELD_NUMBER

public static final int IMAGE_URI_FIELD_NUMBER

See Also:

Constant Field Values

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

RAY_METRIC_SPEC_FIELD_NUMBER

public static final int RAY_METRIC_SPEC_FIELD_NUMBER

See Also:

Constant Field Values

RAY_LOGS_SPEC_FIELD_NUMBER

public static final int RAY_LOGS_SPEC_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()

internalGetMapFieldReflection

protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)

Overrides:

internalGetMapFieldReflection 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
 (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.

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

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.

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.

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.

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

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(InputStream input)
                         throws IOException

Throws:

IOException

parseFrom

public static RaySpec parseFrom(InputStream input,
                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                         throws IOException

Throws:

IOException

parseDelimitedFrom

public static RaySpec parseDelimitedFrom(InputStream input)
                                  throws IOException

Throws:

IOException

parseDelimitedFrom

public static RaySpec parseDelimitedFrom(InputStream input,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws IOException

Throws:

IOException

parseFrom

public static RaySpec parseFrom(com.google.protobuf.CodedInputStream input)
                         throws IOException

Throws:

IOException

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

newBuilder

public static RaySpec.Builder newBuilder()

newBuilder

public static RaySpec.Builder newBuilder(RaySpec prototype)

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