public final class RaySpec extends 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.v1beta1.RaySpec
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
public static final int HEAD_NODE_RESOURCE_POOL_ID_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int IMAGE_URI_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int NFS_MOUNTS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int RAY_LOGS_SPEC_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int RAY_METRIC_SPEC_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int RESOURCE_POOL_IMAGES_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
public static RaySpec getDefaultInstance()
public static final Descriptors.Descriptor getDescriptor()
public static RaySpec.Builder newBuilder()
public static RaySpec.Builder newBuilder(RaySpec prototype)
| Parameter |
| Name |
Description |
prototype |
RaySpec
|
public static RaySpec parseDelimitedFrom(InputStream input)
public static RaySpec parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static RaySpec parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
public static RaySpec parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static RaySpec parseFrom(ByteString data)
public static RaySpec parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static RaySpec parseFrom(CodedInputStream input)
public static RaySpec parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static RaySpec parseFrom(InputStream input)
public static RaySpec parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static RaySpec parseFrom(ByteBuffer data)
public static RaySpec parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Parser<RaySpec> parser()
Methods
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
|
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
public RaySpec getDefaultInstanceForType()
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.
|
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.
|
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.
|
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.
|
public 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
|
public 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 |
|
public 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];
public 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
|
public 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> |
|
public Parser<RaySpec> getParserForType()
Overrides
public RayLogsSpec getRayLogsSpec()
Optional. OSS Ray logging configurations.
.google.cloud.aiplatform.v1beta1.RayLogsSpec ray_logs_spec = 10 [(.google.api.field_behavior) = OPTIONAL];
public RayLogsSpecOrBuilder getRayLogsSpecOrBuilder()
Optional. OSS Ray logging configurations.
.google.cloud.aiplatform.v1beta1.RayLogsSpec ray_logs_spec = 10 [(.google.api.field_behavior) = OPTIONAL];
public RayMetricSpec getRayMetricSpec()
Optional. Ray metrics configurations.
.google.cloud.aiplatform.v1beta1.RayMetricSpec ray_metric_spec = 8 [(.google.api.field_behavior) = OPTIONAL];
public RayMetricSpecOrBuilder getRayMetricSpecOrBuilder()
Optional. Ray metrics configurations.
.google.cloud.aiplatform.v1beta1.RayMetricSpec ray_metric_spec = 8 [(.google.api.field_behavior) = OPTIONAL];
public Map<String,String> getResourcePoolImages()
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 |
|
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];
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];
| Returns |
| Type |
Description |
String |
|
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 |
|
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
public 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.
|
public 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.
|
| Returns |
| Type |
Description |
int |
|
Overrides
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
| Parameter |
| Name |
Description |
number |
int
|
| Returns |
| Type |
Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
public final boolean isInitialized()
Overrides
public RaySpec.Builder newBuilderForType()
protected RaySpec.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
public RaySpec.Builder toBuilder()
public void writeTo(CodedOutputStream output)
Overrides
