Class TransferTypes.GcsData (1.55.0)

public static final class TransferTypes.GcsData extends GeneratedMessageV3 implements TransferTypes.GcsDataOrBuilder

In a GcsData resource, an object's name is the Cloud Storage object's name and its "last modification time" refers to the object's updated property of Cloud Storage objects, which changes when the content or the metadata of the object is updated.

Protobuf type google.storagetransfer.v1.GcsData

Static Fields

BUCKET_NAME_FIELD_NUMBER

public static final int BUCKET_NAME_FIELD_NUMBER
Field Value
Type Description
int

MANAGED_FOLDER_TRANSFER_ENABLED_FIELD_NUMBER

public static final int MANAGED_FOLDER_TRANSFER_ENABLED_FIELD_NUMBER
Field Value
Type Description
int

PATH_FIELD_NUMBER

public static final int PATH_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

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

getDescriptor()

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

newBuilder()

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

newBuilder(TransferTypes.GcsData prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getBucketName()

public String getBucketName()

Required. Cloud Storage bucket name. Must meet Bucket Name Requirements.

string bucket_name = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The bucketName.

getBucketNameBytes()

public ByteString getBucketNameBytes()

Required. Cloud Storage bucket name. Must meet Bucket Name Requirements.

string bucket_name = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for bucketName.

getDefaultInstanceForType()

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

getManagedFolderTransferEnabled()

public boolean getManagedFolderTransferEnabled()

Preview. Enables the transfer of managed folders between Cloud Storage buckets. Set this option on the gcs_data_source.

If set to true:

  • Managed folders in the source bucket are transferred to the destination bucket.
  • Managed folders in the destination bucket are overwritten. Other OVERWRITE options are not supported.

    See Transfer Cloud Storage managed folders.

bool managed_folder_transfer_enabled = 4;

Returns
Type Description
boolean

The managedFolderTransferEnabled.

getParserForType()

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

getPath()

public String getPath()

Root path to transfer objects.

Must be an empty string or full path name that ends with a '/'. This field is treated as an object prefix. As such, it should generally not begin with a '/'.

The root path value must meet Object Name Requirements.

string path = 3;

Returns
Type Description
String

The path.

getPathBytes()

public ByteString getPathBytes()

Root path to transfer objects.

Must be an empty string or full path name that ends with a '/'. This field is treated as an object prefix. As such, it should generally not begin with a '/'.

The root path value must meet Object Name Requirements.

string path = 3;

Returns
Type Description
ByteString

The bytes for path.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
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.GcsData.Builder newBuilderForType()
Returns
Type Description
TransferTypes.GcsData.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected TransferTypes.GcsData.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
TransferTypes.GcsData.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.GcsData.Builder toBuilder()
Returns
Type Description
TransferTypes.GcsData.Builder

writeTo(CodedOutputStream output)

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