Class TransferTypes.ReplicationSpec (1.56.0)

public static final class TransferTypes.ReplicationSpec extends GeneratedMessageV3 implements TransferTypes.ReplicationSpecOrBuilder

Specifies the configuration for a cross-bucket replication job. Cross-bucket replication copies new or updated objects from a source Cloud Storage bucket to a destination Cloud Storage bucket. Existing objects in the source bucket are not copied by a new cross-bucket replication job.

Protobuf type google.storagetransfer.v1.ReplicationSpec

Static Fields

GCS_DATA_SINK_FIELD_NUMBER

public static final int GCS_DATA_SINK_FIELD_NUMBER
Field Value
Type Description
int

GCS_DATA_SOURCE_FIELD_NUMBER

public static final int GCS_DATA_SOURCE_FIELD_NUMBER
Field Value
Type Description
int

OBJECT_CONDITIONS_FIELD_NUMBER

public static final int OBJECT_CONDITIONS_FIELD_NUMBER
Field Value
Type Description
int

TRANSFER_OPTIONS_FIELD_NUMBER

public static final int TRANSFER_OPTIONS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

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

getDescriptor()

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

newBuilder()

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

newBuilder(TransferTypes.ReplicationSpec prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDataSinkCase()

public TransferTypes.ReplicationSpec.DataSinkCase getDataSinkCase()
Returns
Type Description
TransferTypes.ReplicationSpec.DataSinkCase

getDataSourceCase()

public TransferTypes.ReplicationSpec.DataSourceCase getDataSourceCase()
Returns
Type Description
TransferTypes.ReplicationSpec.DataSourceCase

getDefaultInstanceForType()

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

getGcsDataSink()

public TransferTypes.GcsData getGcsDataSink()

The Cloud Storage bucket to which to replicate objects.

.google.storagetransfer.v1.GcsData gcs_data_sink = 2;

Returns
Type Description
TransferTypes.GcsData

The gcsDataSink.

getGcsDataSinkOrBuilder()

public TransferTypes.GcsDataOrBuilder getGcsDataSinkOrBuilder()

The Cloud Storage bucket to which to replicate objects.

.google.storagetransfer.v1.GcsData gcs_data_sink = 2;

Returns
Type Description
TransferTypes.GcsDataOrBuilder

getGcsDataSource()

public TransferTypes.GcsData getGcsDataSource()

The Cloud Storage bucket from which to replicate objects.

.google.storagetransfer.v1.GcsData gcs_data_source = 1;

Returns
Type Description
TransferTypes.GcsData

The gcsDataSource.

getGcsDataSourceOrBuilder()

public TransferTypes.GcsDataOrBuilder getGcsDataSourceOrBuilder()

The Cloud Storage bucket from which to replicate objects.

.google.storagetransfer.v1.GcsData gcs_data_source = 1;

Returns
Type Description
TransferTypes.GcsDataOrBuilder

getObjectConditions()

public TransferTypes.ObjectConditions getObjectConditions()

Object conditions that determine which objects are transferred. For replication jobs, only include_prefixes and exclude_prefixes are supported.

.google.storagetransfer.v1.ObjectConditions object_conditions = 3;

Returns
Type Description
TransferTypes.ObjectConditions

The objectConditions.

getObjectConditionsOrBuilder()

public TransferTypes.ObjectConditionsOrBuilder getObjectConditionsOrBuilder()

Object conditions that determine which objects are transferred. For replication jobs, only include_prefixes and exclude_prefixes are supported.

.google.storagetransfer.v1.ObjectConditions object_conditions = 3;

Returns
Type Description
TransferTypes.ObjectConditionsOrBuilder

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getTransferOptions()

public TransferTypes.TransferOptions getTransferOptions()

Specifies the metadata options to be applied during replication. Delete options are not supported. If a delete option is specified, the request fails with an INVALID_ARGUMENT error.

.google.storagetransfer.v1.TransferOptions transfer_options = 4;

Returns
Type Description
TransferTypes.TransferOptions

The transferOptions.

getTransferOptionsOrBuilder()

public TransferTypes.TransferOptionsOrBuilder getTransferOptionsOrBuilder()

Specifies the metadata options to be applied during replication. Delete options are not supported. If a delete option is specified, the request fails with an INVALID_ARGUMENT error.

.google.storagetransfer.v1.TransferOptions transfer_options = 4;

Returns
Type Description
TransferTypes.TransferOptionsOrBuilder

hasGcsDataSink()

public boolean hasGcsDataSink()

The Cloud Storage bucket to which to replicate objects.

.google.storagetransfer.v1.GcsData gcs_data_sink = 2;

Returns
Type Description
boolean

Whether the gcsDataSink field is set.

hasGcsDataSource()

public boolean hasGcsDataSource()

The Cloud Storage bucket from which to replicate objects.

.google.storagetransfer.v1.GcsData gcs_data_source = 1;

Returns
Type Description
boolean

Whether the gcsDataSource field is set.

hasObjectConditions()

public boolean hasObjectConditions()

Object conditions that determine which objects are transferred. For replication jobs, only include_prefixes and exclude_prefixes are supported.

.google.storagetransfer.v1.ObjectConditions object_conditions = 3;

Returns
Type Description
boolean

Whether the objectConditions field is set.

hasTransferOptions()

public boolean hasTransferOptions()

Specifies the metadata options to be applied during replication. Delete options are not supported. If a delete option is specified, the request fails with an INVALID_ARGUMENT error.

.google.storagetransfer.v1.TransferOptions transfer_options = 4;

Returns
Type Description
boolean

Whether the transferOptions field is set.

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.ReplicationSpec.Builder newBuilderForType()
Returns
Type Description
TransferTypes.ReplicationSpec.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

writeTo(CodedOutputStream output)

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