Package-level declarations

Types

Link copied to clipboard
data class AppEngineHttpTargetResponse(val appEngineRouting: AppEngineRoutingResponse, val body: String, val headers: Map<String, String>, val httpMethod: String, val relativeUri: String)

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.

Link copied to clipboard
data class AppEngineRoutingResponse(val host: String, val instance: String, val service: String, val version: String)

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.

Link copied to clipboard
data class GetJobResult(val appEngineHttpTarget: AppEngineHttpTargetResponse, val attemptDeadline: String, val description: String, val httpTarget: HttpTargetResponse, val lastAttemptTime: String, val legacyAppEngineCron: Boolean, val name: String, val pubsubTarget: PubsubTargetResponse, val retryConfig: RetryConfigResponse, val schedule: String, val scheduleTime: String, val state: String, val status: StatusResponse, val timeZone: String, val userUpdateTime: String)
Link copied to clipboard
data class HttpTargetResponse(val body: String, val headers: Map<String, String>, val httpMethod: String, val oauthToken: OAuthTokenResponse, val oidcToken: OidcTokenResponse, val uri: String)

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.

Link copied to clipboard
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.

Link copied to clipboard
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.

Link copied to clipboard
data class PubsubTargetResponse(val attributes: Map<String, String>, val data: String, val topicName: String)

Pub/Sub target. The job will be delivered by publishing a message to the given Pub/Sub topic.

Link copied to clipboard
data class RetryConfigResponse(val maxBackoffDuration: String, val maxDoublings: Int, val maxRetryDuration: String, val minBackoffDuration: String, val retryCount: Int)

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.

Link copied to clipboard
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.