Stackdriver Monitoring V3 Client - Class SnoozeServiceClient (1.3.2)

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

Service Description: The SnoozeService API is used to temporarily prevent an alert policy from generating alerts. A Snooze is a description of the criteria under which one or more alert policies should not fire alerts for the specified duration.

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:

$snoozeServiceClient = new SnoozeServiceClient();
try {
    $formattedParent = $snoozeServiceClient->workspaceName('[PROJECT]');
    $snooze = new Snooze();
    $response = $snoozeServiceClient->createSnooze($formattedParent, $snooze);
} finally {
    $snoozeServiceClient->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.

Methods

projectName

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

Parameter
Name	Description
`project`	`string`

Returns
Type	Description
`string`	The formatted project resource.

snoozeName

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

Parameters
Name	Description
`project`	`string`
`snooze`	`string`

Returns
Type	Description
`string`	The formatted snooze resource.

workspaceName

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

Parameter
Name	Description
`project`	`string`

Returns
Type	Description
`string`	The formatted workspace resource.

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

project: projects/{project}
snooze: projects/{project}/snoozes/{snooze}
workspace: projects/{project}

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.

__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.

createSnooze

Creates a Snooze that will prevent alerts, which match the provided criteria, from being opened. The Snooze applies for a specific time interval.

Parameters
Name	Description
`parent`	`string` Required. The project in which a `Snooze` should be created. The format is: projects/[PROJECT_ID_OR_NUMBER]
`snooze`	`Google\Cloud\Monitoring\V3\Snooze` Required. The `Snooze` to create. Omit the `name` field, as it will be filled in by the API.
`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\Monitoring\V3\Snooze`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Monitoring\V3\Snooze;
use Google\Cloud\Monitoring\V3\SnoozeServiceClient;
use Google\Cloud\Monitoring\V3\Snooze\Criteria;
use Google\Cloud\Monitoring\V3\TimeInterval;

/**
 * @param string $formattedParent   The
 *                                  [project](https://cloud.google.com/monitoring/api/v3#project_name) in which
 *                                  a `Snooze` should be created. The format is:
 *
 *                                  projects/[PROJECT_ID_OR_NUMBER]
 *                                  Please see {@see SnoozeServiceClient::workspaceName()} for help formatting this field.
 * @param string $snoozeName        The name of the `Snooze`. The format is:
 *
 *                                  projects/[PROJECT_ID_OR_NUMBER]/snoozes/[SNOOZE_ID]
 *
 *                                  The ID of the `Snooze` will be generated by the system.
 * @param string $snoozeDisplayName A display name for the `Snooze`. This can be, at most, 512
 *                                  unicode characters.
 */
function create_snooze_sample(
    string $formattedParent,
    string $snoozeName,
    string $snoozeDisplayName
): void {
    // Create a client.
    $snoozeServiceClient = new SnoozeServiceClient();

    // Prepare any non-scalar elements to be passed along with the request.
    $snoozeCriteria = new Criteria();
    $snoozeInterval = new TimeInterval();
    $snooze = (new Snooze())
        ->setName($snoozeName)
        ->setCriteria($snoozeCriteria)
        ->setInterval($snoozeInterval)
        ->setDisplayName($snoozeDisplayName);

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

/**
 * 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 = SnoozeServiceClient::workspaceName('[PROJECT]');
    $snoozeName = '[NAME]';
    $snoozeDisplayName = '[DISPLAY_NAME]';

    create_snooze_sample($formattedParent, $snoozeName, $snoozeDisplayName);
}

getSnooze

Retrieves a Snooze by name.

Parameters
Name	Description
`name`	`string` Required. The ID of the `Snooze` to retrieve. The format is: projects/[PROJECT_ID_OR_NUMBER]/snoozes/[SNOOZE_ID]
`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\Monitoring\V3\Snooze`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Monitoring\V3\Snooze;
use Google\Cloud\Monitoring\V3\SnoozeServiceClient;

/**
 * @param string $formattedName The ID of the `Snooze` to retrieve. The format is:
 *
 *                              projects/[PROJECT_ID_OR_NUMBER]/snoozes/[SNOOZE_ID]
 *                              Please see {@see SnoozeServiceClient::snoozeName()} for help formatting this field.
 */
function get_snooze_sample(string $formattedName): void
{
    // Create a client.
    $snoozeServiceClient = new SnoozeServiceClient();

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

/**
 * 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 = SnoozeServiceClient::snoozeName('[PROJECT]', '[SNOOZE]');

    get_snooze_sample($formattedName);
}

listSnoozes

Lists the Snoozes associated with a project. Can optionally pass in filter, which specifies predicates to match Snoozes.

Parameters
Name	Description
`parent`	`string` Required. The project whose `Snooze`s should be listed. The format is: projects/[PROJECT_ID_OR_NUMBER]
`optionalArgs`	`array` Optional.
`↳ filter`	`string` Optional. Optional filter to restrict results to the given criteria. The following fields are supported. * `interval.start_time` * `interval.end_time` For example: `interval.start_time > "2022-03-11T00:00:00-08:00" AND interval.end_time < "2022-03-12T00:00:00-08:00"`
`↳ pageSize`	`int` The maximum number of resources contained in the underlying API response. The API may return fewer values in a page, even if there are additional values to be retrieved.
`↳ pageToken`	`string` A page token is used to specify a page of values to be returned. If no page token is specified (the default), the first page of values will be returned. Any page token used here must have been generated by a previous call to the API.
`↳ 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\Snooze;
use Google\Cloud\Monitoring\V3\SnoozeServiceClient;

/**
 * @param string $formattedParent The
 *                                [project](https://cloud.google.com/monitoring/api/v3#project_name) whose
 *                                `Snooze`s should be listed. The format is:
 *
 *                                projects/[PROJECT_ID_OR_NUMBER]
 *                                Please see {@see SnoozeServiceClient::workspaceName()} for help formatting this field.
 */
function list_snoozes_sample(string $formattedParent): void
{
    // Create a client.
    $snoozeServiceClient = new SnoozeServiceClient();

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

        /** @var Snooze $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());
    }
}

/**
 * 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 = SnoozeServiceClient::workspaceName('[PROJECT]');

    list_snoozes_sample($formattedParent);
}

updateSnooze

Updates a Snooze, identified by its name, with the parameters in the given Snooze object.

Parameters
Name	Description
`snooze`	`Google\Cloud\Monitoring\V3\Snooze` Required. The `Snooze` to update. Must have the name field present.
`updateMask`	`Google\Protobuf\FieldMask` Required. The fields to update. For each field listed in `update_mask`: If the `Snooze` object supplied in the `UpdateSnoozeRequest` has a value for that field, the value of the field in the existing `Snooze` will be set to the value of the field in the supplied `Snooze`. If the field does not have a value in the supplied `Snooze`, the field in the existing `Snooze` is set to its default value. Fields not listed retain their existing value. The following are the field names that are accepted in `update_mask`: `display_name` `interval.start_time` `interval.end_time` That said, the start time and end time of the `Snooze` determines which fields can legally be updated. Before attempting an update, users should consult the documentation for `UpdateSnoozeRequest`, which talks about which fields can be updated.
`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\Monitoring\V3\Snooze`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Monitoring\V3\Snooze;
use Google\Cloud\Monitoring\V3\SnoozeServiceClient;
use Google\Cloud\Monitoring\V3\Snooze\Criteria;
use Google\Cloud\Monitoring\V3\TimeInterval;
use Google\Protobuf\FieldMask;

/**
 * @param string $snoozeName        The name of the `Snooze`. The format is:
 *
 *                                  projects/[PROJECT_ID_OR_NUMBER]/snoozes/[SNOOZE_ID]
 *
 *                                  The ID of the `Snooze` will be generated by the system.
 * @param string $snoozeDisplayName A display name for the `Snooze`. This can be, at most, 512
 *                                  unicode characters.
 */
function update_snooze_sample(string $snoozeName, string $snoozeDisplayName): void
{
    // Create a client.
    $snoozeServiceClient = new SnoozeServiceClient();

    // Prepare any non-scalar elements to be passed along with the request.
    $snoozeCriteria = new Criteria();
    $snoozeInterval = new TimeInterval();
    $snooze = (new Snooze())
        ->setName($snoozeName)
        ->setCriteria($snoozeCriteria)
        ->setInterval($snoozeInterval)
        ->setDisplayName($snoozeDisplayName);
    $updateMask = new FieldMask();

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

/**
 * 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
{
    $snoozeName = '[NAME]';
    $snoozeDisplayName = '[DISPLAY_NAME]';

    update_snooze_sample($snoozeName, $snoozeDisplayName);
}

Constants

SERVICE_NAME

Value: 'google.monitoring.v3.SnoozeService'

The name of the service.

SERVICE_ADDRESS

Value: 'monitoring.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.