Class RaySpec.Builder (3.47.0)

public static final class RaySpec.Builder extends GeneratedMessageV3.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

Implements

RaySpecOrBuilder

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public RaySpec.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
RaySpec.Builder
Overrides

build()

public RaySpec build()
Returns
Type Description
RaySpec

buildPartial()

public RaySpec buildPartial()
Returns
Type Description
RaySpec

clear()

public RaySpec.Builder clear()
Returns
Type Description
RaySpec.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public RaySpec.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
RaySpec.Builder
Overrides

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
Type Description
RaySpec.Builder

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

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public RaySpec.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
RaySpec.Builder
Overrides

clearRayMetricSpec()

public RaySpec.Builder clearRayMetricSpec()

Optional. Ray metrics configurations.

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

Returns
Type Description
RaySpec.Builder

clearResourcePoolImages()

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

clone()

public RaySpec.Builder clone()
Returns
Type Description
RaySpec.Builder
Overrides

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

getDefaultInstanceForType()

public RaySpec getDefaultInstanceForType()
Returns
Type Description
RaySpec

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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.

getMutableResourcePoolImages() (deprecated)

public Map<String,String> getMutableResourcePoolImages()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,String>

getRayMetricSpec()

public RayMetricSpec getRayMetricSpec()

Optional. Ray metrics configurations.

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

Returns
Type Description
RayMetricSpec

The rayMetricSpec.

getRayMetricSpecBuilder()

public RayMetricSpec.Builder getRayMetricSpecBuilder()

Optional. Ray metrics configurations.

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

Returns
Type Description
RayMetricSpec.Builder

getRayMetricSpecOrBuilder()

public RayMetricSpecOrBuilder getRayMetricSpecOrBuilder()

Optional. Ray metrics configurations.

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

hasRayMetricSpec()

public boolean hasRayMetricSpec()

Optional. Ray metrics configurations.

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

Returns
Type Description
boolean

Whether the rayMetricSpec field is set.

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.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(RaySpec other)

public RaySpec.Builder mergeFrom(RaySpec other)
Parameter
Name Description
other RaySpec
Returns
Type Description
RaySpec.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public RaySpec.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RaySpec.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public RaySpec.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
RaySpec.Builder
Overrides

mergeRayMetricSpec(RayMetricSpec value)

public RaySpec.Builder mergeRayMetricSpec(RayMetricSpec value)

Optional. Ray metrics configurations.

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

Parameter
Name Description
value RayMetricSpec
Returns
Type Description
RaySpec.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final RaySpec.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
RaySpec.Builder
Overrides

putAllResourcePoolImages(Map<String,String> values)

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

Parameter
Name Description
values Map<String,String>
Returns
Type Description
RaySpec.Builder

putResourcePoolImages(String key, String value)

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

Parameters
Name Description
key String
value String
Returns
Type Description
RaySpec.Builder

removeResourcePoolImages(String key)

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

Parameter
Name Description
key String
Returns
Type Description
RaySpec.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public RaySpec.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
RaySpec.Builder
Overrides

setHeadNodeResourcePoolId(String value)

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

Parameter
Name Description
value String

The headNodeResourcePoolId to set.

Returns
Type Description
RaySpec.Builder

This builder for chaining.

setHeadNodeResourcePoolIdBytes(ByteString value)

public RaySpec.Builder setHeadNodeResourcePoolIdBytes(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];

Parameter
Name Description
value ByteString

The bytes for headNodeResourcePoolId to set.

Returns
Type Description
RaySpec.Builder

This builder for chaining.

setImageUri(String value)

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

Parameter
Name Description
value String

The imageUri to set.

Returns
Type Description
RaySpec.Builder

This builder for chaining.

setImageUriBytes(ByteString value)

public RaySpec.Builder setImageUriBytes(ByteString value)

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

Parameter
Name Description
value ByteString

The bytes for imageUri to set.

Returns
Type Description
RaySpec.Builder

This builder for chaining.

setRayMetricSpec(RayMetricSpec value)

public RaySpec.Builder setRayMetricSpec(RayMetricSpec value)

Optional. Ray metrics configurations.

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

Parameter
Name Description
value RayMetricSpec
Returns
Type Description
RaySpec.Builder

setRayMetricSpec(RayMetricSpec.Builder builderForValue)

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

Parameter
Name Description
builderForValue RayMetricSpec.Builder
Returns
Type Description
RaySpec.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public RaySpec.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
RaySpec.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final RaySpec.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
RaySpec.Builder
Overrides