Cloud Monitoring V3 API - Class Google::Cloud::Monitoring::V3::ListAlertPoliciesRequest (v1.0.1)

Reference documentation and code samples for the Cloud Monitoring V3 API class Google::Cloud::Monitoring::V3::ListAlertPoliciesRequest.

The protocol for the ListAlertPolicies request.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#filter

def filter() -> ::String
Returns
  • (::String) — If provided, this field specifies the criteria that must be met by alert policies to be included in the response.

    For more details, see sorting and filtering.

#filter=

def filter=(value) -> ::String
Parameter
  • value (::String) — If provided, this field specifies the criteria that must be met by alert policies to be included in the response.

    For more details, see sorting and filtering.

Returns
  • (::String) — If provided, this field specifies the criteria that must be met by alert policies to be included in the response.

    For more details, see sorting and filtering.

#name

def name() -> ::String
Returns
  • (::String) — Required. The project whose alert policies are to be listed. The format is:

    projects/[PROJECT_ID_OR_NUMBER]

    Note that this field names the parent container in which the alerting policies to be listed are stored. To retrieve a single alerting policy by name, use the GetAlertPolicy operation, instead.

#name=

def name=(value) -> ::String
Parameter
  • value (::String) — Required. The project whose alert policies are to be listed. The format is:

    projects/[PROJECT_ID_OR_NUMBER]

    Note that this field names the parent container in which the alerting policies to be listed are stored. To retrieve a single alerting policy by name, use the GetAlertPolicy operation, instead.

Returns
  • (::String) — Required. The project whose alert policies are to be listed. The format is:

    projects/[PROJECT_ID_OR_NUMBER]

    Note that this field names the parent container in which the alerting policies to be listed are stored. To retrieve a single alerting policy by name, use the GetAlertPolicy operation, instead.

#order_by

def order_by() -> ::String
Returns
  • (::String) — A comma-separated list of fields by which to sort the result. Supports the same set of field references as the filter field. Entries can be prefixed with a minus sign to sort by the field in descending order.

    For more details, see sorting and filtering.

#order_by=

def order_by=(value) -> ::String
Parameter
  • value (::String) — A comma-separated list of fields by which to sort the result. Supports the same set of field references as the filter field. Entries can be prefixed with a minus sign to sort by the field in descending order.

    For more details, see sorting and filtering.

Returns
  • (::String) — A comma-separated list of fields by which to sort the result. Supports the same set of field references as the filter field. Entries can be prefixed with a minus sign to sort by the field in descending order.

    For more details, see sorting and filtering.

#page_size

def page_size() -> ::Integer
Returns
  • (::Integer) — The maximum number of results to return in a single response.

#page_size=

def page_size=(value) -> ::Integer
Parameter
  • value (::Integer) — The maximum number of results to return in a single response.
Returns
  • (::Integer) — The maximum number of results to return in a single response.

#page_token

def page_token() -> ::String
Returns
  • (::String) — If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return more results from the previous method call.

#page_token=

def page_token=(value) -> ::String
Parameter
  • value (::String) — If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return more results from the previous method call.
Returns
  • (::String) — If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return more results from the previous method call.