Types overview

AwsAccessKey

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

Fields
accessKeyId	string Required. AWS access key ID.
secretAccessKey	string Required. AWS secret access key. This field is not returned in RPC responses.

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.

Fields
awsAccessKey	object (AwsAccessKey) Input only. 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. This field is required. For information on our data retention policy for user credentials, see User credentials.
bucketName	string Required. S3 Bucket name (see Creating a bucket).
path	string Root path to transfer objects. Must be an empty string or full path name that ends with a '/'. This field is treated as an object prefix. As such, it should generally not begin with a '/'.
roleArn	string The Amazon Resource Name (ARN) of the role to support temporary credentials via AssumeRoleWithWebIdentity. For more information about ARNs, see IAM ARNs. When a role ARN is provided, Transfer Service fetches temporary credentials for the session using a AssumeRoleWithWebIdentity call for the provided role using the GoogleServiceAccount for this project.

AzureBlobStorageData

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.

Fields
azureCredentials	object (AzureCredentials) Required. Input only. Credentials used to authenticate API requests to Azure. For information on our data retention policy for user credentials, see User credentials.
container	string Required. The container to transfer from the Azure Storage account.
path	string Root path to transfer objects. Must be an empty string or full path name that ends with a '/'. This field is treated as an object prefix. As such, it should generally not begin with a '/'.
storageAccount	string Required. The name of the Azure Storage account.

AzureCredentials

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

Fields
sasToken	string Required. Azure shared access signature (SAS). Note:Copying data from Azure Data Lake Storage (ADLS) Gen 2 is in Preview. During Preview, if you are copying data from ADLS Gen 2, you must use an account SAS. For more information about SAS, see Grant limited access to Azure Storage resources using shared access signatures (SAS).

Date

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.

Fields
day	integer (int32 format) Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
month	integer (int32 format) Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
year	integer (int32 format) Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.

ErrorLogEntry

An entry describing an error that has occurred.

Fields
errorDetails[]	string A list of messages that carry the error details.
url	string Required. A URL that refers to the target (a data source, a data sink, or an object) with which the error is associated.

ErrorSummary

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

Fields
errorCode	enum Required.
Enum type. Can be one of the following:
OK	Not an error; returned on success HTTP Mapping: 200 OK
CANCELLED	The operation was cancelled, typically by the caller. HTTP Mapping: 499 Client Closed Request
UNKNOWN	Unknown error. For example, this error may be returned when a Status value received from another address space belongs to an error space that is not known in this address space. Also errors raised by APIs that do not return enough error information may be converted to this error. HTTP Mapping: 500 Internal Server Error
INVALID_ARGUMENT	The client specified an invalid argument. Note that this differs from FAILED_PRECONDITION. INVALID_ARGUMENT indicates arguments that are problematic regardless of the state of the system (e.g., a malformed file name). HTTP Mapping: 400 Bad Request
DEADLINE_EXCEEDED	The deadline expired before the operation could complete. For operations that change the state of the system, this error may be returned even if the operation has completed successfully. For example, a successful response from a server could have been delayed long enough for the deadline to expire. HTTP Mapping: 504 Gateway Timeout
NOT_FOUND	Some requested entity (e.g., file or directory) was not found. Note to server developers: if a request is denied for an entire class of users, such as gradual feature rollout or undocumented allowlist, NOT_FOUND may be used. If a request is denied for some users within a class of users, such as user-based access control, PERMISSION_DENIED must be used. HTTP Mapping: 404 Not Found
ALREADY_EXISTS	The entity that a client attempted to create (e.g., file or directory) already exists. HTTP Mapping: 409 Conflict
PERMISSION_DENIED	The caller does not have permission to execute the specified operation. PERMISSION_DENIED must not be used for rejections caused by exhausting some resource (use RESOURCE_EXHAUSTED instead for those errors). PERMISSION_DENIED must not be used if the caller can not be identified (use UNAUTHENTICATED instead for those errors). This error code does not imply the request is valid or the requested entity exists or satisfies other pre-conditions. HTTP Mapping: 403 Forbidden
UNAUTHENTICATED	The request does not have valid authentication credentials for the operation. HTTP Mapping: 401 Unauthorized
RESOURCE_EXHAUSTED	Some resource has been exhausted, perhaps a per-user quota, or perhaps the entire file system is out of space. HTTP Mapping: 429 Too Many Requests
FAILED_PRECONDITION	The operation was rejected because the system is not in a state required for the operation's execution. For example, the directory to be deleted is non-empty, an rmdir operation is applied to a non-directory, etc. Service implementors can use the following guidelines to decide between FAILED_PRECONDITION, ABORTED, and UNAVAILABLE: (a) Use UNAVAILABLE if the client can retry just the failing call. (b) Use ABORTED if the client should retry at a higher level. For example, when a client-specified test-and-set fails, indicating the client should restart a read-modify-write sequence. (c) Use FAILED_PRECONDITION if the client should not retry until the system state has been explicitly fixed. For example, if an "rmdir" fails because the directory is non-empty, FAILED_PRECONDITION should be returned since the client should not retry unless the files are deleted from the directory. HTTP Mapping: 400 Bad Request
ABORTED	The operation was aborted, typically due to a concurrency issue such as a sequencer check failure or transaction abort. See the guidelines above for deciding between FAILED_PRECONDITION, ABORTED, and UNAVAILABLE. HTTP Mapping: 409 Conflict
OUT_OF_RANGE	The operation was attempted past the valid range. E.g., seeking or reading past end-of-file. Unlike INVALID_ARGUMENT, this error indicates a problem that may be fixed if the system state changes. For example, a 32-bit file system will generate INVALID_ARGUMENT if asked to read at an offset that is not in the range [0,2^32-1], but it will generate OUT_OF_RANGE if asked to read from an offset past the current file size. There is a fair bit of overlap between FAILED_PRECONDITION and OUT_OF_RANGE. We recommend using OUT_OF_RANGE (the more specific error) when it applies so that callers who are iterating through a space can easily look for an OUT_OF_RANGE error to detect when they are done. HTTP Mapping: 400 Bad Request
UNIMPLEMENTED	The operation is not implemented or is not supported/enabled in this service. HTTP Mapping: 501 Not Implemented
INTERNAL	Internal errors. This means that some invariants expected by the underlying system have been broken. This error code is reserved for serious errors. HTTP Mapping: 500 Internal Server Error
UNAVAILABLE	The service is currently unavailable. This is most likely a transient condition, which can be corrected by retrying with a backoff. Note that it is not always safe to retry non-idempotent operations. See the guidelines above for deciding between FAILED_PRECONDITION, ABORTED, and UNAVAILABLE. HTTP Mapping: 503 Service Unavailable
DATA_LOSS	Unrecoverable data loss or corruption. HTTP Mapping: 500 Internal Server Error
errorCount	string (int64 format) Required. Count of this type of error.
errorLogEntries[]	object (ErrorLogEntry) Error samples. At most 5 error log entries are recorded for a given error code for a single transfer operation.

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.

Fields
bucketName	string Required. Cloud Storage bucket name. Must meet Bucket Name Requirements.
path	string Root path to transfer objects. Must be an empty string or full path name that ends with a '/'. This field is treated as an object prefix. As such, it should generally not begin with a '/'. The root path value must meet Object Name Requirements.

GoogleServiceAccount

Google service account

Fields
accountEmail	string Email address of the service account.
subjectId	string Unique identifier for the service account.

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

Fields
listUrl	string Required. 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.

ListOperationsResponse

The response message for Operations.ListOperations.

Fields
nextPageToken	string The standard List next-page token.
operations[]	object (Operation) A list of operations that matches the specified filter in the request.

ListTransferJobsResponse

Response from ListTransferJobs.

Fields
nextPageToken	string The list next page token.
transferJobs[]	object (TransferJob) A list of transfer jobs.

LoggingConfig

Logging configure.

Fields
enableOnpremGcsTransferLogs	boolean Enables the Cloud Storage transfer logs for this transfer. This is only supported for transfer jobs with PosixFilesystem sources. The default is that logs are not generated for this transfer.

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

Fields
eventTypes[]	string Event types for which a notification is desired. If empty, send notifications for all event types.
payloadFormat	enum Required. The desired format of the notification message payloads.
Enum type. Can be one of the following:
PAYLOAD_FORMAT_UNSPECIFIED	Illegal value, to avoid allowing a default.
NONE	No payload is included with the notification.
JSON	TransferOperation is formatted as a JSON response, in application/json.
pubsubTopic	string Required. The Topic.name of the Pub/Sub topic to which to publish notifications. Must be of the format: projects/{project}/topics/{topic}. Not matching this format results in an INVALID_ARGUMENT error.

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. This is not supported for transfers involving PosixFilesystem.

Fields
excludePrefixes[]	string If you specify exclude_prefixes, Storage Transfer Service uses the items in the exclude_prefixes array to determine which objects to exclude from a transfer. Objects must not start with one of the matching exclude_prefixes for inclusion in a transfer. The following are requirements of exclude_prefixes: * Each exclude-prefix can contain any sequence of Unicode characters, to a max length of 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 exclude-prefix must omit the leading slash. For example, to exclude the object s3://my-aws-bucket/logs/y=2015/requests.gz, specify the exclude-prefix as logs/y=2015/requests.gz. * None of the exclude-prefix values can be empty, if specified. * Each exclude-prefix must exclude a distinct portion of the object namespace. No exclude-prefix may be a prefix of another exclude-prefix. * If include_prefixes is specified, then each exclude-prefix must start with the value of a path explicitly included by include_prefixes. The max size of exclude_prefixes is 1000. For more information, see Filtering objects from transfers.
includePrefixes[]	string If you specify include_prefixes, Storage Transfer Service uses the items in the include_prefixes array to determine which objects to include in a transfer. Objects must start with one of the matching include_prefixes for inclusion in the transfer. If exclude_prefixes is specified, objects must not start with any of the exclude_prefixes specified for inclusion in the transfer. The following are requirements of include_prefixes: * Each include-prefix can contain any sequence of Unicode characters, to a max length of 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 must omit the leading slash. For example, to include the object s3://my-aws-bucket/logs/y=2015/requests.gz, specify the include-prefix as logs/y=2015/requests.gz. * None of the include-prefix values can be empty, if specified. * Each include-prefix must include a distinct portion of the object namespace. No include-prefix may be a prefix of another include-prefix. The max size of include_prefixes is 1000. For more information, see Filtering objects from transfers.
lastModifiedBefore	string (Timestamp format) If specified, only objects with a "last modification time" before this timestamp and objects that don't have a "last modification time" are transferred.
lastModifiedSince	string (Timestamp format) If specified, only objects with a "last modification time" on or after this timestamp and objects that don't have a "last modification time" are transferred. The last_modified_since and last_modified_before fields can be used together for chunked data processing. For example, consider a script that processes each day's worth of data at a time. For that you'd set each of the fields as follows: * last_modified_since to the start of the day * last_modified_before to the end of the day
maxTimeElapsedSinceLastModification	string (Duration format) If specified, only objects with a "last modification time" on or after NOW - max_time_elapsed_since_last_modification and objects that don't have a "last modification time" are transferred. For each TransferOperation started by this TransferJob, NOW refers to the start_time of the TransferOperation.
minTimeElapsedSinceLastModification	string (Duration format) If specified, only objects with a "last modification time" before NOW - min_time_elapsed_since_last_modification and objects that don't have a "last modification time" are transferred. For each TransferOperation started by this TransferJob, NOW refers to the start_time of the TransferOperation.

Operation

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

Fields
done	boolean If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
error	object (Status) The error result of the operation in case of failure or cancellation.
metadata	map (key: string, value: any) Represents the transfer operation object. To request a TransferOperation object, use transferOperations.get.
name	string The server-assigned unique name. The format of name is transferOperations/some/unique/name.
response	map (key: string, value: any) The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.

PosixFilesystem

A POSIX filesystem data source or sink.

Fields
rootDirectory	string Root directory path to the filesystem.

RunTransferJobRequest

Request passed to RunTransferJob.

Fields
projectId	string Required. The ID of the Google Cloud Platform Console project that owns the transfer job.

Schedule

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

Fields
endTimeOfDay	object (TimeOfDay) The time in UTC that no further transfer operations are scheduled. Combined with schedule_end_date, end_time_of_day specifies the end date and time for starting new transfer operations. This field must be greater than or equal to the timestamp corresponding to the combintation of schedule_start_date and start_time_of_day, and is subject to the following: * If end_time_of_day is not set and schedule_end_date is set, then a default value of 23:59:59 is used for end_time_of_day. * If end_time_of_day is set and schedule_end_date is not set, then INVALID_ARGUMENT is returned.
repeatInterval	string (Duration format) Interval between the start of each scheduled TransferOperation. If unspecified, the default value is 24 hours. This value may not be less than 1 hour.
scheduleEndDate	object (Date) The last day a transfer runs. Date boundaries are determined relative to UTC time. A job runs once per 24 hours within the following guidelines: * If schedule_end_date and schedule_start_date are the same and in the future relative to UTC, the transfer is executed only one time. * If schedule_end_date is later than schedule_start_date and schedule_end_date is in the future relative to UTC, the job runs each day at start_time_of_day through schedule_end_date.
scheduleStartDate	object (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 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 starts 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 creates a TransferJob with schedule_start_date set to June 2 and a start_time_of_day set to midnight UTC. The first scheduled TransferOperation takes place on June 3 at midnight UTC.
startTimeOfDay	object (TimeOfDay) The time in UTC that a transfer job is scheduled to run. Transfers may start later than this time. If start_time_of_day is not specified: * One-time transfers run immediately. * Recurring transfers run immediately, and each day at midnight UTC, through schedule_end_date. If start_time_of_day is specified: * One-time transfers run at the specified time. * Recurring transfers run at the specified time each day, through schedule_end_date.

Status

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.

Fields
code	integer (int32 format) The status code, which should be an enum value of google.rpc.Code.
details[]	object A list of messages that carry the error details. There is a common set of message types for APIs to use.
message	string A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

TimeOfDay

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.

Fields
hours	integer (int32 format) Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
minutes	integer (int32 format) Minutes of hour of day. Must be from 0 to 59.
nanos	integer (int32 format) Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
seconds	integer (int32 format) Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.

TransferCounters

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

Fields
bytesCopiedToSink	string (int64 format) Bytes that are copied to the data sink.
bytesDeletedFromSink	string (int64 format) Bytes that are deleted from the data sink.
bytesDeletedFromSource	string (int64 format) Bytes that are deleted from the data source.
bytesFailedToDeleteFromSink	string (int64 format) Bytes that failed to be deleted from the data sink.
bytesFoundFromSource	string (int64 format) 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.
bytesFoundOnlyFromSink	string (int64 format) Bytes found only in the data sink that are scheduled to be deleted.
bytesFromSourceFailed	string (int64 format) Bytes in the data source that failed to be transferred or that failed to be deleted after being transferred.
bytesFromSourceSkippedBySync	string (int64 format) Bytes in the data source that are not transferred because they already exist in the data sink.
directoriesFailedToListFromSource	string (int64 format) For transfers involving PosixFilesystem only. Number of listing failures for each directory found at the source. Potential failures when listing a directory include permission failure or block failure. If listing a directory fails, no files in the directory are transferred.
directoriesFoundFromSource	string (int64 format) For transfers involving PosixFilesystem only. Number of directories found while listing. For example, if the root directory of the transfer is base/ and there are two other directories, a/ and b/ under this directory, the count after listing base/, base/a/ and base/b/ is 3.
directoriesSuccessfullyListedFromSource	string (int64 format) For transfers involving PosixFilesystem only. Number of successful listings for each directory found at the source.
objectsCopiedToSink	string (int64 format) Objects that are copied to the data sink.
objectsDeletedFromSink	string (int64 format) Objects that are deleted from the data sink.
objectsDeletedFromSource	string (int64 format) Objects that are deleted from the data source.
objectsFailedToDeleteFromSink	string (int64 format) Objects that failed to be deleted from the data sink.
objectsFoundFromSource	string (int64 format) 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.
objectsFoundOnlyFromSink	string (int64 format) Objects found only in the data sink that are scheduled to be deleted.
objectsFromSourceFailed	string (int64 format) Objects in the data source that failed to be transferred or that failed to be deleted after being transferred.
objectsFromSourceSkippedBySync	string (int64 format) Objects in the data source that are not transferred because they already exist in the data sink.

TransferJob

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

Fields
creationTime	string (Timestamp format) Output only. The time that the transfer job was created.
deletionTime	string (Timestamp format) Output only. The time that the transfer job was deleted.
description	string A description provided by the user for the job. Its max length is 1024 bytes when Unicode-encoded.
lastModificationTime	string (Timestamp format) Output only. The time that the transfer job was last modified.
latestOperationName	string The name of the most recently started TransferOperation of this JobConfig. Present if a TransferOperation has been created for this JobConfig.
loggingConfig	object (LoggingConfig) Logging configuration.
name	string A unique name (within the transfer project) assigned when the job is created. If this field is empty in a CreateTransferJobRequest, Storage Transfer Service assigns a unique name. Otherwise, the specified name is used as the unique name for this job. If the specified name is in use by a job, the creation request fails with an ALREADY_EXISTS error. This name must start with "transferJobs/" prefix and end with a letter or a number, and should be no more than 128 characters. For transfers involving PosixFilesystem, this name must start with 'transferJobs/OPI' specifically. For all other transfer types, this name must not start with 'transferJobs/OPI'. 'transferJobs/OPI' is a reserved prefix for PosixFilesystem transfers. Non-PosixFilesystem example: "transferJobs/^(?!OPI)[A-Za-z0-9-._~]*[A-Za-z0-9]$" PosixFilesystem example: "transferJobs/OPI^[A-Za-z0-9-._~]*[A-Za-z0-9]$" Applications must not rely on the enforcement of naming requirements involving OPI. Invalid job names fail with an INVALID_ARGUMENT error.
notificationConfig	object (NotificationConfig) Notification configuration. This is not supported for transfers involving PosixFilesystem.
projectId	string The ID of the Google Cloud Platform Project that owns the job.
schedule	object (Schedule) Specifies schedule for the transfer job. This is an optional field. When the field is not set, the job never executes a transfer, unless you invoke RunTransferJob or update the job to have a non-empty schedule.
status	enum 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.
Enum type. Can be one of the following:
STATUS_UNSPECIFIED	Zero is an illegal value.
ENABLED	New transfers are performed based on the schedule.
DISABLED	New transfers are not scheduled.
DELETED	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. Transfer jobs become eligible for garbage collection 30 days after their status is set to DELETED.
transferSpec	object (TransferSpec) Transfer specification.

TransferOperation

A description of the execution of a transfer.

Fields
counters	object (TransferCounters) Information about the progress of the transfer operation.
endTime	string (Timestamp format) End time of this transfer execution.
errorBreakdowns[]	object (ErrorSummary) Summarizes errors encountered with sample error log entries.
name	string A globally unique ID assigned by the system.
notificationConfig	object (NotificationConfig) Notification configuration.
projectId	string The ID of the Google Cloud Platform Project that owns the operation.
startTime	string (Timestamp format) Start time of this transfer execution.
status	enum Status of the transfer operation.
Enum type. Can be one of the following:
STATUS_UNSPECIFIED	Zero is an illegal value.
IN_PROGRESS	In progress.
PAUSED	Paused.
SUCCESS	Completed successfully.
FAILED	Terminated due to an unrecoverable failure.
ABORTED	Aborted by the user.
QUEUED	Temporarily delayed by the system. No user action is required.
transferJobName	string The name of the transfer job that triggers this transfer operation.
transferSpec	object (TransferSpec) Transfer specification.

TransferOptions

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

Fields
deleteObjectsFromSourceAfterTransfer	boolean Whether objects should be deleted from the source after they are transferred to the sink. Note: This option and delete_objects_unique_in_sink are mutually exclusive.
deleteObjectsUniqueInSink	boolean Whether objects that exist only in the sink should be deleted. Note: This option and delete_objects_from_source_after_transfer are mutually exclusive.
overwriteObjectsAlreadyExistingInSink	boolean When to overwrite objects that already exist in the sink. The default is that only objects that are different from the source are ovewritten. If true, all objects in the sink whose name matches an object in the source are overwritten with the source object.

TransferSpec

Configuration for running a transfer.

Fields
awsS3DataSource	object (AwsS3Data) An AWS S3 data source.
azureBlobStorageDataSource	object (AzureBlobStorageData) An Azure Blob Storage data source.
gcsDataSink	object (GcsData) A Cloud Storage data sink.
gcsDataSource	object (GcsData) A Cloud Storage data source.
httpDataSource	object (HttpData) An HTTP URL data source.
objectConditions	object (ObjectConditions) Only objects that satisfy these object conditions are included in the set of data source and data sink objects. Object conditions based on objects' "last modification time" do not exclude objects in a data sink.
posixDataSource	object (PosixFilesystem) A POSIX Filesystem data source.
transferOptions	object (TransferOptions) If the option delete_objects_unique_in_sink is true and time-based object conditions such as 'last modification time' are specified, the request fails with an INVALID_ARGUMENT error.

UpdateTransferJobRequest

Request passed to UpdateTransferJob.

Fields
projectId	string Required. The ID of the Google Cloud Platform Console project that owns the job.
transferJob	object (TransferJob) Required. The job to update. transferJob is expected to specify only four fields: description, transfer_spec, notification_config, and status. An UpdateTransferJobRequest that specifies other fields are rejected with the error INVALID_ARGUMENT. Updating a job status to DELETED requires storagetransfer.jobs.delete permissions.
updateTransferJobFieldMask	string (FieldMask format) 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, transfer_spec, notification_config, and status. To update the transfer_spec of the job, a complete transfer specification must be provided. An incomplete specification missing any required fields is rejected with the error INVALID_ARGUMENT.