Interface ListEventsRequestOrBuilder (0.9.0)

public interface ListEventsRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getFilter()

public abstract String getFilter()

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 <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

string filter = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The filter.

getFilterBytes()

public abstract ByteString getFilterBytes()

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 <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

string filter = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for filter.

getPageSize()

public abstract int 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.

int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The pageSize.

getPageToken()

public abstract String 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 page_token = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The pageToken.

getPageTokenBytes()

public abstract ByteString getPageTokenBytes()

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 page_token = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for pageToken.

getParent()

public abstract String 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 parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The parent.

getParentBytes()

public abstract ByteString getParentBytes()

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 parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for parent.

getView()

public abstract EventView getView()

Optional. Event fields to include in response.

.google.cloud.servicehealth.v1.EventView view = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
EventView

The view.

getViewValue()

public abstract int getViewValue()

Optional. Event fields to include in response.

.google.cloud.servicehealth.v1.EventView view = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for view.