Package com.google.storagetransfer.v1.proto

Interface TransferTypes.MetadataOptionsOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
TransferTypes.MetadataOptions, TransferTypes.MetadataOptions.Builder
Enclosing class:
TransferTypes
public static interface TransferTypes.MetadataOptionsOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    TransferTypes.MetadataOptions.Acl
    getAcl()
    Specifies how each object's ACLs should be preserved for transfers between Google Cloud Storage buckets.
    int
    getAclValue()
    Specifies how each object's ACLs should be preserved for transfers between Google Cloud Storage buckets.
    TransferTypes.MetadataOptions.GID
    getGid()
    Specifies how each file's POSIX group ID (GID) attribute should be handled by the transfer.
    int
    getGidValue()
    Specifies how each file's POSIX group ID (GID) attribute should be handled by the transfer.
    TransferTypes.MetadataOptions.KmsKey
    getKmsKey()
    Specifies how each object's Cloud KMS customer-managed encryption key (CMEK) is preserved for transfers between Google Cloud Storage buckets.
    int
    getKmsKeyValue()
    Specifies how each object's Cloud KMS customer-managed encryption key (CMEK) is preserved for transfers between Google Cloud Storage buckets.
    TransferTypes.MetadataOptions.Mode
    getMode()
    Specifies how each file's mode attribute should be handled by the transfer.
    int
    getModeValue()
    Specifies how each file's mode attribute should be handled by the transfer.
    TransferTypes.MetadataOptions.StorageClass
    getStorageClass()
    Specifies the storage class to set on objects being transferred to Google Cloud Storage buckets.
    int
    getStorageClassValue()
    Specifies the storage class to set on objects being transferred to Google Cloud Storage buckets.
    TransferTypes.MetadataOptions.Symlink
    getSymlink()
    Specifies how symlinks should be handled by the transfer.
    int
    getSymlinkValue()
    Specifies how symlinks should be handled by the transfer.
    TransferTypes.MetadataOptions.TemporaryHold
    getTemporaryHold()
    Specifies how each object's temporary hold status should be preserved for transfers between Google Cloud Storage buckets.
    int
    getTemporaryHoldValue()
    Specifies how each object's temporary hold status should be preserved for transfers between Google Cloud Storage buckets.
    TransferTypes.MetadataOptions.TimeCreated
    getTimeCreated()
    Specifies how each object's `timeCreated` metadata is preserved for transfers.
    int
    getTimeCreatedValue()
    Specifies how each object's `timeCreated` metadata is preserved for transfers.
    TransferTypes.MetadataOptions.UID
    getUid()
    Specifies how each file's POSIX user ID (UID) attribute should be handled by the transfer.
    int
    getUidValue()
    Specifies how each file's POSIX user ID (UID) attribute should be handled by the transfer.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • getSymlinkValue

      int getSymlinkValue()
       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.
      .google.storagetransfer.v1.MetadataOptions.Symlink symlink = 1;
      Returns:
      The enum numeric value on the wire for symlink.

    • getSymlink

      TransferTypes.MetadataOptions.Symlink getSymlink()
       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.
      .google.storagetransfer.v1.MetadataOptions.Symlink symlink = 1;
      Returns:
      The symlink.

    • getModeValue

      int getModeValue()
       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.
      .google.storagetransfer.v1.MetadataOptions.Mode mode = 2;
      Returns:
      The enum numeric value on the wire for mode.

    • getMode

      TransferTypes.MetadataOptions.Mode getMode()
       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.
      .google.storagetransfer.v1.MetadataOptions.Mode mode = 2;
      Returns:
      The mode.

    • getGidValue

      int getGidValue()
       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.
      .google.storagetransfer.v1.MetadataOptions.GID gid = 3;
      Returns:
      The enum numeric value on the wire for gid.

    • getGid

      TransferTypes.MetadataOptions.GID getGid()
       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.
      .google.storagetransfer.v1.MetadataOptions.GID gid = 3;
      Returns:
      The gid.

    • getUidValue

      int getUidValue()
       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.
      .google.storagetransfer.v1.MetadataOptions.UID uid = 4;
      Returns:
      The enum numeric value on the wire for uid.

    • getUid

      TransferTypes.MetadataOptions.UID getUid()
       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.
      .google.storagetransfer.v1.MetadataOptions.UID uid = 4;
      Returns:
      The uid.

    • getAclValue

      int getAclValue()
       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.
      .google.storagetransfer.v1.MetadataOptions.Acl acl = 5;
      Returns:
      The enum numeric value on the wire for acl.

    • getAcl

      TransferTypes.MetadataOptions.Acl getAcl()
       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.
      .google.storagetransfer.v1.MetadataOptions.Acl acl = 5;
      Returns:
      The acl.

    • getStorageClassValue

      int getStorageClassValue()
       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].
      .google.storagetransfer.v1.MetadataOptions.StorageClass storage_class = 6;
      Returns:
      The enum numeric value on the wire for storageClass.

    • getStorageClass

      TransferTypes.MetadataOptions.StorageClass getStorageClass()
       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].
      .google.storagetransfer.v1.MetadataOptions.StorageClass storage_class = 6;
      Returns:
      The storageClass.

    • getTemporaryHoldValue

      int getTemporaryHoldValue()
       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].
      .google.storagetransfer.v1.MetadataOptions.TemporaryHold temporary_hold = 7;
      Returns:
      The enum numeric value on the wire for temporaryHold.

    • getTemporaryHold

      TransferTypes.MetadataOptions.TemporaryHold getTemporaryHold()
       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].
      .google.storagetransfer.v1.MetadataOptions.TemporaryHold temporary_hold = 7;
      Returns:
      The temporaryHold.

    • getKmsKeyValue

      int getKmsKeyValue()
       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].
      .google.storagetransfer.v1.MetadataOptions.KmsKey kms_key = 8;
      Returns:
      The enum numeric value on the wire for kmsKey.

    • getKmsKey

      TransferTypes.MetadataOptions.KmsKey getKmsKey()
       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].
      .google.storagetransfer.v1.MetadataOptions.KmsKey kms_key = 8;
      Returns:
      The kmsKey.

    • getTimeCreatedValue

      int getTimeCreatedValue()
       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.
      .google.storagetransfer.v1.MetadataOptions.TimeCreated time_created = 9;
      Returns:
      The enum numeric value on the wire for timeCreated.

    • getTimeCreated

      TransferTypes.MetadataOptions.TimeCreated getTimeCreated()
       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.
      .google.storagetransfer.v1.MetadataOptions.TimeCreated time_created = 9;
      Returns:
      The timeCreated.