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 Metrics Scope'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.
Namespace
Google \ Cloud \ Monitoring \ V3 \ ClientMethods
__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 |
↳ 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 |
↳ 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 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 |
use Google\ApiCore\ApiException;
use Google\Cloud\Monitoring\V3\Client\ServiceMonitoringServiceClient;
use Google\Cloud\Monitoring\V3\CreateServiceRequest;
use Google\Cloud\Monitoring\V3\Service;
/**
* @param string $parent Resource
* [name](https://cloud.google.com/monitoring/api/v3#project_name) of the
* parent Metrics Scope. The format is:
*
* projects/[PROJECT_ID_OR_NUMBER]
*/
function create_service_sample(string $parent): void
{
// Create a client.
$serviceMonitoringServiceClient = new ServiceMonitoringServiceClient();
// Prepare the request message.
$service = new Service();
$request = (new CreateServiceRequest())
->setParent($parent)
->setService($service);
// Call the API and handle any network failures.
try {
/** @var Service $response */
$response = $serviceMonitoringServiceClient->createService($request);
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_service_sample($parent);
}
createServiceLevelObjective
Create a ServiceLevelObjective
for the given Service
.
The async variant is 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 |
use Google\ApiCore\ApiException;
use Google\Cloud\Monitoring\V3\Client\ServiceMonitoringServiceClient;
use Google\Cloud\Monitoring\V3\CreateServiceLevelObjectiveRequest;
use Google\Cloud\Monitoring\V3\ServiceLevelObjective;
/**
* @param string $formattedParent Resource name of the parent `Service`. The format is:
*
* projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]
* Please see {@see ServiceMonitoringServiceClient::serviceName()} for help formatting this field.
*/
function create_service_level_objective_sample(string $formattedParent): void
{
// Create a client.
$serviceMonitoringServiceClient = new ServiceMonitoringServiceClient();
// Prepare the request message.
$serviceLevelObjective = new ServiceLevelObjective();
$request = (new CreateServiceLevelObjectiveRequest())
->setParent($formattedParent)
->setServiceLevelObjective($serviceLevelObjective);
// Call the API and handle any network failures.
try {
/** @var ServiceLevelObjective $response */
$response = $serviceMonitoringServiceClient->createServiceLevelObjective($request);
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
{
$formattedParent = ServiceMonitoringServiceClient::serviceName('[PROJECT]', '[SERVICE]');
create_service_level_objective_sample($formattedParent);
}
deleteService
Soft delete this Service
.
The async variant is 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. |
use Google\ApiCore\ApiException;
use Google\Cloud\Monitoring\V3\Client\ServiceMonitoringServiceClient;
use Google\Cloud\Monitoring\V3\DeleteServiceRequest;
/**
* @param string $formattedName Resource name of the `Service` to delete. The format is:
*
* projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]
* Please see {@see ServiceMonitoringServiceClient::serviceName()} for help formatting this field.
*/
function delete_service_sample(string $formattedName): void
{
// Create a client.
$serviceMonitoringServiceClient = new ServiceMonitoringServiceClient();
// Prepare the request message.
$request = (new DeleteServiceRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
$serviceMonitoringServiceClient->deleteService($request);
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 = ServiceMonitoringServiceClient::serviceName('[PROJECT]', '[SERVICE]');
delete_service_sample($formattedName);
}
deleteServiceLevelObjective
Delete the given ServiceLevelObjective
.
The async variant is 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. |
use Google\ApiCore\ApiException;
use Google\Cloud\Monitoring\V3\Client\ServiceMonitoringServiceClient;
use Google\Cloud\Monitoring\V3\DeleteServiceLevelObjectiveRequest;
/**
* @param string $formattedName Resource name of the `ServiceLevelObjective` to delete. The
* format is:
*
* projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]/serviceLevelObjectives/[SLO_NAME]
* Please see {@see ServiceMonitoringServiceClient::serviceLevelObjectiveName()} for help formatting this field.
*/
function delete_service_level_objective_sample(string $formattedName): void
{
// Create a client.
$serviceMonitoringServiceClient = new ServiceMonitoringServiceClient();
// Prepare the request message.
$request = (new DeleteServiceLevelObjectiveRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
$serviceMonitoringServiceClient->deleteServiceLevelObjective($request);
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 = ServiceMonitoringServiceClient::serviceLevelObjectiveName(
'[PROJECT]',
'[SERVICE]',
'[SERVICE_LEVEL_OBJECTIVE]'
);
delete_service_level_objective_sample($formattedName);
}
getService
Get the named Service
.
The async variant is 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 |
use Google\ApiCore\ApiException;
use Google\Cloud\Monitoring\V3\Client\ServiceMonitoringServiceClient;
use Google\Cloud\Monitoring\V3\GetServiceRequest;
use Google\Cloud\Monitoring\V3\Service;
/**
* @param string $formattedName Resource name of the `Service`. The format is:
*
* projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]
* Please see {@see ServiceMonitoringServiceClient::serviceName()} for help formatting this field.
*/
function get_service_sample(string $formattedName): void
{
// Create a client.
$serviceMonitoringServiceClient = new ServiceMonitoringServiceClient();
// Prepare the request message.
$request = (new GetServiceRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var Service $response */
$response = $serviceMonitoringServiceClient->getService($request);
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 = ServiceMonitoringServiceClient::serviceName('[PROJECT]', '[SERVICE]');
get_service_sample($formattedName);
}
getServiceLevelObjective
Get a ServiceLevelObjective
by name.
The async variant is 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 |
use Google\ApiCore\ApiException;
use Google\Cloud\Monitoring\V3\Client\ServiceMonitoringServiceClient;
use Google\Cloud\Monitoring\V3\GetServiceLevelObjectiveRequest;
use Google\Cloud\Monitoring\V3\ServiceLevelObjective;
/**
* @param string $formattedName Resource name of the `ServiceLevelObjective` to get. The format
* is:
*
* projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]/serviceLevelObjectives/[SLO_NAME]
* Please see {@see ServiceMonitoringServiceClient::serviceLevelObjectiveName()} for help formatting this field.
*/
function get_service_level_objective_sample(string $formattedName): void
{
// Create a client.
$serviceMonitoringServiceClient = new ServiceMonitoringServiceClient();
// Prepare the request message.
$request = (new GetServiceLevelObjectiveRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var ServiceLevelObjective $response */
$response = $serviceMonitoringServiceClient->getServiceLevelObjective($request);
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 = ServiceMonitoringServiceClient::serviceLevelObjectiveName(
'[PROJECT]',
'[SERVICE]',
'[SERVICE_LEVEL_OBJECTIVE]'
);
get_service_level_objective_sample($formattedName);
}
listServiceLevelObjectives
List the ServiceLevelObjective
s for the given Service
.
The async variant is 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 |
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Monitoring\V3\Client\ServiceMonitoringServiceClient;
use Google\Cloud\Monitoring\V3\ListServiceLevelObjectivesRequest;
use Google\Cloud\Monitoring\V3\ServiceLevelObjective;
/**
* @param string $formattedParent Resource name of the parent containing the listed SLOs, either a
* project or a Monitoring Metrics Scope. The formats are:
*
* projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]
* workspaces/[HOST_PROJECT_ID_OR_NUMBER]/services/-
* Please see {@see ServiceMonitoringServiceClient::serviceName()} for help formatting this field.
*/
function list_service_level_objectives_sample(string $formattedParent): void
{
// Create a client.
$serviceMonitoringServiceClient = new ServiceMonitoringServiceClient();
// Prepare the request message.
$request = (new ListServiceLevelObjectivesRequest())
->setParent($formattedParent);
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $serviceMonitoringServiceClient->listServiceLevelObjectives($request);
/** @var ServiceLevelObjective $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
{
$formattedParent = ServiceMonitoringServiceClient::serviceName('[PROJECT]', '[SERVICE]');
list_service_level_objectives_sample($formattedParent);
}
listServices
List Service
s for this Metrics Scope.
The async variant is 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 |
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Monitoring\V3\Client\ServiceMonitoringServiceClient;
use Google\Cloud\Monitoring\V3\ListServicesRequest;
use Google\Cloud\Monitoring\V3\Service;
/**
* @param string $parent Resource name of the parent containing the listed services,
* either a [project](https://cloud.google.com/monitoring/api/v3#project_name)
* or a Monitoring Metrics Scope. The formats are:
*
* projects/[PROJECT_ID_OR_NUMBER]
* workspaces/[HOST_PROJECT_ID_OR_NUMBER]
*/
function list_services_sample(string $parent): void
{
// Create a client.
$serviceMonitoringServiceClient = new ServiceMonitoringServiceClient();
// Prepare the request message.
$request = (new ListServicesRequest())
->setParent($parent);
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $serviceMonitoringServiceClient->listServices($request);
/** @var Service $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_services_sample($parent);
}
updateService
Update this Service
.
The async variant is 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 |
use Google\ApiCore\ApiException;
use Google\Cloud\Monitoring\V3\Client\ServiceMonitoringServiceClient;
use Google\Cloud\Monitoring\V3\Service;
use Google\Cloud\Monitoring\V3\UpdateServiceRequest;
/**
* 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_service_sample(): void
{
// Create a client.
$serviceMonitoringServiceClient = new ServiceMonitoringServiceClient();
// Prepare the request message.
$service = new Service();
$request = (new UpdateServiceRequest())
->setService($service);
// Call the API and handle any network failures.
try {
/** @var Service $response */
$response = $serviceMonitoringServiceClient->updateService($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
updateServiceLevelObjective
Update the given ServiceLevelObjective
.
The async variant is 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 |
use Google\ApiCore\ApiException;
use Google\Cloud\Monitoring\V3\Client\ServiceMonitoringServiceClient;
use Google\Cloud\Monitoring\V3\ServiceLevelObjective;
use Google\Cloud\Monitoring\V3\UpdateServiceLevelObjectiveRequest;
/**
* 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_service_level_objective_sample(): void
{
// Create a client.
$serviceMonitoringServiceClient = new ServiceMonitoringServiceClient();
// Prepare the request message.
$serviceLevelObjective = new ServiceLevelObjective();
$request = (new UpdateServiceLevelObjectiveRequest())
->setServiceLevelObjective($serviceLevelObjective);
// Call the API and handle any network failures.
try {
/** @var ServiceLevelObjective $response */
$response = $serviceMonitoringServiceClient->updateServiceLevelObjective($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
createServiceAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Monitoring\V3\CreateServiceRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Monitoring\V3\Service> |
createServiceLevelObjectiveAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Monitoring\V3\CreateServiceLevelObjectiveRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Monitoring\V3\ServiceLevelObjective> |
deleteServiceAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Monitoring\V3\DeleteServiceRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<void> |
deleteServiceLevelObjectiveAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Monitoring\V3\DeleteServiceLevelObjectiveRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<void> |
getServiceAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Monitoring\V3\GetServiceRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Monitoring\V3\Service> |
getServiceLevelObjectiveAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Monitoring\V3\GetServiceLevelObjectiveRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Monitoring\V3\ServiceLevelObjective> |
listServiceLevelObjectivesAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Monitoring\V3\ListServiceLevelObjectivesRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse> |
listServicesAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Monitoring\V3\ListServicesRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse> |
updateServiceAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Monitoring\V3\UpdateServiceRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Monitoring\V3\Service> |
updateServiceLevelObjectiveAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Monitoring\V3\UpdateServiceLevelObjectiveRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Monitoring\V3\ServiceLevelObjective> |
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. |