public static final class RaySpec.Builder extends com.google.protobuf.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.v1beta1.RaySpecgetAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringaddAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, newUninitializedMessageExceptionequals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitpublic static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessageV3.Builder<RaySpec.Builder>protected com.google.protobuf.MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
internalGetMutableMapFieldReflection in class com.google.protobuf.GeneratedMessageV3.Builder<RaySpec.Builder>protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<RaySpec.Builder>public RaySpec.Builder clear()
clear in interface com.google.protobuf.Message.Builderclear in interface com.google.protobuf.MessageLite.Builderclear in class com.google.protobuf.GeneratedMessageV3.Builder<RaySpec.Builder>public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
getDescriptorForType in interface com.google.protobuf.Message.BuildergetDescriptorForType in interface com.google.protobuf.MessageOrBuildergetDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<RaySpec.Builder>public RaySpec getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderpublic RaySpec build()
build in interface com.google.protobuf.Message.Builderbuild in interface com.google.protobuf.MessageLite.Builderpublic RaySpec buildPartial()
buildPartial in interface com.google.protobuf.Message.BuilderbuildPartial in interface com.google.protobuf.MessageLite.Builderpublic RaySpec.Builder clone()
clone in interface com.google.protobuf.Message.Builderclone in interface com.google.protobuf.MessageLite.Builderclone in class com.google.protobuf.GeneratedMessageV3.Builder<RaySpec.Builder>public RaySpec.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
setField in interface com.google.protobuf.Message.BuildersetField in class com.google.protobuf.GeneratedMessageV3.Builder<RaySpec.Builder>public RaySpec.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
clearField in interface com.google.protobuf.Message.BuilderclearField in class com.google.protobuf.GeneratedMessageV3.Builder<RaySpec.Builder>public RaySpec.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
clearOneof in interface com.google.protobuf.Message.BuilderclearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<RaySpec.Builder>public RaySpec.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
setRepeatedField in interface com.google.protobuf.Message.BuildersetRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<RaySpec.Builder>public RaySpec.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
addRepeatedField in interface com.google.protobuf.Message.BuilderaddRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<RaySpec.Builder>public RaySpec.Builder mergeFrom(com.google.protobuf.Message other)
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<RaySpec.Builder>public RaySpec.Builder mergeFrom(RaySpec other)
public final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<RaySpec.Builder>public RaySpec.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in interface com.google.protobuf.MessageLite.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<RaySpec.Builder>IOExceptionpublic 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];getImageUri in interface RaySpecOrBuilderpublic 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];getImageUriBytes in interface RaySpecOrBuilderpublic 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](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];value - The imageUri to set.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](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];public RaySpec.Builder setImageUriBytes(com.google.protobuf.ByteString value)
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];value - The bytes for imageUri to set.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];
getNfsMountsList in interface RaySpecOrBuilderpublic 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];
getNfsMountsCount in interface RaySpecOrBuilderpublic 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];
getNfsMounts in interface RaySpecOrBuilderpublic RaySpec.Builder setNfsMounts(int index, NfsMount value)
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 RaySpec.Builder setNfsMounts(int index, NfsMount.Builder builderForValue)
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 RaySpec.Builder addNfsMounts(NfsMount value)
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 RaySpec.Builder addNfsMounts(int index, NfsMount value)
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 RaySpec.Builder addNfsMounts(NfsMount.Builder builderForValue)
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 RaySpec.Builder addNfsMounts(int index, NfsMount.Builder builderForValue)
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 RaySpec.Builder addAllNfsMounts(Iterable<? extends NfsMount> values)
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 RaySpec.Builder clearNfsMounts()
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 RaySpec.Builder removeNfsMounts(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];
public NfsMount.Builder getNfsMountsBuilder(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];
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];
getNfsMountsOrBuilder in interface RaySpecOrBuilderpublic 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];
getNfsMountsOrBuilderList in interface RaySpecOrBuilderpublic NfsMount.Builder addNfsMountsBuilder()
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 NfsMount.Builder addNfsMountsBuilder(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];
public List<NfsMount.Builder> getNfsMountsBuilderList()
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 int getResourcePoolImagesCount()
RaySpecOrBuilder
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];
getResourcePoolImagesCount in interface RaySpecOrBuilderpublic 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];
containsResourcePoolImages in interface RaySpecOrBuilder@Deprecated public Map<String,String> getResourcePoolImages()
getResourcePoolImagesMap() instead.getResourcePoolImages in interface RaySpecOrBuilderpublic 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];
getResourcePoolImagesMap in interface RaySpecOrBuilderpublic 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];
getResourcePoolImagesOrDefault in interface RaySpecOrBuilderpublic 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];
getResourcePoolImagesOrThrow in interface RaySpecOrBuilderpublic RaySpec.Builder clearResourcePoolImages()
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];
@Deprecated public Map<String,String> getMutableResourcePoolImages()
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];
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];
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];getHeadNodeResourcePoolId in interface RaySpecOrBuilderpublic 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];getHeadNodeResourcePoolIdBytes in interface RaySpecOrBuilderpublic 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];value - The headNodeResourcePoolId to set.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];public RaySpec.Builder setHeadNodeResourcePoolIdBytes(com.google.protobuf.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];value - The bytes for headNodeResourcePoolId to set.public boolean hasRayMetricSpec()
Optional. Ray metrics configurations.
.google.cloud.aiplatform.v1beta1.RayMetricSpec ray_metric_spec = 8 [(.google.api.field_behavior) = OPTIONAL];
hasRayMetricSpec in interface RaySpecOrBuilderpublic RayMetricSpec getRayMetricSpec()
Optional. Ray metrics configurations.
.google.cloud.aiplatform.v1beta1.RayMetricSpec ray_metric_spec = 8 [(.google.api.field_behavior) = OPTIONAL];
getRayMetricSpec in interface RaySpecOrBuilderpublic RaySpec.Builder setRayMetricSpec(RayMetricSpec value)
Optional. Ray metrics configurations.
.google.cloud.aiplatform.v1beta1.RayMetricSpec ray_metric_spec = 8 [(.google.api.field_behavior) = OPTIONAL];
public RaySpec.Builder setRayMetricSpec(RayMetricSpec.Builder builderForValue)
Optional. Ray metrics configurations.
.google.cloud.aiplatform.v1beta1.RayMetricSpec ray_metric_spec = 8 [(.google.api.field_behavior) = OPTIONAL];
public RaySpec.Builder mergeRayMetricSpec(RayMetricSpec value)
Optional. Ray metrics configurations.
.google.cloud.aiplatform.v1beta1.RayMetricSpec ray_metric_spec = 8 [(.google.api.field_behavior) = OPTIONAL];
public RaySpec.Builder clearRayMetricSpec()
Optional. Ray metrics configurations.
.google.cloud.aiplatform.v1beta1.RayMetricSpec ray_metric_spec = 8 [(.google.api.field_behavior) = OPTIONAL];
public RayMetricSpec.Builder getRayMetricSpecBuilder()
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];
getRayMetricSpecOrBuilder in interface RaySpecOrBuilderpublic boolean hasRayLogsSpec()
Optional. OSS Ray logging configurations.
.google.cloud.aiplatform.v1beta1.RayLogsSpec ray_logs_spec = 10 [(.google.api.field_behavior) = OPTIONAL];
hasRayLogsSpec in interface RaySpecOrBuilderpublic RayLogsSpec getRayLogsSpec()
Optional. OSS Ray logging configurations.
.google.cloud.aiplatform.v1beta1.RayLogsSpec ray_logs_spec = 10 [(.google.api.field_behavior) = OPTIONAL];
getRayLogsSpec in interface RaySpecOrBuilderpublic RaySpec.Builder setRayLogsSpec(RayLogsSpec value)
Optional. OSS Ray logging configurations.
.google.cloud.aiplatform.v1beta1.RayLogsSpec ray_logs_spec = 10 [(.google.api.field_behavior) = OPTIONAL];
public RaySpec.Builder setRayLogsSpec(RayLogsSpec.Builder builderForValue)
Optional. OSS Ray logging configurations.
.google.cloud.aiplatform.v1beta1.RayLogsSpec ray_logs_spec = 10 [(.google.api.field_behavior) = OPTIONAL];
public RaySpec.Builder mergeRayLogsSpec(RayLogsSpec value)
Optional. OSS Ray logging configurations.
.google.cloud.aiplatform.v1beta1.RayLogsSpec ray_logs_spec = 10 [(.google.api.field_behavior) = OPTIONAL];
public RaySpec.Builder clearRayLogsSpec()
Optional. OSS Ray logging configurations.
.google.cloud.aiplatform.v1beta1.RayLogsSpec ray_logs_spec = 10 [(.google.api.field_behavior) = OPTIONAL];
public RayLogsSpec.Builder getRayLogsSpecBuilder()
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];
getRayLogsSpecOrBuilder in interface RaySpecOrBuilderpublic final RaySpec.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
setUnknownFields in interface com.google.protobuf.Message.BuildersetUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<RaySpec.Builder>public final RaySpec.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
mergeUnknownFields in interface com.google.protobuf.Message.BuildermergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<RaySpec.Builder>Copyright © 2024 Google LLC. All rights reserved.