Package Classes (1.12.0)

Summary of entries of Classes for storagetransfer.

Classes

StorageTransferServiceAsyncClient

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.

StorageTransferServiceClient

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.

ListAgentPoolsAsyncPager

A pager for iterating through list_agent_pools requests.

This class thinly wraps an initial ListAgentPoolsResponse object, and provides an __aiter__ method to iterate through its agent_pools field.

If there are more pages, the __aiter__ method will make additional ListAgentPools requests and continue to iterate through the agent_pools field on the corresponding responses.

All the usual ListAgentPoolsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListAgentPoolsPager

A pager for iterating through list_agent_pools requests.

This class thinly wraps an initial ListAgentPoolsResponse object, and provides an __iter__ method to iterate through its agent_pools field.

If there are more pages, the __iter__ method will make additional ListAgentPools requests and continue to iterate through the agent_pools field on the corresponding responses.

All the usual ListAgentPoolsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListTransferJobsAsyncPager

A pager for iterating through list_transfer_jobs requests.

This class thinly wraps an initial ListTransferJobsResponse object, and provides an __aiter__ method to iterate through its transfer_jobs field.

If there are more pages, the __aiter__ method will make additional ListTransferJobs requests and continue to iterate through the transfer_jobs field on the corresponding responses.

All the usual ListTransferJobsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListTransferJobsPager

A pager for iterating through list_transfer_jobs requests.

This class thinly wraps an initial ListTransferJobsResponse object, and provides an __iter__ method to iterate through its transfer_jobs field.

If there are more pages, the __iter__ method will make additional ListTransferJobs requests and continue to iterate through the transfer_jobs field on the corresponding responses.

All the usual ListTransferJobsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

BandwidthLimit

Specifies a bandwidth limit for an agent pool.

AwsAccessKey

AWS access key (see AWS Security Credentials <https://docs.aws.amazon.com/general/latest/gr/aws-security-credentials.html>__).

For information on our data retention policy for user credentials, see User credentials </storage-transfer/docs/data-retention#user-credentials>__.

AwsS3CompatibleData

An AwsS3CompatibleData resource.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

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.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

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 <https://docs.microsoft.com/en-us/azure/storage/common/storage-create-storage-account#storage-account-endpoints>. In an AzureBlobStorageData resource, a blobs's name is the Azure Blob Storage blob's key name <https://docs.microsoft.com/en-us/rest/api/storageservices/naming-and-referencing-containers--blobs--and-metadata#blob-names>.

AzureCredentials

Azure credentials

For information on our data retention policy for user credentials, see User credentials </storage-transfer/docs/data-retention#user-credentials>__.

CreateAgentPoolRequest

Specifies the request passed to CreateAgentPool.

CreateTransferJobRequest

Request passed to CreateTransferJob.

DeleteAgentPoolRequest

Specifies the request passed to DeleteAgentPool.

DeleteTransferJobRequest

Request passed to DeleteTransferJob.

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.

EventStream

Specifies the Event-driven transfer options. Event-driven transfers listen to an event stream to transfer updated files.

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.

GetAgentPoolRequest

Specifies the request passed to GetAgentPool.

GetGoogleServiceAccountRequest

Request passed to GetGoogleServiceAccount.

GetTransferJobRequest

Request passed to GetTransferJob.

GoogleServiceAccount

Google service account

HdfsData

An HdfsData resource specifies a path within an HDFS entity (e.g. a cluster). All cluster-specific settings, such as namenodes and ports, are configured on the transfer agents servicing requests, so HdfsData only contains the root path to the data in our transfer.

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 <https://cloud.google.com/storage-transfer/docs/create-url-list>__.

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 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 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][google.storagetransfer.v1.ObjectConditions] have no effect when filtering objects to transfer.

ListAgentPoolsRequest

The request passed to ListAgentPools.

ListAgentPoolsResponse

Response from ListAgentPools.

ListTransferJobsRequest

projectId, jobNames, and jobStatuses are query parameters that can be specified when listing transfer jobs.

ListTransferJobsResponse

Response from ListTransferJobs.

LoggingConfig

Specifies the logging behavior for transfer operations.

Logs can be sent to Cloud Logging for all transfer types. See Read transfer logs <https://cloud.google.com/storage-transfer/docs/read-transfer-logs>__ for details.

LoggableAction

Loggable actions.

LoggableActionState

Loggable action states.

MetadataOptions

Specifies the metadata options for running a transfer.

Acl

Options for handling Cloud Storage object ACLs.

GID

Options for handling file GID attribute.

KmsKey

Options for handling the KmsKey setting for Google Cloud Storage objects.

Mode

Options for handling file mode attribute.

StorageClass

Options for handling Google Cloud Storage object storage class.

Symlink

Whether symlinks should be skipped or preserved during a transfer job.

TemporaryHold

Options for handling temporary holds for Google Cloud Storage objects.

TimeCreated

Options for handling timeCreated metadata for Google Cloud Storage objects.

UID

Options for handling file UID attribute.

NotificationConfig

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][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 the TransferOperation
"transferJobName": the transfer_job_name][google.storagetransfer.v1.TransferOperation.transfer_job_name] of the TransferOperation
"transferOperationName": the name][google.storagetransfer.v1.TransferOperation.name] of the TransferOperation

The PubsubMessage.data contains a TransferOperation][google.storagetransfer.v1.TransferOperation] resource formatted according to the specified PayloadFormat.

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.

PayloadFormat

Enum for specifying the format of a notification message's payload.

ObjectConditions

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][google.storagetransfer.v1.PosixFilesystem] source or destination don't support ObjectConditions.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

UpdateAgentPoolRequest

Specifies the request passed to UpdateAgentPool.

UpdateTransferJobRequest

Request passed to UpdateTransferJob.

Modules

pagers

API documentation for storage_transfer_v1.services.storage_transfer_service.pagers module.