Google Cloud Dataproc V1 Client - Class ClusterControllerClient (3.10.1)

Version 3.10.1

• 3.14.0 (latest)
• 3.13.4
• 3.12.0
• 3.11.0
• 3.10.1
• 3.9.0
• 3.8.1
• 3.7.1
• 3.6.1
• 3.5.1
• 3.4.0
• 3.3.0
• 3.2.2
• 2.2.0
• 2.1.0
• 2.0.0

Beta

This library is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

Reference documentation and code samples for the Google Cloud Dataproc V1 Client class ClusterControllerClient.

Service Description: The ClusterControllerService provides methods to manage clusters of Compute Engine instances.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parseName method to extract the individual identifiers contained within formatted names that are returned by the API.

This class is currently experimental and may be subject to changes. See Google\Cloud\Dataproc\V1\ClusterControllerClient for the stable implementation

Namespace

Google \ Cloud \ Dataproc \ V1 \ Client

Methods

__construct

Constructor.

Parameters
Name	Description
options	array Optional. Options for configuring the service API wrapper.
↳ apiEndpoint	string The address of the API remote host. May optionally include the port, formatted as "
↳ credentials	string|array|FetchAuthTokenInterface|CredentialsWrapper The credentials to be used by the client to authorize API calls. This option accepts either a path to a credentials file, or a decoded credentials file as a PHP array. Advanced usage: In addition, this option can also accept a pre-constructed Google\Auth\FetchAuthTokenInterface object or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored.
↳ credentialsConfig	array Options used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, see Google\ApiCore\CredentialsWrapper::build() .
↳ disableRetries	bool Determines whether or not retries defined by the client configuration should be disabled. Defaults to false.
↳ clientConfig	string|array Client method configuration, including retry settings. This option can be either a path to a JSON file, or a PHP array containing the decoded JSON data. By default this settings points to the default client config file, which is provided in the resources folder.
↳ transport	string|TransportInterface The transport used for executing network requests. May be either the string rest or grpc. Defaults to grpc if gRPC support is detected on the system. Advanced usage: Additionally, it is possible to pass in an already instantiated Google\ApiCore\Transport\TransportInterface object. Note that when this object is provided, any settings in $transportConfig, and any $apiEndpoint setting, will be ignored.
↳ transportConfig	array Configuration options that will be used to construct the transport. Options for each supported transport type should be passed in a key for that transport. For example: $transportConfig = [ 'grpc' => [...], 'rest' => [...], ]; See the Google\ApiCore\Transport\GrpcTransport::build() and Google\ApiCore\Transport\RestTransport::build() methods for the supported options.
↳ clientCertSource	callable A callable which returns the client cert as a string. This can be used to provide a certificate and private key to the transport layer for mTLS.

createCluster

Creates a cluster in a project. The returned Operation.metadata will be ClusterOperationMetadata.

The async variant is Google\Cloud\Dataproc\V1\Client\ClusterControllerClient::createClusterAsync() .

Parameters
Name	Description
request	Google\Cloud\Dataproc\V1\CreateClusterRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\OperationResponse

deleteCluster

Deletes a cluster in a project. The returned Operation.metadata will be ClusterOperationMetadata.

The async variant is Google\Cloud\Dataproc\V1\Client\ClusterControllerClient::deleteClusterAsync() .

Parameters
Name	Description
request	Google\Cloud\Dataproc\V1\DeleteClusterRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\OperationResponse

diagnoseCluster

Gets cluster diagnostic information. The returned Operation.metadata will be ClusterOperationMetadata.

After the operation completes, Operation.response contains DiagnoseClusterResults.

The async variant is Google\Cloud\Dataproc\V1\Client\ClusterControllerClient::diagnoseClusterAsync() .

Parameters
Name	Description
request	Google\Cloud\Dataproc\V1\DiagnoseClusterRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\OperationResponse

getCluster

Gets the resource representation for a cluster in a project.

The async variant is Google\Cloud\Dataproc\V1\Client\ClusterControllerClient::getClusterAsync() .

Parameters
Name	Description
request	Google\Cloud\Dataproc\V1\GetClusterRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\Cloud\Dataproc\V1\Cluster

listClusters

Lists all regions/{region}/clusters in a project alphabetically.

The async variant is Google\Cloud\Dataproc\V1\Client\ClusterControllerClient::listClustersAsync() .

Parameters
Name	Description
request	Google\Cloud\Dataproc\V1\ListClustersRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\PagedListResponse

startCluster

Starts a cluster in a project.

The async variant is Google\Cloud\Dataproc\V1\Client\ClusterControllerClient::startClusterAsync() .

Parameters
Name	Description
request	Google\Cloud\Dataproc\V1\StartClusterRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\OperationResponse

stopCluster

Stops a cluster in a project.

The async variant is Google\Cloud\Dataproc\V1\Client\ClusterControllerClient::stopClusterAsync() .

Parameters
Name	Description
request	Google\Cloud\Dataproc\V1\StopClusterRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\OperationResponse

updateCluster

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.

The async variant is Google\Cloud\Dataproc\V1\Client\ClusterControllerClient::updateClusterAsync() .

Parameters
Name	Description
request	Google\Cloud\Dataproc\V1\UpdateClusterRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\OperationResponse

getIamPolicy

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

The async variant is Google\Cloud\Dataproc\V1\Client\ClusterControllerClient::getIamPolicyAsync() .

Parameters
Name	Description
request	Google\Cloud\Iam\V1\GetIamPolicyRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\Cloud\Iam\V1\Policy

setIamPolicy

Sets the access control policy on the specified resource. Replaces any existing policy.

Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

The async variant is Google\Cloud\Dataproc\V1\Client\ClusterControllerClient::setIamPolicyAsync() .

Parameters
Name	Description
request	Google\Cloud\Iam\V1\SetIamPolicyRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\Cloud\Iam\V1\Policy

testIamPermissions

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.

Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

The async variant is Google\Cloud\Dataproc\V1\Client\ClusterControllerClient::testIamPermissionsAsync() .

Parameters
Name	Description
request	Google\Cloud\Iam\V1\TestIamPermissionsRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\Cloud\Iam\V1\TestIamPermissionsResponse

createClusterAsync

Parameters
Name	Description
request	Google\Cloud\Dataproc\V1\CreateClusterRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

deleteClusterAsync

Parameters
Name	Description
request	Google\Cloud\Dataproc\V1\DeleteClusterRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

diagnoseClusterAsync

Parameters
Name	Description
request	Google\Cloud\Dataproc\V1\DiagnoseClusterRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

getClusterAsync

Parameters
Name	Description
request	Google\Cloud\Dataproc\V1\GetClusterRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

listClustersAsync

Parameters
Name	Description
request	Google\Cloud\Dataproc\V1\ListClustersRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

startClusterAsync

Parameters
Name	Description
request	Google\Cloud\Dataproc\V1\StartClusterRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

stopClusterAsync

Parameters
Name	Description
request	Google\Cloud\Dataproc\V1\StopClusterRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

updateClusterAsync

Parameters
Name	Description
request	Google\Cloud\Dataproc\V1\UpdateClusterRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

getIamPolicyAsync

Parameters
Name	Description
request	Google\Cloud\Iam\V1\GetIamPolicyRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

setIamPolicyAsync

Parameters
Name	Description
request	Google\Cloud\Iam\V1\SetIamPolicyRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

testIamPermissionsAsync

Parameters
Name	Description
request	Google\Cloud\Iam\V1\TestIamPermissionsRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

getOperationsClient

Return an OperationsClient object with the same endpoint as $this.

Returns
Type	Description
Google\ApiCore\LongRunning\OperationsClient

resumeOperation

Resume an existing long running operation that was previously started by a long running API method. If $methodName is not provided, or does not match a long running API method, then the operation can still be resumed, but the OperationResponse object will not deserialize the final response.

Parameters
Name	Description
operationName	string The name of the long running operation
methodName	string The name of the method used to start the operation

Returns
Type	Description
Google\ApiCore\OperationResponse

static::clusterName

Formats a string containing the fully-qualified path to represent a cluster resource.

Parameters
Name	Description
project	string
location	string
cluster	string

Returns
Type	Description
string	The formatted cluster resource.

static::clusterRegionName

Formats a string containing the fully-qualified path to represent a cluster_region resource.

Parameters
Name	Description
project	string
region	string
cluster	string

Returns
Type	Description
string	The formatted cluster_region resource.

static::nodeGroupName

Formats a string containing the fully-qualified path to represent a node_group resource.

Parameters
Name	Description
project	string
region	string
cluster	string
nodeGroup	string

Returns
Type	Description
string	The formatted node_group resource.

static::serviceName

Formats a string containing the fully-qualified path to represent a service resource.

Parameters
Name	Description
project	string
location	string
service	string

Returns
Type	Description
string	The formatted service resource.

static::parseName

Parses a formatted name string and returns an associative array of the components in the name.

The following name formats are supported: Template: Pattern

• cluster: projects/{project}/locations/{location}/clusters/{cluster}
• clusterRegion: projects/{project}/regions/{region}/clusters/{cluster}
• nodeGroup: projects/{project}/regions/{region}/clusters/{cluster}/nodeGroups/{node_group}
• service: projects/{project}/locations/{location}/services/{service}

The optional $template argument can be supplied to specify a particular pattern, and must match one of the templates listed above. If no $template argument is provided, or if the $template argument does not match one of the templates listed, then parseName will check each of the supported templates, and return the first match.

Parameters
Name	Description
formattedName	string The formatted name string
template	string Optional name of template to match

Returns
Type	Description
array	An associative array from name component IDs to component values.