Package types (1.0.2)

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>__.

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

Azure credentials

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

Request passed to CreateTransferJob. .. attribute:: transfer_job

Required. The job to create.

:type: google.cloud.storage_transfer_v1.types.TransferJob

An entry describing an error that has occurred. .. attribute:: url

Required. A URL that refers to the target (a data source, a data sink, or an object) with which the error is associated.

:type: str

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.

Request passed to GetGoogleServiceAccount. .. attribute:: project_id

Required. The ID of the Google Cloud Platform Console project that the Google service account is associated with.

:type: str

Request passed to GetTransferJob. .. attribute:: job_name

Required. The job to get.

:type: str

Google service account .. attribute:: account_email

Email address of the service account.

:type: str

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

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

Response from ListTransferJobs. .. attribute:: transfer_jobs

A list of transfer jobs.

:type: Sequence[google.cloud.storage_transfer_v1.types.TransferJob]

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 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 will contain a TransferOperation][google.storagetransfer.v1.TransferOperation] resource formatted according to the specified PayloadFormat.

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.

Request passed to PauseTransferOperation. .. attribute:: name

Required. The name of the transfer operation.

:type: str

Request passed to ResumeTransferOperation. .. attribute:: name

Required. The name of the transfer operation.

:type: str

Request passed to RunTransferJob. .. attribute:: job_name

Required. The name of the transfer job.

:type: str

Transfers can be scheduled to recur or to run just once. .. attribute:: schedule_start_date

Required. The start date of a transfer. Date boundaries are determined relative to UTC time. If schedule_start_date and start_time_of_day][google.storagetransfer.v1.Schedule.start_time_of_day] are in the past relative to the job's creation time, the transfer starts the day after you schedule the transfer request.

Note: When starting jobs at or near midnight UTC it is possible that a job will start later than expected. For example, if you send an outbound request on June 1 one millisecond prior to midnight UTC and the Storage Transfer Service server receives the request on June 2, then it will create a TransferJob with schedule_start_date set to June 2 and a start_time_of_day set to midnight UTC. The first scheduled TransferOperation][google.storagetransfer.v1.TransferOperation] will take place on June 3 at midnight UTC.

:type: google.type.date_pb2.Date

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

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

A description of the execution of a transfer. .. attribute:: name

A globally unique ID assigned by the system.

:type: str

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

Configuration for running a transfer. .. attribute:: gcs_data_sink

A Cloud Storage data sink.

:type: google.cloud.storage_transfer_v1.types.GcsData

Request passed to UpdateTransferJob. .. attribute:: job_name

Required. The name of job to update.

:type: str