Storage Transfer v1 API - Class MetadataOptions (2.7.0)

public sealed class MetadataOptions : IMessage<MetadataOptions>, IEquatable<MetadataOptions>, IDeepCloneable<MetadataOptions>, IBufferMessage, IMessage

Reference documentation and code samples for the Storage Transfer v1 API class MetadataOptions.

Specifies the metadata options for running a transfer.

Inheritance

object > MetadataOptions

Implements

IMessage MetadataOptions, IEquatable MetadataOptions, IDeepCloneable MetadataOptions, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.StorageTransfer.V1

Assembly

Google.Cloud.StorageTransfer.V1.dll

Constructors

MetadataOptions()

public MetadataOptions()

MetadataOptions(MetadataOptions)

public MetadataOptions(MetadataOptions other)

Parameter
Name	Description
`other`	`MetadataOptions`

Properties

Acl

public MetadataOptions.Types.Acl Acl { get; set; }

Specifies how each object's ACLs should be preserved for transfers between Google Cloud Storage buckets. If unspecified, the default behavior is the same as ACL_DESTINATION_BUCKET_DEFAULT.

Property Value
Type	Description
`MetadataOptionsTypesAcl`

Gid

public MetadataOptions.Types.GID Gid { get; set; }

Specifies how each file's POSIX group ID (GID) attribute should be handled by the transfer. By default, GID is not preserved. Only applicable to transfers involving POSIX file systems, and ignored for other transfers.

Property Value
Type	Description
`MetadataOptionsTypesGID`

KmsKey

public MetadataOptions.Types.KmsKey KmsKey { get; set; }

Specifies how each object's Cloud KMS customer-managed encryption key (CMEK) is preserved for transfers between Google Cloud Storage buckets. If unspecified, the default behavior is the same as [KMS_KEY_DESTINATION_BUCKET_DEFAULT][google.storagetransfer.v1.MetadataOptions.KmsKey.KMS_KEY_DESTINATION_BUCKET_DEFAULT].

Property Value
Type	Description
`MetadataOptionsTypesKmsKey`

Mode

public MetadataOptions.Types.Mode Mode { get; set; }

Specifies how each file's mode attribute should be handled by the transfer. By default, mode is not preserved. Only applicable to transfers involving POSIX file systems, and ignored for other transfers.

Property Value
Type	Description
`MetadataOptionsTypesMode`

StorageClass

public MetadataOptions.Types.StorageClass StorageClass { get; set; }

Specifies the storage class to set on objects being transferred to Google Cloud Storage buckets. If unspecified, the default behavior is the same as [STORAGE_CLASS_DESTINATION_BUCKET_DEFAULT][google.storagetransfer.v1.MetadataOptions.StorageClass.STORAGE_CLASS_DESTINATION_BUCKET_DEFAULT].

Property Value
Type	Description
`MetadataOptionsTypesStorageClass`

Symlink

public MetadataOptions.Types.Symlink Symlink { get; set; }

Specifies how symlinks should be handled by the transfer. By default, symlinks are not preserved. Only applicable to transfers involving POSIX file systems, and ignored for other transfers.

Property Value
Type	Description
`MetadataOptionsTypesSymlink`

TemporaryHold

public MetadataOptions.Types.TemporaryHold TemporaryHold { get; set; }

Specifies how each object's temporary hold status should be preserved for transfers between Google Cloud Storage buckets. If unspecified, the default behavior is the same as [TEMPORARY_HOLD_PRESERVE][google.storagetransfer.v1.MetadataOptions.TemporaryHold.TEMPORARY_HOLD_PRESERVE].

Property Value
Type	Description
`MetadataOptionsTypesTemporaryHold`

TimeCreated

public MetadataOptions.Types.TimeCreated TimeCreated { get; set; }

Specifies how each object's timeCreated metadata is preserved for transfers. If unspecified, the default behavior is the same as [TIME_CREATED_SKIP][google.storagetransfer.v1.MetadataOptions.TimeCreated.TIME_CREATED_SKIP]. This behavior is supported for transfers to Cloud Storage buckets from Cloud Storage, Amazon S3, S3-compatible storage, and Azure sources.

Property Value
Type	Description
`MetadataOptionsTypesTimeCreated`

Uid

public MetadataOptions.Types.UID Uid { get; set; }

Specifies how each file's POSIX user ID (UID) attribute should be handled by the transfer. By default, UID is not preserved. Only applicable to transfers involving POSIX file systems, and ignored for other transfers.

Property Value
Type	Description
`MetadataOptionsTypesUID`