Google Cloud Dataproc V1 Client - Class AutoscalingPolicyServiceClient (3.12.0)

Namespace

Methods

__construct

createAutoscalingPolicy

use Google\ApiCore\ApiException;
use Google\Cloud\Dataproc\V1\AutoscalingPolicy;
use Google\Cloud\Dataproc\V1\BasicAutoscalingAlgorithm;
use Google\Cloud\Dataproc\V1\BasicYarnAutoscalingConfig;
use Google\Cloud\Dataproc\V1\Client\AutoscalingPolicyServiceClient;
use Google\Cloud\Dataproc\V1\CreateAutoscalingPolicyRequest;
use Google\Cloud\Dataproc\V1\InstanceGroupAutoscalingPolicyConfig;
use Google\Protobuf\Duration;

/**
 * @param string $formattedParent                               The "resource name" of the region or location, as described
 *                                                              in https://cloud.google.com/apis/design/resource_names.
 *
 *                                                              * For `projects.regions.autoscalingPolicies.create`, the resource name
 *                                                              of the region has the following format:
 *                                                              `projects/{project_id}/regions/{region}`
 *
 *                                                              * For `projects.locations.autoscalingPolicies.create`, the resource name
 *                                                              of the location has the following format:
 *                                                              `projects/{project_id}/locations/{location}`
 *                                                              Please see {@see AutoscalingPolicyServiceClient::regionName()} for help formatting this field.
 * @param float  $policyBasicAlgorithmYarnConfigScaleUpFactor   Fraction of average YARN pending memory in the last cooldown
 *                                                              period for which to add workers. A scale-up factor of 1.0 will result in
 *                                                              scaling up so that there is no pending memory remaining after the update
 *                                                              (more aggressive scaling). A scale-up factor closer to 0 will result in a
 *                                                              smaller magnitude of scaling up (less aggressive scaling). See [How
 *                                                              autoscaling
 *                                                              works](https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/autoscaling#how_autoscaling_works)
 *                                                              for more information.
 *
 *                                                              Bounds: [0.0, 1.0].
 * @param float  $policyBasicAlgorithmYarnConfigScaleDownFactor Fraction of average YARN pending memory in the last cooldown
 *                                                              period for which to remove workers. A scale-down factor of 1 will result in
 *                                                              scaling down so that there is no available memory remaining after the
 *                                                              update (more aggressive scaling). A scale-down factor of 0 disables
 *                                                              removing workers, which can be beneficial for autoscaling a single job.
 *                                                              See [How autoscaling
 *                                                              works](https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/autoscaling#how_autoscaling_works)
 *                                                              for more information.
 *
 *                                                              Bounds: [0.0, 1.0].
 * @param int    $policyWorkerConfigMaxInstances                Maximum number of instances for this group. Required for primary
 *                                                              workers. Note that by default, clusters will not use secondary workers.
 *                                                              Required for secondary workers if the minimum secondary instances is set.
 *
 *                                                              Primary workers - Bounds: [min_instances, ).
 *                                                              Secondary workers - Bounds: [min_instances, ). Default: 0.
 */
function create_autoscaling_policy_sample(
    string $formattedParent,
    float $policyBasicAlgorithmYarnConfigScaleUpFactor,
    float $policyBasicAlgorithmYarnConfigScaleDownFactor,
    int $policyWorkerConfigMaxInstances
): void {
    // Create a client.
    $autoscalingPolicyServiceClient = new AutoscalingPolicyServiceClient();

    // Prepare the request message.
    $policyBasicAlgorithmYarnConfigGracefulDecommissionTimeout = new Duration();
    $policyBasicAlgorithmYarnConfig = (new BasicYarnAutoscalingConfig())
        ->setGracefulDecommissionTimeout($policyBasicAlgorithmYarnConfigGracefulDecommissionTimeout)
        ->setScaleUpFactor($policyBasicAlgorithmYarnConfigScaleUpFactor)
        ->setScaleDownFactor($policyBasicAlgorithmYarnConfigScaleDownFactor);
    $policyBasicAlgorithm = (new BasicAutoscalingAlgorithm())
        ->setYarnConfig($policyBasicAlgorithmYarnConfig);
    $policyWorkerConfig = (new InstanceGroupAutoscalingPolicyConfig())
        ->setMaxInstances($policyWorkerConfigMaxInstances);
    $policy = (new AutoscalingPolicy())
        ->setBasicAlgorithm($policyBasicAlgorithm)
        ->setWorkerConfig($policyWorkerConfig);
    $request = (new CreateAutoscalingPolicyRequest())
        ->setParent($formattedParent)
        ->setPolicy($policy);

    // Call the API and handle any network failures.
    try {
        /** @var AutoscalingPolicy $response */
        $response = $autoscalingPolicyServiceClient->createAutoscalingPolicy($request);
        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
{
    $formattedParent = AutoscalingPolicyServiceClient::regionName('[PROJECT]', '[REGION]');
    $policyBasicAlgorithmYarnConfigScaleUpFactor = 0.0;
    $policyBasicAlgorithmYarnConfigScaleDownFactor = 0.0;
    $policyWorkerConfigMaxInstances = 0;

    create_autoscaling_policy_sample(
        $formattedParent,
        $policyBasicAlgorithmYarnConfigScaleUpFactor,
        $policyBasicAlgorithmYarnConfigScaleDownFactor,
        $policyWorkerConfigMaxInstances
    );
}

deleteAutoscalingPolicy

use Google\ApiCore\ApiException;
use Google\Cloud\Dataproc\V1\Client\AutoscalingPolicyServiceClient;
use Google\Cloud\Dataproc\V1\DeleteAutoscalingPolicyRequest;

/**
 * @param string $formattedName The "resource name" of the autoscaling policy, as described
 *                              in https://cloud.google.com/apis/design/resource_names.
 *
 *                              * For `projects.regions.autoscalingPolicies.delete`, the resource name
 *                              of the policy has the following format:
 *                              `projects/{project_id}/regions/{region}/autoscalingPolicies/{policy_id}`
 *
 *                              * For `projects.locations.autoscalingPolicies.delete`, the resource name
 *                              of the policy has the following format:
 *                              `projects/{project_id}/locations/{location}/autoscalingPolicies/{policy_id}`
 *                              Please see {@see AutoscalingPolicyServiceClient::autoscalingPolicyName()} for help formatting this field.
 */
function delete_autoscaling_policy_sample(string $formattedName): void
{
    // Create a client.
    $autoscalingPolicyServiceClient = new AutoscalingPolicyServiceClient();

    // Prepare the request message.
    $request = (new DeleteAutoscalingPolicyRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        $autoscalingPolicyServiceClient->deleteAutoscalingPolicy($request);
        printf('Call completed successfully.' . PHP_EOL);
    } 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 = AutoscalingPolicyServiceClient::autoscalingPolicyName(
        '[PROJECT]',
        '[LOCATION]',
        '[AUTOSCALING_POLICY]'
    );

    delete_autoscaling_policy_sample($formattedName);
}

getAutoscalingPolicy

use Google\ApiCore\ApiException;
use Google\Cloud\Dataproc\V1\AutoscalingPolicy;
use Google\Cloud\Dataproc\V1\Client\AutoscalingPolicyServiceClient;
use Google\Cloud\Dataproc\V1\GetAutoscalingPolicyRequest;

/**
 * @param string $formattedName The "resource name" of the autoscaling policy, as described
 *                              in https://cloud.google.com/apis/design/resource_names.
 *
 *                              * For `projects.regions.autoscalingPolicies.get`, the resource name
 *                              of the policy has the following format:
 *                              `projects/{project_id}/regions/{region}/autoscalingPolicies/{policy_id}`
 *
 *                              * For `projects.locations.autoscalingPolicies.get`, the resource name
 *                              of the policy has the following format:
 *                              `projects/{project_id}/locations/{location}/autoscalingPolicies/{policy_id}`
 *                              Please see {@see AutoscalingPolicyServiceClient::autoscalingPolicyName()} for help formatting this field.
 */
function get_autoscaling_policy_sample(string $formattedName): void
{
    // Create a client.
    $autoscalingPolicyServiceClient = new AutoscalingPolicyServiceClient();

    // Prepare the request message.
    $request = (new GetAutoscalingPolicyRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        /** @var AutoscalingPolicy $response */
        $response = $autoscalingPolicyServiceClient->getAutoscalingPolicy($request);
        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 = AutoscalingPolicyServiceClient::autoscalingPolicyName(
        '[PROJECT]',
        '[LOCATION]',
        '[AUTOSCALING_POLICY]'
    );

    get_autoscaling_policy_sample($formattedName);
}

listAutoscalingPolicies

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Dataproc\V1\AutoscalingPolicy;
use Google\Cloud\Dataproc\V1\Client\AutoscalingPolicyServiceClient;
use Google\Cloud\Dataproc\V1\ListAutoscalingPoliciesRequest;

/**
 * @param string $formattedParent The "resource name" of the region or location, as described
 *                                in https://cloud.google.com/apis/design/resource_names.
 *
 *                                * For `projects.regions.autoscalingPolicies.list`, the resource name
 *                                of the region has the following format:
 *                                `projects/{project_id}/regions/{region}`
 *
 *                                * For `projects.locations.autoscalingPolicies.list`, the resource name
 *                                of the location has the following format:
 *                                `projects/{project_id}/locations/{location}`
 *                                Please see {@see AutoscalingPolicyServiceClient::regionName()} for help formatting this field.
 */
function list_autoscaling_policies_sample(string $formattedParent): void
{
    // Create a client.
    $autoscalingPolicyServiceClient = new AutoscalingPolicyServiceClient();

    // Prepare the request message.
    $request = (new ListAutoscalingPoliciesRequest())
        ->setParent($formattedParent);

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $autoscalingPolicyServiceClient->listAutoscalingPolicies($request);

        /** @var AutoscalingPolicy $element */
        foreach ($response as $element) {
            printf('Element data: %s' . PHP_EOL, $element->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 = AutoscalingPolicyServiceClient::regionName('[PROJECT]', '[REGION]');

    list_autoscaling_policies_sample($formattedParent);
}

updateAutoscalingPolicy

use Google\ApiCore\ApiException;
use Google\Cloud\Dataproc\V1\AutoscalingPolicy;
use Google\Cloud\Dataproc\V1\BasicAutoscalingAlgorithm;
use Google\Cloud\Dataproc\V1\BasicYarnAutoscalingConfig;
use Google\Cloud\Dataproc\V1\Client\AutoscalingPolicyServiceClient;
use Google\Cloud\Dataproc\V1\InstanceGroupAutoscalingPolicyConfig;
use Google\Cloud\Dataproc\V1\UpdateAutoscalingPolicyRequest;
use Google\Protobuf\Duration;

/**
 * @param float $policyBasicAlgorithmYarnConfigScaleUpFactor   Fraction of average YARN pending memory in the last cooldown
 *                                                             period for which to add workers. A scale-up factor of 1.0 will result in
 *                                                             scaling up so that there is no pending memory remaining after the update
 *                                                             (more aggressive scaling). A scale-up factor closer to 0 will result in a
 *                                                             smaller magnitude of scaling up (less aggressive scaling). See [How
 *                                                             autoscaling
 *                                                             works](https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/autoscaling#how_autoscaling_works)
 *                                                             for more information.
 *
 *                                                             Bounds: [0.0, 1.0].
 * @param float $policyBasicAlgorithmYarnConfigScaleDownFactor Fraction of average YARN pending memory in the last cooldown
 *                                                             period for which to remove workers. A scale-down factor of 1 will result in
 *                                                             scaling down so that there is no available memory remaining after the
 *                                                             update (more aggressive scaling). A scale-down factor of 0 disables
 *                                                             removing workers, which can be beneficial for autoscaling a single job.
 *                                                             See [How autoscaling
 *                                                             works](https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/autoscaling#how_autoscaling_works)
 *                                                             for more information.
 *
 *                                                             Bounds: [0.0, 1.0].
 * @param int   $policyWorkerConfigMaxInstances                Maximum number of instances for this group. Required for primary
 *                                                             workers. Note that by default, clusters will not use secondary workers.
 *                                                             Required for secondary workers if the minimum secondary instances is set.
 *
 *                                                             Primary workers - Bounds: [min_instances, ).
 *                                                             Secondary workers - Bounds: [min_instances, ). Default: 0.
 */
function update_autoscaling_policy_sample(
    float $policyBasicAlgorithmYarnConfigScaleUpFactor,
    float $policyBasicAlgorithmYarnConfigScaleDownFactor,
    int $policyWorkerConfigMaxInstances
): void {
    // Create a client.
    $autoscalingPolicyServiceClient = new AutoscalingPolicyServiceClient();

    // Prepare the request message.
    $policyBasicAlgorithmYarnConfigGracefulDecommissionTimeout = new Duration();
    $policyBasicAlgorithmYarnConfig = (new BasicYarnAutoscalingConfig())
        ->setGracefulDecommissionTimeout($policyBasicAlgorithmYarnConfigGracefulDecommissionTimeout)
        ->setScaleUpFactor($policyBasicAlgorithmYarnConfigScaleUpFactor)
        ->setScaleDownFactor($policyBasicAlgorithmYarnConfigScaleDownFactor);
    $policyBasicAlgorithm = (new BasicAutoscalingAlgorithm())
        ->setYarnConfig($policyBasicAlgorithmYarnConfig);
    $policyWorkerConfig = (new InstanceGroupAutoscalingPolicyConfig())
        ->setMaxInstances($policyWorkerConfigMaxInstances);
    $policy = (new AutoscalingPolicy())
        ->setBasicAlgorithm($policyBasicAlgorithm)
        ->setWorkerConfig($policyWorkerConfig);
    $request = (new UpdateAutoscalingPolicyRequest())
        ->setPolicy($policy);

    // Call the API and handle any network failures.
    try {
        /** @var AutoscalingPolicy $response */
        $response = $autoscalingPolicyServiceClient->updateAutoscalingPolicy($request);
        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
{
    $policyBasicAlgorithmYarnConfigScaleUpFactor = 0.0;
    $policyBasicAlgorithmYarnConfigScaleDownFactor = 0.0;
    $policyWorkerConfigMaxInstances = 0;

    update_autoscaling_policy_sample(
        $policyBasicAlgorithmYarnConfigScaleUpFactor,
        $policyBasicAlgorithmYarnConfigScaleDownFactor,
        $policyWorkerConfigMaxInstances
    );
}

getIamPolicy

use Google\ApiCore\ApiException;
use Google\Cloud\Dataproc\V1\Client\AutoscalingPolicyServiceClient;
use Google\Cloud\Iam\V1\GetIamPolicyRequest;
use Google\Cloud\Iam\V1\Policy;

/**
 * @param string $resource REQUIRED: The resource for which the policy is being requested.
 *                         See the operation documentation for the appropriate value for this field.
 */
function get_iam_policy_sample(string $resource): void
{
    // Create a client.
    $autoscalingPolicyServiceClient = new AutoscalingPolicyServiceClient();

    // Prepare the request message.
    $request = (new GetIamPolicyRequest())
        ->setResource($resource);

    // Call the API and handle any network failures.
    try {
        /** @var Policy $response */
        $response = $autoscalingPolicyServiceClient->getIamPolicy($request);
        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
{
    $resource = '[RESOURCE]';

    get_iam_policy_sample($resource);
}

setIamPolicy

use Google\ApiCore\ApiException;
use Google\Cloud\Dataproc\V1\Client\AutoscalingPolicyServiceClient;
use Google\Cloud\Iam\V1\Policy;
use Google\Cloud\Iam\V1\SetIamPolicyRequest;

/**
 * @param string $resource REQUIRED: The resource for which the policy is being specified.
 *                         See the operation documentation for the appropriate value for this field.
 */
function set_iam_policy_sample(string $resource): void
{
    // Create a client.
    $autoscalingPolicyServiceClient = new AutoscalingPolicyServiceClient();

    // Prepare the request message.
    $policy = new Policy();
    $request = (new SetIamPolicyRequest())
        ->setResource($resource)
        ->setPolicy($policy);

    // Call the API and handle any network failures.
    try {
        /** @var Policy $response */
        $response = $autoscalingPolicyServiceClient->setIamPolicy($request);
        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
{
    $resource = '[RESOURCE]';

    set_iam_policy_sample($resource);
}

testIamPermissions

use Google\ApiCore\ApiException;
use Google\Cloud\Dataproc\V1\Client\AutoscalingPolicyServiceClient;
use Google\Cloud\Iam\V1\TestIamPermissionsRequest;
use Google\Cloud\Iam\V1\TestIamPermissionsResponse;

/**
 * @param string $resource           REQUIRED: The resource for which the policy detail is being requested.
 *                                   See the operation documentation for the appropriate value for this field.
 * @param string $permissionsElement The set of permissions to check for the `resource`. Permissions with
 *                                   wildcards (such as '*' or 'storage.*') are not allowed. For more
 *                                   information see
 *                                   [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
 */
function test_iam_permissions_sample(string $resource, string $permissionsElement): void
{
    // Create a client.
    $autoscalingPolicyServiceClient = new AutoscalingPolicyServiceClient();

    // Prepare the request message.
    $permissions = [$permissionsElement,];
    $request = (new TestIamPermissionsRequest())
        ->setResource($resource)
        ->setPermissions($permissions);

    // Call the API and handle any network failures.
    try {
        /** @var TestIamPermissionsResponse $response */
        $response = $autoscalingPolicyServiceClient->testIamPermissions($request);
        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
{
    $resource = '[RESOURCE]';
    $permissionsElement = '[PERMISSIONS]';

    test_iam_permissions_sample($resource, $permissionsElement);
}

createAutoscalingPolicyAsync

deleteAutoscalingPolicyAsync

getAutoscalingPolicyAsync

listAutoscalingPoliciesAsync

updateAutoscalingPolicyAsync

getIamPolicyAsync

setIamPolicyAsync

testIamPermissionsAsync

static::autoscalingPolicyName

static::locationName

static::projectLocationAutoscalingPolicyName

static::projectRegionAutoscalingPolicyName

static::regionName

static::parseName