Class TransferTypes.MetadataOptions

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.storagetransfer.v1.proto.TransferTypes.MetadataOptions
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, TransferTypes.MetadataOptionsOrBuilder, Serializable
Enclosing class:
TransferTypes

public static final class TransferTypes.MetadataOptions extends com.google.protobuf.GeneratedMessage implements TransferTypes.MetadataOptionsOrBuilder
 Specifies the metadata options for running a transfer.
 
Protobuf type google.storagetransfer.v1.MetadataOptions
See Also:
  • Field Details

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage
    • getSymlinkValue

      public 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;
      Specified by:
      getSymlinkValue in interface TransferTypes.MetadataOptionsOrBuilder
      Returns:
      The enum numeric value on the wire for 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;
      Specified by:
      getSymlink in interface TransferTypes.MetadataOptionsOrBuilder
      Returns:
      The symlink.
    • getModeValue

      public 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;
      Specified by:
      getModeValue in interface TransferTypes.MetadataOptionsOrBuilder
      Returns:
      The enum numeric value on the wire for 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;
      Specified by:
      getMode in interface TransferTypes.MetadataOptionsOrBuilder
      Returns:
      The mode.
    • getGidValue

      public 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;
      Specified by:
      getGidValue in interface TransferTypes.MetadataOptionsOrBuilder
      Returns:
      The enum numeric value on the wire for 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;
      Specified by:
      getGid in interface TransferTypes.MetadataOptionsOrBuilder
      Returns:
      The gid.
    • getUidValue

      public 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;
      Specified by:
      getUidValue in interface TransferTypes.MetadataOptionsOrBuilder
      Returns:
      The enum numeric value on the wire for 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;
      Specified by:
      getUid in interface TransferTypes.MetadataOptionsOrBuilder
      Returns:
      The uid.
    • getAclValue

      public 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;
      Specified by:
      getAclValue in interface TransferTypes.MetadataOptionsOrBuilder
      Returns:
      The enum numeric value on the wire for 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;
      Specified by:
      getAcl in interface TransferTypes.MetadataOptionsOrBuilder
      Returns:
      The acl.
    • getStorageClassValue

      public 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;
      Specified by:
      getStorageClassValue in interface TransferTypes.MetadataOptionsOrBuilder
      Returns:
      The enum numeric value on the wire for 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;
      Specified by:
      getStorageClass in interface TransferTypes.MetadataOptionsOrBuilder
      Returns:
      The storageClass.
    • getTemporaryHoldValue

      public 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;
      Specified by:
      getTemporaryHoldValue in interface TransferTypes.MetadataOptionsOrBuilder
      Returns:
      The enum numeric value on the wire for 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;
      Specified by:
      getTemporaryHold in interface TransferTypes.MetadataOptionsOrBuilder
      Returns:
      The temporaryHold.
    • getKmsKeyValue

      public 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;
      Specified by:
      getKmsKeyValue in interface TransferTypes.MetadataOptionsOrBuilder
      Returns:
      The enum numeric value on the wire for 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;
      Specified by:
      getKmsKey in interface TransferTypes.MetadataOptionsOrBuilder
      Returns:
      The kmsKey.
    • getTimeCreatedValue

      public 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;
      Specified by:
      getTimeCreatedValue in interface TransferTypes.MetadataOptionsOrBuilder
      Returns:
      The enum numeric value on the wire for 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;
      Specified by:
      getTimeCreated in interface TransferTypes.MetadataOptionsOrBuilder
      Returns:
      The timeCreated.
    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage
    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException
    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage
    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage
    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage
    • parseFrom

      public static TransferTypes.MetadataOptions parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static TransferTypes.MetadataOptions parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static TransferTypes.MetadataOptions parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static TransferTypes.MetadataOptions parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static TransferTypes.MetadataOptions parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static TransferTypes.MetadataOptions parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static TransferTypes.MetadataOptions parseFrom(InputStream input) throws IOException
      Throws:
      IOException
    • parseFrom

      public static TransferTypes.MetadataOptions parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • parseDelimitedFrom

      public static TransferTypes.MetadataOptions parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException
    • parseDelimitedFrom

      public static TransferTypes.MetadataOptions parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • parseFrom

      public static TransferTypes.MetadataOptions parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException
    • parseFrom

      public static TransferTypes.MetadataOptions parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • newBuilderForType

      public TransferTypes.MetadataOptions.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite
    • newBuilder

      public static TransferTypes.MetadataOptions.Builder newBuilder()
    • newBuilder

    • toBuilder

      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite
    • newBuilderForType

      protected TransferTypes.MetadataOptions.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage
    • getDefaultInstance

      public static TransferTypes.MetadataOptions getDefaultInstance()
    • parser

      public static com.google.protobuf.Parser<TransferTypes.MetadataOptions> parser()
    • getParserForType

      public com.google.protobuf.Parser<TransferTypes.MetadataOptions> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage
    • getDefaultInstanceForType

      public TransferTypes.MetadataOptions getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder