The ClusterControllerService provides methods to manage clusters of Compute Engine instances.
Equality
Instances of this class created via copy-construction or copy-assignment always compare equal. Instances created with equal std::shared_ptr<*Connection>
objects compare equal. Objects that compare equal share the same underlying resources.
Performance
Creating a new instance of this class is a relatively expensive operation, new objects establish new connections to the service. In contrast, copy-construction, move-construction, and the corresponding assignment operations are relatively efficient as the copies share all underlying resources.
Thread Safety
Concurrent access to different instances of this class, even if they compare equal, is guaranteed to work. Two or more threads operating on the same instance of this class is not guaranteed to work. Since copy-construction and move-construction is a relatively efficient operation, consider using such a copy when using this class from multiple threads.
Constructors
ClusterControllerClient(ClusterControllerClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
ClusterControllerClient const &
|
ClusterControllerClient(ClusterControllerClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
ClusterControllerClient &&
|
ClusterControllerClient(std::shared_ptr< ClusterControllerConnection >, Options)
Parameters | |
---|---|
Name | Description |
connection |
std::shared_ptr< ClusterControllerConnection >
|
opts |
Options
|
Operators
operator=(ClusterControllerClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
ClusterControllerClient const &
|
Returns | |
---|---|
Type | Description |
ClusterControllerClient & |
operator=(ClusterControllerClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
ClusterControllerClient &&
|
Returns | |
---|---|
Type | Description |
ClusterControllerClient & |
Functions
CreateCluster(std::string const &, std::string const &, google::cloud::dataproc::v1::Cluster const &, Options)
Creates a cluster in a project.
The returned Operation.metadata will be ClusterOperationMetadata.
Parameters | |
---|---|
Name | Description |
project_id |
std::string const &
Required. The ID of the Google Cloud Platform project that the cluster belongs to. |
region |
std::string const &
Required. The Dataproc region in which to handle the request. |
cluster |
google::cloud::dataproc::v1::Cluster const &
Required. The cluster to create. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::dataproc::v1::Cluster > > |
A |
CreateCluster(NoAwaitTag, std::string const &, std::string const &, google::cloud::dataproc::v1::Cluster const &, Options)
Creates a cluster in a project.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
project_id |
std::string const &
|
region |
std::string const &
|
cluster |
google::cloud::dataproc::v1::Cluster const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
CreateCluster(google::cloud::dataproc::v1::CreateClusterRequest const &, Options)
Creates a cluster in a project.
The returned Operation.metadata will be ClusterOperationMetadata.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::dataproc::v1::CreateClusterRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::dataproc::v1::Cluster > > |
A |
CreateCluster(NoAwaitTag, google::cloud::dataproc::v1::CreateClusterRequest const &, Options)
Creates a cluster in a project.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::cloud::dataproc::v1::CreateClusterRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
CreateCluster(google::longrunning::Operation const &, Options)
Creates a cluster in a project.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::dataproc::v1::Cluster > > |
UpdateCluster(std::string const &, std::string const &, std::string const &, google::cloud::dataproc::v1::Cluster const &, google::protobuf::FieldMask const &, Options)
Updates a cluster in a project.
The returned Operation.metadata will be ClusterOperationMetadata. The cluster must be in a RUNNING
state or an error is returned.
Parameters | |
---|---|
Name | Description |
project_id |
std::string const &
Required. The ID of the Google Cloud Platform project the cluster belongs to. |
region |
std::string const &
Required. The Dataproc region in which to handle the request. |
cluster_name |
std::string const &
Required. The cluster name. |
cluster |
google::cloud::dataproc::v1::Cluster const &
Required. The changes to the cluster. |
update_mask |
google::protobuf::FieldMask const &
Required. Specifies the path, relative to |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::dataproc::v1::Cluster > > |
A |
UpdateCluster(NoAwaitTag, std::string const &, std::string const &, std::string const &, google::cloud::dataproc::v1::Cluster const &, google::protobuf::FieldMask const &, Options)
Updates a cluster in a project.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
project_id |
std::string const &
|
region |
std::string const &
|
cluster_name |
std::string const &
|
cluster |
google::cloud::dataproc::v1::Cluster const &
|
update_mask |
google::protobuf::FieldMask const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
UpdateCluster(google::cloud::dataproc::v1::UpdateClusterRequest const &, Options)
Updates a cluster in a project.
The returned Operation.metadata will be ClusterOperationMetadata. The cluster must be in a RUNNING
state or an error is returned.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::dataproc::v1::UpdateClusterRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::dataproc::v1::Cluster > > |
A |
UpdateCluster(NoAwaitTag, google::cloud::dataproc::v1::UpdateClusterRequest const &, Options)
Updates a cluster in a project.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::cloud::dataproc::v1::UpdateClusterRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
UpdateCluster(google::longrunning::Operation const &, Options)
Updates a cluster in a project.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::dataproc::v1::Cluster > > |
StopCluster(google::cloud::dataproc::v1::StopClusterRequest const &, Options)
Stops a cluster in a project.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::dataproc::v1::StopClusterRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::dataproc::v1::Cluster > > |
A |
StopCluster(NoAwaitTag, google::cloud::dataproc::v1::StopClusterRequest const &, Options)
Stops a cluster in a project.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::cloud::dataproc::v1::StopClusterRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
StopCluster(google::longrunning::Operation const &, Options)
Stops a cluster in a project.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::dataproc::v1::Cluster > > |
StartCluster(google::cloud::dataproc::v1::StartClusterRequest const &, Options)
Starts a cluster in a project.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::dataproc::v1::StartClusterRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::dataproc::v1::Cluster > > |
A |
StartCluster(NoAwaitTag, google::cloud::dataproc::v1::StartClusterRequest const &, Options)
Starts a cluster in a project.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::cloud::dataproc::v1::StartClusterRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
StartCluster(google::longrunning::Operation const &, Options)
Starts a cluster in a project.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::dataproc::v1::Cluster > > |
DeleteCluster(std::string const &, std::string const &, std::string const &, Options)
Deletes a cluster in a project.
The returned Operation.metadata will be ClusterOperationMetadata.
Parameters | |
---|---|
Name | Description |
project_id |
std::string const &
Required. The ID of the Google Cloud Platform project that the cluster belongs to. |
region |
std::string const &
Required. The Dataproc region in which to handle the request. |
cluster_name |
std::string const &
Required. The cluster name. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::dataproc::v1::ClusterOperationMetadata > > |
A |
DeleteCluster(NoAwaitTag, std::string const &, std::string const &, std::string const &, Options)
Deletes a cluster in a project.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
project_id |
std::string const &
|
region |
std::string const &
|
cluster_name |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
DeleteCluster(google::cloud::dataproc::v1::DeleteClusterRequest const &, Options)
Deletes a cluster in a project.
The returned Operation.metadata will be ClusterOperationMetadata.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::dataproc::v1::DeleteClusterRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::dataproc::v1::ClusterOperationMetadata > > |
A |
DeleteCluster(NoAwaitTag, google::cloud::dataproc::v1::DeleteClusterRequest const &, Options)
Deletes a cluster in a project.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::cloud::dataproc::v1::DeleteClusterRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
DeleteCluster(google::longrunning::Operation const &, Options)
Deletes a cluster in a project.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::dataproc::v1::ClusterOperationMetadata > > |
GetCluster(std::string const &, std::string const &, std::string const &, Options)
Gets the resource representation for a cluster in a project.
Parameters | |
---|---|
Name | Description |
project_id |
std::string const &
Required. The ID of the Google Cloud Platform project that the cluster belongs to. |
region |
std::string const &
Required. The Dataproc region in which to handle the request. |
cluster_name |
std::string const &
Required. The cluster name. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::dataproc::v1::Cluster > |
the result of the RPC. The response message type (google.cloud.dataproc.v1.Cluster) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetCluster(google::cloud::dataproc::v1::GetClusterRequest const &, Options)
Gets the resource representation for a cluster in a project.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::dataproc::v1::GetClusterRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::dataproc::v1::Cluster > |
the result of the RPC. The response message type (google.cloud.dataproc.v1.Cluster) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
ListClusters(std::string const &, std::string const &, Options)
Lists all regions/{region}/clusters in a project alphabetically.
Parameters | |
---|---|
Name | Description |
project_id |
std::string const &
Required. The ID of the Google Cloud Platform project that the cluster belongs to. |
region |
std::string const &
Required. The Dataproc region in which to handle the request. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::dataproc::v1::Cluster > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListClusters(std::string const &, std::string const &, std::string const &, Options)
Lists all regions/{region}/clusters in a project alphabetically.
Parameters | |
---|---|
Name | Description |
project_id |
std::string const &
Required. The ID of the Google Cloud Platform project that the cluster belongs to. |
region |
std::string const &
Required. The Dataproc region in which to handle the request. |
filter |
std::string const &
Optional. A filter constraining the clusters to list. Filters are case-sensitive and have the following syntax: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::dataproc::v1::Cluster > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListClusters(google::cloud::dataproc::v1::ListClustersRequest, Options)
Lists all regions/{region}/clusters in a project alphabetically.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::dataproc::v1::ListClustersRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::dataproc::v1::Cluster > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
DiagnoseCluster(std::string const &, std::string const &, std::string const &, Options)
Gets cluster diagnostic information.
The returned Operation.metadata will be ClusterOperationMetadata. After the operation completes, Operation.response contains DiagnoseClusterResults.
Parameters | |
---|---|
Name | Description |
project_id |
std::string const &
Required. The ID of the Google Cloud Platform project that the cluster belongs to. |
region |
std::string const &
Required. The Dataproc region in which to handle the request. |
cluster_name |
std::string const &
Required. The cluster name. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::dataproc::v1::DiagnoseClusterResults > > |
A |
DiagnoseCluster(NoAwaitTag, std::string const &, std::string const &, std::string const &, Options)
Gets cluster diagnostic information.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
project_id |
std::string const &
|
region |
std::string const &
|
cluster_name |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
DiagnoseCluster(google::cloud::dataproc::v1::DiagnoseClusterRequest const &, Options)
Gets cluster diagnostic information.
The returned Operation.metadata will be ClusterOperationMetadata. After the operation completes, Operation.response contains DiagnoseClusterResults.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::dataproc::v1::DiagnoseClusterRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::dataproc::v1::DiagnoseClusterResults > > |
A |
DiagnoseCluster(NoAwaitTag, google::cloud::dataproc::v1::DiagnoseClusterRequest const &, Options)
Gets cluster diagnostic information.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::cloud::dataproc::v1::DiagnoseClusterRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
DiagnoseCluster(google::longrunning::Operation const &, Options)
Gets cluster diagnostic information.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::dataproc::v1::DiagnoseClusterResults > > |