TransferSpec

Configuration for running a transfer.

JSON representation
{
  "objectConditions": {
    object(ObjectConditions)
  },
  "transferOptions": {
    object(TransferOptions)
  },

  // Union field data_source can be only one of the following:
  "gcsDataSource": {
    object(GcsData)
  },
  "awsS3DataSource": {
    object(AwsS3Data)
  },
  "httpDataSource": {
    object(HttpData)
  },
  // End of list of possible types for union field data_source.
  "gcsDataSink": {
    object(GcsData)
  },
}
Field name Type Description
objectConditions object(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' lastModificationTime do not exclude objects in a data sink.
transferOptions object(TransferOptions) If the option deleteObjectsUniqueInSink is true, object conditions based on objects' lastModificationTime are ignored and do not exclude objects in a data source or a data sink.
Union field data_source. The read source of the data. data_source can be only one of the following:
gcsDataSource object(GcsData) A Google Cloud Storage data source.
awsS3DataSource object(AwsS3Data) An AWS S3 data source.
httpDataSource object(HttpData) An HTTP URL data source.
gcsDataSink object(GcsData) A Google Cloud Storage data sink.

GcsData

In a GcsData, an object's name is the Google Cloud Storage object's name and its lastModificationTime refers to the object's updated time, which changes when the content or the metadata of the object is updated.

JSON representation
{
  "bucketName": string,
}
Field name Type Description
bucketName string Google Cloud Storage bucket name (see Bucket Name Requirements). Required.

AwsS3Data

An AwsS3Data can be a data source, but not a data sink. In an AwsS3Data, an object's name is the S3 object's key name.

JSON representation
{
  "bucketName": string,
  "awsAccessKey": {
    object(AwsAccessKey)
  },
}
Field name Type Description
bucketName string S3 Bucket name (see Creating a bucket). Required.
awsAccessKey object(AwsAccessKey) AWS access key used to sign the API requests to the AWS S3 bucket. Permissions on the bucket must be granted to the access ID of the AWS access key. Required.

AwsAccessKey

AWS access key (see AWS Security Credentials).

JSON representation
{
  "accessKeyId": string,
  "secretAccessKey": string,
}
Field name Type Description
accessKeyId string AWS access key ID. Required.
secretAccessKey string AWS secret access key. This field is not returned in RPC responses. Required.

HttpData

An HttpData specifies a list of objects on the web to be transferred over HTTP. The information of the objects to be transferred is contained in a file referenced by a URL. The first line in the file must be "TsvHttpData-1.0", which specifies the format of the file. Subsequent lines specify the information of the list of objects, one object per list entry. Each entry has the following tab-delimited fields:

  • HTTP URL - The location of the object.

  • Length - The size of the object in bytes.

  • MD5 - The base64-encoded MD5 hash of the object.

For an example of a valid TSV file, see Transferring data from URLs

When transferring data based on a URL list, keep the following in mind:

  • When an object located at http(s)://hostname:port/<URL-path> is transferred to a data sink, the name of the object at the data sink is <hostname>/<URL-path>.

  • If the specified size of an object does not match the actual size of the object fetched, the object will not be transferred.

  • If the specified MD5 does not match the MD5 computed from the transferred bytes, the object transfer will fail. For more information, see Generating MD5 hashes

  • Ensure that each URL you specify is publicly accessible. For example, in Google Cloud Storage you can share an object publicly and get a link to it.

  • Storage Transfer Service obeys robots.txt rules and requires the source HTTP server to support Range requests and to return a Content-Length header in each response.

  • ObjectConditions have no effect when filtering objects to transfer.

JSON representation
{
  "listUrl": string,
}
Field name Type Description
listUrl string The URL that points to the file that stores the object list entries. This file must allow public access. Currently, only URLs with HTTP and HTTPS schemes are supported. Required.

ObjectConditions

Conditions that determine which objects will be transferred.

JSON representation
{
  "minTimeElapsedSinceLastModification": string,
  "maxTimeElapsedSinceLastModification": string,
  "includePrefixes": [
    string
  ],
  "excludePrefixes": [
    string
  ],
}
Field name Type Description
minTimeElapsedSinceLastModification string
(Duration format)

If unspecified, minTimeElapsedSinceLastModification takes a zero value and maxTimeElapsedSinceLastModification takes the maximum possible value of Duration. Objects that satisfy the object conditions must either have a lastModificationTime greater or equal to NOW - maxTimeElapsedSinceLastModification and less than NOW - minTimeElapsedSinceLastModification, or not have a lastModificationTime.

A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s".

maxTimeElapsedSinceLastModification string
(Duration format)

maxTimeElapsedSinceLastModification is the complement to minTimeElapsedSinceLastModification.

A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s".

includePrefixes[] string

If includePrefixes is specified, objects that satisfy the object conditions must have names that start with one of the includePrefixes and that do not start with any of the excludePrefixes. If includePrefixes is not specified, all objects except those that have names starting with one of the excludePrefixes must satisfy the object conditions.

Requirements:

  • Each include-prefix and exclude-prefix can contain any sequence of Unicode characters, of max length 1024 bytes when UTF8-encoded, and must not contain Carriage Return or Line Feed characters. Wildcard matching and regular expression matching are not supported.

  • Each include-prefix and exclude-prefix must omit the leading slash. For example, to include the requests.gz object in a transfer from s3://my-aws-bucket/logs/y=2015/requests.gz, specify the include prefix as logs/y=2015/requests.gz.

  • None of the include-prefix or the exclude-prefix values can be empty, if specified.

  • Each include-prefix must include a distinct portion of the object namespace, i.e., no include-prefix may be a prefix of another include-prefix.

  • Each exclude-prefix must exclude a distinct portion of the object namespace, i.e., no exclude-prefix may be a prefix of another exclude-prefix.

  • If includePrefixes is specified, then each exclude-prefix must start with the value of a path explicitly included by includePrefixes.

The max size of includePrefixes is 1000.

excludePrefixes[] string

excludePrefixes must follow the requirements described for includePrefixes.

The max size of excludePrefixes is 1000.

TransferOptions

TransferOptions uses three boolean parameters to define the actions to be performed on objects in a transfer.

JSON representation
{
  "overwriteObjectsAlreadyExistingInSink": boolean,
  "deleteObjectsUniqueInSink": boolean,
  "deleteObjectsFromSourceAfterTransfer": boolean,
}
Field name Type Description
overwriteObjectsAlreadyExistingInSink boolean Whether overwriting objects that already exist in the sink is allowed.
deleteObjectsUniqueInSink boolean Whether objects that exist only in the sink should be deleted.
deleteObjectsFromSourceAfterTransfer boolean Whether objects should be deleted from the source after they are transferred to the sink.

Send feedback about...

Cloud Storage Documentation