package google.storagetransfer.v1
Get desktop application:
View/edit binary Protocol Buffers messages
Transfers data between between Google Cloud Storage buckets or from a data source external to Google to a Cloud Storage bucket.
Returns the Google service account that is used by Storage Transfer Service to access buckets in the project where transfers run or in other projects. Each Google service account is associated with one Google Cloud Platform Console project. Users should add this service account to the Google Cloud Storage bucket ACLs to grant access to Storage Transfer Service. This service account is created and owned by Storage Transfer Service and can only be used by Storage Transfer Service.
message
transfer.proto:102Request passed to GetGoogleServiceAccount.
string project_id = 1
The ID of the Google Cloud Platform Console project that the Google service account is associated with. Required.
message
transfer_types.proto:34Google service account
string account_email = 1
Required.
rpc CreateTransferJob (, )
transfer.proto:50Creates a transfer job that runs periodically.
message
transfer.proto:110Request passed to CreateTransferJob.
optional transfer_job = 1
The job to create. Required.
rpc UpdateTransferJob (, )
transfer.proto:60Updates a transfer job. Updating a job's transfer spec does not affect transfer operations that are running already. Updating the scheduling of a job is not allowed.
message
transfer.proto:117Request passed to UpdateTransferJob.
string job_name = 1
The name of job to update. Required.
string project_id = 2
The ID of the Google Cloud Platform Console project that owns the job. Required.
optional transfer_job = 3
The job to update. `transferJob` is expected to specify only three fields: `description`, `transferSpec`, and `status`. An UpdateTransferJobRequest that specifies other fields will be rejected with an error `INVALID_ARGUMENT`. Required.
optional update_transfer_job_field_mask = 4
The field mask of the fields in `transferJob` that are to be updated in this request. Fields in `transferJob` that can be updated are: `description`, `transferSpec`, and `status`. To update the `transferSpec` of the job, a complete transfer specification has to be provided. An incomplete specification which misses any required fields will be rejected with the error `INVALID_ARGUMENT`.
rpc GetTransferJob (, )
transfer.proto:68Gets a transfer job.
message
transfer.proto:143Request passed to GetTransferJob.
string job_name = 1
The job to get. Required.
string project_id = 2
The ID of the Google Cloud Platform Console project that owns the job. Required.
rpc ListTransferJobs (, )
transfer.proto:75Lists transfer jobs.
message
transfer.proto:155`project_id`, `job_names`, and `job_statuses` are query parameters that can be specified when listing transfer jobs.
string filter = 1
A list of query parameters specified as JSON text in the form of {"project_id":"my_project_id", "job_names":["jobid1","jobid2",...], "job_statuses":["status1","status2",...]}. Since `job_names` and `job_statuses` support multiple values, their values must be specified with array notation. `project_id` is required. `job_names` and `job_statuses` are optional. The valid values for `job_statuses` are case-insensitive: `ENABLED`, `DISABLED`, and `DELETED`.
int32 page_size = 4
The list page size. The max allowed value is 256.
string page_token = 5
The list page token.
message
transfer.proto:174Response from ListTransferJobs.
repeated transfer_jobs = 1
A list of transfer jobs.
string next_page_token = 2
The list next page token.
Pauses a transfer operation.
message
transfer.proto:183Request passed to PauseTransferOperation.
string name = 1
The name of the transfer operation. Required.
Resumes a transfer operation that is paused.
message
transfer.proto:190Request passed to ResumeTransferOperation.
string name = 1
The name of the transfer operation. Required.
message
transfer_types.proto:42AWS access key (see [AWS Security Credentials](http://docs.aws.amazon.com/general/latest/gr/aws-security-credentials.html)).
Used in:
string access_key_id = 1
AWS access key ID. Required.
string secret_access_key = 2
AWS secret access key. This field is not returned in RPC responses. Required.
message
transfer_types.proto:123An AwsS3Data can be a data source, but not a data sink. In an AwsS3Data, an object's name is the S3 object's key name.
Used in:
string bucket_name = 1
S3 Bucket name (see [Creating a bucket](http://docs.aws.amazon.com/AmazonS3/latest/dev/create-bucket-get-location-example.html)). Required.
optional aws_access_key = 2
AWS access key used to sign the API requests to the AWS S3 bucket. Permissions on the bucket must be granted to the access ID of the AWS access key. Required.
message
transfer_types.proto:317An entry describing an error that has occurred.
Used in:
string url = 1
A URL that refers to the target (a data source, a data sink, or an object) with which the error is associated. Required.
repeated string error_details = 3
A list of messages that carry the error details.
message
transfer_types.proto:329A summary of errors by error code, plus a count and sample error log entries.
Used in:
rpc.Code error_code = 1
Required.
int64 error_count = 2
Count of this type of error. Required.
repeated error_log_entries = 3
Error samples.
message
transfer_types.proto:113In a GcsData, an object's name is the Google Cloud Storage object's name and its `lastModificationTime` refers to the object's updated time, which changes when the content or the metadata of the object is updated.
Used in:
string bucket_name = 1
Google Cloud Storage bucket name (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). Required.
message
transfer_types.proto:179An HttpData 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/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. For more information, see [Generating MD5 hashes](https://cloud.google.com/storage/transfer/#md5) * Ensure that each URL you specify is publicly accessible. For example, in Google Cloud Storage you can [share an object publicly] (https://cloud.google.com/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](#ObjectConditions) have no effect when filtering objects to transfer.
Used in:
string list_url = 1
The URL that points to the file that stores the object list entries. This file must allow public access. Currently, only URLs with HTTP and HTTPS schemes are supported. Required.
message
transfer_types.proto:53Conditions that determine which objects will be transferred.
Used in:
optional min_time_elapsed_since_last_modification = 1
If unspecified, `minTimeElapsedSinceLastModification` takes a zero value and `maxTimeElapsedSinceLastModification` takes the maximum possible value of Duration. Objects that satisfy the object conditions must either have a `lastModificationTime` greater or equal to `NOW` - `maxTimeElapsedSinceLastModification` and less than `NOW` - `minTimeElapsedSinceLastModification`, or not have a `lastModificationTime`.
optional max_time_elapsed_since_last_modification = 2
`maxTimeElapsedSinceLastModification` is the complement to `minTimeElapsedSinceLastModification`.
repeated string include_prefixes = 3
If `includePrefixes` is specified, objects that satisfy the object conditions must have names that start with one of the `includePrefixes` and that do not start with any of the `excludePrefixes`. If `includePrefixes` is not specified, all objects except those that have names starting with one of the `excludePrefixes` must satisfy the object conditions. Requirements: * Each include-prefix and exclude-prefix can contain any sequence of Unicode characters, of max length 1024 bytes when UTF8-encoded, and must not contain Carriage Return or Line Feed characters. Wildcard matching and regular expression matching are not supported. * Each include-prefix and exclude-prefix must omit the leading slash. For example, to include the `requests.gz` object in a transfer from `s3://my-aws-bucket/logs/y=2015/requests.gz`, specify the include prefix as `logs/y=2015/requests.gz`. * None of the include-prefix or the exclude-prefix values can be empty, if specified. * Each include-prefix must include a distinct portion of the object namespace, i.e., no include-prefix may be a prefix of another include-prefix. * Each exclude-prefix must exclude a distinct portion of the object namespace, i.e., no exclude-prefix may be a prefix of another exclude-prefix. * If `includePrefixes` is specified, then each exclude-prefix must start with the value of a path explicitly included by `includePrefixes`. The max size of `includePrefixes` is 1000.
repeated string exclude_prefixes = 4
`excludePrefixes` must follow the requirements described for `includePrefixes`. The max size of `excludePrefixes` is 1000.
message
transfer_types.proto:236Transfers can be scheduled to recur or to run just once.
Used in:
optional schedule_start_date = 1
The first day the recurring transfer is scheduled to run. If `scheduleStartDate` is in the past, the transfer will run for the first time on the following day. Required.
optional schedule_end_date = 2
The last day the recurring transfer will be run. If `scheduleEndDate` is the same as `scheduleStartDate`, the transfer will be executed only once.
optional start_time_of_day = 3
The time in UTC at which the transfer will be scheduled to start in a day. Transfers may start later than this time. If not specified, recurring and one-time transfers that are scheduled to run today will run immediately; recurring transfers that are scheduled to run on a future date will start at approximately midnight UTC on that date. Note that when configuring a transfer with the Cloud Platform Console, the transfer's start time in a day is specified in your local timezone.
message
transfer_types.proto:342A collection of counters that report the progress of a transfer operation.
Used in:
int64 objects_found_from_source = 1
Objects found in the data source that are scheduled to be transferred, excluding any that are filtered based on object conditions or skipped due to sync.
int64 bytes_found_from_source = 2
Bytes found in the data source that are scheduled to be transferred, excluding any that are filtered based on object conditions or skipped due to sync.
int64 objects_found_only_from_sink = 3
Objects found only in the data sink that are scheduled to be deleted.
int64 bytes_found_only_from_sink = 4
Bytes found only in the data sink that are scheduled to be deleted.
int64 objects_from_source_skipped_by_sync = 5
Objects in the data source that are not transferred because they already exist in the data sink.
int64 bytes_from_source_skipped_by_sync = 6
Bytes in the data source that are not transferred because they already exist in the data sink.
int64 objects_copied_to_sink = 7
Objects that are copied to the data sink.
int64 bytes_copied_to_sink = 8
Bytes that are copied to the data sink.
int64 objects_deleted_from_source = 9
Objects that are deleted from the data source.
int64 bytes_deleted_from_source = 10
Bytes that are deleted from the data source.
int64 objects_deleted_from_sink = 11
Objects that are deleted from the data sink.
int64 bytes_deleted_from_sink = 12
Bytes that are deleted from the data sink.
int64 objects_from_source_failed = 13
Objects in the data source that failed during the transfer.
int64 bytes_from_source_failed = 14
Bytes in the data source that failed during the transfer.
int64 objects_failed_to_delete_from_sink = 15
Objects that failed to be deleted from the data sink.
int64 bytes_failed_to_delete_from_sink = 16
Bytes that failed to be deleted from the data sink.
message
transfer_types.proto:260This resource represents the configuration of a transfer job that runs periodically.
Used as response type in: StorageTransferService.CreateTransferJob, StorageTransferService.GetTransferJob, StorageTransferService.UpdateTransferJob
Used as field type in: , ,
string name = 1
A globally unique name assigned by Storage Transfer Service when the job is created. This field should be left empty in requests to create a new transfer job; otherwise, the requests result in an `INVALID_ARGUMENT` error.
string description = 2
A description provided by the user for the job. Its max length is 1024 bytes when Unicode-encoded.
string project_id = 3
The ID of the Google Cloud Platform Console project that owns the job.
optional transfer_spec = 4
Transfer specification.
optional schedule = 5
Schedule specification.
TransferJob.Status status = 6
Status of the job. This value MUST be specified for `CreateTransferJobRequests`. NOTE: The effect of the new job status takes place during a subsequent job run. For example, if you change the job status from `ENABLED` to `DISABLED`, and an operation spawned by the transfer is running, the status change would not affect the current operation.
optional creation_time = 7
This field cannot be changed by user requests.
optional last_modification_time = 8
This field cannot be changed by user requests.
optional deletion_time = 9
This field cannot be changed by user requests.
The status of the transfer job.
Used in:
STATUS_UNSPECIFIED = 0
Zero is an illegal value.
ENABLED = 1
New transfers will be performed based on the schedule.
DISABLED = 2
New transfers will not be scheduled.
DELETED = 3
This is a soft delete state. After a transfer job is set to this state, the job and all the transfer executions are subject to garbage collection.
message
transfer_types.proto:399A description of the execution of a transfer.
string name = 1
A globally unique ID assigned by the system.
string project_id = 2
The ID of the Google Cloud Platform Console project that owns the operation. Required.
optional transfer_spec = 3
Transfer specification. Required.
optional start_time = 4
Start time of this transfer execution.
optional end_time = 5
End time of this transfer execution.
TransferOperation.Status status = 6
Status of the transfer operation.
optional counters = 7
Information about the progress of the transfer operation.
repeated error_breakdowns = 8
Summarizes errors encountered with sample error log entries.
string transfer_job_name = 9
The name of the transfer job that triggers this transfer operation.
The status of a TransferOperation.
Used in:
STATUS_UNSPECIFIED = 0
Zero is an illegal value.
IN_PROGRESS = 1
In progress.
PAUSED = 2
Paused.
SUCCESS = 3
Completed successfully.
FAILED = 4
Terminated due to an unrecoverable failure.
ABORTED = 5
Aborted by the user.
message
transfer_types.proto:189TransferOptions uses three boolean parameters to define the actions to be performed on objects in a transfer.
Used in:
bool overwrite_objects_already_existing_in_sink = 1
Whether overwriting objects that already exist in the sink is allowed.
bool delete_objects_unique_in_sink = 2
Whether objects that exist only in the sink should be deleted. Note that this option and `deleteObjectsFromSourceAfterTransfer` are mutually exclusive.
bool delete_objects_from_source_after_transfer = 3
Whether objects should be deleted from the source after they are transferred to the sink. Note that this option and `deleteObjectsUniqueInSink` are mutually exclusive.
message
transfer_types.proto:205Configuration for running a transfer.
Used in: ,
oneof data_source
The read source of the data.
gcs_data_source = 1
A Google Cloud Storage data source.
aws_s3_data_source = 2
An AWS S3 data source.
http_data_source = 3
An HTTP URL data source.
oneof data_sink
The write sink for the data.
gcs_data_sink = 4
A Google Cloud Storage data sink.
optional object_conditions = 5
Only objects that satisfy these object conditions are included in the set of data source and data sink objects. Object conditions based on objects' `lastModificationTime` do not exclude objects in a data sink.
optional transfer_options = 6
If the option `deleteObjectsUniqueInSink` is `true`, object conditions based on objects' `lastModificationTime` are ignored and do not exclude objects in a data source or a data sink.