Reference documentation and code samples for the Stackdriver Monitoring V3 Client class ListGroupMembersRequest.
The ListGroupMembers request.
Generated from protobuf message google.monitoring.v3.ListGroupMembersRequest
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 |
↳ 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 |
Google\Cloud\Monitoring\V3\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]
Generated from protobuf field string name = 7 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {
| Returns | |
|---|---|
| Type | Description |
string | |
setName
Required. The group whose members are listed. The format is: projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]
Generated from protobuf field string name = 7 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPageSize
A positive number that is the maximum number of results to return.
Generated from protobuf field int32 page_size = 3;
| Returns | |
|---|---|
| Type | Description |
int | |
setPageSize
A positive number that is the maximum number of results to return.
Generated from protobuf field int32 page_size = 3;
| 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.
Generated from protobuf field string page_token = 4;
| Returns | |
|---|---|
| Type | Description |
string | |
setPageToken
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.
Generated from protobuf field string page_token = 4;
| 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"
Generated from protobuf field string filter = 5;
| Returns | |
|---|---|
| Type | Description |
string | |
setFilter
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"
Generated from protobuf field string filter = 5;
| 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.
Generated from protobuf field .google.monitoring.v3.TimeInterval interval = 6;
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Monitoring\V3\TimeInterval|null | |
hasInterval
clearInterval
setInterval
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.
Generated from protobuf field .google.monitoring.v3.TimeInterval interval = 6;
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Monitoring\V3\TimeInterval
|
| Returns | |
|---|---|
| Type | Description |
$this | |