Cloud KMS V1 Client - Class ListKeyRingsResponse (1.17.0)

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

Response message for KeyManagementService.ListKeyRings.

Generated from protobuf message google.cloud.kms.v1.ListKeyRingsResponse

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ key_rings array<Google\Cloud\Kms\V1\KeyRing>

The list of KeyRings.

↳ next_page_token string

A token to retrieve next page of results. Pass this value in ListKeyRingsRequest.page_token to retrieve the next page of results.

↳ total_size int

The total number of KeyRings that matched the query.

getKeyRings

The list of KeyRings.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setKeyRings

The list of KeyRings.

Parameter
NameDescription
var array<Google\Cloud\Kms\V1\KeyRing>
Returns
TypeDescription
$this

getNextPageToken

A token to retrieve next page of results. Pass this value in ListKeyRingsRequest.page_token to retrieve the next page of results.

Returns
TypeDescription
string

setNextPageToken

A token to retrieve next page of results. Pass this value in ListKeyRingsRequest.page_token to retrieve the next page of results.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getTotalSize

The total number of KeyRings that matched the query.

Returns
TypeDescription
int

setTotalSize

The total number of KeyRings that matched the query.

Parameter
NameDescription
var int
Returns
TypeDescription
$this