Classes
AwsAccessKey
AWS access key (see AWS Security Credentials).
For information on our data retention policy for user credentials, see User credentials.
AwsS3Data
An AwsS3Data resource can be a data source, but not a data sink. In an AwsS3Data resource, an object's name is the S3 object's key name.
AzureBlobStorageData
An AzureBlobStorageData resource can be a data source, but not a data sink. An AzureBlobStorageData resource represents one Azure container. The storage account determines the Azure endpoint. In an AzureBlobStorageData resource, a blobs's name is the Azure Blob Storage blob's key name.
AzureCredentials
Azure credentials
For information on our data retention policy for user credentials, see User credentials.
CreateTransferJobRequest
Request passed to CreateTransferJob.
ErrorLogEntry
An entry describing an error that has occurred.
ErrorSummary
A summary of errors by error code, plus a count and sample error log entries.
GcsData
In a GcsData resource, an object's name is the Cloud Storage object's
name and its "last modification time" refers to the object's updated
property of Cloud Storage objects, which changes when the content or the
metadata of the object is updated.
GetGoogleServiceAccountRequest
Request passed to GetGoogleServiceAccount.
GetTransferJobRequest
Request passed to GetTransferJob.
GoogleServiceAccount
Google service account
HttpData
An HttpData resource 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.
Ensure that each URL you specify is publicly accessible. For example, in 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 supportRange
requests and to return aContent-Length
header in each response.[ObjectConditions][google.storagetransfer.v1.ObjectConditions] have no effect when filtering objects to transfer.
ListTransferJobsRequest
projectId
, jobNames
, and jobStatuses
are query parameters that can
be specified when listing transfer jobs.
ListTransferJobsResponse
Response from ListTransferJobs.
NotificationConfig
Specification to configure notifications published to Cloud Pub/Sub.
Notifications will be published to the customer-provided topic using the
following PubsubMessage.attributes
:
"eventType"
: one of the [EventType][google.storagetransfer.v1.NotificationConfig.EventType] values"payloadFormat"
: one of the [PayloadFormat][google.storagetransfer.v1.NotificationConfig.PayloadFormat] values"projectId"
: the [project_id][google.storagetransfer.v1.TransferOperation.project_id] of theTransferOperation
"transferJobName"
: the [transfer_job_name][google.storagetransfer.v1.TransferOperation.transfer_job_name] of theTransferOperation
"transferOperationName"
: the [name][google.storagetransfer.v1.TransferOperation.name] of theTransferOperation
The PubsubMessage.data
will contain a
[TransferOperation][google.storagetransfer.v1.TransferOperation] resource
formatted according to the specified PayloadFormat
.
NotificationConfig.Types
Container for nested types declared in the NotificationConfig message type.
ObjectConditions
Conditions that determine which objects will be transferred. Applies only to Cloud Data Sources such as S3, Azure, and Cloud Storage.
The "last modification time" refers to the time of the
last change to the object's content or metadata — specifically, this is
the updated
property of Cloud Storage objects, the LastModified
field
of S3 objects, and the Last-Modified
header of Azure blobs.
PauseTransferOperationRequest
Request passed to PauseTransferOperation.
ResumeTransferOperationRequest
Request passed to ResumeTransferOperation.
RunTransferJobRequest
Request passed to RunTransferJob.
Schedule
Transfers can be scheduled to recur or to run just once.
StorageTransferService
Storage Transfer Service and its protos. Transfers data between between Google Cloud Storage buckets or from a data source external to Google to a Cloud Storage bucket.
StorageTransferService.StorageTransferServiceBase
Base class for server-side implementations of StorageTransferService
StorageTransferService.StorageTransferServiceClient
Client for StorageTransferService
StorageTransferServiceClient
StorageTransferService client wrapper, for convenient use.
StorageTransferServiceClientBuilder
Builder class for StorageTransferServiceClient to provide simple configuration of credentials, endpoint etc.
StorageTransferServiceClientImpl
StorageTransferService client wrapper implementation, for convenient use.
StorageTransferServiceSettings
Settings for StorageTransferServiceClient instances.
TransferCounters
A collection of counters that report the progress of a transfer operation.
TransferJob
This resource represents the configuration of a transfer job that runs periodically.
TransferJob.Types
Container for nested types declared in the TransferJob message type.
TransferOperation
A description of the execution of a transfer.
TransferOperation.Types
Container for nested types declared in the TransferOperation message type.
TransferOptions
TransferOptions define the actions to be performed on objects in a transfer.
TransferSpec
Configuration for running a transfer.
UpdateTransferJobRequest
Request passed to UpdateTransferJob.
Enums
NotificationConfig.Types.EventType
Enum for specifying event types for which notifications are to be published.
Additional event types may be added in the future. Clients should either safely ignore unrecognized event types or explicitly specify which event types they are prepared to accept.
NotificationConfig.Types.PayloadFormat
Enum for specifying the format of a notification message's payload.
TransferJob.Types.Status
The status of the transfer job.
TransferOperation.Types.Status
The status of a TransferOperation.
TransferSpec.DataSinkOneofCase
Enum of possible cases for the "data_sink" oneof.
TransferSpec.DataSourceOneofCase
Enum of possible cases for the "data_source" oneof.