Class ClusterControllerClient (2.14.0)

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 future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.dataproc.v1.Cluster proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.dataproc.v1.CreateClusterRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

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 future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.dataproc.v1.Cluster proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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 Cluster, of the field to update. For example, to change the number of workers in a cluster to 5, the update_mask parameter would be specified as config.worker_config.num_instances, and the PATCH request body would specify the new value.
For more information, see UpdateClusterRequest.

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 future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.dataproc.v1.Cluster proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.dataproc.v1.UpdateClusterRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

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 future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.dataproc.v1.Cluster proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.dataproc.v1.StopClusterRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

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 future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.dataproc.v1.Cluster proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.dataproc.v1.StartClusterRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

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 future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.dataproc.v1.Cluster proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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 future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.dataproc.v1.ClusterOperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.dataproc.v1.DeleteClusterRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

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 future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.dataproc.v1.ClusterOperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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 StatusOr contains the error details.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.dataproc.v1.GetClusterRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

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 StatusOr contains the error details.

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 begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.dataproc.v1.Cluster, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

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:
field = value [AND [field = value]] ...
where field is one of status.state, clusterName, or labels.[KEY], and [KEY] is a label key. value can be * to match all values. status.state can be one of the following: ACTIVE, INACTIVE, CREATING, RUNNING, ERROR, DELETING, or UPDATING. ACTIVE contains the CREATING, UPDATING, and RUNNING states. INACTIVE contains the DELETING and ERROR states. clusterName is the name of the cluster provided at creation time. Only the logical AND operator is supported; space-separated items are treated as having an implicit AND operator.
Example filter:
status.state = ACTIVE AND clusterName = mycluster AND labels.env = staging AND labels.starred = *

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 begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.dataproc.v1.Cluster, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.dataproc.v1.ListClustersRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

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 begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.dataproc.v1.Cluster, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

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 future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.dataproc.v1.DiagnoseClusterResults proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.dataproc.v1.DiagnoseClusterRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

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 future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.dataproc.v1.DiagnoseClusterResults proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.