All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

RaySpec, RaySpec.Builder
```
public interface RaySpecOrBuilder
extends com.google.protobuf.MessageOrBuilder
```

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method	Description
`boolean`	`containsResourcePoolImages(String key)`	Optional.
`String`	`getHeadNodeResourcePoolId()`	Optional.
`com.google.protobuf.ByteString`	`getHeadNodeResourcePoolIdBytes()`	Optional.
`String`	`getImageUri()`	Optional.
`com.google.protobuf.ByteString`	`getImageUriBytes()`	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.

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder
isInitialized

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Method Detail

getImageUri

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:: The imageUri.

getImageUriBytes

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

Returns:: The bytes for imageUri.

getResourcePoolImagesCount

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

containsResourcePoolImages

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

getResourcePoolImages
```
@Deprecated
Map<String,String> getResourcePoolImages()
```
Deprecated.

Use getResourcePoolImagesMap() instead.

getResourcePoolImagesMap

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

getResourcePoolImagesOrDefault

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

getResourcePoolImagesOrThrow

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

getHeadNodeResourcePoolId

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:: The headNodeResourcePoolId.

getHeadNodeResourcePoolIdBytes

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.