Cloud KMS V1 Client - Class ListCryptoKeysRequest (1.18.1)

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.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ parent string

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

↳ page_size int

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.

↳ page_token string

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

↳ version_view int

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

↳ filter string

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

↳ order_by 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.

getParent

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

Returns
TypeDescription
string

setParent

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

Parameter
NameDescription
var string
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var int
Returns
TypeDescription
$this

getPageToken

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

Returns
TypeDescription
string

setPageToken

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getVersionView

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

Returns
TypeDescription
int

setVersionView

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

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getFilter

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

Returns
TypeDescription
string

setFilter

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

Parameter
NameDescription
var string
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var string
Returns
TypeDescription
$this

static::build

Parameter
NameDescription
parent string

Required. The resource name of the KeyRing to list, in the format projects/*/locations/*/keyRings/*. Please see Google\Cloud\Kms\V1\KeyManagementServiceClient::keyRingName() for help formatting this field.

Returns
TypeDescription
Google\Cloud\Kms\V1\ListCryptoKeysRequest