Stackdriver Monitoring V3 Client - Class ServiceMonitoringServiceClient (1.7.1)

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

Service Description: The Cloud Monitoring Service-Oriented Monitoring API has endpoints for managing and querying aspects of a workspace's services. These include the Service's monitored resources, its Service-Level Objectives, and a taxonomy of categorized Health Metrics.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods.

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 class is currently experimental and may be subject to changes. See Google\Cloud\Monitoring\V3\ServiceMonitoringServiceClient for the stable implementation

Namespace

Google \ Cloud \ Monitoring \ V3 \ 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.

createService

Create a Service.

The async variant is Google\Cloud\Monitoring\V3\Client\ServiceMonitoringServiceClient::createServiceAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Monitoring\V3\CreateServiceRequest` 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\Monitoring\V3\Service`

createServiceLevelObjective

Create a ServiceLevelObjective for the given Service.

The async variant is Google\Cloud\Monitoring\V3\Client\ServiceMonitoringServiceClient::createServiceLevelObjectiveAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Monitoring\V3\CreateServiceLevelObjectiveRequest` 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\Monitoring\V3\ServiceLevelObjective`

deleteService

Soft delete this Service.

The async variant is Google\Cloud\Monitoring\V3\Client\ServiceMonitoringServiceClient::deleteServiceAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Monitoring\V3\DeleteServiceRequest` 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.

deleteServiceLevelObjective

Delete the given ServiceLevelObjective.

The async variant is Google\Cloud\Monitoring\V3\Client\ServiceMonitoringServiceClient::deleteServiceLevelObjectiveAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Monitoring\V3\DeleteServiceLevelObjectiveRequest` 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.

getService

Get the named Service.

The async variant is Google\Cloud\Monitoring\V3\Client\ServiceMonitoringServiceClient::getServiceAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Monitoring\V3\GetServiceRequest` 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\Monitoring\V3\Service`

getServiceLevelObjective

Get a ServiceLevelObjective by name.

The async variant is Google\Cloud\Monitoring\V3\Client\ServiceMonitoringServiceClient::getServiceLevelObjectiveAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Monitoring\V3\GetServiceLevelObjectiveRequest` 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\Monitoring\V3\ServiceLevelObjective`

listServiceLevelObjectives

List the ServiceLevelObjectives for the given Service.

The async variant is Google\Cloud\Monitoring\V3\Client\ServiceMonitoringServiceClient::listServiceLevelObjectivesAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Monitoring\V3\ListServiceLevelObjectivesRequest` 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`

listServices

List Services for this workspace.

The async variant is Google\Cloud\Monitoring\V3\Client\ServiceMonitoringServiceClient::listServicesAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Monitoring\V3\ListServicesRequest` 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`

updateService

Update this Service.

The async variant is Google\Cloud\Monitoring\V3\Client\ServiceMonitoringServiceClient::updateServiceAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Monitoring\V3\UpdateServiceRequest` 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\Monitoring\V3\Service`

updateServiceLevelObjective

Update the given ServiceLevelObjective.

The async variant is Google\Cloud\Monitoring\V3\Client\ServiceMonitoringServiceClient::updateServiceLevelObjectiveAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Monitoring\V3\UpdateServiceLevelObjectiveRequest` 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\Monitoring\V3\ServiceLevelObjective`

createServiceAsync

Parameters
Name	Description
`request`	`Google\Cloud\Monitoring\V3\CreateServiceRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

createServiceLevelObjectiveAsync

Parameters
Name	Description
`request`	`Google\Cloud\Monitoring\V3\CreateServiceLevelObjectiveRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

deleteServiceAsync

Parameters
Name	Description
`request`	`Google\Cloud\Monitoring\V3\DeleteServiceRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

deleteServiceLevelObjectiveAsync

Parameters
Name	Description
`request`	`Google\Cloud\Monitoring\V3\DeleteServiceLevelObjectiveRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

getServiceAsync

Parameters
Name	Description
`request`	`Google\Cloud\Monitoring\V3\GetServiceRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

getServiceLevelObjectiveAsync

Parameters
Name	Description
`request`	`Google\Cloud\Monitoring\V3\GetServiceLevelObjectiveRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

listServiceLevelObjectivesAsync

Parameters
Name	Description
`request`	`Google\Cloud\Monitoring\V3\ListServiceLevelObjectivesRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

listServicesAsync

Parameters
Name	Description
`request`	`Google\Cloud\Monitoring\V3\ListServicesRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

updateServiceAsync

Parameters
Name	Description
`request`	`Google\Cloud\Monitoring\V3\UpdateServiceRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

updateServiceLevelObjectiveAsync

Parameters
Name	Description
`request`	`Google\Cloud\Monitoring\V3\UpdateServiceLevelObjectiveRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

static::folderServiceName

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

Parameters
Name	Description
`folder`	`string`
`service`	`string`

Returns
Type	Description
`string`	The formatted folder_service resource.

static::folderServiceServiceLevelObjectiveName

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

Parameters
Name	Description
`folder`	`string`
`service`	`string`
`serviceLevelObjective`	`string`

Returns
Type	Description
`string`	The formatted folder_service_service_level_objective resource.

static::organizationServiceName

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

Parameters
Name	Description
`organization`	`string`
`service`	`string`

Returns
Type	Description
`string`	The formatted organization_service resource.

static::organizationServiceServiceLevelObjectiveName

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

Parameters
Name	Description
`organization`	`string`
`service`	`string`
`serviceLevelObjective`	`string`

Returns
Type	Description
`string`	The formatted organization_service_service_level_objective resource.

static::projectServiceName

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

Parameters
Name	Description
`project`	`string`
`service`	`string`

Returns
Type	Description
`string`	The formatted project_service resource.

static::projectServiceServiceLevelObjectiveName

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

Parameters
Name	Description
`project`	`string`
`service`	`string`
`serviceLevelObjective`	`string`

Returns
Type	Description
`string`	The formatted project_service_service_level_objective resource.

static::serviceName

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

Parameters
Name	Description
`project`	`string`
`service`	`string`

Returns
Type	Description
`string`	The formatted service resource.

static::serviceLevelObjectiveName

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

Parameters
Name	Description
`project`	`string`
`service`	`string`
`serviceLevelObjective`	`string`

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

folderService: folders/{folder}/services/{service}
folderServiceServiceLevelObjective: folders/{folder}/services/{service}/serviceLevelObjectives/{service_level_objective}
organizationService: organizations/{organization}/services/{service}
organizationServiceServiceLevelObjective: organizations/{organization}/services/{service}/serviceLevelObjectives/{service_level_objective}
projectService: projects/{project}/services/{service}
projectServiceServiceLevelObjective: projects/{project}/services/{service}/serviceLevelObjectives/{service_level_objective}
service: projects/{project}/services/{service}
serviceLevelObjective: projects/{project}/services/{service}/serviceLevelObjectives/{service_level_objective}

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.