TransferSpec (Storage Transfer API v1-rev20240622-2.0.0)

java.lang.Object
- java.util.AbstractMap<String,Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.storagetransfer.v1.model.TransferSpec

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class TransferSpec
extends com.google.api.client.json.GenericJson
```
Configuration for running a transfer.
This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Storage Transfer API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  com.google.api.client.util.GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

TransferSpec()

Constructors
Constructor and Description
`TransferSpec()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`TransferSpec`	`clone()`
`AwsS3CompatibleData`	`getAwsS3CompatibleDataSource()` An AWS S3 compatible data source.
`AwsS3Data`	`getAwsS3DataSource()` An AWS S3 data source.
`AzureBlobStorageData`	`getAzureBlobStorageDataSource()` An Azure Blob Storage data source.
`GcsData`	`getGcsDataSink()` A Cloud Storage data sink.
`GcsData`	`getGcsDataSource()` A Cloud Storage data source.
`GcsData`	`getGcsIntermediateDataLocation()` For transfers between file systems, specifies a Cloud Storage bucket to be used as an intermediate location through which to transfer data.
`HdfsData`	`getHdfsDataSource()` An HDFS cluster data source.
`HttpData`	`getHttpDataSource()` An HTTP URL data source.
`ObjectConditions`	`getObjectConditions()` Only objects that satisfy these object conditions are included in the set of data source and data sink objects.
`PosixFilesystem`	`getPosixDataSink()` A POSIX Filesystem data sink.
`PosixFilesystem`	`getPosixDataSource()` A POSIX Filesystem data source.
`String`	`getSinkAgentPoolName()` Specifies the agent pool name associated with the posix data sink.
`String`	`getSourceAgentPoolName()` Specifies the agent pool name associated with the posix data source.
`TransferManifest`	`getTransferManifest()` A manifest file provides a list of objects to be transferred from the data source.
`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.
`TransferSpec`	`set(String fieldName, Object value)`
`TransferSpec`	`setAwsS3CompatibleDataSource(AwsS3CompatibleData awsS3CompatibleDataSource)` An AWS S3 compatible data source.
`TransferSpec`	`setAwsS3DataSource(AwsS3Data awsS3DataSource)` An AWS S3 data source.
`TransferSpec`	`setAzureBlobStorageDataSource(AzureBlobStorageData azureBlobStorageDataSource)` An Azure Blob Storage data source.
`TransferSpec`	`setGcsDataSink(GcsData gcsDataSink)` A Cloud Storage data sink.
`TransferSpec`	`setGcsDataSource(GcsData gcsDataSource)` A Cloud Storage data source.
`TransferSpec`	`setGcsIntermediateDataLocation(GcsData gcsIntermediateDataLocation)` For transfers between file systems, specifies a Cloud Storage bucket to be used as an intermediate location through which to transfer data.
`TransferSpec`	`setHdfsDataSource(HdfsData hdfsDataSource)` An HDFS cluster data source.
`TransferSpec`	`setHttpDataSource(HttpData httpDataSource)` An HTTP URL data source.
`TransferSpec`	`setObjectConditions(ObjectConditions objectConditions)` Only objects that satisfy these object conditions are included in the set of data source and data sink objects.
`TransferSpec`	`setPosixDataSink(PosixFilesystem posixDataSink)` A POSIX Filesystem data sink.
`TransferSpec`	`setPosixDataSource(PosixFilesystem posixDataSource)` A POSIX Filesystem data source.
`TransferSpec`	`setSinkAgentPoolName(String sinkAgentPoolName)` Specifies the agent pool name associated with the posix data sink.
`TransferSpec`	`setSourceAgentPoolName(String sourceAgentPoolName)` Specifies the agent pool name associated with the posix data source.
`TransferSpec`	`setTransferManifest(TransferManifest transferManifest)` A manifest file provides a list of objects to be transferred from the data source.
`TransferSpec`	`setTransferOptions(TransferOptions 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.

Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - TransferSpec
```
public TransferSpec()
```
- Method Detail
  - getAwsS3CompatibleDataSource
```
public AwsS3CompatibleData getAwsS3CompatibleDataSource()
```
    An AWS S3 compatible data source.
    
    Returns:
    
    value or null for none
  - setAwsS3CompatibleDataSource
```
public TransferSpec setAwsS3CompatibleDataSource(AwsS3CompatibleData awsS3CompatibleDataSource)
```
    An AWS S3 compatible data source.
    
    Parameters:
    
    awsS3CompatibleDataSource - awsS3CompatibleDataSource or null for none
  - getAwsS3DataSource
```
public AwsS3Data getAwsS3DataSource()
```
    An AWS S3 data source.
    
    Returns:
    
    value or null for none
  - setAwsS3DataSource
```
public TransferSpec setAwsS3DataSource(AwsS3Data awsS3DataSource)
```
    An AWS S3 data source.
    
    Parameters:
    
    awsS3DataSource - awsS3DataSource or null for none
  - getAzureBlobStorageDataSource
```
public AzureBlobStorageData getAzureBlobStorageDataSource()
```
    An Azure Blob Storage data source.
    
    Returns:
    
    value or null for none
  - setAzureBlobStorageDataSource
```
public TransferSpec setAzureBlobStorageDataSource(AzureBlobStorageData azureBlobStorageDataSource)
```
    An Azure Blob Storage data source.
    
    Parameters:
    
    azureBlobStorageDataSource - azureBlobStorageDataSource or null for none
  - getGcsDataSink
```
public GcsData getGcsDataSink()
```
    A Cloud Storage data sink.
    
    Returns:
    
    value or null for none
  - setGcsDataSink
```
public TransferSpec setGcsDataSink(GcsData gcsDataSink)
```
    A Cloud Storage data sink.
    
    Parameters:
    
    gcsDataSink - gcsDataSink or null for none
  - getGcsDataSource
```
public GcsData getGcsDataSource()
```
    A Cloud Storage data source.
    
    Returns:
    
    value or null for none
  - setGcsDataSource
```
public TransferSpec setGcsDataSource(GcsData gcsDataSource)
```
    A Cloud Storage data source.
    
    Parameters:
    
    gcsDataSource - gcsDataSource or null for none
  - getGcsIntermediateDataLocation
```
public GcsData 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](https://cloud.google.com/storage-transfer/docs/file-to-file) for more information.
    
    Returns:
    
    value or null for none
  - setGcsIntermediateDataLocation
```
public TransferSpec setGcsIntermediateDataLocation(GcsData gcsIntermediateDataLocation)
```
    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](https://cloud.google.com/storage-transfer/docs/file-to-file) for more information.
    
    Parameters:
    
    gcsIntermediateDataLocation - gcsIntermediateDataLocation or null for none
  - getHdfsDataSource
```
public HdfsData getHdfsDataSource()
```
    An HDFS cluster data source.
    
    Returns:
    
    value or null for none
  - setHdfsDataSource
```
public TransferSpec setHdfsDataSource(HdfsData hdfsDataSource)
```
    An HDFS cluster data source.
    
    Parameters:
    
    hdfsDataSource - hdfsDataSource or null for none
  - getHttpDataSource
```
public HttpData getHttpDataSource()
```
    An HTTP URL data source.
    
    Returns:
    
    value or null for none
  - setHttpDataSource
```
public TransferSpec setHttpDataSource(HttpData httpDataSource)
```
    An HTTP URL data source.
    
    Parameters:
    
    httpDataSource - httpDataSource or null for none
  - getObjectConditions
```
public 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.
    
    Returns:
    
    value or null for none
  - setObjectConditions
```
public TransferSpec setObjectConditions(ObjectConditions 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.
    
    Parameters:
    
    objectConditions - objectConditions or null for none
  - getPosixDataSink
```
public PosixFilesystem getPosixDataSink()
```
    A POSIX Filesystem data sink.
    
    Returns:
    
    value or null for none
  - setPosixDataSink
```
public TransferSpec setPosixDataSink(PosixFilesystem posixDataSink)
```
    A POSIX Filesystem data sink.
    
    Parameters:
    
    posixDataSink - posixDataSink or null for none
  - getPosixDataSource
```
public PosixFilesystem getPosixDataSource()
```
    A POSIX Filesystem data source.
    
    Returns:
    
    value or null for none
  - setPosixDataSource
```
public TransferSpec setPosixDataSource(PosixFilesystem posixDataSource)
```
    A POSIX Filesystem data source.
    
    Parameters:
    
    posixDataSource - posixDataSource or null for none
  - getSinkAgentPoolName
```
public String getSinkAgentPoolName()
```
    Specifies the agent pool name associated with the posix data sink. When unspecified, the default name is used.
    
    Returns:
    
    value or null for none
  - setSinkAgentPoolName
```
public TransferSpec setSinkAgentPoolName(String sinkAgentPoolName)
```
    Specifies the agent pool name associated with the posix data sink. When unspecified, the default name is used.
    
    Parameters:
    
    sinkAgentPoolName - sinkAgentPoolName or null for none
  - getSourceAgentPoolName
```
public String getSourceAgentPoolName()
```
    Specifies the agent pool name associated with the posix data source. When unspecified, the default name is used.
    
    Returns:
    
    value or null for none
  - setSourceAgentPoolName
```
public TransferSpec setSourceAgentPoolName(String sourceAgentPoolName)
```
    Specifies the agent pool name associated with the posix data source. When unspecified, the default name is used.
    
    Parameters:
    
    sourceAgentPoolName - sourceAgentPoolName or null for none
  - getTransferManifest
```
public 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.
    
    Returns:
    
    value or null for none
  - setTransferManifest
```
public TransferSpec setTransferManifest(TransferManifest 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.
    
    Parameters:
    
    transferManifest - transferManifest or null for none
  - getTransferOptions
```
public 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.
    
    Returns:
    
    value or null for none
  - setTransferOptions
```
public TransferSpec setTransferOptions(TransferOptions 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.
    
    Parameters:
    
    transferOptions - transferOptions or null for none
  - set
```
public TransferSpec set(String fieldName,
                        Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public TransferSpec clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Class TransferSpec

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

TransferSpec

Method Detail

getAwsS3CompatibleDataSource

setAwsS3CompatibleDataSource

getAwsS3DataSource

setAwsS3DataSource

getAzureBlobStorageDataSource

setAzureBlobStorageDataSource

getGcsDataSink

setGcsDataSink

getGcsDataSource

setGcsDataSource

getGcsIntermediateDataLocation

setGcsIntermediateDataLocation

getHdfsDataSource

setHdfsDataSource

getHttpDataSource

setHttpDataSource

getObjectConditions

setObjectConditions

getPosixDataSink

setPosixDataSink

getPosixDataSource

setPosixDataSource

getSinkAgentPoolName

setSinkAgentPoolName

getSourceAgentPoolName

setSourceAgentPoolName

getTransferManifest

setTransferManifest

getTransferOptions

setTransferOptions

set

clone