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:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic enumOptions for handling Cloud Storage object ACLs.static final classSpecifies the metadata options for running a transfer.static enumOptions for handling file GID attribute.static enumOptions for handling the KmsKey setting for Google Cloud Storage objects.static enumOptions for handling file mode attribute.static enumOptions for handling Google Cloud Storage object storage class.static enumWhether symlinks should be skipped or preserved during a transfer job.static enumOptions for handling temporary holds for Google Cloud Storage objects.static enumOptions for handling `timeCreated` metadata for Google Cloud Storage objects.static enumOptions for handling file UID attribute.Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage
com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT, BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message, T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage
com.google.protobuf.AbstractMessage.BuilderParentNested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intFields inherited from class com.google.protobuf.GeneratedMessage
alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFieldsFields inherited from class com.google.protobuf.AbstractMessage
memoizedSizeFields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode -
Method Summary
Modifier and TypeMethodDescriptionbooleangetAcl()Specifies how each object's ACLs should be preserved for transfers between Google Cloud Storage buckets.intSpecifies how each object's ACLs should be preserved for transfers between Google Cloud Storage buckets.static final com.google.protobuf.Descriptors.DescriptorgetGid()Specifies how each file's POSIX group ID (GID) attribute should be handled by the transfer.intSpecifies how each file's POSIX group ID (GID) attribute should be handled by the transfer.Specifies how each object's Cloud KMS customer-managed encryption key (CMEK) is preserved for transfers between Google Cloud Storage buckets.intSpecifies how each object's Cloud KMS customer-managed encryption key (CMEK) is preserved for transfers between Google Cloud Storage buckets.getMode()Specifies how each file's mode attribute should be handled by the transfer.intSpecifies how each file's mode attribute should be handled by the transfer.com.google.protobuf.Parser<TransferTypes.MetadataOptions>intSpecifies the storage class to set on objects being transferred to Google Cloud Storage buckets.intSpecifies the storage class to set on objects being transferred to Google Cloud Storage buckets.Specifies how symlinks should be handled by the transfer.intSpecifies how symlinks should be handled by the transfer.Specifies how each object's temporary hold status should be preserved for transfers between Google Cloud Storage buckets.intSpecifies how each object's temporary hold status should be preserved for transfers between Google Cloud Storage buckets.Specifies how each object's `timeCreated` metadata is preserved for transfers.intSpecifies how each object's `timeCreated` metadata is preserved for transfers.getUid()Specifies how each file's POSIX user ID (UID) attribute should be handled by the transfer.intSpecifies how each file's POSIX user ID (UID) attribute should be handled by the transfer.inthashCode()protected com.google.protobuf.GeneratedMessage.FieldAccessorTablefinal booleannewBuilder(TransferTypes.MetadataOptions prototype) protected TransferTypes.MetadataOptions.BuildernewBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent) parseDelimitedFrom(InputStream input) parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) parseFrom(byte[] data) parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) parseFrom(com.google.protobuf.ByteString data) parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) parseFrom(com.google.protobuf.CodedInputStream input) parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) parseFrom(InputStream input) parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) parseFrom(ByteBuffer data) parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static com.google.protobuf.Parser<TransferTypes.MetadataOptions>parser()voidwriteTo(com.google.protobuf.CodedOutputStream output) Methods inherited from class com.google.protobuf.GeneratedMessage
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagMethods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashFields, toStringMethods inherited from class com.google.protobuf.AbstractMessageLite
addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Field Details
-
SYMLINK_FIELD_NUMBER
public static final int SYMLINK_FIELD_NUMBER- See Also:
-
MODE_FIELD_NUMBER
public static final int MODE_FIELD_NUMBER- See Also:
-
GID_FIELD_NUMBER
public static final int GID_FIELD_NUMBER- See Also:
-
UID_FIELD_NUMBER
public static final int UID_FIELD_NUMBER- See Also:
-
ACL_FIELD_NUMBER
public static final int ACL_FIELD_NUMBER- See Also:
-
STORAGE_CLASS_FIELD_NUMBER
public static final int STORAGE_CLASS_FIELD_NUMBER- See Also:
-
TEMPORARY_HOLD_FIELD_NUMBER
public static final int TEMPORARY_HOLD_FIELD_NUMBER- See Also:
-
KMS_KEY_FIELD_NUMBER
public static final int KMS_KEY_FIELD_NUMBER- See Also:
-
TIME_CREATED_FIELD_NUMBER
public static final int TIME_CREATED_FIELD_NUMBER- See Also:
-
-
Method Details
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTablein classcom.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:
getSymlinkValuein interfaceTransferTypes.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:
getSymlinkin interfaceTransferTypes.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:
getModeValuein interfaceTransferTypes.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:
getModein interfaceTransferTypes.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:
getGidValuein interfaceTransferTypes.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:
getGidin interfaceTransferTypes.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:
getUidValuein interfaceTransferTypes.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:
getUidin interfaceTransferTypes.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:
getAclValuein interfaceTransferTypes.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:
getAclin interfaceTransferTypes.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:
getStorageClassValuein interfaceTransferTypes.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:
getStorageClassin interfaceTransferTypes.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:
getTemporaryHoldValuein interfaceTransferTypes.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:
getTemporaryHoldin interfaceTransferTypes.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:
getKmsKeyValuein interfaceTransferTypes.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:
getKmsKeyin interfaceTransferTypes.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:
getTimeCreatedValuein interfaceTransferTypes.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:
getTimeCreatedin interfaceTransferTypes.MetadataOptionsOrBuilder- Returns:
- The timeCreated.
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessage
-
writeTo
- Specified by:
writeToin interfacecom.google.protobuf.MessageLite- Overrides:
writeToin classcom.google.protobuf.GeneratedMessage- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()- Specified by:
getSerializedSizein interfacecom.google.protobuf.MessageLite- Overrides:
getSerializedSizein classcom.google.protobuf.GeneratedMessage
-
equals
- Specified by:
equalsin interfacecom.google.protobuf.Message- Overrides:
equalsin classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()- Specified by:
hashCodein interfacecom.google.protobuf.Message- Overrides:
hashCodein classcom.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
- 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
- Specified by:
newBuilderForTypein interfacecom.google.protobuf.Message- Specified by:
newBuilderForTypein interfacecom.google.protobuf.MessageLite
-
newBuilder
-
newBuilder
public static TransferTypes.MetadataOptions.Builder newBuilder(TransferTypes.MetadataOptions prototype) -
toBuilder
- Specified by:
toBuilderin interfacecom.google.protobuf.Message- Specified by:
toBuilderin interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected TransferTypes.MetadataOptions.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent) - Overrides:
newBuilderForTypein classcom.google.protobuf.AbstractMessage
-
getDefaultInstance
-
parser
-
getParserForType
- Specified by:
getParserForTypein interfacecom.google.protobuf.Message- Specified by:
getParserForTypein interfacecom.google.protobuf.MessageLite- Overrides:
getParserForTypein classcom.google.protobuf.GeneratedMessage
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-