Generated from protobuf messagegoogle.cloud.kms.v1.ListKeyRingsRequest
Namespace
Google \ Cloud \ Kms \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ parent
string
Required. The resource name of the location associated with theKeyRings, in the formatprojects/*/locations/*.
↳ page_size
int
Optional. Optional limit on the number ofKeyRingsto include in the response. FurtherKeyRingscan subsequently be obtained by including theListKeyRingsResponse.next_page_tokenin a subsequent request. If unspecified, the server will pick an appropriate default.
Optional. Specify how the results should be sorted. If not specified, the results will be sorted in the default order. For more information, seeSorting and filtering list results.
getParent
Required. The resource name of the location associated with theKeyRings, in the formatprojects/*/locations/*.
Returns
Type
Description
string
setParent
Required. The resource name of the location associated with theKeyRings, in the formatprojects/*/locations/*.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getPageSize
Optional. Optional limit on the number ofKeyRingsto include in the response. FurtherKeyRingscan subsequently be obtained by
including theListKeyRingsResponse.next_page_tokenin a subsequent request. If unspecified, the server will pick an
appropriate default.
Returns
Type
Description
int
setPageSize
Optional. Optional limit on the number ofKeyRingsto include in the response. FurtherKeyRingscan subsequently be obtained by
including theListKeyRingsResponse.next_page_tokenin a subsequent request. If unspecified, the server will pick an
appropriate default.
Optional. Specify how the results should be sorted. If not specified, the
results will be sorted in the default order. For more information, seeSorting 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, seeSorting 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 location associated with theKeyRings, in the formatprojects/*/locations/*. Please seeKeyManagementServiceClient::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-04 UTC."],[],[],null,["# Cloud KMS V1 Client - Class ListKeyRingsRequest (2.3.1)\n\nVersion latestkeyboard_arrow_down\n\n- [2.3.1 (latest)](/php/docs/reference/cloud-kms/latest/V1.ListKeyRingsRequest)\n- [2.3.0](/php/docs/reference/cloud-kms/2.3.0/V1.ListKeyRingsRequest)\n- [2.2.0](/php/docs/reference/cloud-kms/2.2.0/V1.ListKeyRingsRequest)\n- [2.1.6](/php/docs/reference/cloud-kms/2.1.6/V1.ListKeyRingsRequest)\n- [2.0.0](/php/docs/reference/cloud-kms/2.0.0/V1.ListKeyRingsRequest)\n- [1.23.0](/php/docs/reference/cloud-kms/1.23.0/V1.ListKeyRingsRequest)\n- [1.22.1](/php/docs/reference/cloud-kms/1.22.1/V1.ListKeyRingsRequest)\n- [1.21.4](/php/docs/reference/cloud-kms/1.21.4/V1.ListKeyRingsRequest)\n- [1.20.3](/php/docs/reference/cloud-kms/1.20.3/V1.ListKeyRingsRequest)\n- [1.19.0](/php/docs/reference/cloud-kms/1.19.0/V1.ListKeyRingsRequest)\n- [1.18.1](/php/docs/reference/cloud-kms/1.18.1/V1.ListKeyRingsRequest)\n- [1.17.0](/php/docs/reference/cloud-kms/1.17.0/V1.ListKeyRingsRequest)\n- [1.16.4](/php/docs/reference/cloud-kms/1.16.4/V1.ListKeyRingsRequest)\n- [1.15.3](/php/docs/reference/cloud-kms/1.15.3/V1.ListKeyRingsRequest) \nReference documentation and code samples for the Cloud KMS V1 Client class ListKeyRingsRequest.\n\nRequest message for\n[KeyManagementService.ListKeyRings](/php/docs/reference/cloud-kms/latest/V1.Client.KeyManagementServiceClient#_Google_Cloud_Kms_V1_Client_KeyManagementServiceClient__listKeyRings__).\n\nGenerated from protobuf message `google.cloud.kms.v1.ListKeyRingsRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Kms \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getParent\n\nRequired. The resource name of the location associated with the\n[KeyRings](/php/docs/reference/cloud-kms/latest/V1.KeyRing), in the format\n`projects/*/locations/*`.\n\n### setParent\n\nRequired. The resource name of the location associated with the\n[KeyRings](/php/docs/reference/cloud-kms/latest/V1.KeyRing), in the format\n`projects/*/locations/*`.\n\n### getPageSize\n\nOptional. Optional limit on the number of\n[KeyRings](/php/docs/reference/cloud-kms/latest/V1.KeyRing) to include in the response. Further\n[KeyRings](/php/docs/reference/cloud-kms/latest/V1.KeyRing) can subsequently be obtained by\nincluding the\n[ListKeyRingsResponse.next_page_token](/php/docs/reference/cloud-kms/latest/V1.ListKeyRingsResponse#_Google_Cloud_Kms_V1_ListKeyRingsResponse__getNextPageToken__)\nin a subsequent request. If unspecified, the server will pick an\nappropriate default.\n\n### setPageSize\n\nOptional. Optional limit on the number of\n[KeyRings](/php/docs/reference/cloud-kms/latest/V1.KeyRing) to include in the response. Further\n[KeyRings](/php/docs/reference/cloud-kms/latest/V1.KeyRing) can subsequently be obtained by\nincluding the\n[ListKeyRingsResponse.next_page_token](/php/docs/reference/cloud-kms/latest/V1.ListKeyRingsResponse#_Google_Cloud_Kms_V1_ListKeyRingsResponse__getNextPageToken__)\nin a subsequent request. If unspecified, the server will pick an\nappropriate default.\n\n### getPageToken\n\nOptional. Optional pagination token, returned earlier via\n[ListKeyRingsResponse.next_page_token](/php/docs/reference/cloud-kms/latest/V1.ListKeyRingsResponse#_Google_Cloud_Kms_V1_ListKeyRingsResponse__getNextPageToken__).\n\n### setPageToken\n\nOptional. Optional pagination token, returned earlier via\n[ListKeyRingsResponse.next_page_token](/php/docs/reference/cloud-kms/latest/V1.ListKeyRingsResponse#_Google_Cloud_Kms_V1_ListKeyRingsResponse__getNextPageToken__).\n\n### getFilter\n\nOptional. Only include resources that match the filter in the response. For\nmore information, see\n[Sorting and filtering list\nresults](https://cloud.google.com/kms/docs/sorting-and-filtering).\n\n### setFilter\n\nOptional. Only include resources that match the filter in the response. For\nmore information, see\n[Sorting and filtering list\nresults](https://cloud.google.com/kms/docs/sorting-and-filtering).\n\n### getOrderBy\n\nOptional. Specify how the results should be sorted. If not specified, the\nresults will be sorted in the default order. For more information, see\n[Sorting and filtering list\nresults](https://cloud.google.com/kms/docs/sorting-and-filtering).\n\n### setOrderBy\n\nOptional. Specify how the results should be sorted. If not specified, the\nresults will be sorted in the default order. For more information, see\n[Sorting and filtering list\nresults](https://cloud.google.com/kms/docs/sorting-and-filtering).\n\n### static::build"]]
