public static final class TransferTypes.TransferSpec extends GeneratedMessageV3 implements TransferTypes.TransferSpecOrBuilder
Configuration for running a transfer.
Protobuf type google.storagetransfer.v1.TransferSpec
Static Fields
AWS_S3_COMPATIBLE_DATA_SOURCE_FIELD_NUMBER
public static final int AWS_S3_COMPATIBLE_DATA_SOURCE_FIELD_NUMBER
Field Value
AWS_S3_DATA_SOURCE_FIELD_NUMBER
public static final int AWS_S3_DATA_SOURCE_FIELD_NUMBER
Field Value
AZURE_BLOB_STORAGE_DATA_SOURCE_FIELD_NUMBER
public static final int AZURE_BLOB_STORAGE_DATA_SOURCE_FIELD_NUMBER
Field Value
GCS_DATA_SINK_FIELD_NUMBER
public static final int GCS_DATA_SINK_FIELD_NUMBER
Field Value
GCS_DATA_SOURCE_FIELD_NUMBER
public static final int GCS_DATA_SOURCE_FIELD_NUMBER
Field Value
public static final int GCS_INTERMEDIATE_DATA_LOCATION_FIELD_NUMBER
Field Value
HTTP_DATA_SOURCE_FIELD_NUMBER
public static final int HTTP_DATA_SOURCE_FIELD_NUMBER
Field Value
OBJECT_CONDITIONS_FIELD_NUMBER
public static final int OBJECT_CONDITIONS_FIELD_NUMBER
Field Value
POSIX_DATA_SINK_FIELD_NUMBER
public static final int POSIX_DATA_SINK_FIELD_NUMBER
Field Value
POSIX_DATA_SOURCE_FIELD_NUMBER
public static final int POSIX_DATA_SOURCE_FIELD_NUMBER
Field Value
SINK_AGENT_POOL_NAME_FIELD_NUMBER
public static final int SINK_AGENT_POOL_NAME_FIELD_NUMBER
Field Value
SOURCE_AGENT_POOL_NAME_FIELD_NUMBER
public static final int SOURCE_AGENT_POOL_NAME_FIELD_NUMBER
Field Value
TRANSFER_MANIFEST_FIELD_NUMBER
public static final int TRANSFER_MANIFEST_FIELD_NUMBER
Field Value
TRANSFER_OPTIONS_FIELD_NUMBER
public static final int TRANSFER_OPTIONS_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static TransferTypes.TransferSpec getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static TransferTypes.TransferSpec.Builder newBuilder()
Returns
newBuilder(TransferTypes.TransferSpec prototype)
public static TransferTypes.TransferSpec.Builder newBuilder(TransferTypes.TransferSpec prototype)
Parameter
Returns
public static TransferTypes.TransferSpec parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static TransferTypes.TransferSpec parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static TransferTypes.TransferSpec parseFrom(byte[] data)
Parameter
Name |
Description |
data |
byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static TransferTypes.TransferSpec parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static TransferTypes.TransferSpec parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static TransferTypes.TransferSpec parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static TransferTypes.TransferSpec parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static TransferTypes.TransferSpec parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static TransferTypes.TransferSpec parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static TransferTypes.TransferSpec parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static TransferTypes.TransferSpec parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static TransferTypes.TransferSpec parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<TransferTypes.TransferSpec> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getAwsS3CompatibleDataSource()
public TransferTypes.AwsS3CompatibleData getAwsS3CompatibleDataSource()
An AWS S3 compatible data source.
.google.storagetransfer.v1.AwsS3CompatibleData aws_s3_compatible_data_source = 19;
Returns
getAwsS3CompatibleDataSourceOrBuilder()
public TransferTypes.AwsS3CompatibleDataOrBuilder getAwsS3CompatibleDataSourceOrBuilder()
An AWS S3 compatible data source.
.google.storagetransfer.v1.AwsS3CompatibleData aws_s3_compatible_data_source = 19;
Returns
getAwsS3DataSource()
public TransferTypes.AwsS3Data getAwsS3DataSource()
An AWS S3 data source.
.google.storagetransfer.v1.AwsS3Data aws_s3_data_source = 2;
Returns
getAwsS3DataSourceOrBuilder()
public TransferTypes.AwsS3DataOrBuilder getAwsS3DataSourceOrBuilder()
An AWS S3 data source.
.google.storagetransfer.v1.AwsS3Data aws_s3_data_source = 2;
Returns
getAzureBlobStorageDataSource()
public TransferTypes.AzureBlobStorageData getAzureBlobStorageDataSource()
An Azure Blob Storage data source.
.google.storagetransfer.v1.AzureBlobStorageData azure_blob_storage_data_source = 8;
Returns
getAzureBlobStorageDataSourceOrBuilder()
public TransferTypes.AzureBlobStorageDataOrBuilder getAzureBlobStorageDataSourceOrBuilder()
An Azure Blob Storage data source.
.google.storagetransfer.v1.AzureBlobStorageData azure_blob_storage_data_source = 8;
Returns
getDataSinkCase()
public TransferTypes.TransferSpec.DataSinkCase getDataSinkCase()
Returns
getDataSourceCase()
public TransferTypes.TransferSpec.DataSourceCase getDataSourceCase()
Returns
getDefaultInstanceForType()
public TransferTypes.TransferSpec getDefaultInstanceForType()
Returns
getGcsDataSink()
public TransferTypes.GcsData getGcsDataSink()
A Cloud Storage data sink.
.google.storagetransfer.v1.GcsData gcs_data_sink = 4;
Returns
getGcsDataSinkOrBuilder()
public TransferTypes.GcsDataOrBuilder getGcsDataSinkOrBuilder()
A Cloud Storage data sink.
.google.storagetransfer.v1.GcsData gcs_data_sink = 4;
Returns
getGcsDataSource()
public TransferTypes.GcsData getGcsDataSource()
A Cloud Storage data source.
.google.storagetransfer.v1.GcsData gcs_data_source = 1;
Returns
getGcsDataSourceOrBuilder()
public TransferTypes.GcsDataOrBuilder getGcsDataSourceOrBuilder()
A Cloud Storage data source.
.google.storagetransfer.v1.GcsData gcs_data_source = 1;
Returns
public TransferTypes.GcsData getGcsIntermediateDataLocation()
Cloud Storage intermediate data location.
.google.storagetransfer.v1.GcsData gcs_intermediate_data_location = 16;
Returns
public TransferTypes.GcsDataOrBuilder getGcsIntermediateDataLocationOrBuilder()
Cloud Storage intermediate data location.
.google.storagetransfer.v1.GcsData gcs_intermediate_data_location = 16;
Returns
getHttpDataSource()
public TransferTypes.HttpData getHttpDataSource()
An HTTP URL data source.
.google.storagetransfer.v1.HttpData http_data_source = 3;
Returns
getHttpDataSourceOrBuilder()
public TransferTypes.HttpDataOrBuilder getHttpDataSourceOrBuilder()
An HTTP URL data source.
.google.storagetransfer.v1.HttpData http_data_source = 3;
Returns
public TransferTypes.TransferSpec.IntermediateDataLocationCase getIntermediateDataLocationCase()
Returns
getObjectConditions()
public TransferTypes.ObjectConditions getObjectConditions()
Only objects that satisfy these object conditions are included in the set
of data source and data sink objects. Object conditions based on
objects' "last modification time" do not exclude objects in a data sink.
.google.storagetransfer.v1.ObjectConditions object_conditions = 5;
Returns
getObjectConditionsOrBuilder()
public TransferTypes.ObjectConditionsOrBuilder getObjectConditionsOrBuilder()
Only objects that satisfy these object conditions are included in the set
of data source and data sink objects. Object conditions based on
objects' "last modification time" do not exclude objects in a data sink.
.google.storagetransfer.v1.ObjectConditions object_conditions = 5;
Returns
getParserForType()
public Parser<TransferTypes.TransferSpec> getParserForType()
Returns
Overrides
getPosixDataSink()
public TransferTypes.PosixFilesystem getPosixDataSink()
A POSIX Filesystem data sink.
.google.storagetransfer.v1.PosixFilesystem posix_data_sink = 13;
Returns
getPosixDataSinkOrBuilder()
public TransferTypes.PosixFilesystemOrBuilder getPosixDataSinkOrBuilder()
A POSIX Filesystem data sink.
.google.storagetransfer.v1.PosixFilesystem posix_data_sink = 13;
Returns
getPosixDataSource()
public TransferTypes.PosixFilesystem getPosixDataSource()
A POSIX Filesystem data source.
.google.storagetransfer.v1.PosixFilesystem posix_data_source = 14;
Returns
getPosixDataSourceOrBuilder()
public TransferTypes.PosixFilesystemOrBuilder getPosixDataSourceOrBuilder()
A POSIX Filesystem data source.
.google.storagetransfer.v1.PosixFilesystem posix_data_source = 14;
Returns
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getSinkAgentPoolName()
public String getSinkAgentPoolName()
Specifies the agent pool name associated with the posix data sink. When
unspecified, the default name is used.
string sink_agent_pool_name = 18;
Returns
Type |
Description |
String |
The sinkAgentPoolName.
|
getSinkAgentPoolNameBytes()
public ByteString getSinkAgentPoolNameBytes()
Specifies the agent pool name associated with the posix data sink. When
unspecified, the default name is used.
string sink_agent_pool_name = 18;
Returns
Type |
Description |
ByteString |
The bytes for sinkAgentPoolName.
|
getSourceAgentPoolName()
public String getSourceAgentPoolName()
Specifies the agent pool name associated with the posix data source. When
unspecified, the default name is used.
string source_agent_pool_name = 17;
Returns
Type |
Description |
String |
The sourceAgentPoolName.
|
getSourceAgentPoolNameBytes()
public ByteString getSourceAgentPoolNameBytes()
Specifies the agent pool name associated with the posix data source. When
unspecified, the default name is used.
string source_agent_pool_name = 17;
Returns
Type |
Description |
ByteString |
The bytes for sourceAgentPoolName.
|
getTransferManifest()
public TransferTypes.TransferManifest getTransferManifest()
A manifest file provides a list of objects to be transferred from the data
source. This field points to the location of the manifest file.
Otherwise, the entire source bucket is used. ObjectConditions still apply.
.google.storagetransfer.v1.TransferManifest transfer_manifest = 15;
Returns
getTransferManifestOrBuilder()
public TransferTypes.TransferManifestOrBuilder getTransferManifestOrBuilder()
A manifest file provides a list of objects to be transferred from the data
source. This field points to the location of the manifest file.
Otherwise, the entire source bucket is used. ObjectConditions still apply.
.google.storagetransfer.v1.TransferManifest transfer_manifest = 15;
Returns
getTransferOptions()
public TransferTypes.TransferOptions getTransferOptions()
If the option
delete_objects_unique_in_sink
is true
and time-based object conditions such as 'last modification time'
are specified, the request fails with an
INVALID_ARGUMENT error.
.google.storagetransfer.v1.TransferOptions transfer_options = 6;
Returns
getTransferOptionsOrBuilder()
public TransferTypes.TransferOptionsOrBuilder getTransferOptionsOrBuilder()
If the option
delete_objects_unique_in_sink
is true
and time-based object conditions such as 'last modification time'
are specified, the request fails with an
INVALID_ARGUMENT error.
.google.storagetransfer.v1.TransferOptions transfer_options = 6;
Returns
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
hasAwsS3CompatibleDataSource()
public boolean hasAwsS3CompatibleDataSource()
An AWS S3 compatible data source.
.google.storagetransfer.v1.AwsS3CompatibleData aws_s3_compatible_data_source = 19;
Returns
Type |
Description |
boolean |
Whether the awsS3CompatibleDataSource field is set.
|
hasAwsS3DataSource()
public boolean hasAwsS3DataSource()
An AWS S3 data source.
.google.storagetransfer.v1.AwsS3Data aws_s3_data_source = 2;
Returns
Type |
Description |
boolean |
Whether the awsS3DataSource field is set.
|
hasAzureBlobStorageDataSource()
public boolean hasAzureBlobStorageDataSource()
An Azure Blob Storage data source.
.google.storagetransfer.v1.AzureBlobStorageData azure_blob_storage_data_source = 8;
Returns
Type |
Description |
boolean |
Whether the azureBlobStorageDataSource field is set.
|
hasGcsDataSink()
public boolean hasGcsDataSink()
A Cloud Storage data sink.
.google.storagetransfer.v1.GcsData gcs_data_sink = 4;
Returns
Type |
Description |
boolean |
Whether the gcsDataSink field is set.
|
hasGcsDataSource()
public boolean hasGcsDataSource()
A Cloud Storage data source.
.google.storagetransfer.v1.GcsData gcs_data_source = 1;
Returns
Type |
Description |
boolean |
Whether the gcsDataSource field is set.
|
public boolean hasGcsIntermediateDataLocation()
Cloud Storage intermediate data location.
.google.storagetransfer.v1.GcsData gcs_intermediate_data_location = 16;
Returns
Type |
Description |
boolean |
Whether the gcsIntermediateDataLocation field is set.
|
hasHttpDataSource()
public boolean hasHttpDataSource()
An HTTP URL data source.
.google.storagetransfer.v1.HttpData http_data_source = 3;
Returns
Type |
Description |
boolean |
Whether the httpDataSource field is set.
|
hasObjectConditions()
public boolean hasObjectConditions()
Only objects that satisfy these object conditions are included in the set
of data source and data sink objects. Object conditions based on
objects' "last modification time" do not exclude objects in a data sink.
.google.storagetransfer.v1.ObjectConditions object_conditions = 5;
Returns
Type |
Description |
boolean |
Whether the objectConditions field is set.
|
hasPosixDataSink()
public boolean hasPosixDataSink()
A POSIX Filesystem data sink.
.google.storagetransfer.v1.PosixFilesystem posix_data_sink = 13;
Returns
Type |
Description |
boolean |
Whether the posixDataSink field is set.
|
hasPosixDataSource()
public boolean hasPosixDataSource()
A POSIX Filesystem data source.
.google.storagetransfer.v1.PosixFilesystem posix_data_source = 14;
Returns
Type |
Description |
boolean |
Whether the posixDataSource field is set.
|
hasTransferManifest()
public boolean hasTransferManifest()
A manifest file provides a list of objects to be transferred from the data
source. This field points to the location of the manifest file.
Otherwise, the entire source bucket is used. ObjectConditions still apply.
.google.storagetransfer.v1.TransferManifest transfer_manifest = 15;
Returns
Type |
Description |
boolean |
Whether the transferManifest field is set.
|
hasTransferOptions()
public boolean hasTransferOptions()
If the option
delete_objects_unique_in_sink
is true
and time-based object conditions such as 'last modification time'
are specified, the request fails with an
INVALID_ARGUMENT error.
.google.storagetransfer.v1.TransferOptions transfer_options = 6;
Returns
Type |
Description |
boolean |
Whether the transferOptions field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public TransferTypes.TransferSpec.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected TransferTypes.TransferSpec.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public TransferTypes.TransferSpec.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions