Cloud KMS V1 Client - Class ListKeyRingsRequest (2.1.0)

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

Request message for KeyManagementService.ListKeyRings.

Generated from protobuf message google.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 the KeyRings, in the format `projects//locations/`.
`↳ page_size`	`int` Optional. Optional limit on the number of KeyRings to include in the response. Further KeyRings can subsequently be obtained by including the ListKeyRingsResponse.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 ListKeyRingsResponse.next_page_token.
`↳ 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 location associated with the KeyRings, in the format projects/*/locations/*.

Returns
Type	Description
`string`

setParent

Required. The resource name of the location associated with the KeyRings, in the format projects/*/locations/*.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getPageSize

Optional. Optional limit on the number of KeyRings to include in the response. Further KeyRings can subsequently be obtained by including the ListKeyRingsResponse.next_page_token in a subsequent request. If unspecified, the server will pick an appropriate default.

Returns
Type	Description
`int`

setPageSize

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getPageToken

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

Returns
Type	Description
`string`

setPageToken

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

Parameter
Name	Description
`var`	`string`

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`

static::build

Parameter
Name	Description
`parent`	`string` Required. The resource name of the location associated with the KeyRings, in the format `projects//locations/`. Please see Google\Cloud\Kms\V1\KeyManagementServiceClient::locationName() for help formatting this field.

Returns
Type	Description
`Google\Cloud\Kms\V1\ListKeyRingsRequest`