Cloud KMS V1 Client - Class ListCryptoKeysRequest (2.9.0)

Reference documentation and code samples for the Cloud KMS V1 Client class ListCryptoKeysRequest.

Request message for KeyManagementService.ListCryptoKeys.

Generated from protobuf message google.cloud.kms.v1.ListCryptoKeysRequest

Namespace

Google \ Cloud \ Kms \ V1

Methods

__construct

Constructor.

Parameter
Name Description
data mixed

getParent

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

Returns
Type Description
string

setParent

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

Parameter
Name Description
var string
Returns
Type Description
$this

getPageSize

Optional. 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
Type Description
int

setPageSize

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

Parameter
Name Description
var int
Returns
Type Description
$this

getPageToken

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

Returns
Type Description
string

setPageToken

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

Parameter
Name Description
var string
Returns
Type Description
$this

getVersionView

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

Returns
Type Description
int Enum of type CryptoKeyVersionView.

setVersionView

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

Parameter
Name Description
var int

Enum of type CryptoKeyVersionView.

Returns
Type Description
$this

getFilter

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

Returns
Type Description
string

setFilter

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

Parameter
Name Description
var string
Returns
Type Description
$this

getOrderBy

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
Type Description
string

setOrderBy

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.

Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameter
Name Description
parent string

Required. The resource name of the KeyRing to list, in the format projects/*/locations/*/keyRings/*. Please see KeyManagementServiceClient::keyRingName() for help formatting this field.
Returns
Type Description
ListCryptoKeysRequest