Reference documentation and code samples for the Google Cloud Storage Transfer V1 Client class TransferSpec.
Configuration for running a transfer.
Generated from protobuf message google.storagetransfer.v1.TransferSpec
Namespace
Google \ Cloud \ StorageTransfer \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ gcs_data_sink
↳ posix_data_sink
↳ 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
↳ gcs_intermediate_data_location
GcsData
For transfers between file systems, specifies a Cloud Storage bucket to be used as an intermediate location through which to transfer data. See Transfer data between file systems for more information.
↳ object_conditions
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.
↳ transfer_options
TransferOptions
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.
↳ transfer_manifest
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.
↳ source_agent_pool_name
string
Specifies the agent pool name associated with the posix data source. When unspecified, the default name is used.
↳ sink_agent_pool_name
string
Specifies the agent pool name associated with the posix data sink. When unspecified, the default name is used.
getGcsDataSink
A Cloud Storage data sink.
hasGcsDataSink
setGcsDataSink
A Cloud Storage data sink.
$this
getPosixDataSink
A POSIX Filesystem data sink.
hasPosixDataSink
setPosixDataSink
A POSIX Filesystem data sink.
$this
getGcsDataSource
A Cloud Storage data source.
hasGcsDataSource
setGcsDataSource
A Cloud Storage data source.
$this
getAwsS3DataSource
An AWS S3 data source.
hasAwsS3DataSource
setAwsS3DataSource
An AWS S3 data source.
$this
getHttpDataSource
An HTTP URL data source.
hasHttpDataSource
setHttpDataSource
An HTTP URL data source.
$this
getPosixDataSource
A POSIX Filesystem data source.
hasPosixDataSource
setPosixDataSource
A POSIX Filesystem data source.
$this
getAzureBlobStorageDataSource
An Azure Blob Storage data source.
hasAzureBlobStorageDataSource
setAzureBlobStorageDataSource
An Azure Blob Storage data source.
$this
getAwsS3CompatibleDataSource
An AWS S3 compatible data source.
hasAwsS3CompatibleDataSource
setAwsS3CompatibleDataSource
An AWS S3 compatible data source.
$this
getHdfsDataSource
An HDFS cluster data source.
hasHdfsDataSource
setHdfsDataSource
An HDFS cluster data source.
$this
getGcsIntermediateDataLocation
For transfers between file systems, specifies a Cloud Storage bucket to be used as an intermediate location through which to transfer data.
See Transfer data between file systems for more information.
hasGcsIntermediateDataLocation
setGcsIntermediateDataLocation
For transfers between file systems, specifies a Cloud Storage bucket to be used as an intermediate location through which to transfer data.
See Transfer data between file systems for more information.
$this
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.
hasObjectConditions
clearObjectConditions
setObjectConditions
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.
$this
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.
hasTransferOptions
clearTransferOptions
setTransferOptions
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.
$this
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.
hasTransferManifest
clearTransferManifest
setTransferManifest
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.
$this
getSourceAgentPoolName
Specifies the agent pool name associated with the posix data source. When unspecified, the default name is used.
string
setSourceAgentPoolName
Specifies the agent pool name associated with the posix data source. When unspecified, the default name is used.
var
string
$this
getSinkAgentPoolName
Specifies the agent pool name associated with the posix data sink. When unspecified, the default name is used.
string
setSinkAgentPoolName
Specifies the agent pool name associated with the posix data sink. When unspecified, the default name is used.
var
string
$this
getDataSink
string
getDataSource
string
getIntermediateDataLocation
string
