Class TransferTypes.GcsData.Builder (1.51.0)

public static final class TransferTypes.GcsData.Builder extends GeneratedMessageV3.Builder<TransferTypes.GcsData.Builder> 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 Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public TransferTypes.GcsData.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
TransferTypes.GcsData.Builder
Overrides

build()

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

buildPartial()

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

clear()

public TransferTypes.GcsData.Builder clear()
Returns
Type Description
TransferTypes.GcsData.Builder
Overrides

clearBucketName()

public TransferTypes.GcsData.Builder clearBucketName()

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

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

Returns
Type Description
TransferTypes.GcsData.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public TransferTypes.GcsData.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
TransferTypes.GcsData.Builder
Overrides

clearManagedFolderTransferEnabled()

public TransferTypes.GcsData.Builder clearManagedFolderTransferEnabled()

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
TransferTypes.GcsData.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public TransferTypes.GcsData.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
TransferTypes.GcsData.Builder
Overrides

clearPath()

public TransferTypes.GcsData.Builder clearPath()

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
TransferTypes.GcsData.Builder

This builder for chaining.

clone()

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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.

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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public TransferTypes.GcsData.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TransferTypes.GcsData.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public TransferTypes.GcsData.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
TransferTypes.GcsData.Builder
Overrides

mergeFrom(TransferTypes.GcsData other)

public TransferTypes.GcsData.Builder mergeFrom(TransferTypes.GcsData other)
Parameter
Name Description
other TransferTypes.GcsData
Returns
Type Description
TransferTypes.GcsData.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final TransferTypes.GcsData.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
TransferTypes.GcsData.Builder
Overrides

setBucketName(String value)

public TransferTypes.GcsData.Builder setBucketName(String value)

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

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

Parameter
Name Description
value String

The bucketName to set.

Returns
Type Description
TransferTypes.GcsData.Builder

This builder for chaining.

setBucketNameBytes(ByteString value)

public TransferTypes.GcsData.Builder setBucketNameBytes(ByteString value)

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

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

Parameter
Name Description
value ByteString

The bytes for bucketName to set.

Returns
Type Description
TransferTypes.GcsData.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public TransferTypes.GcsData.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
TransferTypes.GcsData.Builder
Overrides

setManagedFolderTransferEnabled(boolean value)

public TransferTypes.GcsData.Builder setManagedFolderTransferEnabled(boolean value)

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;

Parameter
Name Description
value boolean

The managedFolderTransferEnabled to set.

Returns
Type Description
TransferTypes.GcsData.Builder

This builder for chaining.

setPath(String value)

public TransferTypes.GcsData.Builder setPath(String value)

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;

Parameter
Name Description
value String

The path to set.

Returns
Type Description
TransferTypes.GcsData.Builder

This builder for chaining.

setPathBytes(ByteString value)

public TransferTypes.GcsData.Builder setPathBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for path to set.

Returns
Type Description
TransferTypes.GcsData.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public TransferTypes.GcsData.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
TransferTypes.GcsData.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final TransferTypes.GcsData.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
TransferTypes.GcsData.Builder
Overrides