Package com.google.cloud.hypercomputecluster.v1

Interface ClusterOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

Cluster, Cluster.Builder

@Generated
public interface ClusterOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method	Description
boolean	containsComputeResources(String key)	Optional.
boolean	containsLabels(String key)	Optional.
boolean	containsNetworkResources(String key)	Optional.
boolean	containsStorageResources(String key)	Optional.
Map<String,ComputeResource>	getComputeResources()	Deprecated.
int	getComputeResourcesCount()	Optional.
Map<String,ComputeResource>	getComputeResourcesMap()	Optional.
ComputeResource	getComputeResourcesOrDefault(String key, ComputeResource defaultValue)	Optional.
ComputeResource	getComputeResourcesOrThrow(String key)	Optional.
com.google.protobuf.Timestamp	getCreateTime()	Output only.
com.google.protobuf.TimestampOrBuilder	getCreateTimeOrBuilder()	Output only.
String	getDescription()	Optional.
com.google.protobuf.ByteString	getDescriptionBytes()	Optional.
Map<String,String>	getLabels()	Deprecated.
int	getLabelsCount()	Optional.
Map<String,String>	getLabelsMap()	Optional.
String	getLabelsOrDefault(String key, String defaultValue)	Optional.
String	getLabelsOrThrow(String key)	Optional.
String	getName()	Identifier.
com.google.protobuf.ByteString	getNameBytes()	Identifier.
Map<String,NetworkResource>	getNetworkResources()	Deprecated.
int	getNetworkResourcesCount()	Optional.
Map<String,NetworkResource>	getNetworkResourcesMap()	Optional.
NetworkResource	getNetworkResourcesOrDefault(String key, NetworkResource defaultValue)	Optional.
NetworkResource	getNetworkResourcesOrThrow(String key)	Optional.
Orchestrator	getOrchestrator()	Optional.
OrchestratorOrBuilder	getOrchestratorOrBuilder()	Optional.
boolean	getReconciling()	Output only.
Map<String,StorageResource>	getStorageResources()	Deprecated.
int	getStorageResourcesCount()	Optional.
Map<String,StorageResource>	getStorageResourcesMap()	Optional.
StorageResource	getStorageResourcesOrDefault(String key, StorageResource defaultValue)	Optional.
StorageResource	getStorageResourcesOrThrow(String key)	Optional.
com.google.protobuf.Timestamp	getUpdateTime()	Output only.
com.google.protobuf.TimestampOrBuilder	getUpdateTimeOrBuilder()	Output only.
boolean	hasCreateTime()	Output only.
boolean	hasOrchestrator()	Optional.
boolean	hasUpdateTime()	Output only.

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Method Details

getName

String getName()

 Identifier. [Relative resource name](https://google.aip.dev/122) of the
 cluster, in the format
 `projects/{project}/locations/{location}/clusters/{cluster}`.
 

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns:

The name.

getNameBytes

com.google.protobuf.ByteString getNameBytes()

 Identifier. [Relative resource name](https://google.aip.dev/122) of the
 cluster, in the format
 `projects/{project}/locations/{location}/clusters/{cluster}`.
 

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns:

The bytes for name.

getDescription

String getDescription()

 Optional. User-provided description of the cluster.
 

string description = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The description.

getDescriptionBytes

com.google.protobuf.ByteString getDescriptionBytes()

 Optional. User-provided description of the cluster.
 

string description = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The bytes for description.

getLabelsCount

int getLabelsCount()

 Optional.
 [Labels](https://cloud.google.com/compute/docs/labeling-resources) 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];

containsLabels

boolean containsLabels(String key)

 Optional.
 [Labels](https://cloud.google.com/compute/docs/labeling-resources) 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];

getLabels

@Deprecated
Map<String,String> getLabels()

Deprecated.

Use getLabelsMap() instead.

getLabelsMap

Map<String,String> getLabelsMap()

 Optional.
 [Labels](https://cloud.google.com/compute/docs/labeling-resources) 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 getLabelsOrDefault(String key,
 String defaultValue)

 Optional.
 [Labels](https://cloud.google.com/compute/docs/labeling-resources) 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];

getLabelsOrThrow

String getLabelsOrThrow(String key)

 Optional.
 [Labels](https://cloud.google.com/compute/docs/labeling-resources) 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];

hasCreateTime

boolean hasCreateTime()

 Output only. Time that the cluster was originally created.
 

.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

Whether the createTime field is set.

getCreateTime

com.google.protobuf.Timestamp getCreateTime()

 Output only. Time that the cluster was originally created.
 

.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The createTime.

getCreateTimeOrBuilder

com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()

 Output only. Time that the cluster was originally created.
 

.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

hasUpdateTime

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:

Whether the updateTime field is set.

getUpdateTime

com.google.protobuf.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:

The updateTime.

getUpdateTimeOrBuilder

com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()

 Output only. Time that the cluster was most recently updated.
 

.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

getReconciling

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:

The reconciling.

getNetworkResourcesCount

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](https://datatracker.ietf.org/doc/html/rfc1034) (lower-case,
 alphanumeric, and at most 63 characters).
 

map<string, .google.cloud.hypercomputecluster.v1.NetworkResource> network_resources = 11 [(.google.api.field_behavior) = OPTIONAL];

containsNetworkResources

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](https://datatracker.ietf.org/doc/html/rfc1034) (lower-case,
 alphanumeric, and at most 63 characters).
 

map<string, .google.cloud.hypercomputecluster.v1.NetworkResource> network_resources = 11 [(.google.api.field_behavior) = OPTIONAL];

getNetworkResources

@Deprecated
Map<String,NetworkResource> getNetworkResources()

Deprecated.

Use getNetworkResourcesMap() instead.

getNetworkResourcesMap

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](https://datatracker.ietf.org/doc/html/rfc1034) (lower-case,
 alphanumeric, and at most 63 characters).
 

map<string, .google.cloud.hypercomputecluster.v1.NetworkResource> network_resources = 11 [(.google.api.field_behavior) = OPTIONAL];

getNetworkResourcesOrDefault

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](https://datatracker.ietf.org/doc/html/rfc1034) (lower-case,
 alphanumeric, and at most 63 characters).
 

map<string, .google.cloud.hypercomputecluster.v1.NetworkResource> network_resources = 11 [(.google.api.field_behavior) = OPTIONAL];

getNetworkResourcesOrThrow

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](https://datatracker.ietf.org/doc/html/rfc1034) (lower-case,
 alphanumeric, and at most 63 characters).
 

map<string, .google.cloud.hypercomputecluster.v1.NetworkResource> network_resources = 11 [(.google.api.field_behavior) = OPTIONAL];

getStorageResourcesCount

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](https://datatracker.ietf.org/doc/html/rfc1034)
 (lower-case, alphanumeric, and at most 63 characters).
 

map<string, .google.cloud.hypercomputecluster.v1.StorageResource> storage_resources = 12 [(.google.api.field_behavior) = OPTIONAL];

containsStorageResources

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](https://datatracker.ietf.org/doc/html/rfc1034)
 (lower-case, alphanumeric, and at most 63 characters).
 

map<string, .google.cloud.hypercomputecluster.v1.StorageResource> storage_resources = 12 [(.google.api.field_behavior) = OPTIONAL];

getStorageResources

@Deprecated
Map<String,StorageResource> getStorageResources()

Deprecated.

Use getStorageResourcesMap() instead.

getStorageResourcesMap

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](https://datatracker.ietf.org/doc/html/rfc1034)
 (lower-case, alphanumeric, and at most 63 characters).
 

map<string, .google.cloud.hypercomputecluster.v1.StorageResource> storage_resources = 12 [(.google.api.field_behavior) = OPTIONAL];

getStorageResourcesOrDefault

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](https://datatracker.ietf.org/doc/html/rfc1034)
 (lower-case, alphanumeric, and at most 63 characters).
 

map<string, .google.cloud.hypercomputecluster.v1.StorageResource> storage_resources = 12 [(.google.api.field_behavior) = OPTIONAL];

getStorageResourcesOrThrow

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](https://datatracker.ietf.org/doc/html/rfc1034)
 (lower-case, alphanumeric, and at most 63 characters).
 

map<string, .google.cloud.hypercomputecluster.v1.StorageResource> storage_resources = 12 [(.google.api.field_behavior) = OPTIONAL];

getComputeResourcesCount

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](https://datatracker.ietf.org/doc/html/rfc1034)
 (lower-case, alphanumeric, and at most 63 characters).
 

map<string, .google.cloud.hypercomputecluster.v1.ComputeResource> compute_resources = 13 [(.google.api.field_behavior) = OPTIONAL];

containsComputeResources

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](https://datatracker.ietf.org/doc/html/rfc1034)
 (lower-case, alphanumeric, and at most 63 characters).
 

map<string, .google.cloud.hypercomputecluster.v1.ComputeResource> compute_resources = 13 [(.google.api.field_behavior) = OPTIONAL];

getComputeResources

@Deprecated
Map<String,ComputeResource> getComputeResources()

Deprecated.

Use getComputeResourcesMap() instead.

getComputeResourcesMap

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](https://datatracker.ietf.org/doc/html/rfc1034)
 (lower-case, alphanumeric, and at most 63 characters).
 

map<string, .google.cloud.hypercomputecluster.v1.ComputeResource> compute_resources = 13 [(.google.api.field_behavior) = OPTIONAL];

getComputeResourcesOrDefault

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](https://datatracker.ietf.org/doc/html/rfc1034)
 (lower-case, alphanumeric, and at most 63 characters).
 

map<string, .google.cloud.hypercomputecluster.v1.ComputeResource> compute_resources = 13 [(.google.api.field_behavior) = OPTIONAL];

getComputeResourcesOrThrow

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](https://datatracker.ietf.org/doc/html/rfc1034)
 (lower-case, alphanumeric, and at most 63 characters).
 

map<string, .google.cloud.hypercomputecluster.v1.ComputeResource> compute_resources = 13 [(.google.api.field_behavior) = OPTIONAL];

hasOrchestrator

boolean hasOrchestrator()

 Optional. Orchestrator that is responsible for scheduling and running jobs
 on the cluster.
 

.google.cloud.hypercomputecluster.v1.Orchestrator orchestrator = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns:

Whether the orchestrator field is set.

getOrchestrator

Orchestrator getOrchestrator()

 Optional. Orchestrator that is responsible for scheduling and running jobs
 on the cluster.
 

.google.cloud.hypercomputecluster.v1.Orchestrator orchestrator = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The orchestrator.

getOrchestratorOrBuilder

OrchestratorOrBuilder getOrchestratorOrBuilder()

 Optional. Orchestrator that is responsible for scheduling and running jobs
 on the cluster.
 

.google.cloud.hypercomputecluster.v1.Orchestrator orchestrator = 8 [(.google.api.field_behavior) = OPTIONAL];