Reference documentation and code samples for the Cloud Key Management Service (KMS) V1 API class Google::Cloud::Kms::V1::ListKeyRingsRequest.
Request message for KeyManagementService.ListKeyRings.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#filter
def filter() -> ::String
Returns
- (::String) — Optional. Only include resources that match the filter in the response. For more information, see Sorting and filtering list results.
#filter=
def filter=(value) -> ::String
Parameter
- value (::String) — Optional. Only include resources that match the filter in the response. For more information, see Sorting and filtering list results.
Returns
- (::String) — Optional. Only include resources that match the filter in the response. For more information, see Sorting and filtering list results.
#order_by
def order_by() -> ::String
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.
#order_by=
def order_by=(value) -> ::String
Parameter
- value (::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.
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.
#page_size
def page_size() -> ::Integer
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.
#page_size=
def page_size=(value) -> ::Integer
Parameter
- value (::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.
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.
#page_token
def page_token() -> ::String
Returns
- (::String) — Optional. Optional pagination token, returned earlier via ListKeyRingsResponse.next_page_token.
#page_token=
def page_token=(value) -> ::String
Parameter
- value (::String) — Optional. Optional pagination token, returned earlier via ListKeyRingsResponse.next_page_token.
Returns
- (::String) — Optional. Optional pagination token, returned earlier via ListKeyRingsResponse.next_page_token.
#parent
def parent() -> ::String
Returns
-
(::String) — Required. The resource name of the location associated with the
KeyRings, in the format
projects/*/locations/*.
#parent=
def parent=(value) -> ::String
Parameter
-
value (::String) — 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/*.