Google Cloud Dataproc V1 Client - Class NodeGroupControllerClient (3.8.1)

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

Service Description: The NodeGroupControllerService provides methods to manage node groups of Compute Engine managed instances.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:

$nodeGroupControllerClient = new NodeGroupControllerClient();
try {
    $formattedParent = $nodeGroupControllerClient->clusterRegionName('[PROJECT]', '[REGION]', '[CLUSTER]');
    $nodeGroup = new NodeGroup();
    $operationResponse = $nodeGroupControllerClient->createNodeGroup($formattedParent, $nodeGroup);
    $operationResponse->pollUntilComplete();
    if ($operationResponse->operationSucceeded()) {
        $result = $operationResponse->getResult();
        // doSomethingWith($result)
    } else {
        $error = $operationResponse->getError();
        // handleError($error)
    }
    // Alternatively:
    // start the operation, keep the operation name, and resume later
    $operationResponse = $nodeGroupControllerClient->createNodeGroup($formattedParent, $nodeGroup);
    $operationName = $operationResponse->getName();
    // ... do other work
    $newOperationResponse = $nodeGroupControllerClient->resumeOperation($operationName, 'createNodeGroup');
    while (!$newOperationResponse->isDone()) {
        // ... do other work
        $newOperationResponse->reload();
    }
    if ($newOperationResponse->operationSucceeded()) {
        $result = $newOperationResponse->getResult();
        // doSomethingWith($result)
    } else {
        $error = $newOperationResponse->getError();
        // handleError($error)
    }
} finally {
    $nodeGroupControllerClient->close();
}

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 service has a new (beta) implementation. See Google\Cloud\Dataproc\V1\Client\NodeGroupControllerClient to use the new surface.

Namespace

Google \ Cloud \ Dataproc \ V1

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.

createNodeGroup

Creates a node group in a cluster. The returned Operation.metadata is NodeGroupOperationMetadata.

Parameters
Name	Description
`parent`	`string` Required. The parent resource where this node group will be created. Format: `projects/{project}/regions/{region}/clusters/{cluster}`
`nodeGroup`	`Google\Cloud\Dataproc\V1\NodeGroup` Required. The node group to create.
`optionalArgs`	`array` Optional.
`↳ nodeGroupId`	`string` Optional. An optional node group ID. Generated if not specified. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). Cannot begin or end with underscore or hyphen. Must consist of from 3 to 33 characters.
`↳ requestId`	`string` Optional. A unique ID used to identify the request. If the server receives two CreateNodeGroupRequest with the same ID, the second request is ignored and the first google.longrunning.Operation created and stored in the backend is returned. Recommendation: Set this value to a UUID. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.
`↳ 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`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Dataproc\V1\NodeGroup;
use Google\Cloud\Dataproc\V1\NodeGroupControllerClient;
use Google\Cloud\Dataproc\V1\NodeGroup\Role;
use Google\Rpc\Status;

/**
 * @param string $formattedParent       The parent resource where this node group will be created.
 *                                      Format: `projects/{project}/regions/{region}/clusters/{cluster}`
 *                                      Please see {@see NodeGroupControllerClient::clusterRegionName()} for help formatting this field.
 * @param int    $nodeGroupRolesElement Node group roles.
 */
function create_node_group_sample(string $formattedParent, int $nodeGroupRolesElement): void
{
    // Create a client.
    $nodeGroupControllerClient = new NodeGroupControllerClient();

    // Prepare any non-scalar elements to be passed along with the request.
    $nodeGroupRoles = [$nodeGroupRolesElement,];
    $nodeGroup = (new NodeGroup())
        ->setRoles($nodeGroupRoles);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $nodeGroupControllerClient->createNodeGroup($formattedParent, $nodeGroup);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            /** @var NodeGroup $result */
            $result = $response->getResult();
            printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
        } else {
            /** @var Status $error */
            $error = $response->getError();
            printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedParent = NodeGroupControllerClient::clusterRegionName(
        '[PROJECT]',
        '[REGION]',
        '[CLUSTER]'
    );
    $nodeGroupRolesElement = Role::ROLE_UNSPECIFIED;

    create_node_group_sample($formattedParent, $nodeGroupRolesElement);
}

getNodeGroup

Gets the resource representation for a node group in a cluster.

Parameters
Name	Description
`name`	`string` Required. The name of the node group to retrieve. Format: `projects/{project}/regions/{region}/clusters/{cluster}/nodeGroups/{nodeGroup}`
`optionalArgs`	`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\NodeGroup`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Dataproc\V1\NodeGroup;
use Google\Cloud\Dataproc\V1\NodeGroupControllerClient;

/**
 * @param string $formattedName The name of the node group to retrieve.
 *                              Format:
 *                              `projects/{project}/regions/{region}/clusters/{cluster}/nodeGroups/{nodeGroup}`
 *                              Please see {@see NodeGroupControllerClient::nodeGroupName()} for help formatting this field.
 */
function get_node_group_sample(string $formattedName): void
{
    // Create a client.
    $nodeGroupControllerClient = new NodeGroupControllerClient();

    // Call the API and handle any network failures.
    try {
        /** @var NodeGroup $response */
        $response = $nodeGroupControllerClient->getNodeGroup($formattedName);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = NodeGroupControllerClient::nodeGroupName(
        '[PROJECT]',
        '[REGION]',
        '[CLUSTER]',
        '[NODE_GROUP]'
    );

    get_node_group_sample($formattedName);
}

resizeNodeGroup

Resizes a node group in a cluster. The returned Operation.metadata is NodeGroupOperationMetadata.

Parameters
Name	Description
`name`	`string` Required. The name of the node group to resize. Format: `projects/{project}/regions/{region}/clusters/{cluster}/nodeGroups/{nodeGroup}`
`size`	`int` Required. The number of running instances for the node group to maintain. The group adds or removes instances to maintain the number of instances specified by this parameter.
`optionalArgs`	`array` Optional.
`↳ requestId`	`string` Optional. A unique ID used to identify the request. If the server receives two ResizeNodeGroupRequest with the same ID, the second request is ignored and the first google.longrunning.Operation created and stored in the backend is returned. Recommendation: Set this value to a UUID. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.
`↳ gracefulDecommissionTimeout`	`Duration` Optional. Timeout for graceful YARN decomissioning. Graceful decommissioning allows the removal of nodes from the Compute Engine node group without interrupting jobs in progress. This 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 Duration). Only supported on Dataproc image versions 1.2 and higher.
`↳ 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`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Dataproc\V1\NodeGroup;
use Google\Cloud\Dataproc\V1\NodeGroupControllerClient;
use Google\Rpc\Status;

/**
 * @param string $name The name of the node group to resize.
 *                     Format:
 *                     `projects/{project}/regions/{region}/clusters/{cluster}/nodeGroups/{nodeGroup}`
 * @param int    $size The number of running instances for the node group to maintain.
 *                     The group adds or removes instances to maintain the number of instances
 *                     specified by this parameter.
 */
function resize_node_group_sample(string $name, int $size): void
{
    // Create a client.
    $nodeGroupControllerClient = new NodeGroupControllerClient();

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $nodeGroupControllerClient->resizeNodeGroup($name, $size);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            /** @var NodeGroup $result */
            $result = $response->getResult();
            printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
        } else {
            /** @var Status $error */
            $error = $response->getError();
            printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $name = '[NAME]';
    $size = 0;

    resize_node_group_sample($name, $size);
}

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::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::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

clusterRegion: projects/{project}/regions/{region}/clusters/{cluster}
nodeGroup: projects/{project}/regions/{region}/clusters/{cluster}/nodeGroups/{node_group}

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.

Constants

SERVICE_NAME

Value: 'google.cloud.dataproc.v1.NodeGroupController'

The name of the service.

SERVICE_ADDRESS

Value: 'dataproc.googleapis.com'

The default address of the service.

DEFAULT_SERVICE_PORT

Value: 443

The default port of the service.

CODEGEN_NAME

Value: 'gapic'

The name of the code generator, to be included in the agent header.