Storage Transfer Service V1 API - Class Google::Cloud::StorageTransfer::V1::TransferSpec (v1.4.0)

Reference documentation and code samples for the Storage Transfer Service V1 API class Google::Cloud::StorageTransfer::V1::TransferSpec.

Configuration for running a transfer.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#aws_s3_compatible_data_source

def aws_s3_compatible_data_source() -> ::Google::Cloud::StorageTransfer::V1::AwsS3CompatibleData
Returns
  • (::Google::Cloud::StorageTransfer::V1::AwsS3CompatibleData) — An AWS S3 compatible data source.

    Note: The following fields are mutually exclusive: aws_s3_compatible_data_source, gcs_data_source, aws_s3_data_source, http_data_source, posix_data_source, azure_blob_storage_data_source, hdfs_data_source. If a field in that set is populated, all other fields in the set will automatically be cleared.

#aws_s3_compatible_data_source=

def aws_s3_compatible_data_source=(value) -> ::Google::Cloud::StorageTransfer::V1::AwsS3CompatibleData
Parameter
  • value (::Google::Cloud::StorageTransfer::V1::AwsS3CompatibleData) — An AWS S3 compatible data source.

    Note: The following fields are mutually exclusive: aws_s3_compatible_data_source, gcs_data_source, aws_s3_data_source, http_data_source, posix_data_source, azure_blob_storage_data_source, hdfs_data_source. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::StorageTransfer::V1::AwsS3CompatibleData) — An AWS S3 compatible data source.

    Note: The following fields are mutually exclusive: aws_s3_compatible_data_source, gcs_data_source, aws_s3_data_source, http_data_source, posix_data_source, azure_blob_storage_data_source, hdfs_data_source. If a field in that set is populated, all other fields in the set will automatically be cleared.

#aws_s3_data_source

def aws_s3_data_source() -> ::Google::Cloud::StorageTransfer::V1::AwsS3Data
Returns
  • (::Google::Cloud::StorageTransfer::V1::AwsS3Data) — An AWS S3 data source.

    Note: The following fields are mutually exclusive: aws_s3_data_source, gcs_data_source, http_data_source, posix_data_source, azure_blob_storage_data_source, aws_s3_compatible_data_source, hdfs_data_source. If a field in that set is populated, all other fields in the set will automatically be cleared.

#aws_s3_data_source=

def aws_s3_data_source=(value) -> ::Google::Cloud::StorageTransfer::V1::AwsS3Data
Parameter
  • value (::Google::Cloud::StorageTransfer::V1::AwsS3Data) — An AWS S3 data source.

    Note: The following fields are mutually exclusive: aws_s3_data_source, gcs_data_source, http_data_source, posix_data_source, azure_blob_storage_data_source, aws_s3_compatible_data_source, hdfs_data_source. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::StorageTransfer::V1::AwsS3Data) — An AWS S3 data source.

    Note: The following fields are mutually exclusive: aws_s3_data_source, gcs_data_source, http_data_source, posix_data_source, azure_blob_storage_data_source, aws_s3_compatible_data_source, hdfs_data_source. If a field in that set is populated, all other fields in the set will automatically be cleared.

#azure_blob_storage_data_source

def azure_blob_storage_data_source() -> ::Google::Cloud::StorageTransfer::V1::AzureBlobStorageData
Returns
  • (::Google::Cloud::StorageTransfer::V1::AzureBlobStorageData) — An Azure Blob Storage data source.

    Note: The following fields are mutually exclusive: azure_blob_storage_data_source, gcs_data_source, aws_s3_data_source, http_data_source, posix_data_source, aws_s3_compatible_data_source, hdfs_data_source. If a field in that set is populated, all other fields in the set will automatically be cleared.

#azure_blob_storage_data_source=

def azure_blob_storage_data_source=(value) -> ::Google::Cloud::StorageTransfer::V1::AzureBlobStorageData
Parameter
  • value (::Google::Cloud::StorageTransfer::V1::AzureBlobStorageData) — An Azure Blob Storage data source.

    Note: The following fields are mutually exclusive: azure_blob_storage_data_source, gcs_data_source, aws_s3_data_source, http_data_source, posix_data_source, aws_s3_compatible_data_source, hdfs_data_source. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::StorageTransfer::V1::AzureBlobStorageData) — An Azure Blob Storage data source.

    Note: The following fields are mutually exclusive: azure_blob_storage_data_source, gcs_data_source, aws_s3_data_source, http_data_source, posix_data_source, aws_s3_compatible_data_source, hdfs_data_source. If a field in that set is populated, all other fields in the set will automatically be cleared.

#gcs_data_sink

def gcs_data_sink() -> ::Google::Cloud::StorageTransfer::V1::GcsData
Returns
  • (::Google::Cloud::StorageTransfer::V1::GcsData) — A Cloud Storage data sink.

    Note: The following fields are mutually exclusive: gcs_data_sink, posix_data_sink. If a field in that set is populated, all other fields in the set will automatically be cleared.

#gcs_data_sink=

def gcs_data_sink=(value) -> ::Google::Cloud::StorageTransfer::V1::GcsData
Parameter
  • value (::Google::Cloud::StorageTransfer::V1::GcsData) — A Cloud Storage data sink.

    Note: The following fields are mutually exclusive: gcs_data_sink, posix_data_sink. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::StorageTransfer::V1::GcsData) — A Cloud Storage data sink.

    Note: The following fields are mutually exclusive: gcs_data_sink, posix_data_sink. If a field in that set is populated, all other fields in the set will automatically be cleared.

#gcs_data_source

def gcs_data_source() -> ::Google::Cloud::StorageTransfer::V1::GcsData
Returns
  • (::Google::Cloud::StorageTransfer::V1::GcsData) — A Cloud Storage data source.

    Note: The following fields are mutually exclusive: gcs_data_source, aws_s3_data_source, http_data_source, posix_data_source, azure_blob_storage_data_source, aws_s3_compatible_data_source, hdfs_data_source. If a field in that set is populated, all other fields in the set will automatically be cleared.

#gcs_data_source=

def gcs_data_source=(value) -> ::Google::Cloud::StorageTransfer::V1::GcsData
Parameter
  • value (::Google::Cloud::StorageTransfer::V1::GcsData) — A Cloud Storage data source.

    Note: The following fields are mutually exclusive: gcs_data_source, aws_s3_data_source, http_data_source, posix_data_source, azure_blob_storage_data_source, aws_s3_compatible_data_source, hdfs_data_source. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::StorageTransfer::V1::GcsData) — A Cloud Storage data source.

    Note: The following fields are mutually exclusive: gcs_data_source, aws_s3_data_source, http_data_source, posix_data_source, azure_blob_storage_data_source, aws_s3_compatible_data_source, hdfs_data_source. If a field in that set is populated, all other fields in the set will automatically be cleared.

#gcs_intermediate_data_location

def gcs_intermediate_data_location() -> ::Google::Cloud::StorageTransfer::V1::GcsData
Returns

#gcs_intermediate_data_location=

def gcs_intermediate_data_location=(value) -> ::Google::Cloud::StorageTransfer::V1::GcsData
Parameter
Returns

#hdfs_data_source

def hdfs_data_source() -> ::Google::Cloud::StorageTransfer::V1::HdfsData
Returns
  • (::Google::Cloud::StorageTransfer::V1::HdfsData) — An HDFS cluster data source.

    Note: The following fields are mutually exclusive: hdfs_data_source, gcs_data_source, aws_s3_data_source, http_data_source, posix_data_source, azure_blob_storage_data_source, aws_s3_compatible_data_source. If a field in that set is populated, all other fields in the set will automatically be cleared.

#hdfs_data_source=

def hdfs_data_source=(value) -> ::Google::Cloud::StorageTransfer::V1::HdfsData
Parameter
  • value (::Google::Cloud::StorageTransfer::V1::HdfsData) — An HDFS cluster data source.

    Note: The following fields are mutually exclusive: hdfs_data_source, gcs_data_source, aws_s3_data_source, http_data_source, posix_data_source, azure_blob_storage_data_source, aws_s3_compatible_data_source. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::StorageTransfer::V1::HdfsData) — An HDFS cluster data source.

    Note: The following fields are mutually exclusive: hdfs_data_source, gcs_data_source, aws_s3_data_source, http_data_source, posix_data_source, azure_blob_storage_data_source, aws_s3_compatible_data_source. If a field in that set is populated, all other fields in the set will automatically be cleared.

#http_data_source

def http_data_source() -> ::Google::Cloud::StorageTransfer::V1::HttpData
Returns
  • (::Google::Cloud::StorageTransfer::V1::HttpData) — An HTTP URL data source.

    Note: The following fields are mutually exclusive: http_data_source, gcs_data_source, aws_s3_data_source, posix_data_source, azure_blob_storage_data_source, aws_s3_compatible_data_source, hdfs_data_source. If a field in that set is populated, all other fields in the set will automatically be cleared.

#http_data_source=

def http_data_source=(value) -> ::Google::Cloud::StorageTransfer::V1::HttpData
Parameter
  • value (::Google::Cloud::StorageTransfer::V1::HttpData) — An HTTP URL data source.

    Note: The following fields are mutually exclusive: http_data_source, gcs_data_source, aws_s3_data_source, posix_data_source, azure_blob_storage_data_source, aws_s3_compatible_data_source, hdfs_data_source. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::StorageTransfer::V1::HttpData) — An HTTP URL data source.

    Note: The following fields are mutually exclusive: http_data_source, gcs_data_source, aws_s3_data_source, posix_data_source, azure_blob_storage_data_source, aws_s3_compatible_data_source, hdfs_data_source. If a field in that set is populated, all other fields in the set will automatically be cleared.

#object_conditions

def object_conditions() -> ::Google::Cloud::StorageTransfer::V1::ObjectConditions
Returns
  • (::Google::Cloud::StorageTransfer::V1::ObjectConditions) — 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.

#object_conditions=

def object_conditions=(value) -> ::Google::Cloud::StorageTransfer::V1::ObjectConditions
Parameter
  • value (::Google::Cloud::StorageTransfer::V1::ObjectConditions) — 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.
Returns
  • (::Google::Cloud::StorageTransfer::V1::ObjectConditions) — 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.

#posix_data_sink

def posix_data_sink() -> ::Google::Cloud::StorageTransfer::V1::PosixFilesystem
Returns
  • (::Google::Cloud::StorageTransfer::V1::PosixFilesystem) — A POSIX Filesystem data sink.

    Note: The following fields are mutually exclusive: posix_data_sink, gcs_data_sink. If a field in that set is populated, all other fields in the set will automatically be cleared.

#posix_data_sink=

def posix_data_sink=(value) -> ::Google::Cloud::StorageTransfer::V1::PosixFilesystem
Parameter
  • value (::Google::Cloud::StorageTransfer::V1::PosixFilesystem) — A POSIX Filesystem data sink.

    Note: The following fields are mutually exclusive: posix_data_sink, gcs_data_sink. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::StorageTransfer::V1::PosixFilesystem) — A POSIX Filesystem data sink.

    Note: The following fields are mutually exclusive: posix_data_sink, gcs_data_sink. If a field in that set is populated, all other fields in the set will automatically be cleared.

#posix_data_source

def posix_data_source() -> ::Google::Cloud::StorageTransfer::V1::PosixFilesystem
Returns
  • (::Google::Cloud::StorageTransfer::V1::PosixFilesystem) — A POSIX Filesystem data source.

    Note: The following fields are mutually exclusive: posix_data_source, gcs_data_source, aws_s3_data_source, http_data_source, azure_blob_storage_data_source, aws_s3_compatible_data_source, hdfs_data_source. If a field in that set is populated, all other fields in the set will automatically be cleared.

#posix_data_source=

def posix_data_source=(value) -> ::Google::Cloud::StorageTransfer::V1::PosixFilesystem
Parameter
  • value (::Google::Cloud::StorageTransfer::V1::PosixFilesystem) — A POSIX Filesystem data source.

    Note: The following fields are mutually exclusive: posix_data_source, gcs_data_source, aws_s3_data_source, http_data_source, azure_blob_storage_data_source, aws_s3_compatible_data_source, hdfs_data_source. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::StorageTransfer::V1::PosixFilesystem) — A POSIX Filesystem data source.

    Note: The following fields are mutually exclusive: posix_data_source, gcs_data_source, aws_s3_data_source, http_data_source, azure_blob_storage_data_source, aws_s3_compatible_data_source, hdfs_data_source. If a field in that set is populated, all other fields in the set will automatically be cleared.

#sink_agent_pool_name

def sink_agent_pool_name() -> ::String
Returns
  • (::String) — Specifies the agent pool name associated with the posix data sink. When unspecified, the default name is used.

#sink_agent_pool_name=

def sink_agent_pool_name=(value) -> ::String
Parameter
  • value (::String) — Specifies the agent pool name associated with the posix data sink. When unspecified, the default name is used.
Returns
  • (::String) — Specifies the agent pool name associated with the posix data sink. When unspecified, the default name is used.

#source_agent_pool_name

def source_agent_pool_name() -> ::String
Returns
  • (::String) — Specifies the agent pool name associated with the posix data source. When unspecified, the default name is used.

#source_agent_pool_name=

def source_agent_pool_name=(value) -> ::String
Parameter
  • value (::String) — Specifies the agent pool name associated with the posix data source. When unspecified, the default name is used.
Returns
  • (::String) — Specifies the agent pool name associated with the posix data source. When unspecified, the default name is used.

#transfer_manifest

def transfer_manifest() -> ::Google::Cloud::StorageTransfer::V1::TransferManifest
Returns
  • (::Google::Cloud::StorageTransfer::V1::TransferManifest) — 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.

#transfer_manifest=

def transfer_manifest=(value) -> ::Google::Cloud::StorageTransfer::V1::TransferManifest
Parameter
  • value (::Google::Cloud::StorageTransfer::V1::TransferManifest) — 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.
Returns
  • (::Google::Cloud::StorageTransfer::V1::TransferManifest) — 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.

#transfer_options

def transfer_options() -> ::Google::Cloud::StorageTransfer::V1::TransferOptions
Returns

#transfer_options=

def transfer_options=(value) -> ::Google::Cloud::StorageTransfer::V1::TransferOptions
Parameter
Returns