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

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/kms/v1/doc/google/cloud/kms/v1/service.rb

Overview

Request message for KeyManagementService::ListKeyRings.

Instance Attribute Summary collapse

Instance Attribute Details

#filterString

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

Returns:



47
# File 'lib/google/cloud/kms/v1/doc/google/cloud/kms/v1/service.rb', line 47

class ListKeyRingsRequest; end

#order_byString

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.



47
# File 'lib/google/cloud/kms/v1/doc/google/cloud/kms/v1/service.rb', line 47

class ListKeyRingsRequest; end

#page_sizeInteger

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.



47
# File 'lib/google/cloud/kms/v1/doc/google/cloud/kms/v1/service.rb', line 47

class ListKeyRingsRequest; end

#page_tokenString

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

Returns:



47
# File 'lib/google/cloud/kms/v1/doc/google/cloud/kms/v1/service.rb', line 47

class ListKeyRingsRequest; end

#parentString

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/*.



47
# File 'lib/google/cloud/kms/v1/doc/google/cloud/kms/v1/service.rb', line 47

class ListKeyRingsRequest; end