Reference documentation and code samples for the Google Cloud Storage Transfer V1 Client class KmsKey.
Options for handling the KmsKey setting for Google Cloud Storage objects.
Protobuf type google.storagetransfer.v1.MetadataOptions.KmsKey
Namespace
Google \ Cloud \ StorageTransfer \ V1 \ MetadataOptions
Methods
static::name
Parameter
Name
Description
value
mixed
static::value
Parameter
Name
Description
name
mixed
Constants
KMS_KEY_UNSPECIFIED
Value: 0
KmsKey behavior is unspecified.
Generated from protobuf enum KMS_KEY_UNSPECIFIED = 0;
KMS_KEY_DESTINATION_BUCKET_DEFAULT
Value: 1
Use the destination bucket's default encryption settings.
Generated from protobuf enum KMS_KEY_DESTINATION_BUCKET_DEFAULT = 1;
KMS_KEY_PRESERVE
Value: 2
Preserve the object's original Cloud KMS customer-managed encryption key
(CMEK) if present. Objects that do not use a Cloud KMS encryption key
will be encrypted using the destination bucket's encryption settings.
Generated from protobuf enum KMS_KEY_PRESERVE = 2;
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Cloud Storage Transfer V1 Client - Class KmsKey (2.2.1)\n\nVersion latestkeyboard_arrow_down\n\n- [2.2.1 (latest)](/php/docs/reference/cloud-storage-transfer/latest/V1.MetadataOptions.KmsKey)\n- [2.2.0](/php/docs/reference/cloud-storage-transfer/2.2.0/V1.MetadataOptions.KmsKey)\n- [2.1.1](/php/docs/reference/cloud-storage-transfer/2.1.1/V1.MetadataOptions.KmsKey)\n- [2.0.2](/php/docs/reference/cloud-storage-transfer/2.0.2/V1.MetadataOptions.KmsKey)\n- [1.5.0](/php/docs/reference/cloud-storage-transfer/1.5.0/V1.MetadataOptions.KmsKey)\n- [1.4.5](/php/docs/reference/cloud-storage-transfer/1.4.5/V1.MetadataOptions.KmsKey)\n- [1.3.1](/php/docs/reference/cloud-storage-transfer/1.3.1/V1.MetadataOptions.KmsKey)\n- [1.2.0](/php/docs/reference/cloud-storage-transfer/1.2.0/V1.MetadataOptions.KmsKey)\n- [1.1.1](/php/docs/reference/cloud-storage-transfer/1.1.1/V1.MetadataOptions.KmsKey)\n- [1.0.6](/php/docs/reference/cloud-storage-transfer/1.0.6/V1.MetadataOptions.KmsKey) \nReference documentation and code samples for the Google Cloud Storage Transfer V1 Client class KmsKey.\n\nOptions for handling the KmsKey setting for Google Cloud Storage objects.\n\nProtobuf type `google.storagetransfer.v1.MetadataOptions.KmsKey`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ StorageTransfer \\\\ V1 \\\\ MetadataOptions\n\nMethods\n-------\n\n### static::name\n\n### static::value\n\nConstants\n---------\n\n### KMS_KEY_UNSPECIFIED\n\n Value: 0\n\nKmsKey behavior is unspecified.\n\nGenerated from protobuf enum `KMS_KEY_UNSPECIFIED = 0;`\n\n### KMS_KEY_DESTINATION_BUCKET_DEFAULT\n\n Value: 1\n\nUse the destination bucket's default encryption settings.\n\nGenerated from protobuf enum `KMS_KEY_DESTINATION_BUCKET_DEFAULT = 1;`\n\n### KMS_KEY_PRESERVE\n\n Value: 2\n\nPreserve the object's original Cloud KMS customer-managed encryption key\n(CMEK) if present. Objects that do not use a Cloud KMS encryption key\nwill be encrypted using the destination bucket's encryption settings.\n\nGenerated from protobuf enum `KMS_KEY_PRESERVE = 2;`"]]
