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
- Status
- PauseJobRequest
- ListLocationsResponse
- ResumeJobRequest
- AppEngineHTTPTargetHeaders
- RetryConfig
- Location
- Empty
- PubsubTargetAttributes
- HTTPTargetHeaders
- PubsubMessage
- JobState
- StatusDetailsItem
- AppEngineHTTPTarget
- HTTPTarget
- RunJobRequest
- Job
- PubsubMessageAttributes
- PubsubTarget
- Xgafv
- ListJobsResponse
- LocationLabels
- LocationMetadata
- AppEngineRouting
- HTTPTargetHTTPMethod
- AppEngineHTTPTargetHTTPMethod
Synopsis
- cloudSchedulerService :: ServiceConfig
- cloudPlatformScope :: Proxy '["https://www.googleapis.com/auth/cloud-platform"]
- data Status
- status :: Status
- sDetails :: Lens' Status [StatusDetailsItem]
- sCode :: Lens' Status (Maybe Int32)
- sMessage :: Lens' Status (Maybe Text)
- data PauseJobRequest
- pauseJobRequest :: PauseJobRequest
- data ListLocationsResponse
- listLocationsResponse :: ListLocationsResponse
- llrNextPageToken :: Lens' ListLocationsResponse (Maybe Text)
- llrLocations :: Lens' ListLocationsResponse [Location]
- data ResumeJobRequest
- resumeJobRequest :: ResumeJobRequest
- data AppEngineHTTPTargetHeaders
- appEngineHTTPTargetHeaders :: HashMap Text Text -> AppEngineHTTPTargetHeaders
- aehttpthAddtional :: Lens' AppEngineHTTPTargetHeaders (HashMap Text Text)
- data RetryConfig
- retryConfig :: RetryConfig
- rcMaxDoublings :: Lens' RetryConfig (Maybe Int32)
- rcMaxRetryDuration :: Lens' RetryConfig (Maybe Scientific)
- rcMinBackoffDuration :: Lens' RetryConfig (Maybe Scientific)
- rcRetryCount :: Lens' RetryConfig (Maybe Int32)
- rcMaxBackoffDuration :: Lens' RetryConfig (Maybe Scientific)
- data Location
- location :: Location
- lName :: Lens' Location (Maybe Text)
- lMetadata :: Lens' Location (Maybe LocationMetadata)
- lDisplayName :: Lens' Location (Maybe Text)
- lLabels :: Lens' Location (Maybe LocationLabels)
- lLocationId :: Lens' Location (Maybe Text)
- data Empty
- empty :: Empty
- data PubsubTargetAttributes
- pubsubTargetAttributes :: HashMap Text Text -> PubsubTargetAttributes
- ptaAddtional :: Lens' PubsubTargetAttributes (HashMap Text Text)
- data HTTPTargetHeaders
- hTTPTargetHeaders :: HashMap Text Text -> HTTPTargetHeaders
- httpthAddtional :: Lens' HTTPTargetHeaders (HashMap Text Text)
- data PubsubMessage
- pubsubMessage :: PubsubMessage
- pmData :: Lens' PubsubMessage (Maybe ByteString)
- pmPublishTime :: Lens' PubsubMessage (Maybe UTCTime)
- pmAttributes :: Lens' PubsubMessage (Maybe PubsubMessageAttributes)
- pmMessageId :: Lens' PubsubMessage (Maybe Text)
- data JobState
- data StatusDetailsItem
- statusDetailsItem :: HashMap Text JSONValue -> StatusDetailsItem
- sdiAddtional :: Lens' StatusDetailsItem (HashMap Text JSONValue)
- data AppEngineHTTPTarget
- appEngineHTTPTarget :: AppEngineHTTPTarget
- aehttptHTTPMethod :: Lens' AppEngineHTTPTarget (Maybe AppEngineHTTPTargetHTTPMethod)
- aehttptRelativeURI :: Lens' AppEngineHTTPTarget (Maybe Text)
- aehttptBody :: Lens' AppEngineHTTPTarget (Maybe ByteString)
- aehttptHeaders :: Lens' AppEngineHTTPTarget (Maybe AppEngineHTTPTargetHeaders)
- aehttptAppEngineRouting :: Lens' AppEngineHTTPTarget (Maybe AppEngineRouting)
- data HTTPTarget
- hTTPTarget :: HTTPTarget
- httptHTTPMethod :: Lens' HTTPTarget (Maybe HTTPTargetHTTPMethod)
- httptBody :: Lens' HTTPTarget (Maybe ByteString)
- httptURI :: Lens' HTTPTarget (Maybe Text)
- httptHeaders :: Lens' HTTPTarget (Maybe HTTPTargetHeaders)
- data RunJobRequest
- runJobRequest :: RunJobRequest
- data Job
- job :: Job
- jStatus :: Lens' Job (Maybe Status)
- jState :: Lens' Job (Maybe JobState)
- jLastAttemptTime :: Lens' Job (Maybe UTCTime)
- jRetryConfig :: Lens' Job (Maybe RetryConfig)
- jSchedule :: Lens' Job (Maybe Text)
- jScheduleTime :: Lens' Job (Maybe UTCTime)
- jAppEngineHTTPTarget :: Lens' Job (Maybe AppEngineHTTPTarget)
- jHTTPTarget :: Lens' Job (Maybe HTTPTarget)
- jName :: Lens' Job (Maybe Text)
- jPubsubTarget :: Lens' Job (Maybe PubsubTarget)
- jUserUpdateTime :: Lens' Job (Maybe UTCTime)
- jTimeZone :: Lens' Job (Maybe Text)
- jDescription :: Lens' Job (Maybe Text)
- data PubsubMessageAttributes
- pubsubMessageAttributes :: HashMap Text Text -> PubsubMessageAttributes
- pmaAddtional :: Lens' PubsubMessageAttributes (HashMap Text Text)
- data PubsubTarget
- pubsubTarget :: PubsubTarget
- ptData :: Lens' PubsubTarget (Maybe ByteString)
- ptTopicName :: Lens' PubsubTarget (Maybe Text)
- ptAttributes :: Lens' PubsubTarget (Maybe PubsubTargetAttributes)
- data Xgafv
- data ListJobsResponse
- listJobsResponse :: ListJobsResponse
- ljrNextPageToken :: Lens' ListJobsResponse (Maybe Text)
- ljrJobs :: Lens' ListJobsResponse [Job]
- data LocationLabels
- locationLabels :: HashMap Text Text -> LocationLabels
- llAddtional :: Lens' LocationLabels (HashMap Text Text)
- data LocationMetadata
- locationMetadata :: HashMap Text JSONValue -> LocationMetadata
- lmAddtional :: Lens' LocationMetadata (HashMap Text JSONValue)
- data AppEngineRouting
- appEngineRouting :: AppEngineRouting
- aerService :: Lens' AppEngineRouting (Maybe Text)
- aerVersion :: Lens' AppEngineRouting (Maybe Text)
- aerHost :: Lens' AppEngineRouting (Maybe Text)
- aerInstance :: Lens' AppEngineRouting (Maybe Text)
- data HTTPTargetHTTPMethod
- data AppEngineHTTPTargetHTTPMethod
Service Configuration
cloudSchedulerService :: ServiceConfig Source #
Default request referring to version v1
of the Cloud Scheduler 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
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, 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.
Instances
Eq Status Source # | |
Data Status Source # | |
Defined in Network.Google.CloudScheduler.Types.Product gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Status -> c Status # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Status # toConstr :: Status -> Constr # dataTypeOf :: Status -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Status) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Status) # gmapT :: (forall b. Data b => b -> b) -> Status -> Status # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Status -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Status -> r # gmapQ :: (forall d. Data d => d -> u) -> Status -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Status -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Status -> m Status # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Status -> m Status # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Status -> m Status # | |
Show Status Source # | |
Generic Status Source # | |
ToJSON Status Source # | |
Defined in Network.Google.CloudScheduler.Types.Product | |
FromJSON Status Source # | |
type Rep Status Source # | |
Defined in Network.Google.CloudScheduler.Types.Product type Rep Status = D1 (MetaData "Status" "Network.Google.CloudScheduler.Types.Product" "gogol-cloudscheduler-0.5.0-8JSqrzwg0pe9aK8yG5ECbq" False) (C1 (MetaCons "Status'" PrefixI True) (S1 (MetaSel (Just "_sDetails") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [StatusDetailsItem])) :*: (S1 (MetaSel (Just "_sCode") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int32))) :*: S1 (MetaSel (Just "_sMessage") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) |
sDetails :: Lens' Status [StatusDetailsItem] Source #
A list of messages that carry the error details. There is 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.
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 field, or localized by the client.
PauseJobRequest
data PauseJobRequest Source #
Request message for PauseJob.
See: pauseJobRequest
smart constructor.
Instances
pauseJobRequest :: PauseJobRequest Source #
Creates a value of PauseJobRequest
with the minimum fields required to make a request.
ListLocationsResponse
data ListLocationsResponse Source #
The response message for Locations.ListLocations.
See: listLocationsResponse
smart constructor.
Instances
listLocationsResponse :: ListLocationsResponse Source #
Creates a value of ListLocationsResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
llrNextPageToken :: Lens' ListLocationsResponse (Maybe Text) Source #
The standard List next-page token.
llrLocations :: Lens' ListLocationsResponse [Location] Source #
A list of locations that matches the specified filter in the request.
ResumeJobRequest
data ResumeJobRequest Source #
Request message for ResumeJob.
See: resumeJobRequest
smart constructor.
Instances
resumeJobRequest :: ResumeJobRequest Source #
Creates a value of ResumeJobRequest
with the minimum fields required to make a request.
AppEngineHTTPTargetHeaders
data AppEngineHTTPTargetHeaders Source #
HTTP request headers. This map contains the header field names and values. Headers can be set when the job is created. Cloud Scheduler sets some headers to default values: * `User-Agent`: By default, this header is `"AppEngine-Google; (+http://code.google.com/appengine)"`. This header can be modified, but Cloud Scheduler will append `"AppEngine-Google; (+http://code.google.com/appengine)"` to the modified `User-Agent`. * `X-CloudScheduler`: This header will be set to true. If the job has an body, Cloud Scheduler sets the following headers: * `Content-Type`: By default, the `Content-Type` header is set to `"application/octet-stream"`. The default can be overridden by explictly setting `Content-Type` to a particular media type when the job is created. For example, `Content-Type` can be set to `"application/json"`. * `Content-Length`: This is computed by Cloud Scheduler. This value is output only. It cannot be changed. The headers below are output only. They cannot be set or overridden: * `X-Google-*`: For Google internal use only. * `X-AppEngine-*`: For Google internal use only. In addition, some App Engine headers, which contain job-specific information, are also be sent to the job handler.
See: appEngineHTTPTargetHeaders
smart constructor.
Instances
appEngineHTTPTargetHeaders Source #
Creates a value of AppEngineHTTPTargetHeaders
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
RetryConfig
data RetryConfig Source #
Settings that determine the retry behavior. By default, if a job does not complete successfully (meaning that an acknowledgement is not received from the handler, then it will be retried with exponential backoff according to the settings in RetryConfig.
See: retryConfig
smart constructor.
Instances
retryConfig :: RetryConfig Source #
Creates a value of RetryConfig
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rcMaxDoublings :: Lens' RetryConfig (Maybe Int32) Source #
The time between retries will double `max_doublings` times. A job's retry interval starts at min_backoff_duration, then doubles `max_doublings` times, then increases linearly, and finally retries retries at intervals of max_backoff_duration up to retry_count times. For example, if min_backoff_duration is 10s, max_backoff_duration is 300s, and `max_doublings` is 3, then the a job will first be retried in 10s. The retry interval will double three times, and then increase linearly by 2^3 * 10s. Finally, the job will retry at intervals of max_backoff_duration until the job has been attempted retry_count times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, .... The default value of this field is 5.
rcMaxRetryDuration :: Lens' RetryConfig (Maybe Scientific) Source #
The time limit for retrying a failed job, measured from time when an execution was first attempted. If specified with retry_count, the job will be retried until both limits are reached. The default value for max_retry_duration is zero, which means retry duration is unlimited.
rcMinBackoffDuration :: Lens' RetryConfig (Maybe Scientific) Source #
The minimum amount of time to wait before retrying a job after it fails. The default value of this field is 5 seconds.
rcRetryCount :: Lens' RetryConfig (Maybe Int32) Source #
The number of attempts that the system will make to run a job using the exponential backoff procedure described by max_doublings. The default value of retry_count is zero. If retry_count is zero, a job attempt will *not* be retried if it fails. Instead the Cloud Scheduler system will wait for the next scheduled execution time. If retry_count is set to a non-zero number then Cloud Scheduler will retry failed attempts, using exponential backoff, retry_count times, or until the next scheduled execution time, whichever comes first. Values greater than 5 and negative values are not allowed.
rcMaxBackoffDuration :: Lens' RetryConfig (Maybe Scientific) Source #
The maximum amount of time to wait before retrying a job after it fails. The default value of this field is 1 hour.
Location
A resource that represents Google Cloud Platform location.
See: location
smart constructor.
Instances
Creates a value of Location
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lName :: Lens' Location (Maybe Text) Source #
Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"`
lMetadata :: Lens' Location (Maybe LocationMetadata) Source #
Service-specific metadata. For example the available capacity at the given location.
lDisplayName :: Lens' Location (Maybe Text) Source #
The friendly name for this location, typically a nearby city name. For example, "Tokyo".
lLabels :: Lens' Location (Maybe LocationLabels) Source #
Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"}
lLocationId :: Lens' Location (Maybe Text) Source #
The canonical id for this location. For example: `"us-east1"`.
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 Source # | |
Data Empty Source # | |
Defined in Network.Google.CloudScheduler.Types.Product gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Empty -> c Empty # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Empty # dataTypeOf :: Empty -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Empty) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Empty) # gmapT :: (forall b. Data b => b -> b) -> Empty -> Empty # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Empty -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Empty -> r # gmapQ :: (forall d. Data d => d -> u) -> Empty -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Empty -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Empty -> m Empty # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Empty -> m Empty # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Empty -> m Empty # | |
Show Empty Source # | |
Generic Empty Source # | |
ToJSON Empty Source # | |
Defined in Network.Google.CloudScheduler.Types.Product | |
FromJSON Empty Source # | |
type Rep Empty Source # | |
PubsubTargetAttributes
data PubsubTargetAttributes Source #
Attributes for PubsubMessage. Pubsub message must contain either non-empty data, or at least one attribute.
See: pubsubTargetAttributes
smart constructor.
Instances
pubsubTargetAttributes Source #
Creates a value of PubsubTargetAttributes
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
HTTPTargetHeaders
data HTTPTargetHeaders Source #
The user can specify HTTP request headers to send with the job's HTTP request. This map contains the header field names and values. Repeated headers are not supported, but a header value can contain commas. These headers represent a subset of the headers that will accompany the job's HTTP request. Some HTTP request headers will be ignored or replaced. A partial list of headers that will be ignored or replaced is below: - Host: This will be computed by Cloud Scheduler and derived from uri. * `Content-Length`: This will be computed by Cloud Scheduler. * `User-Agent`: This will be set to `"Google-Cloud-Scheduler"`. * `X-Google-*`: Google internal use only. * `X-AppEngine-*`: Google internal use only. The total size of headers must be less than 80KB.
See: hTTPTargetHeaders
smart constructor.
Instances
Creates a value of HTTPTargetHeaders
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
PubsubMessage
data PubsubMessage Source #
A message that is published by publishers and consumed by subscribers. The message must contain either a non-empty data field or at least one attribute. Note that client libraries represent this object differently depending on the language. See the corresponding client library documentation for more information. See Quotas and limits for more information about message limits.
See: pubsubMessage
smart constructor.
Instances
pubsubMessage :: PubsubMessage Source #
Creates a value of PubsubMessage
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
pmData :: Lens' PubsubMessage (Maybe ByteString) Source #
The message data field. If this field is empty, the message must contain at least one attribute.
pmPublishTime :: Lens' PubsubMessage (Maybe UTCTime) Source #
The time at which the message was published, populated by the server when it receives the `Publish` call. It must not be populated by the publisher in a `Publish` call.
pmAttributes :: Lens' PubsubMessage (Maybe PubsubMessageAttributes) Source #
Optional attributes for this message.
pmMessageId :: Lens' PubsubMessage (Maybe Text) Source #
ID of this message, assigned by the server when the message is published. Guaranteed to be unique within the topic. This value may be read by a subscriber that receives a `PubsubMessage` via a `Pull` call or a push delivery. It must not be populated by the publisher in a `Publish` call.
JobState
Output only. State of the job.
StateUnspecified |
|
Enabled |
|
Paused |
|
Disabled |
|
UpdateFailed |
|
Instances
StatusDetailsItem
data StatusDetailsItem Source #
Instances
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 'type with type URL.
AppEngineHTTPTarget
data AppEngineHTTPTarget Source #
App Engine target. The job will be pushed to a job handler by means of an HTTP request via an http_method such as HTTP POST, HTTP GET, etc. The job is acknowledged by means of an HTTP response code in the range [200 - 299]. Error 503 is considered an App Engine system error instead of an application error. Requests returning error 503 will be retried regardless of retry configuration and not counted against retry counts. Any other response code, or a failure to receive a response before the deadline, constitutes a failed attempt.
See: appEngineHTTPTarget
smart constructor.
Instances
appEngineHTTPTarget :: AppEngineHTTPTarget Source #
Creates a value of AppEngineHTTPTarget
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
aehttptHTTPMethod :: Lens' AppEngineHTTPTarget (Maybe AppEngineHTTPTargetHTTPMethod) Source #
The HTTP method to use for the request. PATCH and OPTIONS are not permitted.
aehttptRelativeURI :: Lens' AppEngineHTTPTarget (Maybe Text) Source #
The relative URI. The relative URL must begin with "/" and must be a valid HTTP relative URL. It can contain a path, query string arguments, and `#` fragments. If the relative URL is empty, then the root path "/" will be used. No spaces are allowed, and the maximum length allowed is 2083 characters.
aehttptBody :: Lens' AppEngineHTTPTarget (Maybe ByteString) Source #
Body. HTTP request body. A request body is allowed only if the HTTP method is POST or PUT. It will result in invalid argument error to set a body on a job with an incompatible HttpMethod.
aehttptHeaders :: Lens' AppEngineHTTPTarget (Maybe AppEngineHTTPTargetHeaders) Source #
HTTP request headers. This map contains the header field names and values. Headers can be set when the job is created. Cloud Scheduler sets some headers to default values: * `User-Agent`: By default, this header is `"AppEngine-Google; (+http://code.google.com/appengine)"`. This header can be modified, but Cloud Scheduler will append `"AppEngine-Google; (+http://code.google.com/appengine)"` to the modified `User-Agent`. * `X-CloudScheduler`: This header will be set to true. If the job has an body, Cloud Scheduler sets the following headers: * `Content-Type`: By default, the `Content-Type` header is set to `"application/octet-stream"`. The default can be overridden by explictly setting `Content-Type` to a particular media type when the job is created. For example, `Content-Type` can be set to `"application/json"`. * `Content-Length`: This is computed by Cloud Scheduler. This value is output only. It cannot be changed. The headers below are output only. They cannot be set or overridden: * `X-Google-*`: For Google internal use only. * `X-AppEngine-*`: For Google internal use only. In addition, some App Engine headers, which contain job-specific information, are also be sent to the job handler.
aehttptAppEngineRouting :: Lens' AppEngineHTTPTarget (Maybe AppEngineRouting) Source #
App Engine Routing setting for the job.
HTTPTarget
data HTTPTarget Source #
Http target. The job will be pushed to the job handler by means of an HTTP request via an http_method such as HTTP POST, HTTP GET, etc. The job is acknowledged by means of an HTTP response code in the range [200 - 299]. A failure to receive a response constitutes a failed execution. For a redirected request, the response returned by the redirected request is considered.
See: hTTPTarget
smart constructor.
Instances
hTTPTarget :: HTTPTarget Source #
Creates a value of HTTPTarget
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
httptHTTPMethod :: Lens' HTTPTarget (Maybe HTTPTargetHTTPMethod) Source #
Which HTTP method to use for the request.
httptBody :: Lens' HTTPTarget (Maybe ByteString) Source #
HTTP request body. A request body is allowed only if the HTTP method is POST, PUT, or PATCH. It is an error to set body on a job with an incompatible HttpMethod.
httptURI :: Lens' HTTPTarget (Maybe Text) Source #
Required. The full URI path that the request will be sent to. This string must begin with either "http://" or "https://". Some examples of valid values for uri are: `http://acme.com` and `https://acme.com/sales:8080`. Cloud Scheduler will encode some characters for safety and compatibility. The maximum allowed URL length is 2083 characters after encoding.
httptHeaders :: Lens' HTTPTarget (Maybe HTTPTargetHeaders) Source #
The user can specify HTTP request headers to send with the job's HTTP request. This map contains the header field names and values. Repeated headers are not supported, but a header value can contain commas. These headers represent a subset of the headers that will accompany the job's HTTP request. Some HTTP request headers will be ignored or replaced. A partial list of headers that will be ignored or replaced is below: - Host: This will be computed by Cloud Scheduler and derived from uri. * `Content-Length`: This will be computed by Cloud Scheduler. * `User-Agent`: This will be set to `"Google-Cloud-Scheduler"`. * `X-Google-*`: Google internal use only. * `X-AppEngine-*`: Google internal use only. The total size of headers must be less than 80KB.
RunJobRequest
data RunJobRequest Source #
Request message for forcing a job to run now using RunJob.
See: runJobRequest
smart constructor.
Instances
runJobRequest :: RunJobRequest Source #
Creates a value of RunJobRequest
with the minimum fields required to make a request.
Job
Configuration for a job. The maximum allowed size for a job is 100KB.
See: job
smart constructor.
Instances
Creates a value of Job
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
jStatus :: Lens' Job (Maybe Status) Source #
Output only. The response from the target for the last attempted execution.
jLastAttemptTime :: Lens' Job (Maybe UTCTime) Source #
Output only. The time the last job attempt started.
jRetryConfig :: Lens' Job (Maybe RetryConfig) Source #
Settings that determine the retry behavior.
jSchedule :: Lens' Job (Maybe Text) Source #
Required, except when used with UpdateJob. Describes the schedule on which the job will be executed. The schedule can be either of the following types: * Crontab * English-like schedule As a general rule, execution `n + 1` of a job will not begin until execution `n` has finished. Cloud Scheduler will never allow two simultaneously outstanding executions. For example, this implies that if the `n+1`th execution is scheduled to run at 16:00 but the `n`th execution takes until 16:15, the `n+1`th execution will not start until `16:15`. A scheduled start time will be delayed if the previous execution has not ended when its scheduled time occurs. If retry_count > 0 and a job attempt fails, the job will be tried a total of retry_count times, with exponential backoff, until the next scheduled start time.
jScheduleTime :: Lens' Job (Maybe UTCTime) Source #
Output only. The next time the job is scheduled. Note that this may be a retry of a previously failed attempt or the next execution time according to the schedule.
jAppEngineHTTPTarget :: Lens' Job (Maybe AppEngineHTTPTarget) Source #
App Engine HTTP target.
jHTTPTarget :: Lens' Job (Maybe HTTPTarget) Source #
HTTP target.
jName :: Lens' Job (Maybe Text) Source #
Optionally caller-specified in CreateJob, after which it becomes output only. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see Identifying projects * `LOCATION_ID` is the canonical ID for the job's location. The list of available locations can be obtained by calling ListLocations. For more information, see https://cloud.google.com/about/locations/. * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters.
jPubsubTarget :: Lens' Job (Maybe PubsubTarget) Source #
Pub/Sub target.
jTimeZone :: Lens' Job (Maybe Text) Source #
Specifies the time zone to be used in interpreting schedule. The value of this field must be a time zone name from the tz database. Note that some time zones include a provision for daylight savings time. The rules for daylight saving time are determined by the chosen tz. For UTC use the string "utc". If a time zone is not specified, the default will be in UTC (also known as GMT).
jDescription :: Lens' Job (Maybe Text) Source #
Optionally caller-specified in CreateJob or UpdateJob. A human-readable description for the job. This string must not contain more than 500 characters.
PubsubMessageAttributes
data PubsubMessageAttributes Source #
Optional attributes for this message.
See: pubsubMessageAttributes
smart constructor.
Instances
pubsubMessageAttributes Source #
Creates a value of PubsubMessageAttributes
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
PubsubTarget
data PubsubTarget Source #
Pub/Sub target. The job will be delivered by publishing a message to the given Pub/Sub topic.
See: pubsubTarget
smart constructor.
Instances
pubsubTarget :: PubsubTarget Source #
Creates a value of PubsubTarget
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ptData :: Lens' PubsubTarget (Maybe ByteString) Source #
The message payload for PubsubMessage. Pubsub message must contain either non-empty data, or at least one attribute.
ptTopicName :: Lens' PubsubTarget (Maybe Text) Source #
Required. The name of the Cloud Pub/Sub topic to which messages will be published when a job is delivered. The topic name must be in the same format as required by PubSub's PublishRequest.name, for example `projects/PROJECT_ID/topics/TOPIC_ID`. The topic must be in the same project as the Cloud Scheduler job.
ptAttributes :: Lens' PubsubTarget (Maybe PubsubTargetAttributes) Source #
Attributes for PubsubMessage. Pubsub message must contain either non-empty data, or at least one attribute.
Xgafv
V1 error format.
Instances
ListJobsResponse
data ListJobsResponse Source #
Response message for listing jobs using ListJobs.
See: listJobsResponse
smart constructor.
Instances
listJobsResponse :: ListJobsResponse Source #
Creates a value of ListJobsResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ljrNextPageToken :: Lens' ListJobsResponse (Maybe Text) Source #
A token to retrieve next page of results. Pass this value in the page_token field in the subsequent call to ListJobs to retrieve the next page of results. If this is empty it indicates that there are no more results through which to paginate. The page token is valid for only 2 hours.
LocationLabels
data LocationLabels Source #
Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"}
See: locationLabels
smart constructor.
Instances
Creates a value of LocationLabels
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
LocationMetadata
data LocationMetadata Source #
Service-specific metadata. For example the available capacity at the given location.
See: locationMetadata
smart constructor.
Instances
Creates a value of LocationMetadata
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lmAddtional :: Lens' LocationMetadata (HashMap Text JSONValue) Source #
Properties of the object. Contains field 'type with type URL.
AppEngineRouting
data AppEngineRouting Source #
App Engine Routing. For more information about services, versions, and instances see An Overview of App Engine, Microservices Architecture on Google App Engine, App Engine Standard request routing, and App Engine Flex request routing.
See: appEngineRouting
smart constructor.
Instances
appEngineRouting :: AppEngineRouting Source #
Creates a value of AppEngineRouting
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
aerService :: Lens' AppEngineRouting (Maybe Text) Source #
App service. By default, the job is sent to the service which is the default service when the job is attempted.
aerVersion :: Lens' AppEngineRouting (Maybe Text) Source #
App version. By default, the job is sent to the version which is the default version when the job is attempted.
aerHost :: Lens' AppEngineRouting (Maybe Text) Source #
Output only. The host that the job is sent to. For more information about how App Engine requests are routed, see here. The host is constructed as: * `host = [application_domain_name]` `| [service] + '.' + [application_domain_name]` `| [version] + '.' + [application_domain_name]` `| [version_dot_service]+ '.' + [application_domain_name]` `| [instance] + '.' + [application_domain_name]` `| [instance_dot_service] + '.' + [application_domain_name]` `| [instance_dot_version] + '.' + [application_domain_name]` `| [instance_dot_version_dot_service] + '.' + [application_domain_name]` * `application_domain_name` = The domain name of the app, for example .appspot.com, which is associated with the job's project ID. * `service =` service * `version =` version * `version_dot_service =` version `+ '.' +` service * `instance =` instance * `instance_dot_service =` instance `+ '.' +` service * `instance_dot_version =` instance `+ '.' +` version * `instance_dot_version_dot_service =` instance `+ '.' +` version `+ '.' +` service If service is empty, then the job will be sent to the service which is the default service when the job is attempted. If version is empty, then the job will be sent to the version which is the default version when the job is attempted. If instance is empty, then the job will be sent to an instance which is available when the job is attempted. If service, version, or instance is invalid, then the job will be sent to the default version of the default service when the job is attempted.
aerInstance :: Lens' AppEngineRouting (Maybe Text) Source #
App instance. By default, the job is sent to an instance which is available when the job is attempted. Requests can only be sent to a specific instance if manual scaling is used in App Engine Standard. App Engine Flex does not support instances. For more information, see App Engine Standard request routing and App Engine Flex request routing.
HTTPTargetHTTPMethod
data HTTPTargetHTTPMethod Source #
Which HTTP method to use for the request.
HTTPMethodUnspecified |
|
Post' |
|
Get' |
|
Head' |
|
Put' |
|
Delete' |
|
Patch' |
|
Options |
|
Instances
AppEngineHTTPTargetHTTPMethod
data AppEngineHTTPTargetHTTPMethod Source #
The HTTP method to use for the request. PATCH and OPTIONS are not permitted.
AEHTTPTHTTPMHTTPMethodUnspecified |
|
AEHTTPTHTTPMPost' |
|
AEHTTPTHTTPMGet' |
|
AEHTTPTHTTPMHead' |
|
AEHTTPTHTTPMPut' |
|
AEHTTPTHTTPMDelete' |
|
AEHTTPTHTTPMPatch' |
|
AEHTTPTHTTPMOptions |
|