Stackdriver Monitoring V3 Client - Class ListSnoozesRequest (2.2.1)

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

The message definition for listing Snoozes associated with the given parent, satisfying the optional filter.

Generated from protobuf message google.monitoring.v3.ListSnoozesRequest

Namespace

Google \ Cloud \ Monitoring \ V3

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ parent string

Required. The project whose Snoozes should be listed. The format is: projects/[PROJECT_ID_OR_NUMBER]
↳ filter string

Optional. Optional filter to restrict results to the given criteria. The following fields are supported. * * interval.start_time * * interval.end_time For example: interval.start_time > "2022-03-11T00:00:00-08:00" AND interval.end_time < "2022-03-12T00:00:00-08:00"
↳ page_size int

Optional. The maximum number of results to return for a single query. The server may further constrain the maximum number of results returned in a single page. The value should be in the range [1, 1000]. If the value given is outside this range, the server will decide the number of results to be returned.
↳ page_token string

Optional. The next_page_token from a previous call to ListSnoozesRequest to get the next page of results.

getParent

Required. The project whose Snoozes should be listed. The format is: projects/[PROJECT_ID_OR_NUMBER]

Returns
Type Description
string

setParent

Required. The project whose Snoozes should be listed. The format is: projects/[PROJECT_ID_OR_NUMBER]

Parameter
Name Description
var string
Returns
Type Description
$this

getFilter

Optional. Optional filter to restrict results to the given criteria. The following fields are supported.

  • interval.start_time
    • interval.end_time For example: interval.start_time > "2022-03-11T00:00:00-08:00" AND interval.end_time < "2022-03-12T00:00:00-08:00"
Returns
Type Description
string

setFilter

Optional. Optional filter to restrict results to the given criteria. The following fields are supported.

  • interval.start_time
    • interval.end_time For example: interval.start_time > "2022-03-11T00:00:00-08:00" AND interval.end_time < "2022-03-12T00:00:00-08:00"
Parameter
Name Description
var string
Returns
Type Description
$this

getPageSize

Optional. The maximum number of results to return for a single query. The server may further constrain the maximum number of results returned in a single page. The value should be in the range [1, 1000]. If the value given is outside this range, the server will decide the number of results to be returned.

Returns
Type Description
int

setPageSize

Optional. The maximum number of results to return for a single query. The server may further constrain the maximum number of results returned in a single page. The value should be in the range [1, 1000]. If the value given is outside this range, the server will decide the number of results to be returned.

Parameter
Name Description
var int
Returns
Type Description
$this

getPageToken

Optional. The next_page_token from a previous call to ListSnoozesRequest to get the next page of results.

Returns
Type Description
string

setPageToken

Optional. The next_page_token from a previous call to ListSnoozesRequest to get the next page of results.

Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameter
Name Description
parent string

Required. The project whose Snoozes should be listed. The format is:

projects/[PROJECT_ID_OR_NUMBER] Please see SnoozeServiceClient::workspaceName() for help formatting this field.
Returns
Type Description
ListSnoozesRequest