Network.Google.StorageTransfer.Types

Service Configuration

storageTransferService :: Service

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 :: OAuthScope

View and manage your data across Google Cloud Platform services

ErrorSummary

data ErrorSummary

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

See: errorSummary smart constructor.

Instances

Eq ErrorSummary

Data ErrorSummary

Show ErrorSummary

Generic ErrorSummary

ToJSON ErrorSummary

FromJSON ErrorSummary

type Rep ErrorSummary

errorSummary :: ErrorSummary

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

esErrorCount :: Lens' ErrorSummary (Maybe Int64)

Count of this type of error. Required.

esErrorCode :: Lens' ErrorSummary (Maybe Text)

Required.

esErrorLogEntries :: Lens' ErrorSummary [ErrorLogEntry]

Error samples.

Status

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

Instances

Eq Status

Data Status

Show Status

Generic Status

ToJSON Status

FromJSON Status

type Rep Status

status :: Status

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

sDetails :: Lens' Status [StatusDetailsItem]

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)

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

sMessage :: Lens' Status (Maybe Text)

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

The response message for [Operations.ListOperations][google.longrunning.Operations.ListOperations].

See: listOperationsResponse smart constructor.

Instances

Eq ListOperationsResponse

Data ListOperationsResponse

Show ListOperationsResponse

Generic ListOperationsResponse

ToJSON ListOperationsResponse

FromJSON ListOperationsResponse

type Rep ListOperationsResponse

listOperationsResponse :: ListOperationsResponse

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

lorNextPageToken :: Lens' ListOperationsResponse (Maybe Text)

The standard List next-page token.

lorOperations :: Lens' ListOperationsResponse [Operation]

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

Schedule

data Schedule

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

See: schedule smart constructor.

Instances

Eq Schedule

Data Schedule

Show Schedule

Generic Schedule

ToJSON Schedule

FromJSON Schedule

type Rep Schedule

schedule :: Schedule

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

sScheduleEndDate :: Lens' Schedule (Maybe Date)

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)

The first day the recurring transfer is scheduled to run. Required.

sStartTimeOfDay :: Lens' Schedule (Maybe TimeOfDay')

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

Conditions that determine which objects will be transferred.

See: objectConditions smart constructor.

Instances

Eq ObjectConditions

Data ObjectConditions

Show ObjectConditions

Generic ObjectConditions

ToJSON ObjectConditions

FromJSON ObjectConditions

type Rep ObjectConditions

objectConditions :: ObjectConditions

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

ocMinTimeElapsedSinceLastModification :: Lens' ObjectConditions (Maybe Text)

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]

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)

`maxTimeElapsedSinceLastModification` is the complement to `minTimeElapsedSinceLastModification`.

ocExcludePrefixes :: Lens' ObjectConditions [Text]

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

Operation

data Operation

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

See: operation smart constructor.

Instances

Eq Operation

Data Operation

Show Operation

Generic Operation

ToJSON Operation

FromJSON Operation

type Rep Operation

operation :: Operation

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

oDone :: Lens' Operation (Maybe Bool)

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)

The error result of the operation in case of failure.

oResponse :: Lens' Operation (Maybe OperationResponse)

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)

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)

Represents the transfer operation object.

Empty

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

Instances

Eq Empty

Data Empty

Show Empty

Generic Empty

ToJSON Empty

FromJSON Empty

type Rep Empty

empty :: Empty

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

PauseTransferOperationRequest

data PauseTransferOperationRequest

Request passed to PauseTransferOperation.

See: pauseTransferOperationRequest smart constructor.

Instances

Eq PauseTransferOperationRequest

Data PauseTransferOperationRequest

Show PauseTransferOperationRequest

Generic PauseTransferOperationRequest

ToJSON PauseTransferOperationRequest

FromJSON PauseTransferOperationRequest

type Rep PauseTransferOperationRequest

pauseTransferOperationRequest :: PauseTransferOperationRequest

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

GoogleServiceAccount

data GoogleServiceAccount

Google service account

See: googleServiceAccount smart constructor.

Instances

Eq GoogleServiceAccount

Data GoogleServiceAccount

Show GoogleServiceAccount

Generic GoogleServiceAccount

ToJSON GoogleServiceAccount

FromJSON GoogleServiceAccount

type Rep GoogleServiceAccount

googleServiceAccount :: GoogleServiceAccount

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

gsaAccountEmail :: Lens' GoogleServiceAccount (Maybe Text)

Required.

StatusDetailsItem

data StatusDetailsItem

Instances

Eq StatusDetailsItem

Data StatusDetailsItem

Show StatusDetailsItem

Generic StatusDetailsItem

ToJSON StatusDetailsItem

FromJSON StatusDetailsItem

type Rep StatusDetailsItem

statusDetailsItem

Arguments

:: HashMap Text JSONValue

sdiAddtional

-> StatusDetailsItem

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

sdiAddtional :: Lens' StatusDetailsItem (HashMap Text JSONValue)

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

Date

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

Instances

Eq Date

Data Date

Show Date

Generic Date

ToJSON Date

FromJSON Date

type Rep Date

date :: Date

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

dDay :: Lens' Date (Maybe Int32)

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)

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

dMonth :: Lens' Date (Maybe Int32)

Month of year of date. Must be from 1 to 12.

UpdateTransferJobRequest

data UpdateTransferJobRequest

Request passed to UpdateTransferJob.

See: updateTransferJobRequest smart constructor.

Instances

Eq UpdateTransferJobRequest

Data UpdateTransferJobRequest

Show UpdateTransferJobRequest

Generic UpdateTransferJobRequest

ToJSON UpdateTransferJobRequest

FromJSON UpdateTransferJobRequest

type Rep UpdateTransferJobRequest

updateTransferJobRequest :: UpdateTransferJobRequest

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

utjrTransferJob :: Lens' UpdateTransferJobRequest (Maybe TransferJob)

The job to update. Required.

utjrProjectId :: Lens' UpdateTransferJobRequest (Maybe Text)

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

utjrUpdateTransferJobFieldMask :: Lens' UpdateTransferJobRequest (Maybe Text)

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

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

See: transferCounters smart constructor.

Instances

Eq TransferCounters

Data TransferCounters

Show TransferCounters

Generic TransferCounters

ToJSON TransferCounters

FromJSON TransferCounters

type Rep TransferCounters

transferCounters :: TransferCounters

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)

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

tcBytesDeletedFromSink :: Lens' TransferCounters (Maybe Int64)

Bytes that are deleted from the data sink.

tcObjectsDeletedFromSource :: Lens' TransferCounters (Maybe Int64)

Objects that are deleted from the data source.

tcObjectsFoundFromSource :: Lens' TransferCounters (Maybe Int64)

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)

Bytes that failed to be deleted from the data sink.

tcBytesFromSourceFailed :: Lens' TransferCounters (Maybe Int64)

Bytes in the data source that failed during the transfer.

tcBytesCopiedToSink :: Lens' TransferCounters (Maybe Int64)

Bytes that are copied to the data sink.

tcBytesFoundFromSource :: Lens' TransferCounters (Maybe Int64)

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)

Bytes that are deleted from the data source.

tcObjectsDeletedFromSink :: Lens' TransferCounters (Maybe Int64)

Objects that are deleted from the data sink.

tcObjectsFoundOnlyFromSink :: Lens' TransferCounters (Maybe Int64)

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

tcBytesFromSourceSkippedBySync :: Lens' TransferCounters (Maybe Int64)

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

tcObjectsCopiedToSink :: Lens' TransferCounters (Maybe Int64)

Objects that are copied to the data sink.

tcObjectsFromSourceFailed :: Lens' TransferCounters (Maybe Int64)

Objects in the data source that failed during the transfer.

tcObjectsFailedToDeleteFromSink :: Lens' TransferCounters (Maybe Int64)

Objects that failed to be deleted from the data sink.

tcObjectsFromSourceSkippedBySync :: Lens' TransferCounters (Maybe Int64)

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

TransferJob

data TransferJob

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

See: transferJob smart constructor.

Instances

Eq TransferJob

Data TransferJob

Show TransferJob

Generic TransferJob

ToJSON TransferJob

FromJSON TransferJob

type Rep TransferJob

transferJob :: TransferJob

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

tjCreationTime :: Lens' TransferJob (Maybe Text)

This field cannot be changed by user requests.

tjStatus :: Lens' TransferJob (Maybe Text)

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)

Schedule specification. Required.

tjDeletionTime :: Lens' TransferJob (Maybe Text)

This field cannot be changed by user requests.

tjName :: Lens' TransferJob (Maybe Text)

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)

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

tjTransferSpec :: Lens' TransferJob (Maybe TransferSpec)

Transfer specification. Required.

tjDescription :: Lens' TransferJob (Maybe Text)

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

tjLastModificationTime :: Lens' TransferJob (Maybe Text)

This field cannot be changed by user requests.

GcsData

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

Instances

Eq GcsData

Data GcsData

Show GcsData

Generic GcsData

ToJSON GcsData

FromJSON GcsData

type Rep GcsData

gcsData :: GcsData

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

gdBucketName :: Lens' GcsData (Maybe Text)

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

AwsS3Data

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

Instances

Eq AwsS3Data

Data AwsS3Data

Show AwsS3Data

Generic AwsS3Data

ToJSON AwsS3Data

FromJSON AwsS3Data

type Rep AwsS3Data

awsS3Data :: AwsS3Data

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
• asdAwsAccessKey

asdBucketName :: Lens' AwsS3Data (Maybe Text)

S3 Bucket name (see Creating a bucket). Required.

asdAwsAccessKey :: Lens' AwsS3Data (Maybe AwsAccessKey)

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

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

Instances

Eq HTTPData

Data HTTPData

Show HTTPData

Generic HTTPData

ToJSON HTTPData

FromJSON HTTPData

type Rep HTTPData

hTTPData :: HTTPData

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

httpdListURL :: Lens' HTTPData (Maybe Text)

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'

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.

Instances

Eq TimeOfDay'

Data TimeOfDay'

Show TimeOfDay'

Generic TimeOfDay'

ToJSON TimeOfDay'

FromJSON TimeOfDay'

type Rep TimeOfDay'

timeOfDay :: TimeOfDay'

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
• todHours
• todMinutes
• todSeconds

todNanos :: Lens' TimeOfDay' (Maybe Int32)

Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

todHours :: Lens' TimeOfDay' (Maybe Int32)

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)

Minutes of hour of day. Must be from 0 to 59.

todSeconds :: Lens' TimeOfDay' (Maybe Int32)

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

An entry describing an error that has occurred.

See: errorLogEntry smart constructor.

Instances

Eq ErrorLogEntry

Data ErrorLogEntry

Show ErrorLogEntry

Generic ErrorLogEntry

ToJSON ErrorLogEntry

FromJSON ErrorLogEntry

type Rep ErrorLogEntry

errorLogEntry :: ErrorLogEntry

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
• eleErrorDetails

eleURL :: Lens' ErrorLogEntry (Maybe Text)

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]

A list of messages that carry the error details.

OperationMetadata

data OperationMetadata

Represents the transfer operation object.

See: operationMetadata smart constructor.

Instances

Eq OperationMetadata

Data OperationMetadata

Show OperationMetadata

Generic OperationMetadata

ToJSON OperationMetadata

FromJSON OperationMetadata

type Rep OperationMetadata

operationMetadata

Arguments

:: HashMap Text JSONValue

omAddtional

-> OperationMetadata

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

omAddtional :: Lens' OperationMetadata (HashMap Text JSONValue)

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

TransferOptions

data TransferOptions

TransferOptions uses three boolean parameters to define the actions to be performed on objects in a transfer.

See: transferOptions smart constructor.

Instances

Eq TransferOptions

Data TransferOptions

Show TransferOptions

Generic TransferOptions

ToJSON TransferOptions

FromJSON TransferOptions

type Rep TransferOptions

transferOptions :: TransferOptions

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
• toDeleteObjectsFromSourceAfterTransfer
• toOverwriteObjectsAlreadyExistingInSink

toDeleteObjectsUniqueInSink :: Lens' TransferOptions (Maybe Bool)

Whether objects that exist only in the sink should be deleted.

toDeleteObjectsFromSourceAfterTransfer :: Lens' TransferOptions (Maybe Bool)

Whether objects should be deleted from the source after they are transferred to the sink.

toOverwriteObjectsAlreadyExistingInSink :: Lens' TransferOptions (Maybe Bool)

Whether overwriting objects that already exist in the sink is allowed.

TransferOperation

data TransferOperation

A description of the execution of a transfer.

See: transferOperation smart constructor.

Instances

Eq TransferOperation

Data TransferOperation

Show TransferOperation

Generic TransferOperation

ToJSON TransferOperation

FromJSON TransferOperation

type Rep TransferOperation

transferOperation :: TransferOperation

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:

• toStatus
• toCounters
• toStartTime
• toTransferJobName
• toName
• toEndTime
• toProjectId
• toTransferSpec
• toErrorBreakdowns

toStatus :: Lens' TransferOperation (Maybe Text)

Status of the transfer operation.

toCounters :: Lens' TransferOperation (Maybe TransferCounters)

Information about the progress of the transfer operation.

toStartTime :: Lens' TransferOperation (Maybe Text)

Start time of this transfer execution.

toTransferJobName :: Lens' TransferOperation (Maybe Text)

The name of the transfer job that triggers this transfer operation.

toName :: Lens' TransferOperation (Maybe Text)

A globally unique ID assigned by the system.

toEndTime :: Lens' TransferOperation (Maybe Text)

End time of this transfer execution.

toProjectId :: Lens' TransferOperation (Maybe Text)

The ID of the Google Developers Console project that owns the operation. Required.

toTransferSpec :: Lens' TransferOperation (Maybe TransferSpec)

Transfer specification. Required.

toErrorBreakdowns :: Lens' TransferOperation [ErrorSummary]

Summarizes errors encountered with sample error log entries.

TransferSpec

data TransferSpec

Configuration for running a transfer.

See: transferSpec smart constructor.

Instances

Eq TransferSpec

Data TransferSpec

Show TransferSpec

Generic TransferSpec

ToJSON TransferSpec

FromJSON TransferSpec

type Rep TransferSpec

transferSpec :: TransferSpec

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
• tsObjectConditions
• tsHTTPDataSource
• tsAwsS3DataSource
• tsGcsDataSink
• tsTransferOptions

tsGcsDataSource :: Lens' TransferSpec (Maybe GcsData)

A Google Cloud Storage data source.

tsObjectConditions :: Lens' TransferSpec (Maybe 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' `lastModificationTime` do not exclude objects in a data sink.

tsHTTPDataSource :: Lens' TransferSpec (Maybe HTTPData)

An HTTP URL data source.

tsAwsS3DataSource :: Lens' TransferSpec (Maybe AwsS3Data)

An AWS S3 data source.

tsGcsDataSink :: Lens' TransferSpec (Maybe GcsData)

A Google Cloud Storage data sink.

tsTransferOptions :: Lens' TransferSpec (Maybe TransferOptions)

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

Response from ListTransferJobs.

See: listTransferJobsResponse smart constructor.

Instances

Eq ListTransferJobsResponse

Data ListTransferJobsResponse

Show ListTransferJobsResponse

Generic ListTransferJobsResponse

ToJSON ListTransferJobsResponse

FromJSON ListTransferJobsResponse

type Rep ListTransferJobsResponse

listTransferJobsResponse :: ListTransferJobsResponse

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
• ltjrTransferJobs

ltjrNextPageToken :: Lens' ListTransferJobsResponse (Maybe Text)

The list next page token.

ltjrTransferJobs :: Lens' ListTransferJobsResponse [TransferJob]

A list of transfer jobs.

OperationResponse

data OperationResponse

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.

Instances

Eq OperationResponse

Data OperationResponse

Show OperationResponse

Generic OperationResponse

ToJSON OperationResponse

FromJSON OperationResponse

type Rep OperationResponse

operationResponse

Arguments

:: HashMap Text JSONValue

orAddtional

-> OperationResponse

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

orAddtional :: Lens' OperationResponse (HashMap Text JSONValue)

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

ResumeTransferOperationRequest

data ResumeTransferOperationRequest

Request passed to ResumeTransferOperation.

See: resumeTransferOperationRequest smart constructor.

Instances

Eq ResumeTransferOperationRequest

Data ResumeTransferOperationRequest

Show ResumeTransferOperationRequest

Generic ResumeTransferOperationRequest

ToJSON ResumeTransferOperationRequest

FromJSON ResumeTransferOperationRequest

type Rep ResumeTransferOperationRequest

resumeTransferOperationRequest :: ResumeTransferOperationRequest

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

AwsAccessKey

data AwsAccessKey

AWS access key (see AWS Security Credentials).

See: awsAccessKey smart constructor.

Instances

Eq AwsAccessKey

Data AwsAccessKey

Show AwsAccessKey

Generic AwsAccessKey

ToJSON AwsAccessKey

FromJSON AwsAccessKey

type Rep AwsAccessKey

awsAccessKey :: AwsAccessKey

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
• aakAccessKeyId

aakSecretAccessKey :: Lens' AwsAccessKey (Maybe Text)

AWS secret access key. This field is not returned in RPC responses. Required.

aakAccessKeyId :: Lens' AwsAccessKey (Maybe Text)

AWS access key ID. Required.