Class: Google::Cloud::Kms::V1::ListCryptoKeysRequest

Inherits:

Object

• Object
• Google::Cloud::Kms::V1::ListCryptoKeysRequest

Defined in:

lib/google/cloud/kms/v1/doc/google/cloud/kms/v1/service.rb

Overview

Request message for KeyManagementService::ListCryptoKeys.

Instance Attribute Summary

• #filter ⇒ String

  Optional.

• #order_by ⇒ String

  Optional.

• #page_size ⇒ Integer

  Optional limit on the number of CryptoKeys to include in the response.

• #page_token ⇒ String

  Optional pagination token, returned earlier via ListCryptoKeysResponse#next_page_token.

• #parent ⇒ String

  Required.

• #version_view ⇒ Google::Cloud::Kms::V1::CryptoKeyVersion::CryptoKeyVersionView

  The fields of the primary version to include in the response.

Instance Attribute Details

#filter ⇒ String

Returns Optional. Only include resources that match the filter in the response.

Returns:

• (String) —

  Optional. Only include resources that match the filter in the response.

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

class ListCryptoKeysRequest; 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.

Returns:

• (String) —

  Optional. Specify how the results should be sorted. If not specified, the results will be sorted in the default order.

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

class ListCryptoKeysRequest; end

#page_size ⇒ Integer

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

Returns:

• (Integer) —

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

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

class ListCryptoKeysRequest; end

#page_token ⇒ String

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

Returns:

• (String) —

  Optional pagination token, returned earlier via ListCryptoKeysResponse#next_page_token.

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

class ListCryptoKeysRequest; end

#parent ⇒ String

Returns Required. The resource name of the KeyRing to list, in the format projects/*/locations/*/keyRings/*.

Returns:

• (String) —

  Required. The resource name of the KeyRing to list, in the format projects/*/locations/*/keyRings/*.

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

class ListCryptoKeysRequest; end

#version_view ⇒ Google::Cloud::Kms::V1::CryptoKeyVersion::CryptoKeyVersionView

Returns The fields of the primary version to include in the response.

Returns:

• (Google::Cloud::Kms::V1::CryptoKeyVersion::CryptoKeyVersionView) —

  The fields of the primary version to include in the response.

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

class ListCryptoKeysRequest; end