Stackdriver Monitoring V3 Client - Class ListGroupMembersRequest (1.12.1)

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

The ListGroupMembers request.

Generated from protobuf message google.monitoring.v3.ListGroupMembersRequest

Namespace

Google \ Cloud \ Monitoring \ V3

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ name`	`string` Required. The group whose members are listed. The format is: projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]
`↳ page_size`	`int` A positive number that is the maximum number of results to return.
`↳ page_token`	`string` If this field is not empty then it must contain the `next_page_token` value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call.
`↳ 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: `resource.type = "gce_instance"`
`↳ 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.

getName

Required. The group whose members are listed. The format is: projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]

Returns
Type	Description
`string`

setName

Required. The group whose members are listed. The format is: projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getPageSize

A positive number that is the maximum number of results to return.

Returns
Type	Description
`int`

setPageSize

A positive number that is the maximum number of results to return.

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getPageToken

If this field is not empty then it must contain the next_page_token value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call.

Returns
Type	Description
`string`

setPageToken

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getFilter

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: resource.type = "gce_instance"

Returns
Type	Description
`string`

setFilter

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getInterval

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.

Returns
Type	Description
`TimeInterval\|null`

hasInterval

clearInterval

setInterval

Parameter
Name	Description
`var`	`TimeInterval`

Returns
Type	Description
`$this`

static::build

Parameter

Name Description

name

string

Required. The group whose members are listed. The format is:

projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID] Please see GroupServiceClient::groupName() for help formatting this field.

Returns
Type	Description
`ListGroupMembersRequest`