Service Health V1 API - Class Google::Cloud::ServiceHealth::V1::ListOrganizationEventsRequest (v1.0.0)

Reference documentation and code samples for the Service Health V1 API class Google::Cloud::ServiceHealth::V1::ListOrganizationEventsRequest.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#filter

def filter() -> ::String
Returns
  • (::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

    Multiple filter queries are space-separated. 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

#filter=

def filter=(value) -> ::String
Parameter
  • value (::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

    Multiple filter queries are space-separated. 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

Returns
  • (::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

    Multiple filter queries are space-separated. 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

#page_size

def page_size() -> ::Integer
Returns
  • (::Integer) — 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_size=

def page_size=(value) -> ::Integer
Parameter
  • value (::Integer) — 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
  • (::Integer) — 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

def page_token() -> ::String
Returns
  • (::String) — Optional. A token identifying a page of results the server should return.

    Provide Page token returned by a previous ListOrganizationEvents call to retrieve the next page of results.

    When paginating, all other parameters provided to ListOrganizationEvents must match the call that provided the page token.

#page_token=

def page_token=(value) -> ::String
Parameter
  • value (::String) — Optional. A token identifying a page of results the server should return.

    Provide Page token returned by a previous ListOrganizationEvents call to retrieve the next page of results.

    When paginating, all other parameters provided to ListOrganizationEvents must match the call that provided the page token.

Returns
  • (::String) — Optional. A token identifying a page of results the server should return.

    Provide Page token returned by a previous ListOrganizationEvents call to retrieve the next page of results.

    When paginating, all other parameters provided to ListOrganizationEvents must match the call that provided the page token.

#parent

def parent() -> ::String
Returns
  • (::String) — Required. Parent value using the form organizations/{organization_id}/locations/{location}/organizationEvents.

    organization_id - ID (number) of the project that contains the event. To get your organization_id, see Getting your organization resource ID.
    location - The location to get the service health events from. To retrieve service health events of category = INCIDENT, use location = global.

#parent=

def parent=(value) -> ::String
Parameter
  • value (::String) — Required. Parent value using the form organizations/{organization_id}/locations/{location}/organizationEvents.

    organization_id - ID (number) of the project that contains the event. To get your organization_id, see Getting your organization resource ID.
    location - The location to get the service health events from. To retrieve service health events of category = INCIDENT, use location = global.

Returns
  • (::String) — Required. Parent value using the form organizations/{organization_id}/locations/{location}/organizationEvents.

    organization_id - ID (number) of the project that contains the event. To get your organization_id, see Getting your organization resource ID.
    location - The location to get the service health events from. To retrieve service health events of category = INCIDENT, use location = global.

#view

def view() -> ::Google::Cloud::ServiceHealth::V1::OrganizationEventView
Returns

#view=

def view=(value) -> ::Google::Cloud::ServiceHealth::V1::OrganizationEventView
Parameter
Returns