Package-level declarations
Types
AWS access key (see AWS Security Credentials). For information on our data retention policy for user credentials, see /storage-transfer/docs/data-retention#user-credentials.
Builder for AwsAccessKeyArgs.
An AwsS3CompatibleData resource.
Builder for AwsS3CompatibleDataArgs.
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.
Builder for AwsS3DataArgs.
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.
Builder for AzureBlobStorageDataArgs.
Azure credentials For information on our data retention policy for user credentials, see /storage-transfer/docs/data-retention#user-credentials.
Builder for AzureCredentialsArgs.
Specifies a bandwidth limit for an agent pool.
Builder for BandwidthLimitArgs.
Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp
Builder for DateArgs.
Specifies the Event-driven transfer options. Event-driven transfers listen to an event stream to transfer updated files.
Builder for EventStreamArgs.
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.
Builder for GcsDataArgs.
Builder for GetAgentPoolPlainArgs.
Builder for GetTransferJobPlainArgs.
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/
is transferred to a data sink, the name of the object at the data sink is /
. * If the specified size of an object does not match the actual size of the object fetched, the object is not transferred. * If the specified MD5 does not match the MD5 computed from the transferred bytes, the object transfer fails. * Ensure that each URL you specify is publicly accessible. For example, in Cloud Storage you can share an object publicly (/storage/docs/cloud-console#_sharingdata) 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.
Builder for HttpDataArgs.
Specifies the logging behavior for transfer operations. For cloud-to-cloud transfers, logs are sent to Cloud Logging. See Read transfer logs for details. For transfers to or from a POSIX file system, logs are stored in the Cloud Storage bucket that is the source or sink of the transfer. See Managing Transfer for on-premises jobs (https://cloud.google.com/storage-transfer/docs/managing-on-prem-jobs#viewing-logs) for details.
Builder for LoggingConfigArgs.
Specifies the metadata options for running a transfer.
Builder for MetadataOptionsArgs.
Specification to configure notifications published to Pub/Sub. Notifications are published to the customer-provided topic using the following PubsubMessage.attributes
: * "eventType"
: one of the EventType values * "payloadFormat"
: one of the PayloadFormat values * "projectId"
: the project_id of the TransferOperation
* "transferJobName"
: the transfer_job_name of the TransferOperation
* "transferOperationName"
: the name of the TransferOperation
The PubsubMessage.data
contains a TransferOperation resource formatted according to the specified PayloadFormat
.
Builder for NotificationConfigArgs.
Conditions that determine which objects are 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. Transfers with a PosixFilesystem source or destination don't support ObjectConditions
.
Builder for ObjectConditionsArgs.
A POSIX filesystem resource.
Builder for PosixFilesystemArgs.
S3CompatibleMetadata contains the metadata fields that apply to the basic types of S3-compatible data providers.
Builder for S3CompatibleMetadataArgs.
Transfers can be scheduled to recur or to run just once.
Builder for ScheduleArgs.
Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and google.protobuf.Timestamp
.
Builder for TimeOfDayArgs.
Specifies where the manifest is located.
Builder for TransferManifestArgs.
TransferOptions define the actions to be performed on objects in a transfer.
Builder for TransferOptionsArgs.
Configuration for running a transfer.
Builder for TransferSpecArgs.