pulumi-google-native-kotlin/com.pulumi.googlenative.cloudtasks.v2.kotlin.outputs

Package-level declarations

Types

data class AppEngineHttpRequestResponse(val appEngineRouting: AppEngineRoutingResponse, val body: String, val headers: Map<String, String>, val httpMethod: String, val relativeUri: String)

App Engine HTTP request. The message defines the HTTP request that is sent to an App Engine app when the task is dispatched. 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 app_engine_routing_override is set on the queue, this value 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`. The task attempt has failed if the app's handler returns a non-2xx response code or Cloud Tasks does not receive response before the deadline. Failed tasks will be retried according to the retry configuration. 503 (Service Unavailable) is considered an App Engine system error instead of an application error and will cause Cloud Tasks' traffic congestion control to temporarily throttle the queue's dispatches. Unlike other types of task targets, a 429 (Too Many Requests) response from an app handler does not cause traffic congestion control to throttle the queue.

AppEngineRoutingResponse

data class AppEngineRoutingResponse(val host: String, val instance: String, val service: String, val version: String)

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. Using AppEngineRouting requires appengine.applications.get Google IAM permission for the project and the following scope: https://www.googleapis.com/auth/cloud-platform

AttemptResponse

data class AttemptResponse(val dispatchTime: String, val responseStatus: StatusResponse, val responseTime: String, val scheduleTime: String)

The status of a task attempt.

BindingResponse

data class BindingResponse(val condition: ExprResponse, val members: List<String>, val role: String)

Associates members, or principals, with a role.

ExprResponse

data class ExprResponse(val description: String, val expression: String, val location: String, val title: String)

Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.

GetQueueIamPolicyResult

data class GetQueueIamPolicyResult(val bindings: List<BindingResponse>, val etag: String, val version: Int)

GetQueueResult

data class GetQueueResult(val appEngineRoutingOverride: AppEngineRoutingResponse, val name: String, val purgeTime: String, val rateLimits: RateLimitsResponse, val retryConfig: RetryConfigResponse, val stackdriverLoggingConfig: StackdriverLoggingConfigResponse, val state: String)

GetTaskResult

data class GetTaskResult(val appEngineHttpRequest: AppEngineHttpRequestResponse, val createTime: String, val dispatchCount: Int, val dispatchDeadline: String, val firstAttempt: AttemptResponse, val httpRequest: HttpRequestResponse, val lastAttempt: AttemptResponse, val name: String, val responseCount: Int, val scheduleTime: String, val view: String)

HttpRequestResponse

data class HttpRequestResponse(val body: String, val headers: Map<String, String>, val httpMethod: String, val oauthToken: OAuthTokenResponse, val oidcToken: OidcTokenResponse, val url: String)

HTTP request. The task will be pushed to the worker as an HTTP request. If the worker or the redirected worker acknowledges the task by returning a successful HTTP response code (`200` - `299`), the task will be removed from the queue. If any other HTTP response code is returned or no response is received, the task will be retried according to the following: * User-specified throttling: retry configuration, rate limits, and the queue's state. * System throttling: To prevent the worker from overloading, Cloud Tasks may temporarily reduce the queue's effective rate. User-specified settings will not be changed. System throttling happens because: * Cloud Tasks backs off on all errors. Normally the backoff specified in rate limits will be used. But if the worker returns 429 (Too Many Requests), 503 (Service Unavailable), or the rate of errors is high, Cloud Tasks will use a higher backoff rate. The retry specified in the Retry-After HTTP response header is considered. * To prevent traffic spikes and to smooth sudden increases in traffic, dispatches ramp up slowly when the queue is newly created or idle and if large numbers of tasks suddenly become available to dispatch (due to spikes in create task rates, the queue being unpaused, or many tasks that are scheduled at the same time).

OAuthTokenResponse

data class OAuthTokenResponse(val scope: String, val serviceAccountEmail: String)

Contains information needed for generating an OAuth token. This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com.

OidcTokenResponse

data class OidcTokenResponse(val audience: String, val serviceAccountEmail: String)

Contains information needed for generating an OpenID Connect token. This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself.

RateLimitsResponse

data class RateLimitsResponse(val maxBurstSize: Int, val maxConcurrentDispatches: Int, val maxDispatchesPerSecond: Double)

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.

RetryConfigResponse

data class RetryConfigResponse(val maxAttempts: Int, val maxBackoff: String, val maxDoublings: Int, val maxRetryDuration: String, val minBackoff: String)

Retry config. These settings determine when a failed task attempt is retried.

StackdriverLoggingConfigResponse

data class StackdriverLoggingConfigResponse(val samplingRatio: Double)

Configuration options for writing logs to Stackdriver Logging.

StatusResponse

data class StatusResponse(val code: Int, val details: List<Map<String, String>>, val message: String)

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. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.