Interface RaySpecOrBuilder (3.55.0) 

public interface RaySpecOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsResourcePoolImages(String key)

public abstract 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

getHeadNodeResourcePoolId()

public abstract 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 abstract 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 abstract 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 abstract 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.

getNfsMounts(int index)

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

Parameter
Name Description
index int
Returns
Type Description
NfsMount

getNfsMountsCount()

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

Returns
Type Description
int

getNfsMountsList()

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

Returns
Type Description
List<NfsMount>

getNfsMountsOrBuilder(int index)

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

Parameter
Name Description
index int
Returns
Type Description
NfsMountOrBuilder

getNfsMountsOrBuilderList()

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

Returns
Type Description
List<? extends com.google.cloud.aiplatform.v1beta1.NfsMountOrBuilder>

getRayLogsSpec()

public abstract RayLogsSpec getRayLogsSpec()

Optional. OSS Ray logging configurations.

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

Returns
Type Description
RayLogsSpec

The rayLogsSpec.

getRayLogsSpecOrBuilder()

public abstract RayLogsSpecOrBuilder getRayLogsSpecOrBuilder()

Optional. OSS Ray logging configurations.

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

Returns
Type Description
RayLogsSpecOrBuilder

getRayMetricSpec()

public abstract 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 abstract 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 abstract Map<String,String> getResourcePoolImages()

Use #getResourcePoolImagesMap() instead.

Returns
Type Description
Map<String,String>

getResourcePoolImagesCount()

public abstract 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 abstract 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 abstract 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 abstract 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

hasRayLogsSpec()

public abstract boolean hasRayLogsSpec()

Optional. OSS Ray logging configurations.

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

Returns
Type Description
boolean

Whether the rayLogsSpec field is set.

hasRayMetricSpec()

public abstract 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.