Google Cloud KMS Inventory V1 Client - Class SearchProtectedResourcesRequest (0.4.4)

Version latest

• 0.4.4 (latest)
• 0.4.3
• 0.3.1
• 0.2.3
• 0.1.2

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

Namespace

Google \ Cloud \ Kms \ Inventory \ V1

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.
↳ resource_types	array Optional. A list of resource types that this request searches for. If empty, it will search all the trackable resource types. Regular expressions are also supported. For example: * compute.googleapis.com.* snapshots resources whose type starts with compute.googleapis.com. * .*Image snapshots resources whose type ends with Image. * .*Image.* snapshots resources whose type contains Image. See RE2 for all supported regular expression syntax. If the regular expression does not match any supported resource type, an INVALID_ARGUMENT error will be returned.

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

getResourceTypes

Optional. A list of resource types that this request searches for. If empty, it will search all the trackable resource types.

Regular expressions are also supported. For example:

• compute.googleapis.com.* snapshots resources whose type starts with compute.googleapis.com.
• .*Image snapshots resources whose type ends with Image.
• .*Image.* snapshots resources whose type contains Image. See RE2 for all supported regular expression syntax. If the regular expression does not match any supported resource type, an INVALID_ARGUMENT error will be returned.

Returns
Type	Description
Google\Protobuf\Internal\RepeatedField

setResourceTypes

Optional. A list of resource types that this request searches for. If empty, it will search all the trackable resource types.

Regular expressions are also supported. For example:

• compute.googleapis.com.* snapshots resources whose type starts with compute.googleapis.com.
• .*Image snapshots resources whose type ends with Image.
• .*Image.* snapshots resources whose type contains Image. See RE2 for all supported regular expression syntax. If the regular expression does not match any supported resource type, an INVALID_ARGUMENT error will be returned.

Parameter
Name	Description
var	string[]

Returns
Type	Description
$this

static::build

Parameters
Name	Description
scope	string Required. Resource name of the organization. Example: organizations/123 Please see Google\Cloud\Kms\Inventory\V1\KeyTrackingServiceClient::organizationName() for help formatting this field.
cryptoKey	string Required. The resource name of the CryptoKey.

Returns
Type	Description
Google\Cloud\Kms\Inventory\V1\SearchProtectedResourcesRequest