Reference documentation and code samples for the Stackdriver Monitoring V3 Client class GroupServiceClient.
Service Description: The Group API lets you inspect and manage your groups.
A group is a named filter that is used to identify a collection of monitored resources. Groups are typically used to mirror the physical and/or logical topology of the environment. Because group membership is computed dynamically, monitored resources that are started in the future are automatically placed in matching groups. By using a group to name monitored resources in, for example, an alert policy, the target of that alert policy is updated automatically as monitored resources are added and removed from the infrastructure.
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:
$groupServiceClient = new Google\Cloud\Monitoring\V3\GroupServiceClient();
try {
$name = 'name';
$group = new Google\Cloud\Monitoring\V3\Group();
$response = $groupServiceClient->createGroup($name, $group);
} finally {
$groupServiceClient->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\GroupServiceClient to use the new surface.
Namespace
Google \ Cloud \ Monitoring \ V3Methods
__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. |
createGroup
Creates a new group.
Parameters | |
---|---|
Name | Description |
name |
string
Required. The project in which to create the group. The format is: projects/[PROJECT_ID_OR_NUMBER] |
group |
Google\Cloud\Monitoring\V3\Group
Required. A group definition. It is an error to define the |
optionalArgs |
array
Optional. |
↳ validateOnly |
bool
If true, validate this request but do not create the group. |
↳ 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\Group |
use Google\ApiCore\ApiException;
use Google\Cloud\Monitoring\V3\Group;
use Google\Cloud\Monitoring\V3\GroupServiceClient;
/**
* @param string $name The [project](https://cloud.google.com/monitoring/api/v3#project_name) in
* which to create the group. The format is:
*
* projects/[PROJECT_ID_OR_NUMBER]
*/
function create_group_sample(string $name): void
{
// Create a client.
$groupServiceClient = new GroupServiceClient();
// Prepare any non-scalar elements to be passed along with the request.
$group = new Group();
// Call the API and handle any network failures.
try {
/** @var Group $response */
$response = $groupServiceClient->createGroup($name, $group);
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_group_sample($name);
}
deleteGroup
Deletes an existing group.
Parameters | |
---|---|
Name | Description |
name |
string
Required. The group to delete. The format is: projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID] |
optionalArgs |
array
Optional. |
↳ recursive |
bool
If this field is true, then the request means to delete a group with all its descendants. Otherwise, the request means to delete a group only when it has no descendants. The default value is false. |
↳ 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\GroupServiceClient;
/**
* @param string $formattedName The group to delete. The format is:
*
* projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]
* Please see {@see GroupServiceClient::groupName()} for help formatting this field.
*/
function delete_group_sample(string $formattedName): void
{
// Create a client.
$groupServiceClient = new GroupServiceClient();
// Call the API and handle any network failures.
try {
$groupServiceClient->deleteGroup($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 = GroupServiceClient::groupName('[PROJECT]', '[GROUP]');
delete_group_sample($formattedName);
}
getGroup
Gets a single group.
Parameters | |
---|---|
Name | Description |
name |
string
Required. The group to retrieve. The format is: projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID] |
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\Cloud\Monitoring\V3\Group |
use Google\ApiCore\ApiException;
use Google\Cloud\Monitoring\V3\Group;
use Google\Cloud\Monitoring\V3\GroupServiceClient;
/**
* @param string $formattedName The group to retrieve. The format is:
*
* projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]
* Please see {@see GroupServiceClient::groupName()} for help formatting this field.
*/
function get_group_sample(string $formattedName): void
{
// Create a client.
$groupServiceClient = new GroupServiceClient();
// Call the API and handle any network failures.
try {
/** @var Group $response */
$response = $groupServiceClient->getGroup($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 = GroupServiceClient::groupName('[PROJECT]', '[GROUP]');
get_group_sample($formattedName);
}
listGroupMembers
Lists the monitored resources that are members of a group.
Parameters | |
---|---|
Name | Description |
name |
string
Required. The group whose members are listed. The format is: projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID] |
optionalArgs |
array
Optional. |
↳ 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. |
↳ filter |
string
An optional list filter describing the members to be returned. The filter may reference the type, labels, and metadata of monitored resources that comprise the group. For example, to return only resources representing Compute Engine VM instances, use this filter: |
↳ interval |
TimeInterval
An optional time interval for which results should be returned. Only members that were part of the group during the specified interval are included in the response. If no interval is provided then the group membership over the last minute is returned. |
↳ 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\Api\MonitoredResource;
use Google\Cloud\Monitoring\V3\GroupServiceClient;
/**
* @param string $formattedName The group whose members are listed. The format is:
*
* projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]
* Please see {@see GroupServiceClient::groupName()} for help formatting this field.
*/
function list_group_members_sample(string $formattedName): void
{
// Create a client.
$groupServiceClient = new GroupServiceClient();
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $groupServiceClient->listGroupMembers($formattedName);
/** @var MonitoredResource $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 = GroupServiceClient::groupName('[PROJECT]', '[GROUP]');
list_group_members_sample($formattedName);
}
listGroups
Lists the existing groups.
Parameters | |
---|---|
Name | Description |
name |
string
Required. The project whose groups are to be listed. The format is: projects/[PROJECT_ID_OR_NUMBER] |
optionalArgs |
array
Optional. |
↳ childrenOfGroup |
string
A group name. The format is: projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID] Returns groups whose |
↳ ancestorsOfGroup |
string
A group name. The format is: projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID] Returns groups that are ancestors of the specified group. The groups are returned in order, starting with the immediate parent and ending with the most distant ancestor. If the specified group has no immediate parent, the results are empty. |
↳ descendantsOfGroup |
string
A group name. The format is: projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID] Returns the descendants of the specified group. This is a superset of the results returned by the |
↳ 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 |
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Monitoring\V3\Group;
use Google\Cloud\Monitoring\V3\GroupServiceClient;
/**
* @param string $name The [project](https://cloud.google.com/monitoring/api/v3#project_name)
* whose groups are to be listed. The format is:
*
* projects/[PROJECT_ID_OR_NUMBER]
*/
function list_groups_sample(string $name): void
{
// Create a client.
$groupServiceClient = new GroupServiceClient();
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $groupServiceClient->listGroups($name);
/** @var Group $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_groups_sample($name);
}
updateGroup
Updates an existing group.
You can change any group attributes except name
.
Parameters | |
---|---|
Name | Description |
group |
Google\Cloud\Monitoring\V3\Group
Required. The new definition of the group. All fields of the existing group,
excepting |
optionalArgs |
array
Optional. |
↳ validateOnly |
bool
If true, validate this request but do not update the existing group. |
↳ 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\Group |
use Google\ApiCore\ApiException;
use Google\Cloud\Monitoring\V3\Group;
use Google\Cloud\Monitoring\V3\GroupServiceClient;
/**
* 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_group_sample(): void
{
// Create a client.
$groupServiceClient = new GroupServiceClient();
// Prepare any non-scalar elements to be passed along with the request.
$group = new Group();
// Call the API and handle any network failures.
try {
/** @var Group $response */
$response = $groupServiceClient->updateGroup($group);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
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::folderGroupName
Formats a string containing the fully-qualified path to represent a folder_group resource.
Parameters | |
---|---|
Name | Description |
folder |
string
|
group |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted folder_group resource. |
static::groupName
Formats a string containing the fully-qualified path to represent a group resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
group |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted group resource. |
static::organizationGroupName
Formats a string containing the fully-qualified path to represent a organization_group resource.
Parameters | |
---|---|
Name | Description |
organization |
string
|
group |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted organization_group resource. |
static::projectGroupName
Formats a string containing the fully-qualified path to represent a project_group resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
group |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted project_group 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
- folderGroup: folders/{folder}/groups/{group}
- group: projects/{project}/groups/{group}
- organizationGroup: organizations/{organization}/groups/{group}
- projectGroup: projects/{project}/groups/{group}
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.GroupService'
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.