Cloud KMS V1 Client - Class ListKeyHandlesRequest (2.1.0)

Version 2.1.0

• 2.1.1 (latest)
• 2.1.0
• 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 ListKeyHandlesRequest.

Request message for Autokey.ListKeyHandles.

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

Namespace

Google \ Cloud \ Kms \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ parent	string Required. Name of the resource project and location from which to list KeyHandles, e.g. projects/{PROJECT_ID}/locations/{LOCATION}.
↳ page_size	int Optional. Optional limit on the number of KeyHandles to include in the response. The service may return fewer than this value. Further KeyHandles can subsequently be obtained by including the ListKeyHandlesResponse.next_page_token in a subsequent request. If unspecified, at most 100 KeyHandles will be returned.
↳ page_token	string Optional. Optional pagination token, returned earlier via ListKeyHandlesResponse.next_page_token.
↳ filter	string Optional. Filter to apply when listing KeyHandles, e.g. resource_type_selector="{SERVICE}.googleapis.com/{TYPE}".

getParent

Required. Name of the resource project and location from which to list KeyHandles, e.g.

projects/{PROJECT_ID}/locations/{LOCATION}.

Returns
Type	Description
string

setParent

Required. Name of the resource project and location from which to list KeyHandles, e.g.

projects/{PROJECT_ID}/locations/{LOCATION}.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getPageSize

Optional. Optional limit on the number of KeyHandles to include in the response. The service may return fewer than this value. Further KeyHandles can subsequently be obtained by including the ListKeyHandlesResponse.next_page_token in a subsequent request. If unspecified, at most 100 KeyHandles will be returned.

Returns
Type	Description
int

setPageSize

Optional. Optional limit on the number of KeyHandles to include in the response. The service may return fewer than this value. Further KeyHandles can subsequently be obtained by including the ListKeyHandlesResponse.next_page_token in a subsequent request. If unspecified, at most 100 KeyHandles will be returned.

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getPageToken

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

Returns
Type	Description
string

setPageToken

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

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getFilter

Optional. Filter to apply when listing KeyHandles, e.g.

resource_type_selector="{SERVICE}.googleapis.com/{TYPE}".

Returns
Type	Description
string

setFilter

Optional. Filter to apply when listing KeyHandles, e.g.

resource_type_selector="{SERVICE}.googleapis.com/{TYPE}".

Parameter
Name	Description
var	string

Returns
Type	Description
$this

static::build

Parameter
Name	Description
parent	string Required. Name of the resource project and location from which to list KeyHandles, e.g. projects/{PROJECT_ID}/locations/{LOCATION}. Please see Google\Cloud\Kms\V1\AutokeyClient::locationName() for help formatting this field.

Returns
Type	Description
Google\Cloud\Kms\V1\ListKeyHandlesRequest