public final class Cluster extends GeneratedMessageV3 implements ClusterOrBuilder
A collection of virtual machines and connected resources forming a
high-performance computing cluster capable of running large-scale, tightly
coupled workloads. A cluster combines a set a compute resources that perform
computations, storage resources that contain inputs and store outputs, an
orchestrator that is responsible for assigning jobs to compute resources, and
network resources that connect everything together.
Protobuf type google.cloud.hypercomputecluster.v1beta.Cluster
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
COMPUTE_RESOURCES_FIELD_NUMBER
public static final int COMPUTE_RESOURCES_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
LABELS_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
NETWORK_RESOURCES_FIELD_NUMBER
public static final int NETWORK_RESOURCES_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
ORCHESTRATOR_FIELD_NUMBER
public static final int ORCHESTRATOR_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
RECONCILING_FIELD_NUMBER
public static final int RECONCILING_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
STORAGE_RESOURCES_FIELD_NUMBER
public static final int STORAGE_RESOURCES_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
UPDATE_TIME_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static Cluster getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static Cluster.Builder newBuilder()
newBuilder(Cluster prototype)
public static Cluster.Builder newBuilder(Cluster prototype)
| Parameter |
| Name |
Description |
prototype |
Cluster
|
public static Cluster parseDelimitedFrom(InputStream input)
public static Cluster parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static Cluster parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Cluster parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static Cluster parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Cluster parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Cluster parseFrom(CodedInputStream input)
public static Cluster parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static Cluster parseFrom(InputStream input)
public static Cluster parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static Cluster parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Cluster parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<Cluster> parser()
Methods
containsComputeResources(String key)
public boolean containsComputeResources(String key)
Optional. Compute resources available to the cluster. Keys specify the ID
of the compute resource by which it can be referenced elsewhere, and must
conform to RFC-1034
(lower-case, alphanumeric, and at most 63 characters).
map<string, .google.cloud.hypercomputecluster.v1beta.ComputeResource> compute_resources = 13 [(.google.api.field_behavior) = OPTIONAL];
| Parameter |
| Name |
Description |
key |
String
|
containsLabels(String key)
public boolean containsLabels(String key)
Optional.
Labels applied
to the cluster. Labels can be used to organize clusters and to filter them
in queries.
map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameter |
| Name |
Description |
key |
String
|
containsNetworkResources(String key)
public boolean containsNetworkResources(String key)
Optional. Network resources available to the cluster. Must contain at most
one value. Keys specify the ID of the network resource by which it can be
referenced elsewhere, and must conform to
RFC-1034 (lower-case,
alphanumeric, and at most 63 characters).
map<string, .google.cloud.hypercomputecluster.v1beta.NetworkResource> network_resources = 11 [(.google.api.field_behavior) = OPTIONAL];
| Parameter |
| Name |
Description |
key |
String
|
containsStorageResources(String key)
public boolean containsStorageResources(String key)
Optional. Storage resources available to the cluster. Keys specify the ID
of the storage resource by which it can be referenced elsewhere, and must
conform to RFC-1034
(lower-case, alphanumeric, and at most 63 characters).
map<string, .google.cloud.hypercomputecluster.v1beta.StorageResource> storage_resources = 12 [(.google.api.field_behavior) = OPTIONAL];
| Parameter |
| Name |
Description |
key |
String
|
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getComputeResources() (deprecated)
public Map<String,ComputeResource> getComputeResources()
getComputeResourcesCount()
public int getComputeResourcesCount()
Optional. Compute resources available to the cluster. Keys specify the ID
of the compute resource by which it can be referenced elsewhere, and must
conform to RFC-1034
(lower-case, alphanumeric, and at most 63 characters).
map<string, .google.cloud.hypercomputecluster.v1beta.ComputeResource> compute_resources = 13 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
int |
|
getComputeResourcesMap()
public Map<String,ComputeResource> getComputeResourcesMap()
Optional. Compute resources available to the cluster. Keys specify the ID
of the compute resource by which it can be referenced elsewhere, and must
conform to RFC-1034
(lower-case, alphanumeric, and at most 63 characters).
map<string, .google.cloud.hypercomputecluster.v1beta.ComputeResource> compute_resources = 13 [(.google.api.field_behavior) = OPTIONAL];
getComputeResourcesOrDefault(String key, ComputeResource defaultValue)
public ComputeResource getComputeResourcesOrDefault(String key, ComputeResource defaultValue)
Optional. Compute resources available to the cluster. Keys specify the ID
of the compute resource by which it can be referenced elsewhere, and must
conform to RFC-1034
(lower-case, alphanumeric, and at most 63 characters).
map<string, .google.cloud.hypercomputecluster.v1beta.ComputeResource> compute_resources = 13 [(.google.api.field_behavior) = OPTIONAL];
getComputeResourcesOrThrow(String key)
public ComputeResource getComputeResourcesOrThrow(String key)
Optional. Compute resources available to the cluster. Keys specify the ID
of the compute resource by which it can be referenced elsewhere, and must
conform to RFC-1034
(lower-case, alphanumeric, and at most 63 characters).
map<string, .google.cloud.hypercomputecluster.v1beta.ComputeResource> compute_resources = 13 [(.google.api.field_behavior) = OPTIONAL];
| Parameter |
| Name |
Description |
key |
String
|
getCreateTime()
public Timestamp getCreateTime()
Output only. Time that the cluster was originally created.
.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
Timestamp |
The createTime.
|
getCreateTimeOrBuilder()
public TimestampOrBuilder getCreateTimeOrBuilder()
Output only. Time that the cluster was originally created.
.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
getDefaultInstanceForType()
public Cluster getDefaultInstanceForType()
getDescription()
public String getDescription()
Optional. User-provided description of the cluster.
string description = 9 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
String |
The description.
|
getDescriptionBytes()
public ByteString getDescriptionBytes()
Optional. User-provided description of the cluster.
string description = 9 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
ByteString |
The bytes for description.
|
getLabels() (deprecated)
public Map<String,String> getLabels()
getLabelsCount()
public int getLabelsCount()
Optional.
Labels applied
to the cluster. Labels can be used to organize clusters and to filter them
in queries.
map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
int |
|
getLabelsMap()
public Map<String,String> getLabelsMap()
Optional.
Labels applied
to the cluster. Labels can be used to organize clusters and to filter them
in queries.
map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];
getLabelsOrDefault(String key, String defaultValue)
public String getLabelsOrDefault(String key, String defaultValue)
Optional.
Labels applied
to the cluster. Labels can be used to organize clusters and to filter them
in queries.
map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
String |
|
getLabelsOrThrow(String key)
public String getLabelsOrThrow(String key)
Optional.
Labels applied
to the cluster. Labels can be used to organize clusters and to filter them
in queries.
map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameter |
| Name |
Description |
key |
String
|
| Returns |
| Type |
Description |
String |
|
getName()
Identifier. Relative resource name of the
cluster, in the format
projects/{project}/locations/{location}/clusters/{cluster}.
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
| Returns |
| Type |
Description |
String |
The name.
|
getNameBytes()
public ByteString getNameBytes()
Identifier. Relative resource name of the
cluster, in the format
projects/{project}/locations/{location}/clusters/{cluster}.
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
| Returns |
| Type |
Description |
ByteString |
The bytes for name.
|
getNetworkResources() (deprecated)
public Map<String,NetworkResource> getNetworkResources()
getNetworkResourcesCount()
public int getNetworkResourcesCount()
Optional. Network resources available to the cluster. Must contain at most
one value. Keys specify the ID of the network resource by which it can be
referenced elsewhere, and must conform to
RFC-1034 (lower-case,
alphanumeric, and at most 63 characters).
map<string, .google.cloud.hypercomputecluster.v1beta.NetworkResource> network_resources = 11 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
int |
|
getNetworkResourcesMap()
public Map<String,NetworkResource> getNetworkResourcesMap()
Optional. Network resources available to the cluster. Must contain at most
one value. Keys specify the ID of the network resource by which it can be
referenced elsewhere, and must conform to
RFC-1034 (lower-case,
alphanumeric, and at most 63 characters).
map<string, .google.cloud.hypercomputecluster.v1beta.NetworkResource> network_resources = 11 [(.google.api.field_behavior) = OPTIONAL];
getNetworkResourcesOrDefault(String key, NetworkResource defaultValue)
public NetworkResource getNetworkResourcesOrDefault(String key, NetworkResource defaultValue)
Optional. Network resources available to the cluster. Must contain at most
one value. Keys specify the ID of the network resource by which it can be
referenced elsewhere, and must conform to
RFC-1034 (lower-case,
alphanumeric, and at most 63 characters).
map<string, .google.cloud.hypercomputecluster.v1beta.NetworkResource> network_resources = 11 [(.google.api.field_behavior) = OPTIONAL];
getNetworkResourcesOrThrow(String key)
public NetworkResource getNetworkResourcesOrThrow(String key)
Optional. Network resources available to the cluster. Must contain at most
one value. Keys specify the ID of the network resource by which it can be
referenced elsewhere, and must conform to
RFC-1034 (lower-case,
alphanumeric, and at most 63 characters).
map<string, .google.cloud.hypercomputecluster.v1beta.NetworkResource> network_resources = 11 [(.google.api.field_behavior) = OPTIONAL];
| Parameter |
| Name |
Description |
key |
String
|
getOrchestrator()
public Orchestrator getOrchestrator()
Optional. Orchestrator that is responsible for scheduling and running jobs
on the cluster.
.google.cloud.hypercomputecluster.v1beta.Orchestrator orchestrator = 8 [(.google.api.field_behavior) = OPTIONAL];
getOrchestratorOrBuilder()
public OrchestratorOrBuilder getOrchestratorOrBuilder()
Optional. Orchestrator that is responsible for scheduling and running jobs
on the cluster.
.google.cloud.hypercomputecluster.v1beta.Orchestrator orchestrator = 8 [(.google.api.field_behavior) = OPTIONAL];
getParserForType()
public Parser<Cluster> getParserForType()
Overrides
getReconciling()
public boolean getReconciling()
Output only. Indicates whether changes to the cluster are currently in
flight. If this is true, then the current state might not match the
cluster's intended state.
bool reconciling = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
boolean |
The reconciling.
|
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
getStorageResources() (deprecated)
public Map<String,StorageResource> getStorageResources()
getStorageResourcesCount()
public int getStorageResourcesCount()
Optional. Storage resources available to the cluster. Keys specify the ID
of the storage resource by which it can be referenced elsewhere, and must
conform to RFC-1034
(lower-case, alphanumeric, and at most 63 characters).
map<string, .google.cloud.hypercomputecluster.v1beta.StorageResource> storage_resources = 12 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
int |
|
getStorageResourcesMap()
public Map<String,StorageResource> getStorageResourcesMap()
Optional. Storage resources available to the cluster. Keys specify the ID
of the storage resource by which it can be referenced elsewhere, and must
conform to RFC-1034
(lower-case, alphanumeric, and at most 63 characters).
map<string, .google.cloud.hypercomputecluster.v1beta.StorageResource> storage_resources = 12 [(.google.api.field_behavior) = OPTIONAL];
getStorageResourcesOrDefault(String key, StorageResource defaultValue)
public StorageResource getStorageResourcesOrDefault(String key, StorageResource defaultValue)
Optional. Storage resources available to the cluster. Keys specify the ID
of the storage resource by which it can be referenced elsewhere, and must
conform to RFC-1034
(lower-case, alphanumeric, and at most 63 characters).
map<string, .google.cloud.hypercomputecluster.v1beta.StorageResource> storage_resources = 12 [(.google.api.field_behavior) = OPTIONAL];
getStorageResourcesOrThrow(String key)
public StorageResource getStorageResourcesOrThrow(String key)
Optional. Storage resources available to the cluster. Keys specify the ID
of the storage resource by which it can be referenced elsewhere, and must
conform to RFC-1034
(lower-case, alphanumeric, and at most 63 characters).
map<string, .google.cloud.hypercomputecluster.v1beta.StorageResource> storage_resources = 12 [(.google.api.field_behavior) = OPTIONAL];
| Parameter |
| Name |
Description |
key |
String
|
getUpdateTime()
public Timestamp getUpdateTime()
Output only. Time that the cluster was most recently updated.
.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
Timestamp |
The updateTime.
|
getUpdateTimeOrBuilder()
public TimestampOrBuilder getUpdateTimeOrBuilder()
Output only. Time that the cluster was most recently updated.
.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
hasCreateTime()
public boolean hasCreateTime()
Output only. Time that the cluster was originally created.
.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
boolean |
Whether the createTime field is set.
|
hasOrchestrator()
public boolean hasOrchestrator()
Optional. Orchestrator that is responsible for scheduling and running jobs
on the cluster.
.google.cloud.hypercomputecluster.v1beta.Orchestrator orchestrator = 8 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
boolean |
Whether the orchestrator field is set.
|
hasUpdateTime()
public boolean hasUpdateTime()
Output only. Time that the cluster was most recently updated.
.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
boolean |
Whether the updateTime field is set.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
internalGetMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
| Parameter |
| Name |
Description |
number |
int
|
| Returns |
| Type |
Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public Cluster.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Cluster.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public Cluster.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
