Google Cloud Service Health V1 Client - Class ListEventsRequest (0.2.1)

Reference documentation and code samples for the Google Cloud Service Health V1 Client class ListEventsRequest.

Message for requesting list of events.

Generated from protobuf message google.cloud.servicehealth.v1.ListEventsRequest

Namespace

Google \ Cloud \ ServiceHealth \ V1

Methods

__construct

Constructor.

Parameters
Name Description
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.

Returns
Type Description
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.

Parameter
Name Description
var string
Returns
Type Description
$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.

Returns
Type Description
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.

Parameter
Name Description
var int
Returns
Type Description
$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.

Returns
Type Description
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.

Parameter
Name Description
var string
Returns
Type Description
$this

getFilter

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

Returns
Type Description
string

setFilter

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

Parameter
Name Description
var string
Returns
Type Description
$this

getView

Optional. Event fields to include in response.

Returns
Type Description
int

setView

Optional. Event fields to include in response.

Parameter
Name Description
var int
Returns
Type Description
$this

static::build

Parameter
Name Description
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.
Returns
Type Description
ListEventsRequest