Class: Google::Cloud::Kms::V1::ListKeyRingsRequest

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

Overview

Request message for KeyManagementService.ListKeyRings.

Instance Attribute Summary collapse

Instance Attribute Details

#filter ⇒ ::String

Returns Optional. Only include resources that match the filter in the response. For more information, see Sorting and filtering list results.

Returns:



56
57
58
59
 
# File 'proto_docs/google/cloud/kms/v1/service.rb', line 56

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

#order_by ⇒ ::String

Returns Optional. Specify how the results should be sorted. If not specified, the results will be sorted in the default order. For more information, see Sorting and filtering list results.

Returns:

  • (::String) —

    Optional. Specify how the results should be sorted. If not specified, the results will be sorted in the default order. For more information, see Sorting and filtering list results.



56
57
58
59
 
# File 'proto_docs/google/cloud/kms/v1/service.rb', line 56

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

#page_size ⇒ ::Integer

Returns Optional. Optional limit on the number of KeyRings to include in the response. Further KeyRings can subsequently be obtained by including the ListKeyRingsResponse.next_page_token in a subsequent request. If unspecified, the server will pick an appropriate default.

Returns:

  • (::Integer) —

    Optional. Optional limit on the number of KeyRings to include in the response. Further KeyRings can subsequently be obtained by including the ListKeyRingsResponse.next_page_token in a subsequent request. If unspecified, the server will pick an appropriate default.



56
57
58
59
 
# File 'proto_docs/google/cloud/kms/v1/service.rb', line 56

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

#page_token ⇒ ::String

Returns Optional. Optional pagination token, returned earlier via ListKeyRingsResponse.next_page_token.

Returns:



56
57
58
59
 
# File 'proto_docs/google/cloud/kms/v1/service.rb', line 56

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

#parent ⇒ ::String

Returns Required. The resource name of the location associated with the KeyRings, in the format projects/*/locations/*.

Returns:

  • (::String) —

    Required. The resource name of the location associated with the KeyRings, in the format projects/*/locations/*.



56
57
58
59
 
# File 'proto_docs/google/cloud/kms/v1/service.rb', line 56

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