Stackdriver Monitoring V3 Client - Class AlertPolicyServiceClient (1.11.0)

Reference documentation and code samples for the Stackdriver Monitoring V3 Client class AlertPolicyServiceClient.

Service Description: The AlertPolicyService API is used to manage (list, create, delete, edit) alert policies in Cloud Monitoring. An alerting policy is a description of the conditions under which some aspect of your system is considered to be "unhealthy" and the ways to notify people or services about this state. In addition to using this API, alert policies can also be managed through Cloud Monitoring, which can be reached by clicking the "Monitoring" tab in Cloud console.

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.

Namespace

Google \ Cloud \ Monitoring \ V3 \ 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.

createAlertPolicy

Creates a new alerting policy.

Design your application to single-thread API calls that modify the state of alerting policies in a single project. This includes calls to CreateAlertPolicy, DeleteAlertPolicy and UpdateAlertPolicy.

The async variant is Google\Cloud\Monitoring\V3\Client\AlertPolicyServiceClient::createAlertPolicyAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Monitoring\V3\CreateAlertPolicyRequest` 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\Monitoring\V3\AlertPolicy`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Monitoring\V3\AlertPolicy;
use Google\Cloud\Monitoring\V3\Client\AlertPolicyServiceClient;
use Google\Cloud\Monitoring\V3\CreateAlertPolicyRequest;

/**
 * @param string $name The
 *                     [project](https://cloud.google.com/monitoring/api/v3#project_name) in which
 *                     to create the alerting policy. The format is:
 *
 *                     projects/[PROJECT_ID_OR_NUMBER]
 *
 *                     Note that this field names the parent container in which the alerting
 *                     policy will be written, not the name of the created policy. |name| must be
 *                     a host project of a Metrics Scope, otherwise INVALID_ARGUMENT error will
 *                     return. The alerting policy that is returned will have a name that contains
 *                     a normalized representation of this name as a prefix but adds a suffix of
 *                     the form `/alertPolicies/[ALERT_POLICY_ID]`, identifying the policy in the
 *                     container.
 */
function create_alert_policy_sample(string $name): void
{
    // Create a client.
    $alertPolicyServiceClient = new AlertPolicyServiceClient();

    // Prepare the request message.
    $alertPolicy = new AlertPolicy();
    $request = (new CreateAlertPolicyRequest())
        ->setName($name)
        ->setAlertPolicy($alertPolicy);

    // Call the API and handle any network failures.
    try {
        /** @var AlertPolicy $response */
        $response = $alertPolicyServiceClient->createAlertPolicy($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
{
    $name = '[NAME]';

    create_alert_policy_sample($name);
}

deleteAlertPolicy

Deletes an alerting policy.

Design your application to single-thread API calls that modify the state of alerting policies in a single project. This includes calls to CreateAlertPolicy, DeleteAlertPolicy and UpdateAlertPolicy.

The async variant is Google\Cloud\Monitoring\V3\Client\AlertPolicyServiceClient::deleteAlertPolicyAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Monitoring\V3\DeleteAlertPolicyRequest` 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.

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Monitoring\V3\Client\AlertPolicyServiceClient;
use Google\Cloud\Monitoring\V3\DeleteAlertPolicyRequest;

/**
 * @param string $formattedName The alerting policy to delete. The format is:
 *
 *                              projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[ALERT_POLICY_ID]
 *
 *                              For more information, see [AlertPolicy][google.monitoring.v3.AlertPolicy]. Please see
 *                              {@see AlertPolicyServiceClient::alertPolicyName()} for help formatting this field.
 */
function delete_alert_policy_sample(string $formattedName): void
{
    // Create a client.
    $alertPolicyServiceClient = new AlertPolicyServiceClient();

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

    // Call the API and handle any network failures.
    try {
        $alertPolicyServiceClient->deleteAlertPolicy($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 = AlertPolicyServiceClient::alertPolicyName('[PROJECT]', '[ALERT_POLICY]');

    delete_alert_policy_sample($formattedName);
}

getAlertPolicy

Gets a single alerting policy.

The async variant is Google\Cloud\Monitoring\V3\Client\AlertPolicyServiceClient::getAlertPolicyAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Monitoring\V3\GetAlertPolicyRequest` 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\Monitoring\V3\AlertPolicy`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Monitoring\V3\AlertPolicy;
use Google\Cloud\Monitoring\V3\Client\AlertPolicyServiceClient;
use Google\Cloud\Monitoring\V3\GetAlertPolicyRequest;

/**
 * @param string $formattedName The alerting policy to retrieve. The format is:
 *
 *                              projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[ALERT_POLICY_ID]
 *                              Please see {@see AlertPolicyServiceClient::alertPolicyName()} for help formatting this field.
 */
function get_alert_policy_sample(string $formattedName): void
{
    // Create a client.
    $alertPolicyServiceClient = new AlertPolicyServiceClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var AlertPolicy $response */
        $response = $alertPolicyServiceClient->getAlertPolicy($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 = AlertPolicyServiceClient::alertPolicyName('[PROJECT]', '[ALERT_POLICY]');

    get_alert_policy_sample($formattedName);
}

listAlertPolicies

Lists the existing alerting policies for the workspace.

The async variant is Google\Cloud\Monitoring\V3\Client\AlertPolicyServiceClient::listAlertPoliciesAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Monitoring\V3\ListAlertPoliciesRequest` 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`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Monitoring\V3\AlertPolicy;
use Google\Cloud\Monitoring\V3\Client\AlertPolicyServiceClient;
use Google\Cloud\Monitoring\V3\ListAlertPoliciesRequest;

/**
 * @param string $name The
 *                     [project](https://cloud.google.com/monitoring/api/v3#project_name) whose
 *                     alert policies are to be listed. The format is:
 *
 *                     projects/[PROJECT_ID_OR_NUMBER]
 *
 *                     Note that this field names the parent container in which the alerting
 *                     policies to be listed are stored. To retrieve a single alerting policy
 *                     by name, use the
 *                     [GetAlertPolicy][google.monitoring.v3.AlertPolicyService.GetAlertPolicy]
 *                     operation, instead.
 */
function list_alert_policies_sample(string $name): void
{
    // Create a client.
    $alertPolicyServiceClient = new AlertPolicyServiceClient();

    // Prepare the request message.
    $request = (new ListAlertPoliciesRequest())
        ->setName($name);

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

        /** @var AlertPolicy $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
{
    $name = '[NAME]';

    list_alert_policies_sample($name);
}

updateAlertPolicy

Updates an alerting policy. You can either replace the entire policy with a new one or replace only certain fields in the current alerting policy by specifying the fields to be updated via updateMask. Returns the updated alerting policy.

Design your application to single-thread API calls that modify the state of alerting policies in a single project. This includes calls to CreateAlertPolicy, DeleteAlertPolicy and UpdateAlertPolicy.

The async variant is Google\Cloud\Monitoring\V3\Client\AlertPolicyServiceClient::updateAlertPolicyAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Monitoring\V3\UpdateAlertPolicyRequest` 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\Monitoring\V3\AlertPolicy`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Monitoring\V3\AlertPolicy;
use Google\Cloud\Monitoring\V3\Client\AlertPolicyServiceClient;
use Google\Cloud\Monitoring\V3\UpdateAlertPolicyRequest;

/**
 * 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 update_alert_policy_sample(): void
{
    // Create a client.
    $alertPolicyServiceClient = new AlertPolicyServiceClient();

    // Prepare the request message.
    $alertPolicy = new AlertPolicy();
    $request = (new UpdateAlertPolicyRequest())
        ->setAlertPolicy($alertPolicy);

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

createAlertPolicyAsync

Parameters
Name	Description
`request`	`Google\Cloud\Monitoring\V3\CreateAlertPolicyRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

deleteAlertPolicyAsync

Parameters
Name	Description
`request`	`Google\Cloud\Monitoring\V3\DeleteAlertPolicyRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

getAlertPolicyAsync

Parameters
Name	Description
`request`	`Google\Cloud\Monitoring\V3\GetAlertPolicyRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

listAlertPoliciesAsync

Parameters
Name	Description
`request`	`Google\Cloud\Monitoring\V3\ListAlertPoliciesRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

updateAlertPolicyAsync

Parameters
Name	Description
`request`	`Google\Cloud\Monitoring\V3\UpdateAlertPolicyRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

static::alertPolicyName

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

Parameters
Name	Description
`project`	`string`
`alertPolicy`	`string`

Returns
Type	Description
`string`	The formatted alert_policy resource.

static::alertPolicyConditionName

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

Parameters
Name	Description
`project`	`string`
`alertPolicy`	`string`
`condition`	`string`

Returns
Type	Description
`string`	The formatted alert_policy_condition resource.

static::folderAlertPolicyName

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

Parameters
Name	Description
`folder`	`string`
`alertPolicy`	`string`

Returns
Type	Description
`string`	The formatted folder_alert_policy resource.

static::folderAlertPolicyConditionName

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

Parameters
Name	Description
`folder`	`string`
`alertPolicy`	`string`
`condition`	`string`

Returns
Type	Description
`string`	The formatted folder_alert_policy_condition resource.

static::organizationAlertPolicyName

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

Parameters
Name	Description
`organization`	`string`
`alertPolicy`	`string`

Returns
Type	Description
`string`	The formatted organization_alert_policy resource.

static::organizationAlertPolicyConditionName

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

Parameters
Name	Description
`organization`	`string`
`alertPolicy`	`string`
`condition`	`string`

Returns
Type	Description
`string`	The formatted organization_alert_policy_condition resource.

static::projectAlertPolicyName

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

Parameters
Name	Description
`project`	`string`
`alertPolicy`	`string`

Returns
Type	Description
`string`	The formatted project_alert_policy resource.

static::projectAlertPolicyConditionName

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

Parameters
Name	Description
`project`	`string`
`alertPolicy`	`string`
`condition`	`string`

Returns
Type	Description
`string`	The formatted project_alert_policy_condition 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

alertPolicy: projects/{project}/alertPolicies/{alert_policy}
alertPolicyCondition: projects/{project}/alertPolicies/{alert_policy}/conditions/{condition}
folderAlertPolicy: folders/{folder}/alertPolicies/{alert_policy}
folderAlertPolicyCondition: folders/{folder}/alertPolicies/{alert_policy}/conditions/{condition}
organizationAlertPolicy: organizations/{organization}/alertPolicies/{alert_policy}
organizationAlertPolicyCondition: organizations/{organization}/alertPolicies/{alert_policy}/conditions/{condition}
projectAlertPolicy: projects/{project}/alertPolicies/{alert_policy}
projectAlertPolicyCondition: projects/{project}/alertPolicies/{alert_policy}/conditions/{condition}

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.