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.
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.
Required. Name of the resource project and location from which to list
KeyHandles, e.g.
projects/{PROJECT_ID}/locations/{LOCATION}. Please see
AutokeyClient::locationName() for help formatting this field.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-09 UTC."],[],[],null,["# Cloud KMS V1 Client - Class ListKeyHandlesRequest (2.3.1)\n\nVersion latestkeyboard_arrow_down\n\n- [2.3.1 (latest)](/php/docs/reference/cloud-kms/latest/V1.ListKeyHandlesRequest)\n- [2.3.0](/php/docs/reference/cloud-kms/2.3.0/V1.ListKeyHandlesRequest)\n- [2.2.0](/php/docs/reference/cloud-kms/2.2.0/V1.ListKeyHandlesRequest)\n- [2.1.6](/php/docs/reference/cloud-kms/2.1.6/V1.ListKeyHandlesRequest)\n- [2.0.0](/php/docs/reference/cloud-kms/2.0.0/V1.ListKeyHandlesRequest)\n- [1.23.0](/php/docs/reference/cloud-kms/1.23.0/V1.ListKeyHandlesRequest)\n- [1.22.1](/php/docs/reference/cloud-kms/1.22.1/V1.ListKeyHandlesRequest)\n- [1.21.4](/php/docs/reference/cloud-kms/1.21.4/V1.ListKeyHandlesRequest)\n- [1.20.3](/php/docs/reference/cloud-kms/1.20.3/V1.ListKeyHandlesRequest)\n- [1.19.0](/php/docs/reference/cloud-kms/1.19.0/V1.ListKeyHandlesRequest)\n- [1.18.1](/php/docs/reference/cloud-kms/1.18.1/V1.ListKeyHandlesRequest)\n- [1.17.0](/php/docs/reference/cloud-kms/1.17.0/V1.ListKeyHandlesRequest)\n- [1.16.4](/php/docs/reference/cloud-kms/1.16.4/V1.ListKeyHandlesRequest)\n- [1.15.3](/php/docs/reference/cloud-kms/1.15.3/V1.ListKeyHandlesRequest) \nReference documentation and code samples for the Cloud KMS V1 Client class ListKeyHandlesRequest.\n\nRequest message for\n[Autokey.ListKeyHandles](/php/docs/reference/cloud-kms/latest/V1.Client.AutokeyClient#_Google_Cloud_Kms_V1_Client_AutokeyClient__listKeyHandles__).\n\nGenerated from protobuf message `google.cloud.kms.v1.ListKeyHandlesRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Kms \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getParent\n\nRequired. Name of the resource project and location from which to list\n[KeyHandles](/php/docs/reference/cloud-kms/latest/V1.KeyHandle), e.g.\n\n`projects/{PROJECT_ID}/locations/{LOCATION}`.\n\n### setParent\n\nRequired. Name of the resource project and location from which to list\n[KeyHandles](/php/docs/reference/cloud-kms/latest/V1.KeyHandle), e.g.\n\n`projects/{PROJECT_ID}/locations/{LOCATION}`.\n\n### getPageSize\n\nOptional. Optional limit on the number of\n[KeyHandles](/php/docs/reference/cloud-kms/latest/V1.KeyHandle) to include in the response. The\nservice may return fewer than this value. Further\n[KeyHandles](/php/docs/reference/cloud-kms/latest/V1.KeyHandle) can subsequently be obtained by\nincluding the\n[ListKeyHandlesResponse.next_page_token](/php/docs/reference/cloud-kms/latest/V1.ListKeyHandlesResponse#_Google_Cloud_Kms_V1_ListKeyHandlesResponse__getNextPageToken__)\nin a subsequent request. If unspecified, at most 100\n[KeyHandles](/php/docs/reference/cloud-kms/latest/V1.KeyHandle) will be returned.\n\n### setPageSize\n\nOptional. Optional limit on the number of\n[KeyHandles](/php/docs/reference/cloud-kms/latest/V1.KeyHandle) to include in the response. The\nservice may return fewer than this value. Further\n[KeyHandles](/php/docs/reference/cloud-kms/latest/V1.KeyHandle) can subsequently be obtained by\nincluding the\n[ListKeyHandlesResponse.next_page_token](/php/docs/reference/cloud-kms/latest/V1.ListKeyHandlesResponse#_Google_Cloud_Kms_V1_ListKeyHandlesResponse__getNextPageToken__)\nin a subsequent request. If unspecified, at most 100\n[KeyHandles](/php/docs/reference/cloud-kms/latest/V1.KeyHandle) will be returned.\n\n### getPageToken\n\nOptional. Optional pagination token, returned earlier via\n[ListKeyHandlesResponse.next_page_token](/php/docs/reference/cloud-kms/latest/V1.ListKeyHandlesResponse#_Google_Cloud_Kms_V1_ListKeyHandlesResponse__getNextPageToken__).\n\n### setPageToken\n\nOptional. Optional pagination token, returned earlier via\n[ListKeyHandlesResponse.next_page_token](/php/docs/reference/cloud-kms/latest/V1.ListKeyHandlesResponse#_Google_Cloud_Kms_V1_ListKeyHandlesResponse__getNextPageToken__).\n\n### getFilter\n\nOptional. Filter to apply when listing\n[KeyHandles](/php/docs/reference/cloud-kms/latest/V1.KeyHandle), e.g.\n\n`resource_type_selector=\"{SERVICE}.googleapis.com/{TYPE}\"`.\n\n### setFilter\n\nOptional. Filter to apply when listing\n[KeyHandles](/php/docs/reference/cloud-kms/latest/V1.KeyHandle), e.g.\n\n`resource_type_selector=\"{SERVICE}.googleapis.com/{TYPE}\"`.\n\n### static::build"]]
