com.google.cloud.aiplatform.v1beta1

Interface RaySpecOrBuilder

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

Modifier and Type	Method and Description
boolean	containsResourcePoolImages(String key) Optional.
String	getHeadNodeResourcePoolId() Optional.
com.google.protobuf.ByteString	getHeadNodeResourcePoolIdBytes() Optional.
String	getImageUri() Optional.
com.google.protobuf.ByteString	getImageUriBytes() Optional.
NfsMount	getNfsMounts(int index) Optional.
int	getNfsMountsCount() Optional.
List<NfsMount>	getNfsMountsList() Optional.
NfsMountOrBuilder	getNfsMountsOrBuilder(int index) Optional.
List<? extends NfsMountOrBuilder>	getNfsMountsOrBuilderList() Optional.
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.
boolean	hasRayLogsSpec() Optional.
boolean	hasRayMetricSpec() Optional.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getImageUri

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

Returns:

The imageUri.

getImageUriBytes

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

Returns:

The bytes for imageUri.

getNfsMountsList

List<NfsMount> getNfsMountsList()

 Optional. Use if you want to mount to any NFS storages.
 

repeated .google.cloud.aiplatform.v1beta1.NfsMount nfs_mounts = 11 [(.google.api.field_behavior) = OPTIONAL];

getNfsMounts

NfsMount getNfsMounts(int index)

 Optional. Use if you want to mount to any NFS storages.
 

repeated .google.cloud.aiplatform.v1beta1.NfsMount nfs_mounts = 11 [(.google.api.field_behavior) = OPTIONAL];

getNfsMountsCount

int getNfsMountsCount()

 Optional. Use if you want to mount to any NFS storages.
 

repeated .google.cloud.aiplatform.v1beta1.NfsMount nfs_mounts = 11 [(.google.api.field_behavior) = OPTIONAL];

getNfsMountsOrBuilderList

List<? extends NfsMountOrBuilder> getNfsMountsOrBuilderList()

 Optional. Use if you want to mount to any NFS storages.
 

repeated .google.cloud.aiplatform.v1beta1.NfsMount nfs_mounts = 11 [(.google.api.field_behavior) = OPTIONAL];

getNfsMountsOrBuilder

NfsMountOrBuilder getNfsMountsOrBuilder(int index)

 Optional. Use if you want to mount to any NFS storages.
 

repeated .google.cloud.aiplatform.v1beta1.NfsMount nfs_mounts = 11 [(.google.api.field_behavior) = OPTIONAL];

getResourcePoolImagesCount

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

containsResourcePoolImages

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

getResourcePoolImages

@Deprecated
Map<String,String> getResourcePoolImages()

Deprecated.

Use getResourcePoolImagesMap() instead.

getResourcePoolImagesMap

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

getResourcePoolImagesOrDefault

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

getResourcePoolImagesOrThrow

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

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

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

Returns:

The bytes for headNodeResourcePoolId.

hasRayMetricSpec

boolean hasRayMetricSpec()

 Optional. Ray metrics configurations.
 

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

Returns:

Whether the rayMetricSpec field is set.

getRayMetricSpec

RayMetricSpec getRayMetricSpec()

 Optional. Ray metrics configurations.
 

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

Returns:

The rayMetricSpec.

getRayMetricSpecOrBuilder

RayMetricSpecOrBuilder getRayMetricSpecOrBuilder()

 Optional. Ray metrics configurations.
 

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

hasRayLogsSpec

boolean hasRayLogsSpec()

 Optional. OSS Ray logging configurations.
 

.google.cloud.aiplatform.v1beta1.RayLogsSpec ray_logs_spec = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns:

Whether the rayLogsSpec field is set.

getRayLogsSpec

RayLogsSpec getRayLogsSpec()

 Optional. OSS Ray logging configurations.
 

.google.cloud.aiplatform.v1beta1.RayLogsSpec ray_logs_spec = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The rayLogsSpec.

getRayLogsSpecOrBuilder

RayLogsSpecOrBuilder getRayLogsSpecOrBuilder()

 Optional. OSS Ray logging configurations.
 

.google.cloud.aiplatform.v1beta1.RayLogsSpec ray_logs_spec = 10 [(.google.api.field_behavior) = OPTIONAL];