ClusterControllerClient(
transport=None,
channel=None,
credentials=None,
client_config=None,
client_info=None,
client_options=None,
)
The ClusterControllerService provides methods to manage clusters of Compute Engine instances.
Inheritance
builtins.object > google.cloud.dataproc_v1beta2.gapic.cluster_controller_client.ClusterControllerClient > ClusterControllerClientMethods
ClusterControllerClient
ClusterControllerClient(
transport=None,
channel=None,
credentials=None,
client_config=None,
client_info=None,
client_options=None,
)
Constructor.
Name | Description |
channel |
grpc.Channel
DEPRECATED. A |
credentials |
google.auth.credentials.Credentials
The authorization credentials to attach to requests. These credentials identify this application to the service. If none are specified, the client will attempt to ascertain the credentials from the environment. This argument is mutually exclusive with providing a transport instance to |
client_config |
dict
DEPRECATED. A dictionary of call options for each method. If not specified, the default configuration is used. |
client_info |
google.api_core.gapic_v1.client_info.ClientInfo
The client info used to send a user-agent string along with API requests. If |
client_options |
Union[dict, google.api_core.client_options.ClientOptions]
Client options used to set user options on the client. API Endpoint should be set through client_options. |
create_cluster
create_cluster(project_id, region, cluster, request_id=None, retry=<object object>, timeout=<object object>, metadata=None)
Creates a cluster in a project. The returned Operation.metadata
will be
ClusterOperationMetadata <https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1beta2#clusteroperationmetadata>
__.
.. rubric:: Example
from google.cloud import dataproc_v1beta2
client = dataproc_v1beta2.ClusterControllerClient()
TODO: Initialize
project_id
:project_id = ''
TODO: Initialize
region
:region = ''
TODO: Initialize
cluster
:cluster = {}
response = client.create_cluster(project_id, region, cluster)
def callback(operation_future): ... # Handle result. ... result = operation_future.result()
response.add_done_callback(callback)
Handle metadata.
metadata = response.metadata()
Name | Description |
project_id |
str
Required. The ID of the Google Cloud Platform project that the cluster belongs to. |
region |
str
Required. The Dataproc region in which to handle the request. |
cluster |
Union[dict, Cluster]
Required. The cluster to create. If a dict is provided, it must be of the same form as the protobuf message Cluster |
request_id |
str
Optional. A unique id used to identify the request. If the server receives two |
retry |
Optional[google.api_core.retry.Retry]
A retry object used to retry requests. If |
timeout |
Optional[float]
The amount of time, in seconds, to wait for the request to complete. Note that if |
metadata |
Optional[Sequence[Tuple[str, str]]]
Additional metadata that is provided to the method. |
Type | Description |
google.api_core.exceptions.GoogleAPICallError | If the request failed for any reason. |
google.api_core.exceptions.RetryError | If the request failed due to a retryable error and retry attempts failed. |
ValueError | If the parameters are invalid. |
delete_cluster
delete_cluster(project_id, region, cluster_name, cluster_uuid=None, request_id=None, retry=<object object>, timeout=<object object>, metadata=None)
Deletes a cluster in a project. The returned Operation.metadata
will be
ClusterOperationMetadata <https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1beta2#clusteroperationmetadata>
__.
.. rubric:: Example
from google.cloud import dataproc_v1beta2
client = dataproc_v1beta2.ClusterControllerClient()
TODO: Initialize
project_id
:project_id = ''
TODO: Initialize
region
:region = ''
TODO: Initialize
cluster_name
:cluster_name = ''
response = client.delete_cluster(project_id, region, cluster_name)
def callback(operation_future): ... # Handle result. ... result = operation_future.result()
response.add_done_callback(callback)
Handle metadata.
metadata = response.metadata()
Name | Description |
project_id |
str
Required. The ID of the Google Cloud Platform project that the cluster belongs to. |
region |
str
Required. The Dataproc region in which to handle the request. |
cluster_name |
str
Required. The cluster name. |
cluster_uuid |
str
Optional. Specifying the |
request_id |
str
Optional. A unique id used to identify the request. If the server receives two |
retry |
Optional[google.api_core.retry.Retry]
A retry object used to retry requests. If |
timeout |
Optional[float]
The amount of time, in seconds, to wait for the request to complete. Note that if |
metadata |
Optional[Sequence[Tuple[str, str]]]
Additional metadata that is provided to the method. |
Type | Description |
google.api_core.exceptions.GoogleAPICallError | If the request failed for any reason. |
google.api_core.exceptions.RetryError | If the request failed due to a retryable error and retry attempts failed. |
ValueError | If the parameters are invalid. |
diagnose_cluster
diagnose_cluster(project_id, region, cluster_name, retry=<object object>, timeout=<object object>, metadata=None)
Gets cluster diagnostic information. The returned
Operation.metadata
will be
ClusterOperationMetadata <https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1beta2#clusteroperationmetadata>
__.
After the operation completes, Operation.response
contains
Empty
.
.. rubric:: Example
from google.cloud import dataproc_v1beta2
client = dataproc_v1beta2.ClusterControllerClient()
TODO: Initialize
project_id
:project_id = ''
TODO: Initialize
region
:region = ''
TODO: Initialize
cluster_name
:cluster_name = ''
response = client.diagnose_cluster(project_id, region, cluster_name)
def callback(operation_future): ... # Handle result. ... result = operation_future.result()
response.add_done_callback(callback)
Handle metadata.
metadata = response.metadata()
Name | Description |
project_id |
str
Required. The ID of the Google Cloud Platform project that the cluster belongs to. |
region |
str
Required. The Dataproc region in which to handle the request. |
cluster_name |
str
Required. The cluster name. |
retry |
Optional[google.api_core.retry.Retry]
A retry object used to retry requests. If |
timeout |
Optional[float]
The amount of time, in seconds, to wait for the request to complete. Note that if |
metadata |
Optional[Sequence[Tuple[str, str]]]
Additional metadata that is provided to the method. |
Type | Description |
google.api_core.exceptions.GoogleAPICallError | If the request failed for any reason. |
google.api_core.exceptions.RetryError | If the request failed due to a retryable error and retry attempts failed. |
ValueError | If the parameters are invalid. |
from_service_account_file
from_service_account_file(filename, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
Name | Description |
filename |
str
The path to the service account private key json file. |
Type | Description |
ClusterControllerClient | The constructed client. |
from_service_account_json
from_service_account_json(filename, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
Name | Description |
filename |
str
The path to the service account private key json file. |
Type | Description |
ClusterControllerClient | The constructed client. |
get_cluster
get_cluster(project_id, region, cluster_name, retry=<object object>, timeout=<object object>, metadata=None)
Gets the resource representation for a cluster in a project.
.. rubric:: Example
from google.cloud import dataproc_v1beta2
client = dataproc_v1beta2.ClusterControllerClient()
TODO: Initialize
project_id
:project_id = ''
TODO: Initialize
region
:region = ''
TODO: Initialize
cluster_name
:cluster_name = ''
response = client.get_cluster(project_id, region, cluster_name)
Name | Description |
project_id |
str
Required. The ID of the Google Cloud Platform project that the cluster belongs to. |
region |
str
Required. The Dataproc region in which to handle the request. |
cluster_name |
str
Required. The cluster name. |
retry |
Optional[google.api_core.retry.Retry]
A retry object used to retry requests. If |
timeout |
Optional[float]
The amount of time, in seconds, to wait for the request to complete. Note that if |
metadata |
Optional[Sequence[Tuple[str, str]]]
Additional metadata that is provided to the method. |
Type | Description |
google.api_core.exceptions.GoogleAPICallError | If the request failed for any reason. |
google.api_core.exceptions.RetryError | If the request failed due to a retryable error and retry attempts failed. |
ValueError | If the parameters are invalid. |
list_clusters
list_clusters(project_id, region, filter_=None, page_size=None, retry=<object object>, timeout=<object object>, metadata=None)
Lists all regions/{region}/clusters in a project alphabetically.
.. rubric:: Example
from google.cloud import dataproc_v1beta2
client = dataproc_v1beta2.ClusterControllerClient()
TODO: Initialize
project_id
:project_id = ''
TODO: Initialize
region
:region = ''
Iterate over all results
for element in client.list_clusters(project_id, region): ... # process element ... pass
Alternatively:
Iterate over results one page at a time
for page in client.list_clusters(project_id, region).pages: ... for element in page: ... # process element ... pass
Name | Description |
project_id |
str
Required. The ID of the Google Cloud Platform project that the cluster belongs to. |
region |
str
Required. The Dataproc region in which to handle the request. |
filter_ |
str
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 |
page_size |
int
The maximum number of resources contained in the underlying API response. If page streaming is performed per- resource, this parameter does not affect the return value. If page streaming is performed per-page, this determines the maximum number of resources in a page. |
retry |
Optional[google.api_core.retry.Retry]
A retry object used to retry requests. If |
timeout |
Optional[float]
The amount of time, in seconds, to wait for the request to complete. Note that if |
metadata |
Optional[Sequence[Tuple[str, str]]]
Additional metadata that is provided to the method. |
Type | Description |
google.api_core.exceptions.GoogleAPICallError | If the request failed for any reason. |
google.api_core.exceptions.RetryError | If the request failed due to a retryable error and retry attempts failed. |
ValueError | If the parameters are invalid. |
update_cluster
update_cluster(project_id, region, cluster_name, cluster, update_mask, graceful_decommission_timeout=None, request_id=None, retry=<object object>, timeout=<object object>, metadata=None)
Updates a cluster in a project. The returned Operation.metadata
will be
ClusterOperationMetadata <https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1beta2#clusteroperationmetadata>
__.
.. rubric:: Example
from google.cloud import dataproc_v1beta2
client = dataproc_v1beta2.ClusterControllerClient()
TODO: Initialize
project_id
:project_id = ''
TODO: Initialize
region
:region = ''
TODO: Initialize
cluster_name
:cluster_name = ''
TODO: Initialize
cluster
:cluster = {}
TODO: Initialize
update_mask
:update_mask = {}
response = client.update_cluster(project_id, region, cluster_name, cluster, update_mask)
def callback(operation_future): ... # Handle result. ... result = operation_future.result()
response.add_done_callback(callback)
Handle metadata.
metadata = response.metadata()
Name | Description | ||||||||||||||||
project_id |
str
Required. The ID of the Google Cloud Platform project the cluster belongs to. | ||||||||||||||||
region |
str
Required. The Dataproc region in which to handle the request. | ||||||||||||||||
cluster_name |
str
Required. The cluster name. | ||||||||||||||||
cluster |
Union[dict, Cluster]
Required. The changes to the cluster. If a dict is provided, it must be of the same form as the protobuf message Cluster | ||||||||||||||||
update_mask |
Union[dict, FieldMask]
Required. Specifies the path, relative to
| ||||||||||||||||
graceful_decommission_timeout |
Union[dict, Duration]
Optional. Timeout for graceful YARN decomissioning. Graceful decommissioning allows removing nodes from the cluster without interrupting jobs in progress. Timeout specifies how long to wait for jobs in progress to finish before forcefully removing nodes (and potentially interrupting jobs). Default timeout is 0 (for forceful decommission), and the maximum allowed timeout is 1 day (see JSON representation of | ||||||||||||||||
request_id |
str
Optional. A unique id used to identify the request. If the server receives two | ||||||||||||||||
retry |
Optional[google.api_core.retry.Retry]
A retry object used to retry requests. If | ||||||||||||||||
timeout |
Optional[float]
The amount of time, in seconds, to wait for the request to complete. Note that if | ||||||||||||||||
metadata |
Optional[Sequence[Tuple[str, str]]]
Additional metadata that is provided to the method. |
Type | Description |
google.api_core.exceptions.GoogleAPICallError | If the request failed for any reason. |
google.api_core.exceptions.RetryError | If the request failed due to a retryable error and retry attempts failed. |
ValueError | If the parameters are invalid. |