Google Cloud KMS Inventory V1 Client - Class ListCryptoKeysRequest (0.3.1)

Reference documentation and code samples for the Google Cloud KMS Inventory V1 Client class ListCryptoKeysRequest.

Request message for KeyDashboardService.ListCryptoKeys.

Generated from protobuf message google.cloud.kms.inventory.v1.ListCryptoKeysRequest

Namespace

Google \ Cloud \ Kms \ Inventory \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ parent string

Required. The Google Cloud project for which to retrieve key metadata, in the format projects/*

↳ page_size int

Optional. The maximum number of keys to return. The service may return fewer than this value. If unspecified, at most 1000 keys will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

↳ page_token string

Optional. Pass this into a subsequent request in order to receive the next page of results.

getParent

Required. The Google Cloud project for which to retrieve key metadata, in the format projects/*

Returns
TypeDescription
string

setParent

Required. The Google Cloud project for which to retrieve key metadata, in the format projects/*

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getPageSize

Optional. The maximum number of keys to return. The service may return fewer than this value. If unspecified, at most 1000 keys will be returned.

The maximum value is 1000; values above 1000 will be coerced to 1000.

Returns
TypeDescription
int

setPageSize

Optional. The maximum number of keys to return. The service may return fewer than this value. If unspecified, at most 1000 keys will be returned.

The maximum value is 1000; values above 1000 will be coerced to 1000.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getPageToken

Optional. Pass this into a subsequent request in order to receive the next page of results.

Returns
TypeDescription
string

setPageToken

Optional. Pass this into a subsequent request in order to receive the next page of results.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

static::build

Parameter
NameDescription
parent string

Required. The Google Cloud project for which to retrieve key metadata, in the format projects/* Please see Google\Cloud\Kms\Inventory\V1\KeyDashboardServiceClient::projectName() for help formatting this field.

Returns
TypeDescription
Google\Cloud\Kms\Inventory\V1\ListCryptoKeysRequest