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.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ gcs_data_sink |
GcsData
A Cloud Storage data sink. |
↳ posix_data_sink |
PosixFilesystem
A POSIX Filesystem data sink. |
↳ gcs_data_source |
GcsData
A Cloud Storage data source. |
↳ aws_s3_data_source |
AwsS3Data
An AWS S3 data source. |
↳ http_data_source |
HttpData
An HTTP URL data source. |
↳ posix_data_source |
PosixFilesystem
A POSIX Filesystem data source. |
↳ azure_blob_storage_data_source |
AzureBlobStorageData
An Azure Blob Storage data source. |
↳ aws_s3_compatible_data_source |
AwsS3CompatibleData
An AWS S3 compatible data source. |
↳ hdfs_data_source |
HdfsData
An HDFS cluster 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 |
↳ 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.
| Returns | |
|---|---|
| Type | Description |
GcsData|null |
|
hasGcsDataSink
setGcsDataSink
A Cloud Storage data sink.
| Parameter | |
|---|---|
| Name | Description |
var |
GcsData
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPosixDataSink
A POSIX Filesystem data sink.
| Returns | |
|---|---|
| Type | Description |
PosixFilesystem|null |
|
hasPosixDataSink
setPosixDataSink
A POSIX Filesystem data sink.
| Parameter | |
|---|---|
| Name | Description |
var |
PosixFilesystem
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getGcsDataSource
A Cloud Storage data source.
| Returns | |
|---|---|
| Type | Description |
GcsData|null |
|
hasGcsDataSource
setGcsDataSource
A Cloud Storage data source.
| Parameter | |
|---|---|
| Name | Description |
var |
GcsData
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAwsS3DataSource
An AWS S3 data source.
| Returns | |
|---|---|
| Type | Description |
AwsS3Data|null |
|
hasAwsS3DataSource
setAwsS3DataSource
An AWS S3 data source.
| Parameter | |
|---|---|
| Name | Description |
var |
AwsS3Data
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getHttpDataSource
An HTTP URL data source.
| Returns | |
|---|---|
| Type | Description |
HttpData|null |
|
hasHttpDataSource
setHttpDataSource
An HTTP URL data source.
| Parameter | |
|---|---|
| Name | Description |
var |
HttpData
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPosixDataSource
A POSIX Filesystem data source.
| Returns | |
|---|---|
| Type | Description |
PosixFilesystem|null |
|
hasPosixDataSource
setPosixDataSource
A POSIX Filesystem data source.
| Parameter | |
|---|---|
| Name | Description |
var |
PosixFilesystem
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAzureBlobStorageDataSource
An Azure Blob Storage data source.
| Returns | |
|---|---|
| Type | Description |
AzureBlobStorageData|null |
|
hasAzureBlobStorageDataSource
setAzureBlobStorageDataSource
An Azure Blob Storage data source.
| Parameter | |
|---|---|
| Name | Description |
var |
AzureBlobStorageData
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAwsS3CompatibleDataSource
An AWS S3 compatible data source.
| Returns | |
|---|---|
| Type | Description |
AwsS3CompatibleData|null |
|
hasAwsS3CompatibleDataSource
setAwsS3CompatibleDataSource
An AWS S3 compatible data source.
| Parameter | |
|---|---|
| Name | Description |
var |
AwsS3CompatibleData
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getHdfsDataSource
An HDFS cluster data source.
| Returns | |
|---|---|
| Type | Description |
HdfsData|null |
|
hasHdfsDataSource
setHdfsDataSource
An HDFS cluster data source.
| Parameter | |
|---|---|
| Name | Description |
var |
HdfsData
|
| Returns | |
|---|---|
| Type | Description |
$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.
| Returns | |
|---|---|
| Type | Description |
GcsData|null |
|
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.
| Parameter | |
|---|---|
| Name | Description |
var |
GcsData
|
| Returns | |
|---|---|
| Type | Description |
$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.
| Returns | |
|---|---|
| Type | Description |
ObjectConditions|null |
|
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.
| Parameter | |
|---|---|
| Name | Description |
var |
ObjectConditions
|
| Returns | |
|---|---|
| Type | Description |
$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.
| Returns | |
|---|---|
| Type | Description |
TransferOptions|null |
|
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.
| Parameter | |
|---|---|
| Name | Description |
var |
TransferOptions
|
| Returns | |
|---|---|
| Type | Description |
$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.
| Returns | |
|---|---|
| Type | Description |
TransferManifest|null |
|
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.
| Parameter | |
|---|---|
| Name | Description |
var |
TransferManifest
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSourceAgentPoolName
Specifies the agent pool name associated with the posix data source. When unspecified, the default name is used.
| Returns | |
|---|---|
| Type | Description |
string |
|
setSourceAgentPoolName
Specifies the agent pool name associated with the posix data source. When unspecified, the default name is used.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSinkAgentPoolName
Specifies the agent pool name associated with the posix data sink. When unspecified, the default name is used.
| Returns | |
|---|---|
| Type | Description |
string |
|
setSinkAgentPoolName
Specifies the agent pool name associated with the posix data sink. When unspecified, the default name is used.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDataSink
| Returns | |
|---|---|
| Type | Description |
string |
|
getDataSource
| Returns | |
|---|---|
| Type | Description |
string |
|
getIntermediateDataLocation
| Returns | |
|---|---|
| Type | Description |
string |
|