Service Health v1 API - Class ListEventsRequest (1.3.0) 

public sealed class ListEventsRequest : IMessage<ListEventsRequest>, IEquatable<ListEventsRequest>, IDeepCloneable<ListEventsRequest>, IBufferMessage, IMessage, IPageRequest

Reference documentation and code samples for the Service Health v1 API class ListEventsRequest.

Message for requesting list of events.

Inheritance

object > ListEventsRequest

Namespace

Google.Cloud.ServiceHealth.V1

Assembly

Google.Cloud.ServiceHealth.V1.dll

Constructors

ListEventsRequest()

public ListEventsRequest()

ListEventsRequest(ListEventsRequest)

public ListEventsRequest(ListEventsRequest other)
Parameter
Name Description
other ListEventsRequest

Properties

Filter

public string Filter { get; set; }

Optional. A filter expression that filters resources listed in the response. The expression takes the following forms: <br>

  • field=value for category and state<br>
  • field &lt;, >, &lt;=, or >= value for update_time <br> Examples: category=INCIDENT, update_time>="2000-01-01T11:30:00-04:00", event_impacts.product.product_name:"Eventarc" <br>

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

Property Value
Type Description
string

PageSize

public int PageSize { get; set; }

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.

Property Value
Type Description
int

PageToken

public string PageToken { get; set; }

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.

Property Value
Type Description
string

Parent

public string Parent { get; set; }

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.

Property Value
Type Description
string

ParentAsLocationName

public LocationName ParentAsLocationName { get; set; }

LocationName-typed view over the Parent resource name property.

Property Value
Type Description
LocationName

View

public EventView View { get; set; }

Optional. Event fields to include in response.

Property Value
Type Description
EventView