Reference documentation and code samples for the Google Cloud Service Health V1 Client class ListEventsRequest.
Requests list of events.
Generated from protobuf message google.cloud.servicehealth.v1.ListEventsRequest
Namespace
Google \ Cloud \ ServiceHealth \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ parent
string
Required. Parent value using the form projects/{project_id}/locations/{location}/events
. project_id
- ID of the project for which to list service health events. location
- The location to get the service health events from. To retrieve service health events of category = INCIDENT, use location
= global
.
↳ page_size
int
Optional. The maximum number of events that should be returned. Acceptable values are 1 to 100, inclusive. (The default value is 10.) If more results are available, the service returns a next_page_token that you can use to get the next page of results in subsequent list requests. The service may return fewer events than the requested page_size.
↳ page_token
string
Optional. A token identifying a page of results the server should return. Provide Page token returned by a previous ListEvents
call to retrieve the next page of results. When paginating, all other parameters provided to ListEvents
must match the call that provided the page token.
↳ filter
string
Optional. A filter expression that filters resources listed in the response. The expression takes the following forms:
* * field=value for category
and state
* * field <, >, <=, or >= value for update_time
Examples: category=INCIDENT
, update_time>="2000-01-01T11:30:00-04:00"
, event_impacts.product.product_name:"Eventarc"
Multiple filter queries are separated by spaces. Example: category=INCIDENT state=ACTIVE
. By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. Filter is supported for the following fields: category
, state
, update_time
, event_impacts.product.product_name
↳ view
int
Optional. Event fields to include in response.
getParent
Required. Parent value using the form projects/{project_id}/locations/{location}/events
.
project_id
- ID of the project for which to list service health
events. location
- The location to get the service health events from.
To retrieve service health events of category = INCIDENT, use location
= global
.
string
setParent
Required. Parent value using the form projects/{project_id}/locations/{location}/events
.
project_id
- ID of the project for which to list service health
events. location
- The location to get the service health events from.
To retrieve service health events of category = INCIDENT, use location
= global
.
var
string
$this
getPageSize
Optional. The maximum number of events that should be returned. Acceptable values are 1 to 100, inclusive. (The default value is 10.) If more results are available, the service returns a next_page_token that you can use to get the next page of results in subsequent list requests. The service may return fewer events than the requested page_size.
int
setPageSize
Optional. The maximum number of events that should be returned. Acceptable values are 1 to 100, inclusive. (The default value is 10.) If more results are available, the service returns a next_page_token that you can use to get the next page of results in subsequent list requests. The service may return fewer events than the requested page_size.
var
int
$this
getPageToken
Optional. A token identifying a page of results the server should return.
Provide Page token returned by a previous ListEvents
call to retrieve the
next page of results. When paginating, all other parameters provided to ListEvents
must match the call that provided the page token.
string
setPageToken
Optional. A token identifying a page of results the server should return.
Provide Page token returned by a previous ListEvents
call to retrieve the
next page of results. When paginating, all other parameters provided to ListEvents
must match the call that provided the page token.
var
string
$this
getFilter
Optional. A filter expression that filters resources listed in the
response. The expression takes the following forms:
- field=value for
category
andstate
- field <, >, <=, or >= value for
update_time
Examples:category=INCIDENT
,update_time>="2000-01-01T11:30:00-04:00"
,event_impacts.product.product_name:"Eventarc"
Multiple filter queries are separated by spaces. Example:category=INCIDENT state=ACTIVE
.
By default, each expression is an AND expression. However, you can include
AND and OR expressions explicitly.
Filter is supported for the following fields: category
, state
, update_time
, event_impacts.product.product_name
string
setFilter
Optional. A filter expression that filters resources listed in the
response. The expression takes the following forms:
- field=value for
category
andstate
- field <, >, <=, or >= value for
update_time
Examples:category=INCIDENT
,update_time>="2000-01-01T11:30:00-04:00"
,event_impacts.product.product_name:"Eventarc"
Multiple filter queries are separated by spaces. Example:category=INCIDENT state=ACTIVE
.
By default, each expression is an AND expression. However, you can include
AND and OR expressions explicitly.
Filter is supported for the following fields: category
, state
, update_time
, event_impacts.product.product_name
var
string
$this
getView
Optional. Event fields to include in response.
int
setView
Optional. Event fields to include in response.
var
int
$this
static::build
parent
string
Required. Parent value using the form projects/{project_id}/locations/{location}/events
.
project_id
- ID of the project for which to list service health
events. location
- The location to get the service health events from.
To retrieve service health events of category = INCIDENT, use location
= global
. Please see ServiceHealthClient::locationName()
for help formatting this field.