API Reference google_api_storage_transfer v0.33.2

Modules

API client metadata for GoogleApi.StorageTransfer.V1.

API calls for all endpoints tagged GoogleServiceAccounts.

API calls for all endpoints tagged Projects.

API calls for all endpoints tagged TransferJobs.

API calls for all endpoints tagged TransferOperations.

Handle Tesla connections for GoogleApi.StorageTransfer.V1.

Represents an On-Premises Agent pool.

AWS access key (see AWS Security Credentials). For information on our data retention policy for user credentials, see User credentials.

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.

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.

Azure credentials For information on our data retention policy for user credentials, see User credentials.

Specifies a bandwidth limit for an agent pool.

The request message for Operations.CancelOperation.

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 value, with a zero year, such as an anniversary A year on its own, with zero month and day values A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and google.protobuf.Timestamp.

A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for Empty is empty JSON object {}.

An entry describing an error that has occurred.

A summary of errors by error code, plus a count and sample error log entries.

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.

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.

The response message for Operations.ListOperations.

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.

Specifies the metadata options for running a transfer.

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.

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.

This resource represents a long-running operation that is the result of a network API call.

Request passed to PauseTransferOperation.

Request passed to ResumeTransferOperation.

Transfers can be scheduled to recur or to run just once.

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.

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.

A collection of counters that report the progress of a transfer operation.

This resource represents the configuration of a transfer job that runs periodically.

Specifies where the manifest is located.

A description of the execution of a transfer.

TransferOptions define the actions to be performed on objects in a transfer.

Configuration for running a transfer.