Reference documentation and code samples for the Google Cloud KMS Inventory V1 Client class SearchProtectedResourcesRequest.
Request message for KeyTrackingService.SearchProtectedResources.
Generated from protobuf message google.cloud.kms.inventory.v1.SearchProtectedResourcesRequest
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ scope |
string
Required. Resource name of the organization. Example: organizations/123 |
↳ crypto_key |
string
Required. The resource name of the CryptoKey. |
↳ page_size |
int
The maximum number of resources to return. The service may return fewer than this value. If unspecified, at most 500 resources will be returned. The maximum value is 500; values above 500 will be coerced to 500. |
↳ page_token |
string
A page token, received from a previous KeyTrackingService.SearchProtectedResources call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to KeyTrackingService.SearchProtectedResources must match the call that provided the page token. |
getScope
Required. Resource name of the organization.
Example: organizations/123
| Returns | |
|---|---|
| Type | Description |
string |
|
setScope
Required. Resource name of the organization.
Example: organizations/123
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCryptoKey
Required. The resource name of the CryptoKey.
| Returns | |
|---|---|
| Type | Description |
string |
|
setCryptoKey
Required. The resource name of the CryptoKey.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPageSize
The maximum number of resources to return. The service may return fewer than this value.
If unspecified, at most 500 resources will be returned. The maximum value is 500; values above 500 will be coerced to 500.
| Returns | |
|---|---|
| Type | Description |
int |
|
setPageSize
The maximum number of resources to return. The service may return fewer than this value.
If unspecified, at most 500 resources will be returned. The maximum value is 500; values above 500 will be coerced to 500.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPageToken
A page token, received from a previous KeyTrackingService.SearchProtectedResources call. Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to KeyTrackingService.SearchProtectedResources must match the call that provided the page token.
| Returns | |
|---|---|
| Type | Description |
string |
|
setPageToken
A page token, received from a previous KeyTrackingService.SearchProtectedResources call. Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to KeyTrackingService.SearchProtectedResources must match the call that provided the page token.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|