Google Cloud Container V1 Client - Class DatabaseEncryption (2.3.0)

Reference documentation and code samples for the Google Cloud Container V1 Client class DatabaseEncryption.

Configuration of etcd encryption.

Generated from protobuf message google.container.v1.DatabaseEncryption

Namespace

Google \ Cloud \ Container \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ key_name string

Name of CloudKMS key to use for the encryption of secrets in etcd. Ex. projects/my-project/locations/global/keyRings/my-ring/cryptoKeys/my-key

↳ state int

The desired state of etcd encryption.

↳ current_state int

Output only. The current state of etcd encryption.

↳ decryption_keys array

Output only. Keys in use by the cluster for decrypting existing objects, in addition to the key in key_name. Each item is a CloudKMS key resource.

↳ last_operation_errors array<DatabaseEncryption\OperationError>

Output only. Records errors seen during DatabaseEncryption update operations.

getKeyName

Name of CloudKMS key to use for the encryption of secrets in etcd.

Ex. projects/my-project/locations/global/keyRings/my-ring/cryptoKeys/my-key

Returns
Type Description
string

setKeyName

Name of CloudKMS key to use for the encryption of secrets in etcd.

Ex. projects/my-project/locations/global/keyRings/my-ring/cryptoKeys/my-key

Parameter
Name Description
var string
Returns
Type Description
$this

getState

The desired state of etcd encryption.

Returns
Type Description
int

setState

The desired state of etcd encryption.

Parameter
Name Description
var int
Returns
Type Description
$this

getCurrentState

Output only. The current state of etcd encryption.

Returns
Type Description
int

hasCurrentState

clearCurrentState

setCurrentState

Output only. The current state of etcd encryption.

Parameter
Name Description
var int
Returns
Type Description
$this

getDecryptionKeys

Output only. Keys in use by the cluster for decrypting existing objects, in addition to the key in key_name.

Each item is a CloudKMS key resource.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setDecryptionKeys

Output only. Keys in use by the cluster for decrypting existing objects, in addition to the key in key_name.

Each item is a CloudKMS key resource.

Parameter
Name Description
var string[]
Returns
Type Description
$this

getLastOperationErrors

Output only. Records errors seen during DatabaseEncryption update operations.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setLastOperationErrors

Output only. Records errors seen during DatabaseEncryption update operations.

Parameter
Name Description
var array<DatabaseEncryption\OperationError>
Returns
Type Description
$this