Default request referring to version v1 of the Storage Transfer API. This contains the host and root path used as a starting point for constructing service requests.

View and manage your data across Google Cloud Platform services

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

See: errorSummary smart constructor.

Creates a value of ErrorSummary with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• esErrorCount
• esErrorCode
• esErrorLogEntries

Count of this type of error. Required.

Required.

Error samples.

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. The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` that can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons.

See: status smart constructor.

Creates a value of Status with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• sDetails
• sCode
• sMessage

A list of messages that carry the error details. There is a common set of message types for APIs to use.

The status code, which should be an enum value of google.rpc.Code.

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.

The response message for Operations.ListOperations.

See: listOperationsResponse smart constructor.

Creates a value of ListOperationsResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• lorNextPageToken
• lorOperations

The standard List next-page token.

A list of operations that matches the specified filter in the request.

Status of the transfer operation.

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

See: schedule smart constructor.

Creates a value of Schedule with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• sScheduleEndDate
• sScheduleStartDate
• sStartTimeOfDay

The last day the recurring transfer will be run. If `scheduleEndDate` is the same as `scheduleStartDate`, the transfer will be executed only once.

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.

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.

Conditions that determine which objects will be transferred.

See: objectConditions smart constructor.

Creates a value of ObjectConditions with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• ocMinTimeElapsedSinceLastModification
• ocIncludePrefixes
• ocMaxTimeElapsedSinceLastModification
• ocExcludePrefixes

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

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.

`maxTimeElapsedSinceLastModification` is the complement to `minTimeElapsedSinceLastModification`.

`excludePrefixes` must follow the requirements described for `includePrefixes`. The max size of `excludePrefixes` is 1000.

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

See: operation smart constructor.

Creates a value of Operation with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• oDone
• oError
• oResponse
• oName
• oMetadata

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.

The error result of the operation in case of failure or cancellation.

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

The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should have the format of `transferOperations/some/unique/name`.

Represents the transfer operation object.

A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.

See: empty smart constructor.

Creates a value of Empty with the minimum fields required to make a request.

Request passed to PauseTransferOperation.

See: pauseTransferOperationRequest smart constructor.

Creates a value of PauseTransferOperationRequest with the minimum fields required to make a request.

Google service account

See: googleServiceAccount smart constructor.

Creates a value of GoogleServiceAccount with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• gsaAccountEmail

Required.

Creates a value of StatusDetailsItem with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• sdiAddtional

Properties of the object. Contains field 'type with type URL.

Represents a whole or partial calendar date, e.g. a birthday. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the Proleptic Gregorian Calendar. This can represent: * A full date, with non-zero year, month and day values * A month and day value, with a zero year, e.g. an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, e.g. a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.

See: date smart constructor.

Creates a value of Date with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• dDay
• dYear
• dMonth

Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year by itself or a year and month where the day is not significant.

Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year.

Month of year. Must be from 1 to 12, or 0 if specifying a year without a month and day.

Request passed to UpdateTransferJob.

See: updateTransferJobRequest smart constructor.

Creates a value of UpdateTransferJobRequest with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• utjrTransferJob
• utjrProjectId
• utjrUpdateTransferJobFieldMask

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.

The ID of the Google Cloud Platform Console project that owns the job. Required.

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

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

See: transferCounters smart constructor.

Creates a value of TransferCounters with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• tcBytesFoundOnlyFromSink
• tcBytesDeletedFromSink
• tcObjectsDeletedFromSource
• tcObjectsFoundFromSource
• tcBytesFailedToDeleteFromSink
• tcBytesFromSourceFailed
• tcBytesCopiedToSink
• tcBytesFoundFromSource
• tcBytesDeletedFromSource
• tcObjectsDeletedFromSink
• tcObjectsFoundOnlyFromSink
• tcBytesFromSourceSkippedBySync
• tcObjectsCopiedToSink
• tcObjectsFromSourceFailed
• tcObjectsFailedToDeleteFromSink
• tcObjectsFromSourceSkippedBySync

Bytes found only in the data sink that are scheduled to be deleted.

Bytes that are deleted from the data sink.

Objects that are deleted from the data source.

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.

Bytes that failed to be deleted from the data sink.

Bytes in the data source that failed to be transferred or that failed to be deleted after being transferred.

Bytes that are copied to the data sink.

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.

Bytes that are deleted from the data source.

Objects that are deleted from the data sink.

Objects found only in the data sink that are scheduled to be deleted.

Bytes in the data source that are not transferred because they already exist in the data sink.

Objects that are copied to the data sink.

Objects in the data source that failed to be transferred or that failed to be deleted after being transferred.

Objects that failed to be deleted from the data sink.

Objects in the data source that are not transferred because they already exist in the data sink.

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

See: transferJob smart constructor.

Creates a value of TransferJob with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• tjCreationTime
• tjStatus
• tjSchedule
• tjDeletionTime
• tjName
• tjProjectId
• tjTransferSpec
• tjDescription
• tjLastModificationTime

This field cannot be changed by user requests.

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.

Schedule specification.

This field cannot be changed by user requests.

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.

The ID of the Google Cloud Platform Console project that owns the job.

Transfer specification.

A description provided by the user for the job. Its max length is 1024 bytes when Unicode-encoded.

This field cannot be changed by user requests.

In a GcsData resource, 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.

See: gcsData smart constructor.

Creates a value of GcsData with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• gdBucketName

Google Cloud Storage bucket name (see Bucket Name Requirements). Required.

V1 error format.