Stackdriver Monitoring V3 Client - Class UptimeCheckServiceClient (1.6.0)

$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();
}

Namespace

Methods

__construct

createUptimeCheckConfig

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());
    }
}

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

    create_uptime_check_config_sample($parent);
}

deleteUptimeCheckConfig

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());
    }
}

/**
 * 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 = UptimeCheckServiceClient::uptimeCheckConfigName(
        '[PROJECT]',
        '[UPTIME_CHECK_CONFIG]'
    );

    delete_uptime_check_config_sample($formattedName);
}

getUptimeCheckConfig

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());
    }
}

/**
 * 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 = UptimeCheckServiceClient::uptimeCheckConfigName(
        '[PROJECT]',
        '[UPTIME_CHECK_CONFIG]'
    );

    get_uptime_check_config_sample($formattedName);
}

listUptimeCheckConfigs

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());
    }
}

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

    list_uptime_check_configs_sample($parent);
}

listUptimeCheckIps

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

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());
    }
}

static::projectName

static::folderUptimeCheckConfigName

static::organizationUptimeCheckConfigName

static::projectUptimeCheckConfigName

static::uptimeCheckConfigName

static::parseName

Constants

SERVICE_NAME

Value: 'google.monitoring.v3.UptimeCheckService'

SERVICE_ADDRESS

Value: 'monitoring.googleapis.com'

DEFAULT_SERVICE_PORT

Value: 443

CODEGEN_NAME

Value: 'gapic'