package google.cloud.scheduler.v1beta1

Mouse Melon logoGet desktop application:
View/edit binary Protocol Buffers messages

service CloudScheduler

cloudscheduler.proto:36

The Cloud Scheduler API allows external entities to reliably schedule asynchronous jobs.

message AppEngineHttpTarget

target.proto:103

App Engine target. The job will be pushed to a job handler by means of an HTTP request via an [http_method][google.cloud.scheduler.v1beta1.AppEngineHttpTarget.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.

Used in: Job

message AppEngineRouting

target.proto:199

App Engine Routing. For more information about services, versions, and instances see [An Overview of App Engine](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine), [Microservices Architecture on Google App Engine](https://cloud.google.com/appengine/docs/python/microservices-on-app-engine), [App Engine Standard request routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed), and [App Engine Flex request routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).

Used in: AppEngineHttpTarget

enum HttpMethod

target.proto:289

The HTTP method used to execute the job.

Used in: AppEngineHttpTarget, HttpTarget

message HttpTarget

target.proto:34

Http target. The job will be pushed to the job handler by means of an HTTP request via an [http_method][google.cloud.scheduler.v1beta1.HttpTarget.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.

Used in: Job

message Job

job.proto:34

Configuration for a job. The maximum allowed size for a job is 100KB.

Used as response type in: CloudScheduler.CreateJob, CloudScheduler.GetJob, CloudScheduler.PauseJob, CloudScheduler.ResumeJob, CloudScheduler.RunJob, CloudScheduler.UpdateJob

Used as field type in: CreateJobRequest, ListJobsResponse, UpdateJobRequest

enum Job.State

job.proto:41

State of the job.

Used in: Job

message OAuthToken

target.proto:319

Contains information needed for generating an [OAuth token](https://developers.google.com/identity/protocols/OAuth2). This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com.

Used in: HttpTarget

message OidcToken

target.proto:338

Contains information needed for generating an [OpenID Connect token](https://developers.google.com/identity/protocols/OpenIDConnect). This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself.

Used in: HttpTarget

message PubsubTarget

target.proto:163

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

Used in: Job

message RetryConfig

job.proto:179

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][google.cloud.scheduler.v1beta1.RetryConfig].

Used in: Job