Class TransferTypes.MetadataOptions (1.5.0) 

public static final class TransferTypes.MetadataOptions extends GeneratedMessageV3 implements TransferTypes.MetadataOptionsOrBuilder

Specifies the metadata options for running a transfer.

Protobuf type google.storagetransfer.v1.MetadataOptions

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > TransferTypes.MetadataOptions

Static Fields

ACL_FIELD_NUMBER

public static final int ACL_FIELD_NUMBER
Field Value
Type Description
int

GID_FIELD_NUMBER

public static final int GID_FIELD_NUMBER
Field Value
Type Description
int

KMS_KEY_FIELD_NUMBER

public static final int KMS_KEY_FIELD_NUMBER
Field Value
Type Description
int

MODE_FIELD_NUMBER

public static final int MODE_FIELD_NUMBER
Field Value
Type Description
int

STORAGE_CLASS_FIELD_NUMBER

public static final int STORAGE_CLASS_FIELD_NUMBER
Field Value
Type Description
int 
public static final int SYMLINK_FIELD_NUMBER
Field Value
Type Description
int

TEMPORARY_HOLD_FIELD_NUMBER

public static final int TEMPORARY_HOLD_FIELD_NUMBER
Field Value
Type Description
int

TIME_CREATED_FIELD_NUMBER

public static final int TIME_CREATED_FIELD_NUMBER
Field Value
Type Description
int

UID_FIELD_NUMBER

public static final int UID_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static TransferTypes.MetadataOptions getDefaultInstance()
Returns
Type Description
TransferTypes.MetadataOptions

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static TransferTypes.MetadataOptions.Builder newBuilder()
Returns
Type Description
TransferTypes.MetadataOptions.Builder

newBuilder(TransferTypes.MetadataOptions prototype)

public static TransferTypes.MetadataOptions.Builder newBuilder(TransferTypes.MetadataOptions prototype)
Parameter
Name Description
prototype TransferTypes.MetadataOptions
Returns
Type Description
TransferTypes.MetadataOptions.Builder

parseDelimitedFrom(InputStream input)

public static TransferTypes.MetadataOptions parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
TransferTypes.MetadataOptions
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static TransferTypes.MetadataOptions parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TransferTypes.MetadataOptions
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static TransferTypes.MetadataOptions parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
TransferTypes.MetadataOptions
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static TransferTypes.MetadataOptions parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TransferTypes.MetadataOptions
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static TransferTypes.MetadataOptions parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
TransferTypes.MetadataOptions
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static TransferTypes.MetadataOptions parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TransferTypes.MetadataOptions
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static TransferTypes.MetadataOptions parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
TransferTypes.MetadataOptions
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static TransferTypes.MetadataOptions parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TransferTypes.MetadataOptions
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static TransferTypes.MetadataOptions parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
TransferTypes.MetadataOptions
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static TransferTypes.MetadataOptions parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TransferTypes.MetadataOptions
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static TransferTypes.MetadataOptions parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
TransferTypes.MetadataOptions
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static TransferTypes.MetadataOptions parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TransferTypes.MetadataOptions
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<TransferTypes.MetadataOptions> parser()
Returns
Type Description
Parser<MetadataOptions>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getAcl()

public 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
Type Description
TransferTypes.MetadataOptions.Acl

The acl.

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;

Returns
Type Description
int

The enum numeric value on the wire for acl.

getDefaultInstanceForType()

public TransferTypes.MetadataOptions getDefaultInstanceForType()
Returns
Type Description
TransferTypes.MetadataOptions

getGid()

public 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
Type Description
TransferTypes.MetadataOptions.GID

The gid.

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;

Returns
Type Description
int

The enum numeric value on the wire for gid.

getKmsKey()

public 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 = 8;

Returns
Type Description
TransferTypes.MetadataOptions.KmsKey

The kmsKey.

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 = 8;

Returns
Type Description
int

The enum numeric value on the wire for kmsKey.

getMode()

public 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
Type Description
TransferTypes.MetadataOptions.Mode

The mode.

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;

Returns
Type Description
int

The enum numeric value on the wire for mode.

getParserForType()

public Parser<TransferTypes.MetadataOptions> getParserForType()
Returns
Type Description
Parser<MetadataOptions>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getStorageClass()

public 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 = 6;

Returns
Type Description
TransferTypes.MetadataOptions.StorageClass

The storageClass.

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 = 6;

Returns
Type Description
int

The enum numeric value on the wire for storageClass.

getSymlink()

public 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
Type Description
TransferTypes.MetadataOptions.Symlink

The symlink.

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;

Returns
Type Description
int

The enum numeric value on the wire for symlink.

getTemporaryHold()

public 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 = 7;

Returns
Type Description
TransferTypes.MetadataOptions.TemporaryHold

The temporaryHold.

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 = 7;

Returns
Type Description
int

The enum numeric value on the wire for temporaryHold.

getTimeCreated()

public TransferTypes.MetadataOptions.TimeCreated getTimeCreated()

Specifies how each object's timeCreated metadata is preserved for transfers between Google Cloud Storage buckets. If unspecified, the default behavior is the same as TIME_CREATED_SKIP.

.google.storagetransfer.v1.MetadataOptions.TimeCreated time_created = 9;

Returns
Type Description
TransferTypes.MetadataOptions.TimeCreated

The timeCreated.

getTimeCreatedValue()

public int getTimeCreatedValue()

Specifies how each object's timeCreated metadata is preserved for transfers between Google Cloud Storage buckets. If unspecified, the default behavior is the same as TIME_CREATED_SKIP.

.google.storagetransfer.v1.MetadataOptions.TimeCreated time_created = 9;

Returns
Type Description
int

The enum numeric value on the wire for timeCreated.

getUid()

public 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
Type Description
TransferTypes.MetadataOptions.UID

The uid.

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;

Returns
Type Description
int

The enum numeric value on the wire for uid.

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
Type Description
UnknownFieldSet
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public TransferTypes.MetadataOptions.Builder newBuilderForType()
Returns
Type Description
TransferTypes.MetadataOptions.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected TransferTypes.MetadataOptions.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
TransferTypes.MetadataOptions.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public TransferTypes.MetadataOptions.Builder toBuilder()
Returns
Type Description
TransferTypes.MetadataOptions.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides Exceptions
Type Description
IOException