Google Cloud Sql Admin V1 Client - Class EncryptionOptions (1.6.0)

Reference documentation and code samples for the Google Cloud Sql Admin V1 Client class EncryptionOptions.

Generated from protobuf message google.cloud.sql.v1.ImportContext.SqlBakImportOptions.EncryptionOptions

Namespace

Google \ Cloud \ Sql \ V1 \ ImportContext \ SqlBakImportOptions

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ cert_path string

Path to the Certificate (.cer) in Cloud Storage, in the form gs://bucketName/fileName. The instance must have write permissions to the bucket and read access to the file.
↳ pvk_path string

Path to the Certificate Private Key (.pvk) in Cloud Storage, in the form gs://bucketName/fileName. The instance must have write permissions to the bucket and read access to the file.
↳ pvk_password string

Password that encrypts the private key
↳ keep_encrypted Google\Protobuf\BoolValue

Optional. Whether the imported file remains encrypted.

getCertPath

Path to the Certificate (.cer) in Cloud Storage, in the form gs://bucketName/fileName. The instance must have write permissions to the bucket and read access to the file.

Returns
Type Description
string

setCertPath

Path to the Certificate (.cer) in Cloud Storage, in the form gs://bucketName/fileName. The instance must have write permissions to the bucket and read access to the file.

Parameter
Name Description
var string
Returns
Type Description
$this

getPvkPath

Path to the Certificate Private Key (.pvk) in Cloud Storage, in the form gs://bucketName/fileName. The instance must have write permissions to the bucket and read access to the file.

Returns
Type Description
string

setPvkPath

Path to the Certificate Private Key (.pvk) in Cloud Storage, in the form gs://bucketName/fileName. The instance must have write permissions to the bucket and read access to the file.

Parameter
Name Description
var string
Returns
Type Description
$this

getPvkPassword

Password that encrypts the private key

Returns
Type Description
string

setPvkPassword

Password that encrypts the private key

Parameter
Name Description
var string
Returns
Type Description
$this

getKeepEncrypted

Optional. Whether the imported file remains encrypted.

Returns
Type Description
Google\Protobuf\BoolValue|null

hasKeepEncrypted

clearKeepEncrypted

getKeepEncryptedUnwrapped

Returns the unboxed value from getKeepEncrypted()

Optional. Whether the imported file remains encrypted.

Returns
Type Description
bool|null

setKeepEncrypted

Optional. Whether the imported file remains encrypted.

Parameter
Name Description
var Google\Protobuf\BoolValue
Returns
Type Description
$this

setKeepEncryptedUnwrapped

Sets the field by wrapping a primitive type in a Google\Protobuf\BoolValue object.

Optional. Whether the imported file remains encrypted.

Parameter
Name Description
var bool|null
Returns
Type Description
$this