Service Health V1 API - Class Google::Cloud::ServiceHealth::V1::ListOrganizationImpactsRequest (v1.0.2)

Version latest

• 1.0.2 (latest)
• 1.0.1
• 0.2.0
• 0.1.2

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

Message for requesting list of organization impacts.

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 is in the form of field:value for checking if a repeated field contains a value.

  Example: events:organizations%2F{organization_id}%2Flocations%2Fglobal%2ForganizationEvents%2Fevent-id

  To get your {organization_id}, see Getting your organization resource ID.

  Multiple filter queries are separated by spaces.

  By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. Filter is supported for the following fields: events.

#filter=

def filter=(value) -> ::String

Parameter

• value (::String) — Optional. A filter expression that filters resources listed in the response. The expression is in the form of field:value for checking if a repeated field contains a value.

  Example: events:organizations%2F{organization_id}%2Flocations%2Fglobal%2ForganizationEvents%2Fevent-id

  To get your {organization_id}, see Getting your organization resource ID.

  Multiple filter queries are separated by spaces.

  By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. Filter is supported for the following fields: events.

Returns

• (::String) — Optional. A filter expression that filters resources listed in the response. The expression is in the form of field:value for checking if a repeated field contains a value.

  Example: events:organizations%2F{organization_id}%2Flocations%2Fglobal%2ForganizationEvents%2Fevent-id

  To get your {organization_id}, see Getting your organization resource ID.

  Multiple filter queries are separated by spaces.

  By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. Filter is supported for the following fields: events.

#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 can be used to get the next page of results in subsequent list requests. The service may return fewer impacts 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 can be used to get the next page of results in subsequent list requests. The service may return fewer impacts 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 can be used to get the next page of results in subsequent list requests. The service may return fewer impacts 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 ListOrganizationImpacts call to retrieve the next page of results.

  When paginating, all other parameters provided to ListOrganizationImpacts 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 ListOrganizationImpacts call to retrieve the next page of results.

  When paginating, all other parameters provided to ListOrganizationImpacts 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 ListOrganizationImpacts call to retrieve the next page of results.

  When paginating, all other parameters provided to ListOrganizationImpacts 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}/organizationImpacts.

  organization_id - ID (number) of the project that contains the event. To get your organization_id, see Getting your organization resource ID.

#parent=

def parent=(value) -> ::String

Parameter

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

  organization_id - ID (number) of the project that contains the event. To get your organization_id, see Getting your organization resource ID.

Returns

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

  organization_id - ID (number) of the project that contains the event. To get your organization_id, see Getting your organization resource ID.