Console
    Contact Us Start free

    Google Cloud Storage Transfer V1 Client - Class TransferSpec (1.1.1)

    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 \ V1

    Methods

    __construct

    Constructor.

    Parameters
    Name
    Description
    data
    array

    Optional. Data for populating the Message object.

    ↳ gcs_data_sink
    Google\Cloud\StorageTransfer\V1\GcsData

    A Cloud Storage data sink.

    ↳ posix_data_sink
    Google\Cloud\StorageTransfer\V1\PosixFilesystem

    A POSIX Filesystem data sink.

    ↳ gcs_data_source
    Google\Cloud\StorageTransfer\V1\GcsData

    A Cloud Storage data source.

    ↳ aws_s3_data_source
    Google\Cloud\StorageTransfer\V1\AwsS3Data

    An AWS S3 data source.

    ↳ http_data_source
    Google\Cloud\StorageTransfer\V1\HttpData

    An HTTP URL data source.

    ↳ posix_data_source
    Google\Cloud\StorageTransfer\V1\PosixFilesystem

    A POSIX Filesystem data source.

    ↳ azure_blob_storage_data_source
    Google\Cloud\StorageTransfer\V1\AzureBlobStorageData

    An Azure Blob Storage data source.

    ↳ aws_s3_compatible_data_source
    Google\Cloud\StorageTransfer\V1\AwsS3CompatibleData

    An AWS S3 compatible data source.

    ↳ gcs_intermediate_data_location
    Google\Cloud\StorageTransfer\V1\GcsData

    Cloud Storage intermediate data location.

    ↳ object_conditions
    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.

    ↳ transfer_options
    Google\Cloud\StorageTransfer\V1\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
    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.

    ↳ 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
    Google\Cloud\StorageTransfer\V1\GcsData |null

    hasGcsDataSink

    setGcsDataSink

    A Cloud Storage data sink.

    Parameter
    Name
    Description
    var
    Google\Cloud\StorageTransfer\V1\GcsData
    Returns
    Type
    Description
    $this

    getPosixDataSink

    A POSIX Filesystem data sink.

    Returns
    Type
    Description
    Google\Cloud\StorageTransfer\V1\PosixFilesystem |null

    hasPosixDataSink

    setPosixDataSink

    A POSIX Filesystem data sink.

    Parameter
    Name
    Description
    var
    Google\Cloud\StorageTransfer\V1\PosixFilesystem
    Returns
    Type
    Description
    $this

    getGcsDataSource

    A Cloud Storage data source.

    Returns
    Type
    Description
    Google\Cloud\StorageTransfer\V1\GcsData |null

    hasGcsDataSource

    setGcsDataSource

    A Cloud Storage data source.

    Parameter
    Name
    Description
    var
    Google\Cloud\StorageTransfer\V1\GcsData
    Returns
    Type
    Description
    $this

    getAwsS3DataSource

    An AWS S3 data source.

    Returns
    Type
    Description
    Google\Cloud\StorageTransfer\V1\AwsS3Data |null

    hasAwsS3DataSource

    setAwsS3DataSource

    An AWS S3 data source.

    Parameter
    Name
    Description
    var
    Google\Cloud\StorageTransfer\V1\AwsS3Data
    Returns
    Type
    Description
    $this

    getHttpDataSource

    An HTTP URL data source.

    Returns
    Type
    Description
    Google\Cloud\StorageTransfer\V1\HttpData |null

    hasHttpDataSource

    setHttpDataSource

    An HTTP URL data source.

    Parameter
    Name
    Description
    var
    Google\Cloud\StorageTransfer\V1\HttpData
    Returns
    Type
    Description
    $this

    getPosixDataSource

    A POSIX Filesystem data source.

    Returns
    Type
    Description
    Google\Cloud\StorageTransfer\V1\PosixFilesystem |null

    hasPosixDataSource

    setPosixDataSource

    A POSIX Filesystem data source.

    Parameter
    Name
    Description
    var
    Google\Cloud\StorageTransfer\V1\PosixFilesystem
    Returns
    Type
    Description
    $this

    getAzureBlobStorageDataSource

    An Azure Blob Storage data source.

    Returns
    Type
    Description
    Google\Cloud\StorageTransfer\V1\AzureBlobStorageData |null

    hasAzureBlobStorageDataSource

    setAzureBlobStorageDataSource

    An Azure Blob Storage data source.

    Parameter
    Name
    Description
    var
    Google\Cloud\StorageTransfer\V1\AzureBlobStorageData
    Returns
    Type
    Description
    $this

    getAwsS3CompatibleDataSource

    An AWS S3 compatible data source.

    Returns
    Type
    Description
    Google\Cloud\StorageTransfer\V1\AwsS3CompatibleData |null

    hasAwsS3CompatibleDataSource

    setAwsS3CompatibleDataSource

    An AWS S3 compatible data source.

    Parameter
    Name
    Description
    var
    Google\Cloud\StorageTransfer\V1\AwsS3CompatibleData
    Returns
    Type
    Description
    $this

    getGcsIntermediateDataLocation

    Cloud Storage intermediate data location.

    Returns
    Type
    Description
    Google\Cloud\StorageTransfer\V1\GcsData |null

    hasGcsIntermediateDataLocation

    setGcsIntermediateDataLocation

    Cloud Storage intermediate data location.

    Parameter
    Name
    Description
    var
    Google\Cloud\StorageTransfer\V1\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
    Google\Cloud\StorageTransfer\V1\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
    Google\Cloud\StorageTransfer\V1\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
    Google\Cloud\StorageTransfer\V1\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
    Google\Cloud\StorageTransfer\V1\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
    Google\Cloud\StorageTransfer\V1\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
    Google\Cloud\StorageTransfer\V1\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
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: