public static final class RaySpec.Builder extends 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.v1.RaySpec
Inherited Members
com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)
com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)
com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)
Static Methods
public static final Descriptors.Descriptor getDescriptor()
Methods
public RaySpec.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Overrides
public RaySpec buildPartial()
public RaySpec.Builder clear()
Overrides
public RaySpec.Builder clearField(Descriptors.FieldDescriptor field)
Overrides
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 clearImageUri()
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];
public RaySpec.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Overrides
public RaySpec.Builder clearRayMetricSpec()
Optional. Ray metrics configurations.
.google.cloud.aiplatform.v1.RayMetricSpec ray_metric_spec = 8 [(.google.api.field_behavior) = OPTIONAL];
public RaySpec.Builder clearResourcePoolImages()
public RaySpec.Builder clone()
Overrides
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 RaySpec getDefaultInstanceForType()
public Descriptors.Descriptor getDescriptorForType()
Overrides
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 Map<String,String> getMutableResourcePoolImages()
Use alternate mutation accessors instead.
public RayMetricSpec getRayMetricSpec()
Optional. Ray metrics configurations.
.google.cloud.aiplatform.v1.RayMetricSpec ray_metric_spec = 8 [(.google.api.field_behavior) = OPTIONAL];
public RayMetricSpec.Builder getRayMetricSpecBuilder()
Optional. Ray metrics configurations.
.google.cloud.aiplatform.v1.RayMetricSpec ray_metric_spec = 8 [(.google.api.field_behavior) = OPTIONAL];
public RayMetricSpecOrBuilder getRayMetricSpecOrBuilder()
Optional. Ray metrics configurations.
.google.cloud.aiplatform.v1.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 boolean hasRayMetricSpec()
Optional. Ray metrics configurations.
.google.cloud.aiplatform.v1.RayMetricSpec ray_metric_spec = 8 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
boolean |
Whether the rayMetricSpec field is set.
|
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.Builder.internalGetMapFieldReflection(int)
protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
| Parameter |
| Name |
Description |
number |
int
|
| Returns |
| Type |
Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)
public final boolean isInitialized()
Overrides
public RaySpec.Builder mergeFrom(RaySpec other)
| Parameter |
| Name |
Description |
other |
RaySpec
|
public RaySpec.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Overrides
public RaySpec.Builder mergeFrom(Message other)
| Parameter |
| Name |
Description |
other |
Message
|
Overrides
public RaySpec.Builder mergeRayMetricSpec(RayMetricSpec value)
Optional. Ray metrics configurations.
.google.cloud.aiplatform.v1.RayMetricSpec ray_metric_spec = 8 [(.google.api.field_behavior) = OPTIONAL];
public final RaySpec.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Overrides
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 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 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];
| Parameter |
| Name |
Description |
key |
String
|
public RaySpec.Builder setField(Descriptors.FieldDescriptor field, Object value)
Overrides
public 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];
| Parameter |
| Name |
Description |
value |
String
The headNodeResourcePoolId to set.
|
public RaySpec.Builder setHeadNodeResourcePoolIdBytes(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];
| Parameter |
| Name |
Description |
value |
ByteString
The bytes for headNodeResourcePoolId to set.
|
public 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.
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];
| Parameter |
| Name |
Description |
value |
String
The imageUri to set.
|
public RaySpec.Builder setImageUriBytes(ByteString value)
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];
| Parameter |
| Name |
Description |
value |
ByteString
The bytes for imageUri to set.
|
public RaySpec.Builder setRayMetricSpec(RayMetricSpec value)
Optional. Ray metrics configurations.
.google.cloud.aiplatform.v1.RayMetricSpec ray_metric_spec = 8 [(.google.api.field_behavior) = OPTIONAL];
public RaySpec.Builder setRayMetricSpec(RayMetricSpec.Builder builderForValue)
Optional. Ray metrics configurations.
.google.cloud.aiplatform.v1.RayMetricSpec ray_metric_spec = 8 [(.google.api.field_behavior) = OPTIONAL];
public RaySpec.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Overrides
public final RaySpec.Builder setUnknownFields(UnknownFieldSet unknownFields)
Overrides
