Reference documentation and code samples for the Google Cloud Hypercompute Cluster V1beta Client class Cluster.
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.
Generated from protobuf message google.cloud.hypercomputecluster.v1beta.Cluster
Namespace
Google \ Cloud \ HypercomputeCluster \ V1betaMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Identifier. Relative resource name of the cluster, in the format |
↳ description |
string
Optional. User-provided description of the cluster. |
↳ labels |
array|Google\Protobuf\Internal\MapField
Optional. Labels applied to the cluster. Labels can be used to organize clusters and to filter them in queries. |
↳ create_time |
Google\Protobuf\Timestamp
Output only. Time that the cluster was originally created. |
↳ update_time |
Google\Protobuf\Timestamp
Output only. Time that the cluster was most recently updated. |
↳ reconciling |
bool
Output only. Indicates whether changes to the cluster are currently in flight. If this is |
↳ network_resources |
array|Google\Protobuf\Internal\MapField
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). |
↳ storage_resources |
array|Google\Protobuf\Internal\MapField
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). |
↳ compute_resources |
array|Google\Protobuf\Internal\MapField
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). |
↳ orchestrator |
Orchestrator
Optional. Orchestrator that is responsible for scheduling and running jobs on the cluster. |
getName
Identifier. Relative resource name of the
cluster, in the format
projects/{project}/locations/{location}/clusters/{cluster}.
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Identifier. Relative resource name of the
cluster, in the format
projects/{project}/locations/{location}/clusters/{cluster}.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDescription
Optional. User-provided description of the cluster.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDescription
Optional. User-provided description of the cluster.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getLabels
Optional.
Labels applied to the cluster. Labels can be used to organize clusters and to filter them in queries.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField |
|
setLabels
Optional.
Labels applied to the cluster. Labels can be used to organize clusters and to filter them in queries.
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCreateTime
Output only. Time that the cluster was originally created.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasCreateTime
clearCreateTime
setCreateTime
Output only. Time that the cluster was originally created.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUpdateTime
Output only. Time that the cluster was most recently updated.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. Time that the cluster was most recently updated.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
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.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setReconciling
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.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getNetworkResources
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).
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField |
|
setNetworkResources
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).
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getStorageResources
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).
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField |
|
setStorageResources
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).
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getComputeResources
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).
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField |
|
setComputeResources
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).
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getOrchestrator
Optional. Orchestrator that is responsible for scheduling and running jobs on the cluster.
| Returns | |
|---|---|
| Type | Description |
Orchestrator|null |
|
hasOrchestrator
clearOrchestrator
setOrchestrator
Optional. Orchestrator that is responsible for scheduling and running jobs on the cluster.
| Parameter | |
|---|---|
| Name | Description |
var |
Orchestrator
|
| Returns | |
|---|---|
| Type | Description |
$this |
|