Copyright | (c) 2015-2016 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
- Service Configuration
- OAuth Scopes
- API Declaration
- Resources
- storagetransfer.getGoogleServiceAccount
- storagetransfer.googleServiceAccounts.get
- storagetransfer.transferJobs.create
- storagetransfer.transferJobs.get
- storagetransfer.transferJobs.list
- storagetransfer.transferJobs.patch
- storagetransfer.transferOperations.cancel
- storagetransfer.transferOperations.delete
- storagetransfer.transferOperations.get
- storagetransfer.transferOperations.list
- storagetransfer.transferOperations.pause
- storagetransfer.transferOperations.resume
- Types
- ErrorSummary
- Status
- ListOperationsResponse
- Schedule
- ObjectConditions
- Operation
- Empty
- PauseTransferOperationRequest
- GoogleServiceAccount
- StatusDetailsItem
- Date
- UpdateTransferJobRequest
- TransferCounters
- TransferJob
- GcsData
- AwsS3Data
- HTTPData
- TimeOfDay'
- ErrorLogEntry
- OperationMetadata
- TransferOptions
- TransferOperation
- TransferSpec
- ListTransferJobsResponse
- OperationResponse
- ResumeTransferOperationRequest
- AwsAccessKey
Transfers data from external data sources to a Google Cloud Storage bucket or between Google Cloud Storage buckets.
- storageTransferService :: ServiceConfig
- cloudPlatformScope :: Proxy '["https://www.googleapis.com/auth/cloud-platform"]
- type StorageTransferAPI = TransferJobsListResource :<|> (TransferJobsPatchResource :<|> (TransferJobsGetResource :<|> (TransferJobsCreateResource :<|> (GetGoogleServiceAccountResource :<|> (TransferOperationsListResource :<|> (TransferOperationsGetResource :<|> (TransferOperationsPauseResource :<|> (TransferOperationsCancelResource :<|> (TransferOperationsDeleteResource :<|> (TransferOperationsResumeResource :<|> GoogleServiceAccountsGetResource))))))))))
- module Network.Google.Resource.StorageTransfer.GetGoogleServiceAccount
- module Network.Google.Resource.StorageTransfer.GoogleServiceAccounts.Get
- module Network.Google.Resource.StorageTransfer.TransferJobs.Create
- module Network.Google.Resource.StorageTransfer.TransferJobs.Get
- module Network.Google.Resource.StorageTransfer.TransferJobs.List
- module Network.Google.Resource.StorageTransfer.TransferJobs.Patch
- module Network.Google.Resource.StorageTransfer.TransferOperations.Cancel
- module Network.Google.Resource.StorageTransfer.TransferOperations.Delete
- module Network.Google.Resource.StorageTransfer.TransferOperations.Get
- module Network.Google.Resource.StorageTransfer.TransferOperations.List
- module Network.Google.Resource.StorageTransfer.TransferOperations.Pause
- module Network.Google.Resource.StorageTransfer.TransferOperations.Resume
- data ErrorSummary
- errorSummary :: ErrorSummary
- esErrorCount :: Lens' ErrorSummary (Maybe Int64)
- esErrorCode :: Lens' ErrorSummary (Maybe Text)
- esErrorLogEntries :: Lens' ErrorSummary [ErrorLogEntry]
- data Status
- status :: Status
- sDetails :: Lens' Status [StatusDetailsItem]
- sCode :: Lens' Status (Maybe Int32)
- sMessage :: Lens' Status (Maybe Text)
- data ListOperationsResponse
- listOperationsResponse :: ListOperationsResponse
- lorNextPageToken :: Lens' ListOperationsResponse (Maybe Text)
- lorOperations :: Lens' ListOperationsResponse [Operation]
- data Schedule
- schedule :: Schedule
- sScheduleEndDate :: Lens' Schedule (Maybe Date)
- sScheduleStartDate :: Lens' Schedule (Maybe Date)
- sStartTimeOfDay :: Lens' Schedule (Maybe TimeOfDay')
- data ObjectConditions
- objectConditions :: ObjectConditions
- ocMinTimeElapsedSinceLastModification :: Lens' ObjectConditions (Maybe Text)
- ocIncludePrefixes :: Lens' ObjectConditions [Text]
- ocMaxTimeElapsedSinceLastModification :: Lens' ObjectConditions (Maybe Text)
- ocExcludePrefixes :: Lens' ObjectConditions [Text]
- data Operation
- operation :: Operation
- oDone :: Lens' Operation (Maybe Bool)
- oError :: Lens' Operation (Maybe Status)
- oResponse :: Lens' Operation (Maybe OperationResponse)
- oName :: Lens' Operation (Maybe Text)
- oMetadata :: Lens' Operation (Maybe OperationMetadata)
- data Empty
- empty :: Empty
- data PauseTransferOperationRequest
- pauseTransferOperationRequest :: PauseTransferOperationRequest
- data GoogleServiceAccount
- googleServiceAccount :: GoogleServiceAccount
- gsaAccountEmail :: Lens' GoogleServiceAccount (Maybe Text)
- data StatusDetailsItem
- statusDetailsItem :: HashMap Text JSONValue -> StatusDetailsItem
- sdiAddtional :: Lens' StatusDetailsItem (HashMap Text JSONValue)
- data Date
- date :: Date
- dDay :: Lens' Date (Maybe Int32)
- dYear :: Lens' Date (Maybe Int32)
- dMonth :: Lens' Date (Maybe Int32)
- data UpdateTransferJobRequest
- updateTransferJobRequest :: UpdateTransferJobRequest
- utjrTransferJob :: Lens' UpdateTransferJobRequest (Maybe TransferJob)
- utjrProjectId :: Lens' UpdateTransferJobRequest (Maybe Text)
- utjrUpdateTransferJobFieldMask :: Lens' UpdateTransferJobRequest (Maybe Text)
- data TransferCounters
- transferCounters :: TransferCounters
- tcBytesFoundOnlyFromSink :: Lens' TransferCounters (Maybe Int64)
- tcBytesDeletedFromSink :: Lens' TransferCounters (Maybe Int64)
- tcObjectsDeletedFromSource :: Lens' TransferCounters (Maybe Int64)
- tcObjectsFoundFromSource :: Lens' TransferCounters (Maybe Int64)
- tcBytesFailedToDeleteFromSink :: Lens' TransferCounters (Maybe Int64)
- tcBytesFromSourceFailed :: Lens' TransferCounters (Maybe Int64)
- tcBytesCopiedToSink :: Lens' TransferCounters (Maybe Int64)
- tcBytesFoundFromSource :: Lens' TransferCounters (Maybe Int64)
- tcBytesDeletedFromSource :: Lens' TransferCounters (Maybe Int64)
- tcObjectsDeletedFromSink :: Lens' TransferCounters (Maybe Int64)
- tcObjectsFoundOnlyFromSink :: Lens' TransferCounters (Maybe Int64)
- tcBytesFromSourceSkippedBySync :: Lens' TransferCounters (Maybe Int64)
- tcObjectsCopiedToSink :: Lens' TransferCounters (Maybe Int64)
- tcObjectsFromSourceFailed :: Lens' TransferCounters (Maybe Int64)
- tcObjectsFailedToDeleteFromSink :: Lens' TransferCounters (Maybe Int64)
- tcObjectsFromSourceSkippedBySync :: Lens' TransferCounters (Maybe Int64)
- data TransferJob
- transferJob :: TransferJob
- tjCreationTime :: Lens' TransferJob (Maybe Text)
- tjStatus :: Lens' TransferJob (Maybe Text)
- tjSchedule :: Lens' TransferJob (Maybe Schedule)
- tjDeletionTime :: Lens' TransferJob (Maybe Text)
- tjName :: Lens' TransferJob (Maybe Text)
- tjProjectId :: Lens' TransferJob (Maybe Text)
- tjTransferSpec :: Lens' TransferJob (Maybe TransferSpec)
- tjDescription :: Lens' TransferJob (Maybe Text)
- tjLastModificationTime :: Lens' TransferJob (Maybe Text)
- data GcsData
- gcsData :: GcsData
- gdBucketName :: Lens' GcsData (Maybe Text)
- data AwsS3Data
- awsS3Data :: AwsS3Data
- asdBucketName :: Lens' AwsS3Data (Maybe Text)
- asdAwsAccessKey :: Lens' AwsS3Data (Maybe AwsAccessKey)
- data HTTPData
- hTTPData :: HTTPData
- httpdListURL :: Lens' HTTPData (Maybe Text)
- data TimeOfDay'
- timeOfDay :: TimeOfDay'
- todNanos :: Lens' TimeOfDay' (Maybe Int32)
- todHours :: Lens' TimeOfDay' (Maybe Int32)
- todMinutes :: Lens' TimeOfDay' (Maybe Int32)
- todSeconds :: Lens' TimeOfDay' (Maybe Int32)
- data ErrorLogEntry
- errorLogEntry :: ErrorLogEntry
- eleURL :: Lens' ErrorLogEntry (Maybe Text)
- eleErrorDetails :: Lens' ErrorLogEntry [Text]
- data OperationMetadata
- operationMetadata :: HashMap Text JSONValue -> OperationMetadata
- omAddtional :: Lens' OperationMetadata (HashMap Text JSONValue)
- data TransferOptions
- transferOptions :: TransferOptions
- toDeleteObjectsUniqueInSink :: Lens' TransferOptions (Maybe Bool)
- toDeleteObjectsFromSourceAfterTransfer :: Lens' TransferOptions (Maybe Bool)
- toOverwriteObjectsAlreadyExistingInSink :: Lens' TransferOptions (Maybe Bool)
- data TransferOperation
- transferOperation :: TransferOperation
- toStatus :: Lens' TransferOperation (Maybe Text)
- toCounters :: Lens' TransferOperation (Maybe TransferCounters)
- toStartTime :: Lens' TransferOperation (Maybe Text)
- toTransferJobName :: Lens' TransferOperation (Maybe Text)
- toName :: Lens' TransferOperation (Maybe Text)
- toEndTime :: Lens' TransferOperation (Maybe Text)
- toProjectId :: Lens' TransferOperation (Maybe Text)
- toTransferSpec :: Lens' TransferOperation (Maybe TransferSpec)
- toErrorBreakdowns :: Lens' TransferOperation [ErrorSummary]
- data TransferSpec
- transferSpec :: TransferSpec
- tsGcsDataSource :: Lens' TransferSpec (Maybe GcsData)
- tsObjectConditions :: Lens' TransferSpec (Maybe ObjectConditions)
- tsHTTPDataSource :: Lens' TransferSpec (Maybe HTTPData)
- tsAwsS3DataSource :: Lens' TransferSpec (Maybe AwsS3Data)
- tsGcsDataSink :: Lens' TransferSpec (Maybe GcsData)
- tsTransferOptions :: Lens' TransferSpec (Maybe TransferOptions)
- data ListTransferJobsResponse
- listTransferJobsResponse :: ListTransferJobsResponse
- ltjrNextPageToken :: Lens' ListTransferJobsResponse (Maybe Text)
- ltjrTransferJobs :: Lens' ListTransferJobsResponse [TransferJob]
- data OperationResponse
- operationResponse :: HashMap Text JSONValue -> OperationResponse
- orAddtional :: Lens' OperationResponse (HashMap Text JSONValue)
- data ResumeTransferOperationRequest
- resumeTransferOperationRequest :: ResumeTransferOperationRequest
- data AwsAccessKey
- awsAccessKey :: AwsAccessKey
- aakSecretAccessKey :: Lens' AwsAccessKey (Maybe Text)
- aakAccessKeyId :: Lens' AwsAccessKey (Maybe Text)
Service Configuration
storageTransferService :: ServiceConfig Source #
Default request referring to version v1
of the Google Storage Transfer API. This contains the host and root path used as a starting point for constructing service requests.
OAuth Scopes
cloudPlatformScope :: Proxy '["https://www.googleapis.com/auth/cloud-platform"] Source #
View and manage your data across Google Cloud Platform services
API Declaration
type StorageTransferAPI = TransferJobsListResource :<|> (TransferJobsPatchResource :<|> (TransferJobsGetResource :<|> (TransferJobsCreateResource :<|> (GetGoogleServiceAccountResource :<|> (TransferOperationsListResource :<|> (TransferOperationsGetResource :<|> (TransferOperationsPauseResource :<|> (TransferOperationsCancelResource :<|> (TransferOperationsDeleteResource :<|> (TransferOperationsResumeResource :<|> GoogleServiceAccountsGetResource)))))))))) Source #
Represents the entirety of the methods and resources available for the Google Storage Transfer API service.
Resources
storagetransfer.getGoogleServiceAccount
storagetransfer.googleServiceAccounts.get
storagetransfer.transferJobs.create
storagetransfer.transferJobs.get
storagetransfer.transferJobs.list
storagetransfer.transferJobs.patch
storagetransfer.transferOperations.cancel
storagetransfer.transferOperations.delete
storagetransfer.transferOperations.get
storagetransfer.transferOperations.list
storagetransfer.transferOperations.pause
storagetransfer.transferOperations.resume
Types
ErrorSummary
data ErrorSummary Source #
A summary of errors by error code, plus a count and sample error log entries.
See: errorSummary
smart constructor.
errorSummary :: ErrorSummary Source #
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 :: Lens' ErrorSummary (Maybe Int64) Source #
Count of this type of error. Required.
esErrorCode :: Lens' ErrorSummary (Maybe Text) Source #
Required.
esErrorLogEntries :: Lens' ErrorSummary [ErrorLogEntry] Source #
Error samples.
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. 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][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` which 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 purpose. - 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.
sDetails :: Lens' Status [StatusDetailsItem] Source #
A list of messages that carry the error details. There will be a common set of message types for APIs to use.
sCode :: Lens' Status (Maybe Int32) Source #
The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].
sMessage :: Lens' Status (Maybe Text) Source #
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][google.rpc.Status.details] field, or localized by the client.
ListOperationsResponse
data ListOperationsResponse Source #
The response message for [Operations.ListOperations][google.longrunning.Operations.ListOperations].
See: listOperationsResponse
smart constructor.
listOperationsResponse :: ListOperationsResponse Source #
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 :: Lens' ListOperationsResponse (Maybe Text) Source #
The standard List next-page token.
lorOperations :: Lens' ListOperationsResponse [Operation] Source #
A list of operations that matches the specified filter in the request.
Schedule
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 :: Lens' Schedule (Maybe Date) Source #
The last day the recurring transfer will be run. If `scheduleEndDate` is the same as `scheduleStartDate`, the transfer will be executed only once.
sScheduleStartDate :: Lens' Schedule (Maybe Date) Source #
The first day the recurring transfer is scheduled to run. Required.
sStartTimeOfDay :: Lens' Schedule (Maybe TimeOfDay') Source #
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, transfers are scheduled to start at midnight UTC.
ObjectConditions
data ObjectConditions Source #
Conditions that determine which objects will be transferred.
See: objectConditions
smart constructor.
objectConditions :: ObjectConditions Source #
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 :: Lens' ObjectConditions (Maybe Text) Source #
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`.
ocIncludePrefixes :: Lens' ObjectConditions [Text] Source #
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. * 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 20.
ocMaxTimeElapsedSinceLastModification :: Lens' ObjectConditions (Maybe Text) Source #
`maxTimeElapsedSinceLastModification` is the complement to `minTimeElapsedSinceLastModification`.
ocExcludePrefixes :: Lens' ObjectConditions [Text] Source #
`excludePrefixes` must follow the requirements described for `includePrefixes`. The max size of `excludePrefixes` is 20.
Operation
This resource represents a long-running operation that is the result of a network API call.
See: operation
smart constructor.
oDone :: Lens' Operation (Maybe Bool) Source #
If the value is `false`, it means the operation is still in progress. If true, the operation is completed and the `result` is available.
oError :: Lens' Operation (Maybe Status) Source #
The error result of the operation in case of failure.
oResponse :: Lens' Operation (Maybe OperationResponse) Source #
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`.
oName :: Lens' Operation (Maybe Text) Source #
The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping above, the `name` should have the format of `operations/some/unique/name`.
oMetadata :: Lens' Operation (Maybe OperationMetadata) Source #
Represents the transfer operation object.
Empty
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.
PauseTransferOperationRequest
data PauseTransferOperationRequest Source #
Request passed to PauseTransferOperation.
See: pauseTransferOperationRequest
smart constructor.
pauseTransferOperationRequest :: PauseTransferOperationRequest Source #
Creates a value of PauseTransferOperationRequest
with the minimum fields required to make a request.
GoogleServiceAccount
data GoogleServiceAccount Source #
Google service account
See: googleServiceAccount
smart constructor.
googleServiceAccount :: GoogleServiceAccount Source #
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 :: Lens' GoogleServiceAccount (Maybe Text) Source #
Required.
StatusDetailsItem
data StatusDetailsItem Source #
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 :: Lens' StatusDetailsItem (HashMap Text JSONValue) Source #
Properties of the object. Contains field 'ype with type URL.
Date
Represents a whole calendar date, e.g. date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the Proleptic Gregorian Calendar. The day may be 0 to represent a year and month where the day is not significant, e.g. credit card expiration date. The year may be 0 to represent a month and day independent of year, e.g. anniversary date. Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and `google.protobuf.Timestamp`.
See: date
smart constructor.
dDay :: Lens' Date (Maybe Int32) Source #
Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year/month where the day is not sigificant.
dYear :: Lens' Date (Maybe Int32) Source #
Year of date. Must be from 1 to 9,999, or 0 if specifying a date without a year.
UpdateTransferJobRequest
data UpdateTransferJobRequest Source #
Request passed to UpdateTransferJob.
See: updateTransferJobRequest
smart constructor.
updateTransferJobRequest :: UpdateTransferJobRequest Source #
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 :: Lens' UpdateTransferJobRequest (Maybe TransferJob) Source #
The job to update. Required.
utjrProjectId :: Lens' UpdateTransferJobRequest (Maybe Text) Source #
The ID of the Google Developers Console project that owns the job. Required.
utjrUpdateTransferJobFieldMask :: Lens' UpdateTransferJobRequest (Maybe Text) Source #
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`.
TransferCounters
data TransferCounters Source #
A collection of counters that report the progress of a transfer operation.
See: transferCounters
smart constructor.
transferCounters :: TransferCounters Source #
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
tcBytesFoundOnlyFromSink :: Lens' TransferCounters (Maybe Int64) Source #
Bytes found only in the data sink that are scheduled to be deleted.
tcBytesDeletedFromSink :: Lens' TransferCounters (Maybe Int64) Source #
Bytes that are deleted from the data sink.
tcObjectsDeletedFromSource :: Lens' TransferCounters (Maybe Int64) Source #
Objects that are deleted from the data source.
tcObjectsFoundFromSource :: Lens' TransferCounters (Maybe Int64) Source #
Objects found in the data source that are scheduled to be transferred, which will be copied, excluded based on conditions, or skipped due to failures.
tcBytesFailedToDeleteFromSink :: Lens' TransferCounters (Maybe Int64) Source #
Bytes that failed to be deleted from the data sink.
tcBytesFromSourceFailed :: Lens' TransferCounters (Maybe Int64) Source #
Bytes in the data source that failed during the transfer.
tcBytesCopiedToSink :: Lens' TransferCounters (Maybe Int64) Source #
Bytes that are copied to the data sink.
tcBytesFoundFromSource :: Lens' TransferCounters (Maybe Int64) Source #
Bytes found in the data source that are scheduled to be transferred, which will be copied, excluded based on conditions, or skipped due to failures.
tcBytesDeletedFromSource :: Lens' TransferCounters (Maybe Int64) Source #
Bytes that are deleted from the data source.
tcObjectsDeletedFromSink :: Lens' TransferCounters (Maybe Int64) Source #
Objects that are deleted from the data sink.
tcObjectsFoundOnlyFromSink :: Lens' TransferCounters (Maybe Int64) Source #
Objects found only in the data sink that are scheduled to be deleted.
tcBytesFromSourceSkippedBySync :: Lens' TransferCounters (Maybe Int64) Source #
Bytes in the data source that are not transferred because they already exist in the data sink.
tcObjectsCopiedToSink :: Lens' TransferCounters (Maybe Int64) Source #
Objects that are copied to the data sink.
tcObjectsFromSourceFailed :: Lens' TransferCounters (Maybe Int64) Source #
Objects in the data source that failed during the transfer.
tcObjectsFailedToDeleteFromSink :: Lens' TransferCounters (Maybe Int64) Source #
Objects that failed to be deleted from the data sink.
tcObjectsFromSourceSkippedBySync :: Lens' TransferCounters (Maybe Int64) Source #
Objects in the data source that are not transferred because they already exist in the data sink.
TransferJob
data TransferJob Source #
This resource represents the configuration of a transfer job that runs periodically.
See: transferJob
smart constructor.
transferJob :: TransferJob Source #
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 :: Lens' TransferJob (Maybe Text) Source #
This field cannot be changed by user requests.
tjStatus :: Lens' TransferJob (Maybe Text) Source #
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.
tjSchedule :: Lens' TransferJob (Maybe Schedule) Source #
Schedule specification. Required.
tjDeletionTime :: Lens' TransferJob (Maybe Text) Source #
This field cannot be changed by user requests.
tjName :: Lens' TransferJob (Maybe Text) Source #
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.
tjProjectId :: Lens' TransferJob (Maybe Text) Source #
The ID of the Google Developers Console project that owns the job. Required.
tjTransferSpec :: Lens' TransferJob (Maybe TransferSpec) Source #
Transfer specification. Required.
tjDescription :: Lens' TransferJob (Maybe Text) Source #
A description provided by the user for the job. Its max length is 1024 bytes when Unicode-encoded.
tjLastModificationTime :: Lens' TransferJob (Maybe Text) Source #
This field cannot be changed by user requests.
GcsData
In 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.
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 :: Lens' GcsData (Maybe Text) Source #
Google Cloud Storage bucket name (see Bucket Name Requirements). Required.
AwsS3Data
An 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.
See: awsS3Data
smart constructor.
awsS3Data :: AwsS3Data Source #
Creates a value of AwsS3Data
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
asdBucketName :: Lens' AwsS3Data (Maybe Text) Source #
S3 Bucket name (see Creating a bucket). Required.
asdAwsAccessKey :: Lens' AwsS3Data (Maybe AwsAccessKey) Source #
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.
HTTPData
An 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 * Length * MD5 - This field is a base64-encoded MD5 hash of the object An HTTP URL that points to the object to be transferred. It must be a valid URL with URL scheme HTTP or HTTPS. When an object with URL `http(s)://hostname:port/` is transferred to the data sink, the name of the object at the data sink is `/`. Length and MD5 provide the size and the base64-encoded MD5 hash of the object. If Length does not match the actual length of the object fetched, the object will not be transferred. If MD5 does not match the MD5 computed from the transferred bytes, the object transfer will fail. `lastModificationTime` is not available in HttpData objects. The objects that the URL list points to must allow public access. Storage Transfer Service obeys `robots.txt` rules and requires the HTTP server to support Range requests and to return a Content-Length header in each response.
See: hTTPData
smart constructor.
Creates a value of HTTPData
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
httpdListURL :: Lens' HTTPData (Maybe Text) Source #
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.
TimeOfDay'
data TimeOfDay' Source #
Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may chose to allow leap seconds. Related types are [google.type.Date][google.type.Date] and `google.protobuf.Timestamp`.
See: timeOfDay
smart constructor.
timeOfDay :: TimeOfDay' Source #
Creates a value of TimeOfDay
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
todNanos :: Lens' TimeOfDay' (Maybe Int32) Source #
Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
todHours :: Lens' TimeOfDay' (Maybe Int32) Source #
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.
todMinutes :: Lens' TimeOfDay' (Maybe Int32) Source #
Minutes of hour of day. Must be from 0 to 59.
todSeconds :: Lens' TimeOfDay' (Maybe Int32) Source #
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.
ErrorLogEntry
data ErrorLogEntry Source #
An entry describing an error that has occurred.
See: errorLogEntry
smart constructor.
errorLogEntry :: ErrorLogEntry Source #
Creates a value of ErrorLogEntry
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
eleURL :: Lens' ErrorLogEntry (Maybe Text) Source #
A URL that refers to the target (a data source, a data sink, or an object) with which the error is associated. Required.
eleErrorDetails :: Lens' ErrorLogEntry [Text] Source #
A list of messages that carry the error details.
OperationMetadata
data OperationMetadata Source #
Represents the transfer operation object.
See: operationMetadata
smart constructor.
Creates a value of OperationMetadata
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
omAddtional :: Lens' OperationMetadata (HashMap Text JSONValue) Source #
Properties of the object. Contains field 'ype with type URL.
TransferOptions
data TransferOptions Source #
TransferOptions uses three boolean parameters to define the actions to be performed on objects in a transfer.
See: transferOptions
smart constructor.
transferOptions :: TransferOptions Source #
Creates a value of TransferOptions
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
toDeleteObjectsUniqueInSink :: Lens' TransferOptions (Maybe Bool) Source #
Whether objects that exist only in the sink should be deleted.
toDeleteObjectsFromSourceAfterTransfer :: Lens' TransferOptions (Maybe Bool) Source #
Whether objects should be deleted from the source after they are transferred to the sink.
toOverwriteObjectsAlreadyExistingInSink :: Lens' TransferOptions (Maybe Bool) Source #
Whether overwriting objects that already exist in the sink is allowed.
TransferOperation
data TransferOperation Source #
A description of the execution of a transfer.
See: transferOperation
smart constructor.
transferOperation :: TransferOperation Source #
Creates a value of TransferOperation
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
toCounters :: Lens' TransferOperation (Maybe TransferCounters) Source #
Information about the progress of the transfer operation.
toStartTime :: Lens' TransferOperation (Maybe Text) Source #
Start time of this transfer execution.
toTransferJobName :: Lens' TransferOperation (Maybe Text) Source #
The name of the transfer job that triggers this transfer operation.
toProjectId :: Lens' TransferOperation (Maybe Text) Source #
The ID of the Google Developers Console project that owns the operation. Required.
toTransferSpec :: Lens' TransferOperation (Maybe TransferSpec) Source #
Transfer specification. Required.
toErrorBreakdowns :: Lens' TransferOperation [ErrorSummary] Source #
Summarizes errors encountered with sample error log entries.
TransferSpec
data TransferSpec Source #
Configuration for running a transfer.
See: transferSpec
smart constructor.
transferSpec :: TransferSpec Source #
Creates a value of TransferSpec
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
tsGcsDataSource :: Lens' TransferSpec (Maybe GcsData) Source #
A Google Cloud Storage data source.
tsObjectConditions :: Lens' TransferSpec (Maybe ObjectConditions) Source #
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.
tsHTTPDataSource :: Lens' TransferSpec (Maybe HTTPData) Source #
An HTTP URL data source.
tsAwsS3DataSource :: Lens' TransferSpec (Maybe AwsS3Data) Source #
An AWS S3 data source.
tsGcsDataSink :: Lens' TransferSpec (Maybe GcsData) Source #
A Google Cloud Storage data sink.
tsTransferOptions :: Lens' TransferSpec (Maybe TransferOptions) Source #
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.
ListTransferJobsResponse
data ListTransferJobsResponse Source #
Response from ListTransferJobs.
See: listTransferJobsResponse
smart constructor.
listTransferJobsResponse :: ListTransferJobsResponse Source #
Creates a value of ListTransferJobsResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ltjrNextPageToken :: Lens' ListTransferJobsResponse (Maybe Text) Source #
The list next page token.
ltjrTransferJobs :: Lens' ListTransferJobsResponse [TransferJob] Source #
A list of transfer jobs.
OperationResponse
data OperationResponse Source #
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`.
See: operationResponse
smart constructor.
Creates a value of OperationResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
orAddtional :: Lens' OperationResponse (HashMap Text JSONValue) Source #
Properties of the object. Contains field 'ype with type URL.
ResumeTransferOperationRequest
data ResumeTransferOperationRequest Source #
Request passed to ResumeTransferOperation.
See: resumeTransferOperationRequest
smart constructor.
resumeTransferOperationRequest :: ResumeTransferOperationRequest Source #
Creates a value of ResumeTransferOperationRequest
with the minimum fields required to make a request.
AwsAccessKey
data AwsAccessKey Source #
AWS access key (see AWS Security Credentials).
See: awsAccessKey
smart constructor.
awsAccessKey :: AwsAccessKey Source #
Creates a value of AwsAccessKey
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
aakSecretAccessKey :: Lens' AwsAccessKey (Maybe Text) Source #
AWS secret access key. This field is not returned in RPC responses. Required.
aakAccessKeyId :: Lens' AwsAccessKey (Maybe Text) Source #
AWS access key ID. Required.