Google Cloud Storage Batch Operations V1 Client - Class RewriteObject (0.1.2)

Reference documentation and code samples for the Google Cloud Storage Batch Operations V1 Client class RewriteObject.

Describes options for object rewrite.

Generated from protobuf message google.cloud.storagebatchoperations.v1.RewriteObject

Namespace

Google \ Cloud \ StorageBatchOperations \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ kms_key string

Required. Resource name of the Cloud KMS key that will be used to encrypt the object. The Cloud KMS key must be located in same ___location as the object. Refer to https://cloud.google.com/storage/docs/encryption/using-customer-managed-keys#add-object-key for additional documentation. Format: projects/{project}/locations/{___location}/keyRings/{keyring}/cryptoKeys/{key} For example: "projects/123456/locations/us-central1/keyRings/my-keyring/cryptoKeys/my-key". The object will be rewritten and set with the specified KMS key.

getKmsKey

Required. Resource name of the Cloud KMS key that will be used to encrypt the object. The Cloud KMS key must be located in same ___location as the object. Refer to https://cloud.google.com/storage/docs/encryption/using-customer-managed-keys#add-object-key for additional documentation. Format: projects/{project}/locations/{___location}/keyRings/{keyring}/cryptoKeys/{key} For example: "projects/123456/locations/us-central1/keyRings/my-keyring/cryptoKeys/my-key".

The object will be rewritten and set with the specified KMS key.

Returns
Type Description
string

hasKmsKey

clearKmsKey

setKmsKey

Required. Resource name of the Cloud KMS key that will be used to encrypt the object. The Cloud KMS key must be located in same ___location as the object. Refer to https://cloud.google.com/storage/docs/encryption/using-customer-managed-keys#add-object-key for additional documentation. Format: projects/{project}/locations/{___location}/keyRings/{keyring}/cryptoKeys/{key} For example: "projects/123456/locations/us-central1/keyRings/my-keyring/cryptoKeys/my-key".

The object will be rewritten and set with the specified KMS key.

Parameter
Name Description
var string
Returns
Type Description
$this