Cloud KMS V1 Client - Class ListCryptoKeyVersionsRequest (1.15.3)

Version 1.15.3

• 2.1.2 (latest)
• 2.1.1
• 2.0.0
• 1.23.0
• 1.22.1
• 1.21.4
• 1.20.3
• 1.19.0
• 1.18.1
• 1.17.0
• 1.16.4
• 1.15.3

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

Request message for KeyManagementService.ListCryptoKeyVersions.

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

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ parent	string Required. The resource name of the CryptoKey to list, in the format projects/*/locations/*/keyRings/*/cryptoKeys/*.
↳ page_size	int Optional. Optional limit on the number of CryptoKeyVersions to include in the response. Further CryptoKeyVersions can subsequently be obtained by including the ListCryptoKeyVersionsResponse.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 ListCryptoKeyVersionsResponse.next_page_token.
↳ view	int The fields 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 CryptoKey to list, in the format projects/*/locations/*/keyRings/*/cryptoKeys/*.

Returns
Type	Description
string

setParent

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

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getPageSize

Optional. Optional limit on the number of CryptoKeyVersions to include in the response. Further CryptoKeyVersions can subsequently be obtained by including the ListCryptoKeyVersionsResponse.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 CryptoKeyVersions to include in the response. Further CryptoKeyVersions can subsequently be obtained by including the ListCryptoKeyVersionsResponse.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 ListCryptoKeyVersionsResponse.next_page_token.

Returns
Type	Description
string

setPageToken

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

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getView

The fields to include in the response.

Returns
Type	Description
int

setView

The fields to include in the response.

Parameter
Name	Description
var	int

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