- 3.52.0 (latest)
- 3.50.0
- 3.49.0
- 3.48.0
- 3.47.0
- 3.46.0
- 3.45.0
- 3.44.0
- 3.43.0
- 3.42.0
- 3.41.0
- 3.40.0
- 3.38.0
- 3.37.0
- 3.36.0
- 3.35.0
- 3.34.0
- 3.33.0
- 3.32.0
- 3.31.0
- 3.30.0
- 3.29.0
- 3.28.0
- 3.25.0
- 3.24.0
- 3.23.0
- 3.22.0
- 3.21.0
- 3.20.0
- 3.19.0
- 3.18.0
- 3.17.0
- 3.16.0
- 3.15.0
- 3.14.0
- 3.13.0
- 3.12.0
- 3.11.0
- 3.10.0
- 3.9.0
- 3.8.0
- 3.7.0
- 3.6.0
- 3.5.0
- 3.4.2
- 3.3.0
- 3.2.0
- 3.0.0
- 2.9.8
- 2.8.9
- 2.7.4
- 2.5.3
- 2.4.0
public static final class RaySpec.Builder extends GeneratedMessageV3.Builder<RaySpec.Builder> implements RaySpecOrBuilderConfiguration 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
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > RaySpec.BuilderImplements
RaySpecOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public RaySpec.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
RaySpec.Builder |
|
build()
public RaySpec build()| Returns | |
|---|---|
| Type | Description |
RaySpec |
|
buildPartial()
public RaySpec buildPartial()| Returns | |
|---|---|
| Type | Description |
RaySpec |
|
clear()
public RaySpec.Builder clear()| Returns | |
|---|---|
| Type | Description |
RaySpec.Builder |
|
clearField(Descriptors.FieldDescriptor field)
public RaySpec.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
RaySpec.Builder |
|
clearHeadNodeResourcePoolId()
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];
| Returns | |
|---|---|
| Type | Description |
RaySpec.Builder |
This builder for chaining. |
clearImageUri()
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];
| Returns | |
|---|---|
| Type | Description |
RaySpec.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public RaySpec.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
RaySpec.Builder |
|
clearRayLogsSpec()
public RaySpec.Builder clearRayLogsSpec()Optional. OSS Ray logging configurations.
.google.cloud.aiplatform.v1beta1.RayLogsSpec ray_logs_spec = 10 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
RaySpec.Builder |
|
clearRayMetricSpec()
public RaySpec.Builder clearRayMetricSpec()Optional. Ray metrics configurations.
.google.cloud.aiplatform.v1beta1.RayMetricSpec ray_metric_spec = 8 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
RaySpec.Builder |
|
clearResourcePoolImages()
public RaySpec.Builder clearResourcePoolImages()| Returns | |
|---|---|
| Type | Description |
RaySpec.Builder |
|
clone()
public RaySpec.Builder clone()| Returns | |
|---|---|
| Type | Description |
RaySpec.Builder |
|
containsResourcePoolImages(String key)
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 |
| Returns | |
|---|---|
| Type | Description |
boolean |
|
getDefaultInstanceForType()
public RaySpec getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
RaySpec |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getHeadNodeResourcePoolId()
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. |
getHeadNodeResourcePoolIdBytes()
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. |
getImageUri()
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. |
getImageUriBytes()
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. |
getMutableResourcePoolImages() (deprecated)
public Map<String,String> getMutableResourcePoolImages()Use alternate mutation accessors instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getRayLogsSpec()
public 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. |
getRayLogsSpecBuilder()
public RayLogsSpec.Builder getRayLogsSpecBuilder()Optional. OSS Ray logging configurations.
.google.cloud.aiplatform.v1beta1.RayLogsSpec ray_logs_spec = 10 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
RayLogsSpec.Builder |
|
getRayLogsSpecOrBuilder()
public 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 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. |
getRayMetricSpecBuilder()
public RayMetricSpec.Builder getRayMetricSpecBuilder()Optional. Ray metrics configurations.
.google.cloud.aiplatform.v1beta1.RayMetricSpec ray_metric_spec = 8 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
RayMetricSpec.Builder |
|
getRayMetricSpecOrBuilder()
public 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 Map<String,String> getResourcePoolImages()Use #getResourcePoolImagesMap() instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getResourcePoolImagesCount()
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 |
|
getResourcePoolImagesMap()
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];
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getResourcePoolImagesOrDefault(String key, String defaultValue)
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];
| Parameters | |
|---|---|
| Name | Description |
key |
String |
defaultValue |
String |
| Returns | |
|---|---|
| Type | Description |
String |
|
getResourcePoolImagesOrThrow(String key)
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 |
|
hasRayLogsSpec()
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. |
hasRayMetricSpec()
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. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
internalGetMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)| Parameter | |
|---|---|
| Name | Description |
number |
int |
| Returns | |
|---|---|
| Type | Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
internalGetMutableMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)| Parameter | |
|---|---|
| Name | Description |
number |
int |
| Returns | |
|---|---|
| Type | Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFrom(RaySpec other)
public RaySpec.Builder mergeFrom(RaySpec other)| Parameter | |
|---|---|
| Name | Description |
other |
RaySpec |
| Returns | |
|---|---|
| Type | Description |
RaySpec.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public RaySpec.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
RaySpec.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public RaySpec.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
RaySpec.Builder |
|
mergeRayLogsSpec(RayLogsSpec value)
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];
| Parameter | |
|---|---|
| Name | Description |
value |
RayLogsSpec |
| Returns | |
|---|---|
| Type | Description |
RaySpec.Builder |
|
mergeRayMetricSpec(RayMetricSpec value)
public RaySpec.Builder mergeRayMetricSpec(RayMetricSpec value)Optional. Ray metrics configurations.
.google.cloud.aiplatform.v1beta1.RayMetricSpec ray_metric_spec = 8 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
RayMetricSpec |
| Returns | |
|---|---|
| Type | Description |
RaySpec.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final RaySpec.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
RaySpec.Builder |
|
putAllResourcePoolImages(Map<String,String> values)
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];
| Parameter | |
|---|---|
| Name | Description |
values |
Map<String,String> |
| Returns | |
|---|---|
| Type | Description |
RaySpec.Builder |
|
putResourcePoolImages(String key, String value)
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];
| Parameters | |
|---|---|
| Name | Description |
key |
String |
value |
String |
| Returns | |
|---|---|
| Type | Description |
RaySpec.Builder |
|
removeResourcePoolImages(String key)
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 |
| Returns | |
|---|---|
| Type | Description |
RaySpec.Builder |
|
setField(Descriptors.FieldDescriptor field, Object value)
public RaySpec.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
RaySpec.Builder |
|
setHeadNodeResourcePoolId(String value)
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 |
StringThe headNodeResourcePoolId to set. |
| Returns | |
|---|---|
| Type | Description |
RaySpec.Builder |
This builder for chaining. |
setHeadNodeResourcePoolIdBytes(ByteString value)
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 |
ByteStringThe bytes for headNodeResourcePoolId to set. |
| Returns | |
|---|---|
| Type | Description |
RaySpec.Builder |
This builder for chaining. |
setImageUri(String value)
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 |
StringThe imageUri to set. |
| Returns | |
|---|---|
| Type | Description |
RaySpec.Builder |
This builder for chaining. |
setImageUriBytes(ByteString value)
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 |
ByteStringThe bytes for imageUri to set. |
| Returns | |
|---|---|
| Type | Description |
RaySpec.Builder |
This builder for chaining. |
setRayLogsSpec(RayLogsSpec value)
public RaySpec.Builder setRayLogsSpec(RayLogsSpec value)Optional. OSS Ray logging configurations.
.google.cloud.aiplatform.v1beta1.RayLogsSpec ray_logs_spec = 10 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
RayLogsSpec |
| Returns | |
|---|---|
| Type | Description |
RaySpec.Builder |
|
setRayLogsSpec(RayLogsSpec.Builder builderForValue)
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];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
RayLogsSpec.Builder |
| Returns | |
|---|---|
| Type | Description |
RaySpec.Builder |
|
setRayMetricSpec(RayMetricSpec value)
public RaySpec.Builder setRayMetricSpec(RayMetricSpec value)Optional. Ray metrics configurations.
.google.cloud.aiplatform.v1beta1.RayMetricSpec ray_metric_spec = 8 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
RayMetricSpec |
| Returns | |
|---|---|
| Type | Description |
RaySpec.Builder |
|
setRayMetricSpec(RayMetricSpec.Builder builderForValue)
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];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
RayMetricSpec.Builder |
| Returns | |
|---|---|
| Type | Description |
RaySpec.Builder |
|
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public RaySpec.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
RaySpec.Builder |
|
setUnknownFields(UnknownFieldSet unknownFields)
public final RaySpec.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
RaySpec.Builder |
|