Namespace Google.Cloud.Scheduler.V1 (2.2.0)

Classes

AppEngineHttpTarget

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.v1.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.

AppEngineRouting

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.

CloudScheduler

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

CloudScheduler.CloudSchedulerBase

Base class for server-side implementations of CloudScheduler

CloudScheduler.CloudSchedulerClient

Client for CloudScheduler

CloudSchedulerClient

CloudScheduler client wrapper, for convenient use.

CloudSchedulerClientBuilder

Builder class for CloudSchedulerClient to provide simple configuration of credentials, endpoint etc.

CloudSchedulerClientImpl

CloudScheduler client wrapper implementation, for convenient use.

CloudSchedulerSettings

Settings for CloudSchedulerClient instances.

CreateJobRequest

Request message for [CreateJob][google.cloud.scheduler.v1.CloudScheduler.CreateJob].

DeleteJobRequest

Request message for deleting a job using [DeleteJob][google.cloud.scheduler.v1.CloudScheduler.DeleteJob].

GetJobRequest

Request message for [GetJob][google.cloud.scheduler.v1.CloudScheduler.GetJob].

HttpTarget

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

Job

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

Job.Types

Container for nested types declared in the Job message type.

JobName

Resource name for the Job resource.

ListJobsRequest

Request message for listing jobs using [ListJobs][google.cloud.scheduler.v1.CloudScheduler.ListJobs].

ListJobsResponse

Response message for listing jobs using [ListJobs][google.cloud.scheduler.v1.CloudScheduler.ListJobs].

OAuthToken

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.

OidcToken

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.

PauseJobRequest

Request message for [PauseJob][google.cloud.scheduler.v1.CloudScheduler.PauseJob].

PubsubTarget

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

ResumeJobRequest

Request message for [ResumeJob][google.cloud.scheduler.v1.CloudScheduler.ResumeJob].

RetryConfig

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.v1.RetryConfig].

RunJobRequest

Request message for forcing a job to run now using [RunJob][google.cloud.scheduler.v1.CloudScheduler.RunJob].

TopicName

Resource name for the Topic resource.

UpdateJobRequest

Request message for [UpdateJob][google.cloud.scheduler.v1.CloudScheduler.UpdateJob].

Enums

HttpMethod

The HTTP method used to execute the job.

HttpTarget.AuthorizationHeaderOneofCase

Enum of possible cases for the "authorization_header" oneof.

Job.TargetOneofCase

Enum of possible cases for the "target" oneof.

Job.Types.State

State of the job.

JobName.ResourceNameType

The possible contents of JobName.

TopicName.ResourceNameType

The possible contents of TopicName.