Class: Google::Cloud::ServiceHealth::V1::ListOrganizationEventsRequest

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/servicehealth/v1/event_resources.rb

Overview

Message for requesting list of organization events.

Instance Attribute Summary collapse

Instance Attribute Details

#filter ⇒ ::String

Returns 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



556
557
558
559
 
# File 'proto_docs/google/cloud/servicehealth/v1/event_resources.rb', line 556

class ListOrganizationEventsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#page_size ⇒ ::Integer

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



556
557
558
559
 
# File 'proto_docs/google/cloud/servicehealth/v1/event_resources.rb', line 556

class ListOrganizationEventsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#page_token ⇒ ::String

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



556
557
558
559
 
# File 'proto_docs/google/cloud/servicehealth/v1/event_resources.rb', line 556

class ListOrganizationEventsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#parent ⇒ ::String

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



556
557
558
559
 
# File 'proto_docs/google/cloud/servicehealth/v1/event_resources.rb', line 556

class ListOrganizationEventsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#view ⇒ ::Google::Cloud::ServiceHealth::V1::OrganizationEventView

Returns Optional. OrganizationEvent fields to include in response.

Returns:



556
557
558
559
 
# File 'proto_docs/google/cloud/servicehealth/v1/event_resources.rb', line 556

class ListOrganizationEventsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end