Stackdriver Monitoring V3 Client - Class MetricServiceClient (1.8.0)

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

Service Description: Manages metric descriptors, monitored resource descriptors, and time series data.

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:

$metricServiceClient = new Google\Cloud\Monitoring\V3\MetricServiceClient();
try {
    $name = 'name';
    $metricDescriptor = new Google\Cloud\Monitoring\V3\MetricDescriptor();
    $response = $metricServiceClient->createMetricDescriptor($name, $metricDescriptor);
} finally {
    $metricServiceClient->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.

This service has a new (beta) implementation. See Google\Cloud\Monitoring\V3\Client\MetricServiceClient to use the new surface.

Namespace

Google \ Cloud \ Monitoring \ V3

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.

createMetricDescriptor

Creates a new metric descriptor.

The creation is executed asynchronously and callers may check the returned operation to track its progress. User-created metric descriptors define custom metrics.

Parameters
Name	Description
`name`	`string` Required. The project on which to execute the request. The format is: 4 projects/[PROJECT_ID_OR_NUMBER]
`metricDescriptor`	`Google\Api\MetricDescriptor` Required. The new custom metric descriptor.
`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\Api\MetricDescriptor`

Example

use Google\ApiCore\ApiException;
use Google\Api\MetricDescriptor;
use Google\Cloud\Monitoring\V3\MetricServiceClient;

/**
 * @param string $name The [project](https://cloud.google.com/monitoring/api/v3#project_name) on
 *                     which to execute the request. The format is:
 *                     4
 *                     projects/[PROJECT_ID_OR_NUMBER]
 */
function create_metric_descriptor_sample(string $name): void
{
    // Create a client.
    $metricServiceClient = new MetricServiceClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var MetricDescriptor $response */
        $response = $metricServiceClient->createMetricDescriptor($name, $metricDescriptor);
        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_metric_descriptor_sample($name);
}

createServiceTimeSeries

Creates or adds data to one or more service time series. A service time series is a time series for a metric from a Google Cloud service. The response is empty if all time series in the request were written. If any time series could not be written, a corresponding failure message is included in the error response. This endpoint rejects writes to user-defined metrics.

This method is only for use by Google Cloud services. Use projects.timeSeries.create instead.

Parameters
Name	Description
`name`	`string` Required. The project on which to execute the request. The format is: projects/[PROJECT_ID_OR_NUMBER]
`timeSeries`	`array<Google\Cloud\Monitoring\V3\TimeSeries>` Required. The new data to be added to a list of time series. Adds at most one data point to each of several time series. The new data point must be more recent than any other point in its time series. Each `TimeSeries` value must fully specify a unique time series by supplying all label values for the metric and the monitored resource. The maximum number of `TimeSeries` objects per `Create` request is 200.
`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.

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Monitoring\V3\MetricServiceClient;
use Google\Cloud\Monitoring\V3\TimeSeries;

/**
 * @param string $formattedName The [project](https://cloud.google.com/monitoring/api/v3#project_name) on
 *                              which to execute the request. The format is:
 *
 *                              projects/[PROJECT_ID_OR_NUMBER]
 *                              Please see {@see MetricServiceClient::projectName()} for help formatting this field.
 */
function create_service_time_series_sample(string $formattedName): void
{
    // Create a client.
    $metricServiceClient = new MetricServiceClient();

    // Prepare any non-scalar elements to be passed along with the request.
    $timeSeries = [new TimeSeries()];

    // Call the API and handle any network failures.
    try {
        $metricServiceClient->createServiceTimeSeries($formattedName, $timeSeries);
        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 = MetricServiceClient::projectName('[PROJECT]');

    create_service_time_series_sample($formattedName);
}

createTimeSeries

Creates or adds data to one or more time series.

The response is empty if all time series in the request were written. If any time series could not be written, a corresponding failure message is included in the error response.

Parameters
Name	Description
`name`	`string` Required. The project on which to execute the request. The format is: projects/[PROJECT_ID_OR_NUMBER]
`timeSeries`	`array<Google\Cloud\Monitoring\V3\TimeSeries>` Required. The new data to be added to a list of time series. Adds at most one data point to each of several time series. The new data point must be more recent than any other point in its time series. Each `TimeSeries` value must fully specify a unique time series by supplying all label values for the metric and the monitored resource. The maximum number of `TimeSeries` objects per `Create` request is 200.
`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.

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Monitoring\V3\MetricServiceClient;
use Google\Cloud\Monitoring\V3\TimeSeries;

/**
 * @param string $formattedName The [project](https://cloud.google.com/monitoring/api/v3#project_name) on
 *                              which to execute the request. The format is:
 *
 *                              projects/[PROJECT_ID_OR_NUMBER]
 *                              Please see {@see MetricServiceClient::projectName()} for help formatting this field.
 */
function create_time_series_sample(string $formattedName): void
{
    // Create a client.
    $metricServiceClient = new MetricServiceClient();

    // Prepare any non-scalar elements to be passed along with the request.
    $timeSeries = [new TimeSeries()];

    // Call the API and handle any network failures.
    try {
        $metricServiceClient->createTimeSeries($formattedName, $timeSeries);
        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 = MetricServiceClient::projectName('[PROJECT]');

    create_time_series_sample($formattedName);
}

deleteMetricDescriptor

Deletes a metric descriptor. Only user-created custom metrics can be deleted.

Parameters
Name	Description
`name`	`string` Required. The metric descriptor on which to execute the request. The format is: projects/[PROJECT_ID_OR_NUMBER]/metricDescriptors/[METRIC_ID] An example of `[METRIC_ID]` is: `"custom.googleapis.com/my_test_metric"`.
`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.

Example

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

/**
 * @param string $formattedName The metric descriptor on which to execute the request. The format is:
 *
 *                              projects/[PROJECT_ID_OR_NUMBER]/metricDescriptors/[METRIC_ID]
 *
 *                              An example of `[METRIC_ID]` is:
 *                              `"custom.googleapis.com/my_test_metric"`. Please see
 *                              {@see MetricServiceClient::metricDescriptorName()} for help formatting this field.
 */
function delete_metric_descriptor_sample(string $formattedName): void
{
    // Create a client.
    $metricServiceClient = new MetricServiceClient();

    // Call the API and handle any network failures.
    try {
        $metricServiceClient->deleteMetricDescriptor($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 = MetricServiceClient::metricDescriptorName('[PROJECT]', '[METRIC_DESCRIPTOR]');

    delete_metric_descriptor_sample($formattedName);
}

getMetricDescriptor

Gets a single metric descriptor. This method does not require a Workspace.

Parameters
Name	Description
`name`	`string` Required. The metric descriptor on which to execute the request. The format is: projects/[PROJECT_ID_OR_NUMBER]/metricDescriptors/[METRIC_ID] An example value of `[METRIC_ID]` is `"compute.googleapis.com/instance/disk/read_bytes_count"`.
`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\Api\MetricDescriptor`

Example

use Google\ApiCore\ApiException;
use Google\Api\MetricDescriptor;
use Google\Cloud\Monitoring\V3\MetricServiceClient;

/**
 * @param string $formattedName The metric descriptor on which to execute the request. The format is:
 *
 *                              projects/[PROJECT_ID_OR_NUMBER]/metricDescriptors/[METRIC_ID]
 *
 *                              An example value of `[METRIC_ID]` is
 *                              `"compute.googleapis.com/instance/disk/read_bytes_count"`. Please see
 *                              {@see MetricServiceClient::metricDescriptorName()} for help formatting this field.
 */
function get_metric_descriptor_sample(string $formattedName): void
{
    // Create a client.
    $metricServiceClient = new MetricServiceClient();

    // Call the API and handle any network failures.
    try {
        /** @var MetricDescriptor $response */
        $response = $metricServiceClient->getMetricDescriptor($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 = MetricServiceClient::metricDescriptorName('[PROJECT]', '[METRIC_DESCRIPTOR]');

    get_metric_descriptor_sample($formattedName);
}

getMonitoredResourceDescriptor

Gets a single monitored resource descriptor. This method does not require a Workspace.

Parameters
Name	Description
`name`	`string` Required. The monitored resource descriptor to get. The format is: projects/[PROJECT_ID_OR_NUMBER]/monitoredResourceDescriptors/[RESOURCE_TYPE] The `[RESOURCE_TYPE]` is a predefined type, such as `cloudsql_database`.
`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\Api\MonitoredResourceDescriptor`

Example

use Google\ApiCore\ApiException;
use Google\Api\MonitoredResourceDescriptor;
use Google\Cloud\Monitoring\V3\MetricServiceClient;

/**
 * @param string $formattedName The monitored resource descriptor to get.  The format is:
 *
 *                              projects/[PROJECT_ID_OR_NUMBER]/monitoredResourceDescriptors/[RESOURCE_TYPE]
 *
 *                              The `[RESOURCE_TYPE]` is a predefined type, such as
 *                              `cloudsql_database`. Please see
 *                              {@see MetricServiceClient::monitoredResourceDescriptorName()} for help formatting this field.
 */
function get_monitored_resource_descriptor_sample(string $formattedName): void
{
    // Create a client.
    $metricServiceClient = new MetricServiceClient();

    // Call the API and handle any network failures.
    try {
        /** @var MonitoredResourceDescriptor $response */
        $response = $metricServiceClient->getMonitoredResourceDescriptor($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 = MetricServiceClient::monitoredResourceDescriptorName(
        '[PROJECT]',
        '[MONITORED_RESOURCE_DESCRIPTOR]'
    );

    get_monitored_resource_descriptor_sample($formattedName);
}

listMetricDescriptors

Lists metric descriptors that match a filter. This method does not require a Workspace.

Parameters
Name	Description
`name`	`string` Required. The project on which to execute the request. The format is: projects/[PROJECT_ID_OR_NUMBER]
`optionalArgs`	`array` Optional.
`↳ filter`	`string` If this field is empty, all custom and system-defined metric descriptors are returned. Otherwise, the filter specifies which metric descriptors are to be returned. For example, the following filter matches all custom metrics: metric.type = starts_with("custom.googleapis.com/")
`↳ 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\Api\MetricDescriptor;
use Google\Cloud\Monitoring\V3\MetricServiceClient;

/**
 * @param string $name The [project](https://cloud.google.com/monitoring/api/v3#project_name) on
 *                     which to execute the request. The format is:
 *
 *                     projects/[PROJECT_ID_OR_NUMBER]
 */
function list_metric_descriptors_sample(string $name): void
{
    // Create a client.
    $metricServiceClient = new MetricServiceClient();

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

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

listMonitoredResourceDescriptors

Lists monitored resource descriptors that match a filter. This method does not require a Workspace.

Parameters
Name	Description
`name`	`string` Required. The project on which to execute the request. The format is: projects/[PROJECT_ID_OR_NUMBER]
`optionalArgs`	`array` Optional.
`↳ filter`	`string` An optional filter describing the descriptors to be returned. The filter can reference the descriptor's type and labels. For example, the following filter returns only Google Compute Engine descriptors that have an `id` label: resource.type = starts_with("gce_") AND resource.label:id
`↳ 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\Api\MonitoredResourceDescriptor;
use Google\Cloud\Monitoring\V3\MetricServiceClient;

/**
 * @param string $name The [project](https://cloud.google.com/monitoring/api/v3#project_name) on
 *                     which to execute the request. The format is:
 *
 *                     projects/[PROJECT_ID_OR_NUMBER]
 */
function list_monitored_resource_descriptors_sample(string $name): void
{
    // Create a client.
    $metricServiceClient = new MetricServiceClient();

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

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

listTimeSeries

Lists time series that match a filter. This method does not require a Workspace.

Parameters
Name	Description
`name`	`string` Required. The project, organization or folder on which to execute the request. The format is: projects/[PROJECT_ID_OR_NUMBER] organizations/[ORGANIZATION_ID] folders/[FOLDER_ID]
`filter`	`string` Required. A monitoring filter that specifies which time series should be returned. The filter must specify a single metric type, and can additionally specify metric labels and other information. For example: metric.type = "compute.googleapis.com/instance/cpu/usage_time" AND metric.labels.instance_name = "my-instance-name"
`interval`	`Google\Cloud\Monitoring\V3\TimeInterval` Required. The time interval for which results should be returned. Only time series that contain data points in the specified interval are included in the response.
`view`	`int` Required. Specifies which information is returned about the time series. For allowed values, use constants defined on Google\Cloud\Monitoring\V3\ListTimeSeriesRequest\TimeSeriesView
`optionalArgs`	`array` Optional.
`↳ aggregation`	`Aggregation` Specifies the alignment of data points in individual time series as well as how to combine the retrieved time series across specified labels. By default (if no `aggregation` is explicitly specified), the raw time series data is returned.
`↳ secondaryAggregation`	`Aggregation` Apply a second aggregation after `aggregation` is applied. May only be specified if `aggregation` is specified.
`↳ orderBy`	`string` Unsupported: must be left blank. The points in each time series are currently returned in reverse time order (most recent to oldest).
`↳ 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\ListTimeSeriesRequest\TimeSeriesView;
use Google\Cloud\Monitoring\V3\MetricServiceClient;
use Google\Cloud\Monitoring\V3\TimeInterval;
use Google\Cloud\Monitoring\V3\TimeSeries;

/**
 * @param string $formattedName The [project](https://cloud.google.com/monitoring/api/v3#project_name),
 *                              organization or folder on which to execute the request. The format is:
 *
 *                              projects/[PROJECT_ID_OR_NUMBER]
 *                              organizations/[ORGANIZATION_ID]
 *                              folders/[FOLDER_ID]
 *                              Please see {@see MetricServiceClient::workspaceName()} for help formatting this field.
 * @param string $filter        A [monitoring filter](https://cloud.google.com/monitoring/api/v3/filters)
 *                              that specifies which time series should be returned.  The filter must
 *                              specify a single metric type, and can additionally specify metric labels
 *                              and other information. For example:
 *
 *                              metric.type = "compute.googleapis.com/instance/cpu/usage_time" AND
 *                              metric.labels.instance_name = "my-instance-name"
 * @param int    $view          Specifies which information is returned about the time series.
 */
function list_time_series_sample(string $formattedName, string $filter, int $view): void
{
    // Create a client.
    $metricServiceClient = new MetricServiceClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $metricServiceClient->listTimeSeries($formattedName, $filter, $interval, $view);

        /** @var TimeSeries $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
{
    $formattedName = MetricServiceClient::workspaceName('[PROJECT]');
    $filter = '[FILTER]';
    $view = TimeSeriesView::FULL;

    list_time_series_sample($formattedName, $filter, $view);
}

static::folderName

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

Parameter
Name	Description
`folder`	`string`

Returns
Type	Description
`string`	The formatted folder resource.

static::folderMetricDescriptorName

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

Parameters
Name	Description
`folder`	`string`
`metricDescriptor`	`string`

Returns
Type	Description
`string`	The formatted folder_metric_descriptor resource.

static::folderMonitoredResourceDescriptorName

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

Parameters
Name	Description
`folder`	`string`
`monitoredResourceDescriptor`	`string`

Returns
Type	Description
`string`	The formatted folder_monitored_resource_descriptor resource.

static::metricDescriptorName

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

Parameters
Name	Description
`project`	`string`
`metricDescriptor`	`string`

Returns
Type	Description
`string`	The formatted metric_descriptor resource.

static::monitoredResourceDescriptorName

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

Parameters
Name	Description
`project`	`string`
`monitoredResourceDescriptor`	`string`

Returns
Type	Description
`string`	The formatted monitored_resource_descriptor resource.

static::organizationName

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

Parameter
Name	Description
`organization`	`string`

Returns
Type	Description
`string`	The formatted organization resource.

static::organizationMetricDescriptorName

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

Parameters
Name	Description
`organization`	`string`
`metricDescriptor`	`string`

Returns
Type	Description
`string`	The formatted organization_metric_descriptor resource.

static::organizationMonitoredResourceDescriptorName

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

Parameters
Name	Description
`organization`	`string`
`monitoredResourceDescriptor`	`string`

Returns
Type	Description
`string`	The formatted organization_monitored_resource_descriptor resource.

static::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.

static::projectMetricDescriptorName

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

Parameters
Name	Description
`project`	`string`
`metricDescriptor`	`string`

Returns
Type	Description
`string`	The formatted project_metric_descriptor resource.

static::projectMonitoredResourceDescriptorName

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

Parameters
Name	Description
`project`	`string`
`monitoredResourceDescriptor`	`string`

Returns
Type	Description
`string`	The formatted project_monitored_resource_descriptor resource.

static::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.

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

folder: folders/{folder}
folderMetricDescriptor: folders/{folder}/metricDescriptors/{metric_descriptor=**}
folderMonitoredResourceDescriptor: folders/{folder}/monitoredResourceDescriptors/{monitored_resource_descriptor}
metricDescriptor: projects/{project}/metricDescriptors/{metric_descriptor=**}
monitoredResourceDescriptor: projects/{project}/monitoredResourceDescriptors/{monitored_resource_descriptor}
organization: organizations/{organization}
organizationMetricDescriptor: organizations/{organization}/metricDescriptors/{metric_descriptor=**}
organizationMonitoredResourceDescriptor: organizations/{organization}/monitoredResourceDescriptors/{monitored_resource_descriptor}
project: projects/{project}
projectMetricDescriptor: projects/{project}/metricDescriptors/{metric_descriptor=**}
projectMonitoredResourceDescriptor: projects/{project}/monitoredResourceDescriptors/{monitored_resource_descriptor}
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.

Constants

SERVICE_NAME

Value: 'google.monitoring.v3.MetricService'

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.