Stackdriver Monitoring V3 Client - Class GroupServiceClient (1.6.0)

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.

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

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.

createGroup

Creates a new group.

The async variant is Google\Cloud\Monitoring\V3\Client\BaseClient\self::createGroupAsync() .

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

deleteGroup

Deletes an existing group.

The async variant is Google\Cloud\Monitoring\V3\Client\BaseClient\self::deleteGroupAsync() .

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

getGroup

Gets a single group.

The async variant is Google\Cloud\Monitoring\V3\Client\BaseClient\self::getGroupAsync() .

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

listGroupMembers

Lists the monitored resources that are members of a group.

The async variant is Google\Cloud\Monitoring\V3\Client\BaseClient\self::listGroupMembersAsync() .

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

listGroups

Lists the existing groups.

The async variant is Google\Cloud\Monitoring\V3\Client\BaseClient\self::listGroupsAsync() .

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

updateGroup

Updates an existing group.

You can change any group attributes except name.

The async variant is Google\Cloud\Monitoring\V3\Client\BaseClient\self::updateGroupAsync() .

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

createGroupAsync

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

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

deleteGroupAsync

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

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

getGroupAsync

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

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

listGroupMembersAsync

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

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

listGroupsAsync

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

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

updateGroupAsync

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

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

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.