Stackdriver Monitoring V3 Client - Class UptimeCheckServiceClient (1.2.2)

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

Service Description: The UptimeCheckService API is used to manage (list, create, delete, edit) Uptime check configurations in the Stackdriver Monitoring product. An Uptime check is a piece of configuration that determines which resources and services to monitor for availability. These configurations can also be configured interactively by navigating to the Cloud Console, selecting the appropriate project, clicking on "Monitoring" on the left-hand side to navigate to Stackdriver, and then clicking on "Uptime".

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:

$uptimeCheckServiceClient = new Google\Cloud\Monitoring\V3\UptimeCheckServiceClient();
try {
    $parent = 'parent';
    $uptimeCheckConfig = new Google\Cloud\Monitoring\V3\UptimeCheckConfig();
    $response = $uptimeCheckServiceClient->createUptimeCheckConfig($parent, $uptimeCheckConfig);
} finally {
    $uptimeCheckServiceClient->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.

folderUptimeCheckConfigName

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

Parameters
Name	Description
`folder`	`string`
`uptimeCheckConfig`	`string`

Returns
Type	Description
`string`	The formatted folder_uptime_check_config resource.

organizationUptimeCheckConfigName

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

Parameters
Name	Description
`organization`	`string`
`uptimeCheckConfig`	`string`

Returns
Type	Description
`string`	The formatted organization_uptime_check_config resource.

projectUptimeCheckConfigName

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

Parameters
Name	Description
`project`	`string`
`uptimeCheckConfig`	`string`

Returns
Type	Description
`string`	The formatted project_uptime_check_config resource.

uptimeCheckConfigName

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

Parameters
Name	Description
`project`	`string`
`uptimeCheckConfig`	`string`

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

folderUptimeCheckConfig: folders/{folder}/uptimeCheckConfigs/{uptime_check_config}
organizationUptimeCheckConfig: organizations/{organization}/uptimeCheckConfigs/{uptime_check_config}
projectUptimeCheckConfig: projects/{project}/uptimeCheckConfigs/{uptime_check_config}
uptimeCheckConfig: projects/{project}/uptimeCheckConfigs/{uptime_check_config}

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 {@see} object or {@see} 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 {@see} .
`↳ 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 {@see} 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 {@see} and {@see} 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.

createUptimeCheckConfig

Creates a new Uptime check configuration.

Parameters
Name	Description
`parent`	`string` Required. The project in which to create the Uptime check. The format is: projects/[PROJECT_ID_OR_NUMBER]
`uptimeCheckConfig`	`Google\Cloud\Monitoring\V3\UptimeCheckConfig` Required. The new Uptime check configuration.
`optionalArgs`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a {@see} object, or an associative array of retry settings parameters. See the documentation on {@see} for example usage.

Returns
Type	Description
`Google\Cloud\Monitoring\V3\UptimeCheckConfig`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Monitoring\V3\UptimeCheckConfig;
use Google\Cloud\Monitoring\V3\UptimeCheckServiceClient;

/**
 * @param string $parent The
 *                       [project](https://cloud.google.com/monitoring/api/v3#project_name) in which
 *                       to create the Uptime check. The format is:
 *
 *                       projects/[PROJECT_ID_OR_NUMBER]
 */
function create_uptime_check_config_sample(string $parent): void
{
    // Create a client.
    $uptimeCheckServiceClient = new UptimeCheckServiceClient();

    // Prepare any non-scalar elements to be passed along with the request.
    $uptimeCheckConfig = new UptimeCheckConfig();

    // Call the API and handle any network failures.
    try {
        /** @var UptimeCheckConfig $response */
        $response = $uptimeCheckServiceClient->createUptimeCheckConfig($parent, $uptimeCheckConfig);
        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
{
    $parent = '[PARENT]';

    create_uptime_check_config_sample($parent);
}

deleteUptimeCheckConfig

Deletes an Uptime check configuration. Note that this method will fail if the Uptime check configuration is referenced by an alert policy or other dependent configs that would be rendered invalid by the deletion.

Parameters
Name	Description
`name`	`string` Required. The Uptime check configuration to delete. The format is: projects/[PROJECT_ID_OR_NUMBER]/uptimeCheckConfigs/[UPTIME_CHECK_ID]
`optionalArgs`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a {@see} object, or an associative array of retry settings parameters. See the documentation on {@see} for example usage.

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Monitoring\V3\UptimeCheckServiceClient;

/**
 * @param string $formattedName The Uptime check configuration to delete. The format is:
 *
 *                              projects/[PROJECT_ID_OR_NUMBER]/uptimeCheckConfigs/[UPTIME_CHECK_ID]
 *                              Please see {@see UptimeCheckServiceClient::uptimeCheckConfigName()} for help formatting this field.
 */
function delete_uptime_check_config_sample(string $formattedName): void
{
    // Create a client.
    $uptimeCheckServiceClient = new UptimeCheckServiceClient();

    // Call the API and handle any network failures.
    try {
        $uptimeCheckServiceClient->deleteUptimeCheckConfig($formattedName);
        printf('Call completed successfully.' . PHP_EOL);
    } 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 = UptimeCheckServiceClient::uptimeCheckConfigName(
        '[PROJECT]',
        '[UPTIME_CHECK_CONFIG]'
    );

    delete_uptime_check_config_sample($formattedName);
}

getUptimeCheckConfig

Gets a single Uptime check configuration.

Parameters
Name	Description
`name`	`string` Required. The Uptime check configuration to retrieve. The format is: projects/[PROJECT_ID_OR_NUMBER]/uptimeCheckConfigs/[UPTIME_CHECK_ID]
`optionalArgs`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a {@see} object, or an associative array of retry settings parameters. See the documentation on {@see} for example usage.

Returns
Type	Description
`Google\Cloud\Monitoring\V3\UptimeCheckConfig`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Monitoring\V3\UptimeCheckConfig;
use Google\Cloud\Monitoring\V3\UptimeCheckServiceClient;

/**
 * @param string $formattedName The Uptime check configuration to retrieve. The format is:
 *
 *                              projects/[PROJECT_ID_OR_NUMBER]/uptimeCheckConfigs/[UPTIME_CHECK_ID]
 *                              Please see {@see UptimeCheckServiceClient::uptimeCheckConfigName()} for help formatting this field.
 */
function get_uptime_check_config_sample(string $formattedName): void
{
    // Create a client.
    $uptimeCheckServiceClient = new UptimeCheckServiceClient();

    // Call the API and handle any network failures.
    try {
        /** @var UptimeCheckConfig $response */
        $response = $uptimeCheckServiceClient->getUptimeCheckConfig($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 = UptimeCheckServiceClient::uptimeCheckConfigName(
        '[PROJECT]',
        '[UPTIME_CHECK_CONFIG]'
    );

    get_uptime_check_config_sample($formattedName);
}

listUptimeCheckConfigs

Lists the existing valid Uptime check configurations for the project (leaving out any invalid configurations).

Parameters
Name	Description
`parent`	`string` Required. The project whose Uptime check configurations are listed. The format is: projects/[PROJECT_ID_OR_NUMBER]
`optionalArgs`	`array` Optional.
`↳ 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 {@see} object, or an associative array of retry settings parameters. See the documentation on {@see} for example usage.

Returns
Type	Description
`Google\ApiCore\PagedListResponse`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Monitoring\V3\UptimeCheckConfig;
use Google\Cloud\Monitoring\V3\UptimeCheckServiceClient;

/**
 * @param string $parent The
 *                       [project](https://cloud.google.com/monitoring/api/v3#project_name) whose
 *                       Uptime check configurations are listed. The format is:
 *
 *                       projects/[PROJECT_ID_OR_NUMBER]
 */
function list_uptime_check_configs_sample(string $parent): void
{
    // Create a client.
    $uptimeCheckServiceClient = new UptimeCheckServiceClient();

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

        /** @var UptimeCheckConfig $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
{
    $parent = '[PARENT]';

    list_uptime_check_configs_sample($parent);
}

listUptimeCheckIps

Returns the list of IP addresses that checkers run from

Parameters
Name	Description
`optionalArgs`	`array` Optional.
`↳ 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 {@see} object, or an associative array of retry settings parameters. See the documentation on {@see} for example usage.

Returns
Type	Description
`Google\ApiCore\PagedListResponse`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Monitoring\V3\UptimeCheckIp;
use Google\Cloud\Monitoring\V3\UptimeCheckServiceClient;

/**
 * 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 list_uptime_check_ips_sample(): void
{
    // Create a client.
    $uptimeCheckServiceClient = new UptimeCheckServiceClient();

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

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

updateUptimeCheckConfig

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

Returns the updated configuration.

Parameters
Name	Description
`uptimeCheckConfig`	`Google\Cloud\Monitoring\V3\UptimeCheckConfig` Required. If an `updateMask` has been specified, this field gives the values for the set of fields mentioned in the `updateMask`. If an `updateMask` has not been given, this Uptime check configuration replaces the current configuration. If a field is mentioned in `updateMask` but the corresonding field is omitted in this partial Uptime check configuration, it has the effect of deleting/clearing the field from the configuration on the server. The following fields can be updated: `display_name`, `http_check`, `tcp_check`, `timeout`, `content_matchers`, and `selected_regions`.
`optionalArgs`	`array` Optional.
`↳ updateMask`	`FieldMask` Optional. If present, only the listed fields in the current Uptime check configuration are updated with values from the new configuration. If this field is empty, then the current configuration is completely replaced with the new configuration.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a {@see} object, or an associative array of retry settings parameters. See the documentation on {@see} for example usage.

Returns
Type	Description
`Google\Cloud\Monitoring\V3\UptimeCheckConfig`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Monitoring\V3\UptimeCheckConfig;
use Google\Cloud\Monitoring\V3\UptimeCheckServiceClient;

/**
 * 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_uptime_check_config_sample(): void
{
    // Create a client.
    $uptimeCheckServiceClient = new UptimeCheckServiceClient();

    // Prepare any non-scalar elements to be passed along with the request.
    $uptimeCheckConfig = new UptimeCheckConfig();

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

Constants

SERVICE_NAME

Value: 'google.monitoring.v3.UptimeCheckService'

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.