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
- RateLimits
- Status
- Expr
- ListLocationsResponse
- GetIAMPolicyRequest
- RetryConfig
- RunTaskRequest
- Location
- Empty
- CreateTaskRequest
- TaskView
- ListQueuesResponse
- StatusDetailsItem
- QueueState
- AppEngineHTTPQueue
- CreateTaskRequestResponseView
- SetIAMPolicyRequest
- Queue
- AppEngineHTTPRequestHTTPMethod
- ListTasksResponse
- AppEngineHTTPRequestHeaders
- Xgafv
- PauseQueueRequest
- TestIAMPermissionsRequest
- Attempt
- PurgeQueueRequest
- Task
- TestIAMPermissionsResponse
- Policy
- LocationLabels
- LocationMetadata
- RunTaskRequestResponseView
- AppEngineRouting
- AppEngineHTTPRequest
- ResumeQueueRequest
- Binding
Synopsis
- cloudTasksService :: ServiceConfig
- cloudPlatformScope :: Proxy '["https://www.googleapis.com/auth/cloud-platform"]
- data RateLimits
- rateLimits :: RateLimits
- rlMaxConcurrentDispatches :: Lens' RateLimits (Maybe Int32)
- rlMaxDispatchesPerSecond :: Lens' RateLimits (Maybe Double)
- rlMaxBurstSize :: Lens' RateLimits (Maybe Int32)
- data Status
- status :: Status
- sDetails :: Lens' Status [StatusDetailsItem]
- sCode :: Lens' Status (Maybe Int32)
- sMessage :: Lens' Status (Maybe Text)
- data Expr
- expr :: Expr
- eLocation :: Lens' Expr (Maybe Text)
- eExpression :: Lens' Expr (Maybe Text)
- eTitle :: Lens' Expr (Maybe Text)
- eDescription :: Lens' Expr (Maybe Text)
- data ListLocationsResponse
- listLocationsResponse :: ListLocationsResponse
- llrNextPageToken :: Lens' ListLocationsResponse (Maybe Text)
- llrLocations :: Lens' ListLocationsResponse [Location]
- data GetIAMPolicyRequest
- getIAMPolicyRequest :: GetIAMPolicyRequest
- data RetryConfig
- retryConfig :: RetryConfig
- rcMaxDoublings :: Lens' RetryConfig (Maybe Int32)
- rcMaxRetryDuration :: Lens' RetryConfig (Maybe Scientific)
- rcMaxAttempts :: Lens' RetryConfig (Maybe Int32)
- rcMaxBackoff :: Lens' RetryConfig (Maybe Scientific)
- rcMinBackoff :: Lens' RetryConfig (Maybe Scientific)
- data RunTaskRequest
- runTaskRequest :: RunTaskRequest
- rtrResponseView :: Lens' RunTaskRequest (Maybe RunTaskRequestResponseView)
- 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 CreateTaskRequest
- createTaskRequest :: CreateTaskRequest
- ctrResponseView :: Lens' CreateTaskRequest (Maybe CreateTaskRequestResponseView)
- ctrTask :: Lens' CreateTaskRequest (Maybe Task)
- data TaskView
- = ViewUnspecified
- | Basic
- | Full
- data ListQueuesResponse
- listQueuesResponse :: ListQueuesResponse
- lqrNextPageToken :: Lens' ListQueuesResponse (Maybe Text)
- lqrQueues :: Lens' ListQueuesResponse [Queue]
- data StatusDetailsItem
- statusDetailsItem :: HashMap Text JSONValue -> StatusDetailsItem
- sdiAddtional :: Lens' StatusDetailsItem (HashMap Text JSONValue)
- data QueueState
- data AppEngineHTTPQueue
- appEngineHTTPQueue :: AppEngineHTTPQueue
- aehttpqAppEngineRoutingOverride :: Lens' AppEngineHTTPQueue (Maybe AppEngineRouting)
- data CreateTaskRequestResponseView
- data SetIAMPolicyRequest
- setIAMPolicyRequest :: SetIAMPolicyRequest
- siprPolicy :: Lens' SetIAMPolicyRequest (Maybe Policy)
- data Queue
- queue :: Queue
- qRateLimits :: Lens' Queue (Maybe RateLimits)
- qState :: Lens' Queue (Maybe QueueState)
- qRetryConfig :: Lens' Queue (Maybe RetryConfig)
- qAppEngineHTTPQueue :: Lens' Queue (Maybe AppEngineHTTPQueue)
- qName :: Lens' Queue (Maybe Text)
- qPurgeTime :: Lens' Queue (Maybe UTCTime)
- data AppEngineHTTPRequestHTTPMethod
- data ListTasksResponse
- listTasksResponse :: ListTasksResponse
- ltrNextPageToken :: Lens' ListTasksResponse (Maybe Text)
- ltrTasks :: Lens' ListTasksResponse [Task]
- data AppEngineHTTPRequestHeaders
- appEngineHTTPRequestHeaders :: HashMap Text Text -> AppEngineHTTPRequestHeaders
- aehttprhAddtional :: Lens' AppEngineHTTPRequestHeaders (HashMap Text Text)
- data Xgafv
- data PauseQueueRequest
- pauseQueueRequest :: PauseQueueRequest
- data TestIAMPermissionsRequest
- testIAMPermissionsRequest :: TestIAMPermissionsRequest
- tiprPermissions :: Lens' TestIAMPermissionsRequest [Text]
- data Attempt
- attempt :: Attempt
- aResponseStatus :: Lens' Attempt (Maybe Status)
- aScheduleTime :: Lens' Attempt (Maybe UTCTime)
- aDispatchTime :: Lens' Attempt (Maybe UTCTime)
- aResponseTime :: Lens' Attempt (Maybe UTCTime)
- data PurgeQueueRequest
- purgeQueueRequest :: PurgeQueueRequest
- data Task
- task :: Task
- tLastAttempt :: Lens' Task (Maybe Attempt)
- tScheduleTime :: Lens' Task (Maybe UTCTime)
- tName :: Lens' Task (Maybe Text)
- tFirstAttempt :: Lens' Task (Maybe Attempt)
- tView :: Lens' Task (Maybe TaskView)
- tResponseCount :: Lens' Task (Maybe Int32)
- tDispatchCount :: Lens' Task (Maybe Int32)
- tAppEngineHTTPRequest :: Lens' Task (Maybe AppEngineHTTPRequest)
- tCreateTime :: Lens' Task (Maybe UTCTime)
- data TestIAMPermissionsResponse
- testIAMPermissionsResponse :: TestIAMPermissionsResponse
- tiamprPermissions :: Lens' TestIAMPermissionsResponse [Text]
- data Policy
- policy :: Policy
- pEtag :: Lens' Policy (Maybe ByteString)
- pVersion :: Lens' Policy (Maybe Int32)
- pBindings :: Lens' Policy [Binding]
- 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 RunTaskRequestResponseView
- 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 AppEngineHTTPRequest
- appEngineHTTPRequest :: AppEngineHTTPRequest
- aehttprHTTPMethod :: Lens' AppEngineHTTPRequest (Maybe AppEngineHTTPRequestHTTPMethod)
- aehttprRelativeURI :: Lens' AppEngineHTTPRequest (Maybe Text)
- aehttprBody :: Lens' AppEngineHTTPRequest (Maybe ByteString)
- aehttprHeaders :: Lens' AppEngineHTTPRequest (Maybe AppEngineHTTPRequestHeaders)
- aehttprAppEngineRouting :: Lens' AppEngineHTTPRequest (Maybe AppEngineRouting)
- data ResumeQueueRequest
- resumeQueueRequest :: ResumeQueueRequest
- data Binding
- binding :: Binding
- bMembers :: Lens' Binding [Text]
- bRole :: Lens' Binding (Maybe Text)
- bCondition :: Lens' Binding (Maybe Expr)
Service Configuration
cloudTasksService :: ServiceConfig Source #
Default request referring to version v2beta3
of the Cloud Tasks 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
RateLimits
data RateLimits Source #
Rate limits. This message determines the maximum rate that tasks can be dispatched by a queue, regardless of whether the dispatch is a first task attempt or a retry. Note: The debugging command, RunTask, will run a task even if the queue has reached its RateLimits.
See: rateLimits
smart constructor.
Instances
rateLimits :: RateLimits Source #
Creates a value of RateLimits
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rlMaxConcurrentDispatches :: Lens' RateLimits (Maybe Int32) Source #
The maximum number of concurrent tasks that Cloud Tasks allows to be dispatched for this queue. After this threshold has been reached, Cloud Tasks stops dispatching tasks until the number of concurrent requests decreases. If unspecified when the queue is created, Cloud Tasks will pick the default. The maximum allowed value is 5,000. This field has the same meaning as max_concurrent_requests in queue.yaml/xml.
rlMaxDispatchesPerSecond :: Lens' RateLimits (Maybe Double) Source #
The maximum rate at which tasks are dispatched from this queue. If unspecified when the queue is created, Cloud Tasks will pick the default. * For App Engine queues, the maximum allowed value is 500. This field has the same meaning as rate in queue.yaml/xml.
rlMaxBurstSize :: Lens' RateLimits (Maybe Int32) Source #
Output only. The max burst size. Max burst size limits how fast tasks in queue are processed when many tasks are in the queue and the rate is high. This field allows the queue to have a high rate so processing starts shortly after a task is enqueued, but still limits resource usage when many tasks are enqueued in a short period of time. The token bucket algorithm is used to control the rate of task dispatches. Each queue has a token bucket that holds tokens, up to the maximum specified by `max_burst_size`. Each time a task is dispatched, a token is removed from the bucket. Tasks will be dispatched until the queue's bucket runs out of tokens. The bucket will be continuously refilled with new tokens based on max_dispatches_per_second. Cloud Tasks will pick the value of `max_burst_size` based on the value of max_dispatches_per_second. For App Engine queues that were created or updated using `queue.yaml/xml`, `max_burst_size` is equal to bucket_size. Since `max_burst_size` is output only, if UpdateQueue is called on a queue created by `queue.yaml/xml`, `max_burst_size` will be reset based on the value of max_dispatches_per_second, regardless of whether max_dispatches_per_second is updated.
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.CloudTasks.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.CloudTasks.Types.Product | |
FromJSON Status Source # | |
type Rep Status Source # | |
Defined in Network.Google.CloudTasks.Types.Product type Rep Status = D1 (MetaData "Status" "Network.Google.CloudTasks.Types.Product" "gogol-cloudtasks-0.4.0-JYw8G9RDcROAs8IJ376NEk" 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.
Expr
Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0"
See: expr
smart constructor.
Instances
Eq Expr Source # | |
Data Expr Source # | |
Defined in Network.Google.CloudTasks.Types.Product gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Expr -> c Expr # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Expr # dataTypeOf :: Expr -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Expr) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Expr) # gmapT :: (forall b. Data b => b -> b) -> Expr -> Expr # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Expr -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Expr -> r # gmapQ :: (forall d. Data d => d -> u) -> Expr -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Expr -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Expr -> m Expr # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Expr -> m Expr # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Expr -> m Expr # | |
Show Expr Source # | |
Generic Expr Source # | |
ToJSON Expr Source # | |
Defined in Network.Google.CloudTasks.Types.Product | |
FromJSON Expr Source # | |
type Rep Expr Source # | |
Defined in Network.Google.CloudTasks.Types.Product type Rep Expr = D1 (MetaData "Expr" "Network.Google.CloudTasks.Types.Product" "gogol-cloudtasks-0.4.0-JYw8G9RDcROAs8IJ376NEk" False) (C1 (MetaCons "Expr'" PrefixI True) ((S1 (MetaSel (Just "_eLocation") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_eExpression") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_eTitle") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_eDescription") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) |
Creates a value of Expr
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
eLocation :: Lens' Expr (Maybe Text) Source #
An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
eExpression :: Lens' Expr (Maybe Text) Source #
Textual representation of an expression in Common Expression Language syntax. The application context of the containing message determines which well-known feature set of CEL is supported.
eTitle :: Lens' Expr (Maybe Text) Source #
An optional title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
eDescription :: Lens' Expr (Maybe Text) Source #
An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
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.
GetIAMPolicyRequest
data GetIAMPolicyRequest Source #
Request message for `GetIamPolicy` method.
See: getIAMPolicyRequest
smart constructor.
Instances
getIAMPolicyRequest :: GetIAMPolicyRequest Source #
Creates a value of GetIAMPolicyRequest
with the minimum fields required to make a request.
RetryConfig
data RetryConfig Source #
Retry config. These settings determine when a failed task attempt is retried.
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 task's retry interval starts at min_backoff, then doubles `max_doublings` times, then increases linearly, and finally retries retries at intervals of max_backoff up to max_attempts times. For example, if min_backoff is 10s, max_backoff is 300s, and `max_doublings` is 3, then the a task will first be retried in 10s. The retry interval will double three times, and then increase linearly by 2^3 * 10s. Finally, the task will retry at intervals of max_backoff until the task has been attempted max_attempts times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, .... If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as max_doublings in queue.yaml/xml.
rcMaxRetryDuration :: Lens' RetryConfig (Maybe Scientific) Source #
If positive, `max_retry_duration` specifies the time limit for retrying a failed task, measured from when the task was first attempted. Once `max_retry_duration` time has passed *and* the task has been attempted max_attempts times, no further attempts will be made and the task will be deleted. If zero, then the task age is unlimited. If unspecified when the queue is created, Cloud Tasks will pick the default. `max_retry_duration` will be truncated to the nearest second. This field has the same meaning as task_age_limit in queue.yaml/xml.
rcMaxAttempts :: Lens' RetryConfig (Maybe Int32) Source #
Number of attempts per task. Cloud Tasks will attempt the task `max_attempts` times (that is, if the first attempt fails, then there will be `max_attempts - 1` retries). Must be >= -1. If unspecified when the queue is created, Cloud Tasks will pick the default. -1 indicates unlimited attempts. This field has the same meaning as task_retry_limit in queue.yaml/xml.
rcMaxBackoff :: Lens' RetryConfig (Maybe Scientific) Source #
A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. If unspecified when the queue is created, Cloud Tasks will pick the default. `max_backoff` will be truncated to the nearest second. This field has the same meaning as max_backoff_seconds in queue.yaml/xml.
rcMinBackoff :: Lens' RetryConfig (Maybe Scientific) Source #
A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. If unspecified when the queue is created, Cloud Tasks will pick the default. `min_backoff` will be truncated to the nearest second. This field has the same meaning as min_backoff_seconds in queue.yaml/xml.
RunTaskRequest
data RunTaskRequest Source #
Request message for forcing a task to run now using RunTask.
See: runTaskRequest
smart constructor.
Instances
runTaskRequest :: RunTaskRequest Source #
Creates a value of RunTaskRequest
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rtrResponseView :: Lens' RunTaskRequest (Maybe RunTaskRequestResponseView) Source #
The response_view specifies which subset of the Task will be returned. By default response_view is BASIC; not all information is retrieved by default because some data, such as payloads, might be desirable to return only when needed because of its large size or because of the sensitivity of data that it contains. Authorization for FULL requires `cloudtasks.tasks.fullView` Google IAM permission on the Task resource.
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.CloudTasks.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.CloudTasks.Types.Product | |
FromJSON Empty Source # | |
type Rep Empty Source # | |
CreateTaskRequest
data CreateTaskRequest Source #
Request message for CreateTask.
See: createTaskRequest
smart constructor.
Instances
createTaskRequest :: CreateTaskRequest Source #
Creates a value of CreateTaskRequest
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ctrResponseView :: Lens' CreateTaskRequest (Maybe CreateTaskRequestResponseView) Source #
The response_view specifies which subset of the Task will be returned. By default response_view is BASIC; not all information is retrieved by default because some data, such as payloads, might be desirable to return only when needed because of its large size or because of the sensitivity of data that it contains. Authorization for FULL requires `cloudtasks.tasks.fullView` Google IAM permission on the Task resource.
ctrTask :: Lens' CreateTaskRequest (Maybe Task) Source #
Required. The task to add. Task names have the following format: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`. The user can optionally specify a task name. If a name is not specified then the system will generate a random unique task id, which will be set in the task returned in the response. If schedule_time is not set or is in the past then Cloud Tasks will set it to the current time. Task De-duplication: Explicitly specifying a task ID enables task de-duplication. If a task's ID is identical to that of an existing task or a task that was deleted or executed recently then the call will fail with ALREADY_EXISTS. If the task's queue was created using Cloud Tasks, then another task with the same name can't be created for ~1hour after the original task was deleted or executed. If the task's queue was created using queue.yaml or queue.xml, then another task with the same name can't be created for ~9days after the original task was deleted or executed. Because there is an extra lookup cost to identify duplicate task names, these CreateTask calls have significantly increased latency. Using hashed strings for the task id or for the prefix of the task id is recommended. Choosing task ids that are sequential or have sequential prefixes, for example using a timestamp, causes an increase in latency and error rates in all task commands. The infrastructure relies on an approximately uniform distribution of task ids to store and serve tasks efficiently.
TaskView
Output only. The view specifies which subset of the Task has been returned.
ViewUnspecified |
|
Basic |
|
Full |
|
Instances
ListQueuesResponse
data ListQueuesResponse Source #
Response message for ListQueues.
See: listQueuesResponse
smart constructor.
Instances
listQueuesResponse :: ListQueuesResponse Source #
Creates a value of ListQueuesResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lqrNextPageToken :: Lens' ListQueuesResponse (Maybe Text) Source #
A token to retrieve next page of results. To return the next page of results, call ListQueues with this value as the page_token. If the next_page_token is empty, there are no more results. The page token is valid for only 2 hours.
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.
QueueState
data QueueState Source #
Output only. The state of the queue. `state` can only be changed by called PauseQueue, ResumeQueue, or uploading queue.yaml/xml. UpdateQueue cannot be used to change `state`.
StateUnspecified |
|
Running |
|
Paused |
|
Disabled |
|
Instances
AppEngineHTTPQueue
data AppEngineHTTPQueue Source #
App Engine HTTP queue. The task will be delivered to the App Engine application hostname specified by its AppEngineHttpQueue and AppEngineHttpRequest. The documentation for AppEngineHttpRequest explains how the task's host URL is constructed. Using AppEngineHttpQueue requires `appengine.applications.get` Google IAM permission for the project and the following scope: `https://www.googleapis.com/auth/cloud-platform`
See: appEngineHTTPQueue
smart constructor.
Instances
appEngineHTTPQueue :: AppEngineHTTPQueue Source #
Creates a value of AppEngineHTTPQueue
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
aehttpqAppEngineRoutingOverride :: Lens' AppEngineHTTPQueue (Maybe AppEngineRouting) Source #
Overrides for the task-level app_engine_routing. If set, `app_engine_routing_override` is used for all tasks in the queue, no matter what the setting is for the task-level app_engine_routing.
CreateTaskRequestResponseView
data CreateTaskRequestResponseView Source #
The response_view specifies which subset of the Task will be returned. By default response_view is BASIC; not all information is retrieved by default because some data, such as payloads, might be desirable to return only when needed because of its large size or because of the sensitivity of data that it contains. Authorization for FULL requires `cloudtasks.tasks.fullView` Google IAM permission on the Task resource.
CTRRVViewUnspecified |
|
CTRRVBasic |
|
CTRRVFull |
|
Instances
SetIAMPolicyRequest
data SetIAMPolicyRequest Source #
Request message for `SetIamPolicy` method.
See: setIAMPolicyRequest
smart constructor.
Instances
setIAMPolicyRequest :: SetIAMPolicyRequest Source #
Creates a value of SetIAMPolicyRequest
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
siprPolicy :: Lens' SetIAMPolicyRequest (Maybe Policy) Source #
REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them.
Queue
A queue is a container of related tasks. Queues are configured to manage how those tasks are dispatched. Configurable properties include rate limits, retry options, queue types, and others.
See: queue
smart constructor.
Instances
Creates a value of Queue
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
qRateLimits :: Lens' Queue (Maybe RateLimits) Source #
Rate limits for task dispatches. rate_limits and retry_config are related because they both control task attempts however they control how tasks are attempted in different ways: * rate_limits controls the total rate of dispatches from a queue (i.e. all traffic dispatched from the queue, regardless of whether the dispatch is from a first attempt or a retry). * retry_config controls what happens to particular a task after its first attempt fails. That is, retry_config controls task retries (the second attempt, third attempt, etc).
qState :: Lens' Queue (Maybe QueueState) Source #
Output only. The state of the queue. `state` can only be changed by called PauseQueue, ResumeQueue, or uploading queue.yaml/xml. UpdateQueue cannot be used to change `state`.
qRetryConfig :: Lens' Queue (Maybe RetryConfig) Source #
Settings that determine the retry behavior. * For tasks created using Cloud Tasks: the queue-level retry settings apply to all tasks in the queue that were created using Cloud Tasks. Retry settings cannot be set on individual tasks. * For tasks created using the App Engine SDK: the queue-level retry settings apply to all tasks in the queue which do not have retry settings explicitly set on the task and were created by the App Engine SDK. See App Engine documentation.
qAppEngineHTTPQueue :: Lens' Queue (Maybe AppEngineHTTPQueue) Source #
App Engine HTTP queue. An App Engine queue is a queue that has an AppEngineHttpQueue type.
qName :: Lens' Queue (Maybe Text) Source #
Caller-specified and required in CreateQueue, after which it becomes output only. The queue name. The queue name must have the following format: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_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 queue's location. The list of available locations can be obtained by calling ListLocations. For more information, see https://cloud.google.com/about/locations/. * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or hyphens (-). The maximum length is 100 characters.
qPurgeTime :: Lens' Queue (Maybe UTCTime) Source #
Output only. The last time this queue was purged. All tasks that were created before this time were purged. A queue can be purged using PurgeQueue, the App Engine Task Queue SDK, or the Cloud Console. Purge time will be truncated to the nearest microsecond. Purge time will be unset if the queue has never been purged.
AppEngineHTTPRequestHTTPMethod
data AppEngineHTTPRequestHTTPMethod Source #
The HTTP method to use for the request. The default is POST. The app's request handler for the task's target URL must be able to handle HTTP requests with this http_method, otherwise the task attempt will fail with error code 405 (Method Not Allowed). See Writing a push task request handler and the documentation for the request handlers in the language your app is written in e.g. Python Request Handler.
HTTPMethodUnspecified |
|
Post' |
|
Get' |
|
Head' |
|
Put' |
|
Delete' |
|
Instances
ListTasksResponse
data ListTasksResponse Source #
Response message for listing tasks using ListTasks.
See: listTasksResponse
smart constructor.
Instances
listTasksResponse :: ListTasksResponse Source #
Creates a value of ListTasksResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ltrNextPageToken :: Lens' ListTasksResponse (Maybe Text) Source #
A token to retrieve next page of results. To return the next page of results, call ListTasks with this value as the page_token. If the next_page_token is empty, there are no more results.
AppEngineHTTPRequestHeaders
data AppEngineHTTPRequestHeaders Source #
HTTP request headers. This map contains the header field names and values. Headers can be set when the task is created. Repeated headers are not supported but a header value can contain commas. Cloud Tasks 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 Tasks will append `"AppEngine-Google; (+http://code.google.com/appengine)"` to the modified `User-Agent`. If the task has a body, Cloud Tasks sets the following headers: * `Content-Type`: By default, the `Content-Type` header is set to `"application/octet-stream"`. The default can be overridden by explicitly setting `Content-Type` to a particular media type when the task is created. For example, `Content-Type` can be set to `"application/json"`. * `Content-Length`: This is computed by Cloud Tasks. This value is output only. It cannot be changed. The headers below cannot be set or overridden: * `Host` * `X-Google-*` * `X-AppEngine-*` In addition, Cloud Tasks sets some headers when the task is dispatched, such as headers containing information about the task; see request headers. These headers are set only when the task is dispatched, so they are not visible when the task is returned in a Cloud Tasks response. Although there is no specific limit for the maximum number of headers or the size, there is a limit on the maximum size of the Task. For more information, see the CreateTask documentation.
See: appEngineHTTPRequestHeaders
smart constructor.
Instances
appEngineHTTPRequestHeaders Source #
Creates a value of AppEngineHTTPRequestHeaders
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
Xgafv
V1 error format.
Instances
PauseQueueRequest
data PauseQueueRequest Source #
Request message for PauseQueue.
See: pauseQueueRequest
smart constructor.
Instances
pauseQueueRequest :: PauseQueueRequest Source #
Creates a value of PauseQueueRequest
with the minimum fields required to make a request.
TestIAMPermissionsRequest
data TestIAMPermissionsRequest Source #
Request message for `TestIamPermissions` method.
See: testIAMPermissionsRequest
smart constructor.
Instances
testIAMPermissionsRequest :: TestIAMPermissionsRequest Source #
Creates a value of TestIAMPermissionsRequest
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
tiprPermissions :: Lens' TestIAMPermissionsRequest [Text] Source #
The set of permissions to check for the `resource`. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. For more information see IAM Overview.
Attempt
The status of a task attempt.
See: attempt
smart constructor.
Instances
Eq Attempt Source # | |
Data Attempt Source # | |
Defined in Network.Google.CloudTasks.Types.Product gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Attempt -> c Attempt # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Attempt # toConstr :: Attempt -> Constr # dataTypeOf :: Attempt -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Attempt) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Attempt) # gmapT :: (forall b. Data b => b -> b) -> Attempt -> Attempt # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Attempt -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Attempt -> r # gmapQ :: (forall d. Data d => d -> u) -> Attempt -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Attempt -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Attempt -> m Attempt # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Attempt -> m Attempt # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Attempt -> m Attempt # | |
Show Attempt Source # | |
Generic Attempt Source # | |
ToJSON Attempt Source # | |
Defined in Network.Google.CloudTasks.Types.Product | |
FromJSON Attempt Source # | |
type Rep Attempt Source # | |
Defined in Network.Google.CloudTasks.Types.Product type Rep Attempt = D1 (MetaData "Attempt" "Network.Google.CloudTasks.Types.Product" "gogol-cloudtasks-0.4.0-JYw8G9RDcROAs8IJ376NEk" False) (C1 (MetaCons "Attempt'" PrefixI True) ((S1 (MetaSel (Just "_aResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Status)) :*: S1 (MetaSel (Just "_aScheduleTime") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe DateTime'))) :*: (S1 (MetaSel (Just "_aDispatchTime") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe DateTime')) :*: S1 (MetaSel (Just "_aResponseTime") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe DateTime'))))) |
Creates a value of Attempt
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
aResponseStatus :: Lens' Attempt (Maybe Status) Source #
Output only. The response from the target for this attempt. If `response_time` is unset, then the task has not been attempted or is currently running and the `response_status` field is meaningless.
aScheduleTime :: Lens' Attempt (Maybe UTCTime) Source #
Output only. The time that this attempt was scheduled. `schedule_time` will be truncated to the nearest microsecond.
aDispatchTime :: Lens' Attempt (Maybe UTCTime) Source #
Output only. The time that this attempt was dispatched. `dispatch_time` will be truncated to the nearest microsecond.
aResponseTime :: Lens' Attempt (Maybe UTCTime) Source #
Output only. The time that this attempt response was received. `response_time` will be truncated to the nearest microsecond.
PurgeQueueRequest
data PurgeQueueRequest Source #
Request message for PurgeQueue.
See: purgeQueueRequest
smart constructor.
Instances
purgeQueueRequest :: PurgeQueueRequest Source #
Creates a value of PurgeQueueRequest
with the minimum fields required to make a request.
Task
A unit of scheduled work.
See: task
smart constructor.
Instances
Creates a value of Task
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
tLastAttempt :: Lens' Task (Maybe Attempt) Source #
Output only. The status of the task's last attempt.
tScheduleTime :: Lens' Task (Maybe UTCTime) Source #
The time when the task is scheduled to be attempted. For App Engine queues, this is when the task will be attempted or retried. `schedule_time` will be truncated to the nearest microsecond.
tName :: Lens' Task (Maybe Text) Source #
Optionally caller-specified in CreateTask. The task name. The task name must have the following format: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_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 task's location. The list of available locations can be obtained by calling ListLocations. For more information, see https://cloud.google.com/about/locations/. * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or hyphens (-). The maximum length is 100 characters. * `TASK_ID` can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters.
tFirstAttempt :: Lens' Task (Maybe Attempt) Source #
Output only. The status of the task's first attempt. Only dispatch_time will be set. The other Attempt information is not retained by Cloud Tasks.
tView :: Lens' Task (Maybe TaskView) Source #
Output only. The view specifies which subset of the Task has been returned.
tResponseCount :: Lens' Task (Maybe Int32) Source #
Output only. The number of attempts which have received a response.
tDispatchCount :: Lens' Task (Maybe Int32) Source #
Output only. The number of attempts dispatched. This count includes tasks which have been dispatched but haven't received a response.
tAppEngineHTTPRequest :: Lens' Task (Maybe AppEngineHTTPRequest) Source #
App Engine HTTP request that is sent to the task's target. Can be set only if app_engine_http_queue is set on the queue. An App Engine task is a task that has AppEngineHttpRequest set.
tCreateTime :: Lens' Task (Maybe UTCTime) Source #
Output only. The time that the task was created. `create_time` will be truncated to the nearest second.
TestIAMPermissionsResponse
data TestIAMPermissionsResponse Source #
Response message for `TestIamPermissions` method.
See: testIAMPermissionsResponse
smart constructor.
Instances
testIAMPermissionsResponse :: TestIAMPermissionsResponse Source #
Creates a value of TestIAMPermissionsResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
tiamprPermissions :: Lens' TestIAMPermissionsResponse [Text] Source #
A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
Policy
Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **JSON Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike'example.com", "group:admins'example.com", "domain:google.com", "serviceAccount:my-other-app'appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean'example.com"] } ] } **YAML Example** bindings: - members: - user:mike'example.com - group:admins'example.com - domain:google.com - serviceAccount:my-other-app'appspot.gserviceaccount.com role: roles/owner - members: - user:sean'example.com role: roles/viewer For a description of IAM and its features, see the IAM developer's guide.
See: policy
smart constructor.
Instances
Eq Policy Source # | |
Data Policy Source # | |
Defined in Network.Google.CloudTasks.Types.Product gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Policy -> c Policy # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Policy # toConstr :: Policy -> Constr # dataTypeOf :: Policy -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Policy) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Policy) # gmapT :: (forall b. Data b => b -> b) -> Policy -> Policy # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Policy -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Policy -> r # gmapQ :: (forall d. Data d => d -> u) -> Policy -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Policy -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Policy -> m Policy # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Policy -> m Policy # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Policy -> m Policy # | |
Show Policy Source # | |
Generic Policy Source # | |
ToJSON Policy Source # | |
Defined in Network.Google.CloudTasks.Types.Product | |
FromJSON Policy Source # | |
type Rep Policy Source # | |
Defined in Network.Google.CloudTasks.Types.Product type Rep Policy = D1 (MetaData "Policy" "Network.Google.CloudTasks.Types.Product" "gogol-cloudtasks-0.4.0-JYw8G9RDcROAs8IJ376NEk" False) (C1 (MetaCons "Policy'" PrefixI True) (S1 (MetaSel (Just "_pEtag") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bytes)) :*: (S1 (MetaSel (Just "_pVersion") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int32))) :*: S1 (MetaSel (Just "_pBindings") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Binding]))))) |
pEtag :: Lens' Policy (Maybe ByteString) Source #
`etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly.
pBindings :: Lens' Policy [Binding] Source #
Associates a list of `members` to a `role`. `bindings` with no members will result in an error.
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.
RunTaskRequestResponseView
data RunTaskRequestResponseView Source #
The response_view specifies which subset of the Task will be returned. By default response_view is BASIC; not all information is retrieved by default because some data, such as payloads, might be desirable to return only when needed because of its large size or because of the sensitivity of data that it contains. Authorization for FULL requires `cloudtasks.tasks.fullView` Google IAM permission on the Task resource.
RTRRVViewUnspecified |
|
RTRRVBasic |
|
RTRRVFull |
|
Instances
AppEngineRouting
data AppEngineRouting Source #
App Engine Routing. Defines routing characteristics specific to App Engine - service, version, and instance. 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 task is sent to the service which is the default service when the task is attempted. For some queues or tasks which were created using the App Engine Task Queue API, host is not parsable into service, version, and instance. For example, some tasks which were created using the App Engine SDK use a custom domain name; custom domains are not parsed by Cloud Tasks. If host is not parsable, then service, version, and instance are the empty string.
aerVersion :: Lens' AppEngineRouting (Maybe Text) Source #
App version. By default, the task is sent to the version which is the default version when the task is attempted. For some queues or tasks which were created using the App Engine Task Queue API, host is not parsable into service, version, and instance. For example, some tasks which were created using the App Engine SDK use a custom domain name; custom domains are not parsed by Cloud Tasks. If host is not parsable, then service, version, and instance are the empty string.
aerHost :: Lens' AppEngineRouting (Maybe Text) Source #
Output only. The host that the task is sent to. The host is constructed from the domain name of the app associated with the queue's project ID (for example .appspot.com), and the service, version, and instance. Tasks which were created using the App Engine SDK might have a custom domain name. For more information, see How Requests are Routed.
aerInstance :: Lens' AppEngineRouting (Maybe Text) Source #
App instance. By default, the task is sent to an instance which is available when the task 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.
AppEngineHTTPRequest
data AppEngineHTTPRequest Source #
App Engine HTTP request. The message defines the HTTP request that is sent to an App Engine app when the task is dispatched. This proto can only be used for tasks in a queue which has app_engine_http_queue set. Using AppEngineHttpRequest requires `appengine.applications.get` Google IAM permission for the project and the following scope: `https://www.googleapis.com/auth/cloud-platform` The task will be delivered to the App Engine app which belongs to the same project as the queue. For more information, see How Requests are Routed and how routing is affected by dispatch files. Traffic is encrypted during transport and never leaves Google datacenters. Because this traffic is carried over a communication mechanism internal to Google, you cannot explicitly set the protocol (for example, HTTP or HTTPS). The request to the handler, however, will appear to have used the HTTP protocol. The AppEngineRouting used to construct the URL that the task is delivered to can be set at the queue-level or task-level: * If set, app_engine_routing_override is used for all tasks in the queue, no matter what the setting is for the task-level app_engine_routing. The `url` that the task will be sent to is: * `url =` host `+` relative_uri Tasks can be dispatched to secure app handlers, unsecure app handlers, and URIs restricted with `login: admin`. Because tasks are not run as any user, they cannot be dispatched to URIs restricted with `login: required` Task dispatches also do not follow redirects. The task attempt has succeeded if the app's request handler returns an HTTP response code in the range [`200` - `299`]. `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 is a failed attempt.
See: appEngineHTTPRequest
smart constructor.
Instances
appEngineHTTPRequest :: AppEngineHTTPRequest Source #
Creates a value of AppEngineHTTPRequest
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
aehttprHTTPMethod :: Lens' AppEngineHTTPRequest (Maybe AppEngineHTTPRequestHTTPMethod) Source #
The HTTP method to use for the request. The default is POST. The app's request handler for the task's target URL must be able to handle HTTP requests with this http_method, otherwise the task attempt will fail with error code 405 (Method Not Allowed). See Writing a push task request handler and the documentation for the request handlers in the language your app is written in e.g. Python Request Handler.
aehttprRelativeURI :: Lens' AppEngineHTTPRequest (Maybe Text) Source #
The relative URI. The relative URI must begin with "/" and must be a valid HTTP relative URI. It can contain a path and query string arguments. If the relative URI is empty, then the root path "/" will be used. No spaces are allowed, and the maximum length allowed is 2083 characters.
aehttprBody :: Lens' AppEngineHTTPRequest (Maybe ByteString) Source #
HTTP request body. A request body is allowed only if the HTTP method is POST or PUT. It is an error to set a body on a task with an incompatible HttpMethod.
aehttprHeaders :: Lens' AppEngineHTTPRequest (Maybe AppEngineHTTPRequestHeaders) Source #
HTTP request headers. This map contains the header field names and values. Headers can be set when the task is created. Repeated headers are not supported but a header value can contain commas. Cloud Tasks 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 Tasks will append `"AppEngine-Google; (+http://code.google.com/appengine)"` to the modified `User-Agent`. If the task has a body, Cloud Tasks sets the following headers: * `Content-Type`: By default, the `Content-Type` header is set to `"application/octet-stream"`. The default can be overridden by explicitly setting `Content-Type` to a particular media type when the task is created. For example, `Content-Type` can be set to `"application/json"`. * `Content-Length`: This is computed by Cloud Tasks. This value is output only. It cannot be changed. The headers below cannot be set or overridden: * `Host` * `X-Google-*` * `X-AppEngine-*` In addition, Cloud Tasks sets some headers when the task is dispatched, such as headers containing information about the task; see request headers. These headers are set only when the task is dispatched, so they are not visible when the task is returned in a Cloud Tasks response. Although there is no specific limit for the maximum number of headers or the size, there is a limit on the maximum size of the Task. For more information, see the CreateTask documentation.
aehttprAppEngineRouting :: Lens' AppEngineHTTPRequest (Maybe AppEngineRouting) Source #
Task-level setting for App Engine routing. If set, app_engine_routing_override is used for all tasks in the queue, no matter what the setting is for the task-level app_engine_routing.
ResumeQueueRequest
data ResumeQueueRequest Source #
Request message for ResumeQueue.
See: resumeQueueRequest
smart constructor.
Instances
resumeQueueRequest :: ResumeQueueRequest Source #
Creates a value of ResumeQueueRequest
with the minimum fields required to make a request.
Binding
Associates `members` with a `role`.
See: binding
smart constructor.
Instances
Eq Binding Source # | |
Data Binding Source # | |
Defined in Network.Google.CloudTasks.Types.Product gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Binding -> c Binding # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Binding # toConstr :: Binding -> Constr # dataTypeOf :: Binding -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Binding) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Binding) # gmapT :: (forall b. Data b => b -> b) -> Binding -> Binding # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Binding -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Binding -> r # gmapQ :: (forall d. Data d => d -> u) -> Binding -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Binding -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Binding -> m Binding # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Binding -> m Binding # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Binding -> m Binding # | |
Show Binding Source # | |
Generic Binding Source # | |
ToJSON Binding Source # | |
Defined in Network.Google.CloudTasks.Types.Product | |
FromJSON Binding Source # | |
type Rep Binding Source # | |
Defined in Network.Google.CloudTasks.Types.Product type Rep Binding = D1 (MetaData "Binding" "Network.Google.CloudTasks.Types.Product" "gogol-cloudtasks-0.4.0-JYw8G9RDcROAs8IJ376NEk" False) (C1 (MetaCons "Binding'" PrefixI True) (S1 (MetaSel (Just "_bMembers") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text])) :*: (S1 (MetaSel (Just "_bRole") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_bCondition") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Expr))))) |
Creates a value of Binding
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
bMembers :: Lens' Binding [Text] Source #
Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice'gmail.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app'appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins'example.com`. * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`.