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

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

Aggregate information about the resources protected by a Cloud KMS key in the same Cloud organization as the key.

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

Namespace

Google \ Cloud \ Kms \ Inventory \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ name string

The full name of the ProtectedResourcesSummary resource. Example: projects/test-project/locations/us/keyRings/test-keyring/cryptoKeys/test-key/protectedResourcesSummary

↳ resource_count int|string

The total number of protected resources in the same Cloud organization as the key.

↳ project_count int

The number of distinct Cloud projects in the same Cloud organization as the key that have resources protected by the key.

↳ resource_types array|Google\Protobuf\Internal\MapField

The number of resources protected by the key grouped by resource type.

↳ cloud_products array|Google\Protobuf\Internal\MapField

The number of resources protected by the key grouped by Cloud product.

↳ locations array|Google\Protobuf\Internal\MapField

The number of resources protected by the key grouped by region.

getName

The full name of the ProtectedResourcesSummary resource.

Example: projects/test-project/locations/us/keyRings/test-keyring/cryptoKeys/test-key/protectedResourcesSummary

Returns
TypeDescription
string

setName

The full name of the ProtectedResourcesSummary resource.

Example: projects/test-project/locations/us/keyRings/test-keyring/cryptoKeys/test-key/protectedResourcesSummary

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getResourceCount

The total number of protected resources in the same Cloud organization as the key.

Returns
TypeDescription
int|string

setResourceCount

The total number of protected resources in the same Cloud organization as the key.

Parameter
NameDescription
var int|string
Returns
TypeDescription
$this

getProjectCount

The number of distinct Cloud projects in the same Cloud organization as the key that have resources protected by the key.

Returns
TypeDescription
int

setProjectCount

The number of distinct Cloud projects in the same Cloud organization as the key that have resources protected by the key.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getResourceTypes

The number of resources protected by the key grouped by resource type.

Returns
TypeDescription
Google\Protobuf\Internal\MapField

setResourceTypes

The number of resources protected by the key grouped by resource type.

Parameter
NameDescription
var array|Google\Protobuf\Internal\MapField
Returns
TypeDescription
$this

getCloudProducts

The number of resources protected by the key grouped by Cloud product.

Returns
TypeDescription
Google\Protobuf\Internal\MapField

setCloudProducts

The number of resources protected by the key grouped by Cloud product.

Parameter
NameDescription
var array|Google\Protobuf\Internal\MapField
Returns
TypeDescription
$this

getLocations

The number of resources protected by the key grouped by region.

Returns
TypeDescription
Google\Protobuf\Internal\MapField

setLocations

The number of resources protected by the key grouped by region.

Parameter
NameDescription
var array|Google\Protobuf\Internal\MapField
Returns
TypeDescription
$this