Stackdriver Logging V2 Client - Class MetricsServiceV2Client (1.27.1)

Reference documentation and code samples for the Stackdriver Logging V2 Client class MetricsServiceV2Client.

Service Description: Service for configuring logs-based metrics.

This class is currently experimental and may be subject to changes.

Namespace

Google \ Cloud \ Logging \ V2 \ 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.

createLogMetric

Creates a logs-based metric.

The async variant is Google\Cloud\Logging\V2\Client\BaseClient\self::createLogMetricAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Logging\V2\CreateLogMetricRequest` 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\Logging\V2\LogMetric`

deleteLogMetric

Deletes a logs-based metric.

The async variant is Google\Cloud\Logging\V2\Client\BaseClient\self::deleteLogMetricAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Logging\V2\DeleteLogMetricRequest` 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.

getLogMetric

Gets a logs-based metric.

The async variant is Google\Cloud\Logging\V2\Client\BaseClient\self::getLogMetricAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Logging\V2\GetLogMetricRequest` 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\Logging\V2\LogMetric`

listLogMetrics

Lists logs-based metrics.

The async variant is Google\Cloud\Logging\V2\Client\BaseClient\self::listLogMetricsAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Logging\V2\ListLogMetricsRequest` 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`

updateLogMetric

Creates or updates a logs-based metric.

The async variant is Google\Cloud\Logging\V2\Client\BaseClient\self::updateLogMetricAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Logging\V2\UpdateLogMetricRequest` 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\Logging\V2\LogMetric`

createLogMetricAsync

Parameters
Name	Description
`request`	`Google\Cloud\Logging\V2\CreateLogMetricRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

deleteLogMetricAsync

Parameters
Name	Description
`request`	`Google\Cloud\Logging\V2\DeleteLogMetricRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

getLogMetricAsync

Parameters
Name	Description
`request`	`Google\Cloud\Logging\V2\GetLogMetricRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

listLogMetricsAsync

Parameters
Name	Description
`request`	`Google\Cloud\Logging\V2\ListLogMetricsRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

updateLogMetricAsync

Parameters
Name	Description
`request`	`Google\Cloud\Logging\V2\UpdateLogMetricRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

static::logMetricName

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

Parameters
Name	Description
`project`	`string`
`metric`	`string`

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

logMetric: projects/{project}/metrics/{metric}
project: 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.