Class: Google::Cloud::Monitoring::V3::ListAlertPoliciesRequest

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/monitoring/v3/alert_service.rb

Overview

The protocol for the ListAlertPolicies request.

Instance Attribute Summary collapse

Instance Attribute Details

#filter ⇒ ::String

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



96
97
98
99
 
# File 'proto_docs/google/monitoring/v3/alert_service.rb', line 96

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

#name ⇒ ::String

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



96
97
98
99
 
# File 'proto_docs/google/monitoring/v3/alert_service.rb', line 96

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

#order_by ⇒ ::String

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



96
97
98
99
 
# File 'proto_docs/google/monitoring/v3/alert_service.rb', line 96

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

#page_size ⇒ ::Integer

Returns The maximum number of results to return in a single response.

Returns:

  • (::Integer) —

    The maximum number of results to return in a single response.



96
97
98
99
 
# File 'proto_docs/google/monitoring/v3/alert_service.rb', line 96

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

#page_token ⇒ ::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.



96
97
98
99
 
# File 'proto_docs/google/monitoring/v3/alert_service.rb', line 96

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