Reference documentation and code samples for the Cloud KMS V1 Client class ListRetiredResourcesRequest.
Request message for KeyManagementService.ListRetiredResources.
Generated from protobuf message google.cloud.kms.v1.ListRetiredResourcesRequest
Namespace
Google \ Cloud \ Kms \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ parent |
string
Required. The project-specific location holding the RetiredResources, in the format |
↳ page_size |
int
Optional. Optional limit on the number of RetiredResources to be included in the response. Further RetiredResources can subsequently be obtained by including the ListRetiredResourcesResponse.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 ListRetiredResourcesResponse.next_page_token. |
getParent
Required. The project-specific location holding the
RetiredResources, in the format
projects/*/locations/*.
| Returns | |
|---|---|
| Type | Description |
string |
|
setParent
Required. The project-specific location holding the
RetiredResources, in the format
projects/*/locations/*.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPageSize
Optional. Optional limit on the number of RetiredResources to be included in the response. Further RetiredResources can subsequently be obtained by including the ListRetiredResourcesResponse.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 RetiredResources to be included in the response. Further RetiredResources can subsequently be obtained by including the ListRetiredResourcesResponse.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 ListRetiredResourcesResponse.next_page_token.
| Returns | |
|---|---|
| Type | Description |
string |
|
setPageToken
Optional. Optional pagination token, returned earlier via ListRetiredResourcesResponse.next_page_token.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
static::build
| Parameter | |
|---|---|
| Name | Description |
parent |
string
Required. The project-specific location holding the
RetiredResources, in the format
|
| Returns | |
|---|---|
| Type | Description |
ListRetiredResourcesRequest |
|