Storage Transfer v1 API - Namespace Google.Cloud.StorageTransfer.V1 (2.8.0)

Classes

AgentPool.Types

Container for nested types declared in the AgentPool message type.

AgentPool.Types.BandwidthLimit

Specifies a bandwidth limit for an agent pool.

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.

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.

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.

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 for details.

LoggingConfig.Types

Container for nested types declared in the LoggingConfig message type.

MetadataOptions

Specifies the metadata options for running a transfer.

MetadataOptions.Types

Container for nested types declared in the MetadataOptions message type.

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.

NotificationConfig.Types

Container for nested types declared in the NotificationConfig message type.

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.

PauseTransferOperationRequest

Request passed to PauseTransferOperation.

PosixFilesystem

A POSIX filesystem resource.

ReplicationSpec

Specifies the configuration for a cross-bucket replication job. Cross-bucket replication copies new or updated objects from a source Cloud Storage bucket to a destination Cloud Storage bucket. Existing objects in the source bucket are not copied by a new cross-bucket replication job.

ResumeTransferOperationRequest

Request passed to ResumeTransferOperation.

RunTransferJobRequest

Request passed to RunTransferJob.

S3CompatibleMetadata

S3CompatibleMetadata contains the metadata fields that apply to the basic types of S3-compatible data providers.

S3CompatibleMetadata.Types

Container for nested types declared in the S3CompatibleMetadata message type.

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.