Default request referring to version v1beta1 of the Cloud Scheduler API. This contains the host and root path used as a starting point for constructing service requests.

View and manage your data across Google Cloud Platform services

Represents the entirety of the methods and resources available for the Cloud Scheduler API service.

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.

Creates a value of Status with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• sDetails
• sCode
• sMessage

A list of messages that carry the error details. There is a common set of message types for APIs to use.

The status code, which should be an enum value of google.rpc.Code.

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.

Request message for PauseJob.

See: pauseJobRequest smart constructor.

Creates a value of PauseJobRequest with the minimum fields required to make a request.

The response message for Locations.ListLocations.

See: listLocationsResponse smart constructor.

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
• llrLocations

The standard List next-page token.

A list of locations that matches the specified filter in the request.

Request message for ResumeJob.

See: resumeJobRequest smart constructor.

Creates a value of ResumeJobRequest with the minimum fields required to make a request.

HTTP request headers. This map contains the header field names and values. Headers can be set when the job is created. Cloud Scheduler 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 Scheduler will append `"AppEngine-Google; (+http://code.google.com/appengine)"` to the modified `User-Agent`. * `X-CloudScheduler`: This header will be set to true. If the job has an body, Cloud Scheduler sets the following headers: * `Content-Type`: By default, the `Content-Type` header is set to `"application/octet-stream"`. The default can be overridden by explictly setting `Content-Type` to a particular media type when the job is created. For example, `Content-Type` can be set to `"application/json"`. * `Content-Length`: This is computed by Cloud Scheduler. This value is output only. It cannot be changed. The headers below are output only. They cannot be set or overridden: * `X-Google-*`: For Google internal use only. * `X-AppEngine-*`: For Google internal use only. In addition, some App Engine headers, which contain job-specific information, are also be sent to the job handler.

See: appEngineHTTPTargetHeaders smart constructor.

Creates a value of AppEngineHTTPTargetHeaders with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• aehttpthAddtional

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.

See: retryConfig smart constructor.

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
• rcMaxRetryDuration
• rcMinBackoffDuration
• rcRetryCount
• rcMaxBackoffDuration

The time between retries will double `max_doublings` times. A job's retry interval starts at min_backoff_duration, then doubles `max_doublings` times, then increases linearly, and finally retries retries at intervals of max_backoff_duration up to retry_count times. For example, if min_backoff_duration is 10s, max_backoff_duration is 300s, and `max_doublings` is 3, then the a job will first be retried in 10s. The retry interval will double three times, and then increase linearly by 2^3 * 10s. Finally, the job will retry at intervals of max_backoff_duration until the job has been attempted retry_count times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, .... The default value of this field is 5.

The time limit for retrying a failed job, measured from time when an execution was first attempted. If specified with retry_count, the job will be retried until both limits are reached. The default value for max_retry_duration is zero, which means retry duration is unlimited.

The minimum amount of time to wait before retrying a job after it fails. The default value of this field is 5 seconds.

The number of attempts that the system will make to run a job using the exponential backoff procedure described by max_doublings. The default value of retry_count is zero. If retry_count is zero, a job attempt will *not* be retried if it fails. Instead the Cloud Scheduler system will wait for the next scheduled execution time. If retry_count is set to a non-zero number then Cloud Scheduler will retry failed attempts, using exponential backoff, retry_count times, or until the next scheduled execution time, whichever comes first. Values greater than 5 and negative values are not allowed.

The maximum amount of time to wait before retrying a job after it fails. The default value of this field is 1 hour.

A resource that represents Google Cloud Platform location.

See: location smart constructor.

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
• lMetadata
• lDisplayName
• lLabels
• lLocationId

Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"`

Service-specific metadata. For example the available capacity at the given location.

The friendly name for this location, typically a nearby city name. For example, "Tokyo".

Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"}

The canonical id for this location. For example: `"us-east1"`.

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.

Creates a value of Empty with the minimum fields required to make a request.

Attributes for PubsubMessage. Pubsub message must contain either non-empty data, or at least one attribute.

See: pubsubTargetAttributes smart constructor.

Creates a value of PubsubTargetAttributes with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• ptaAddtional

The user can specify HTTP request headers to send with the job's HTTP request. This map contains the header field names and values. Repeated headers are not supported, but a header value can contain commas. These headers represent a subset of the headers that will accompany the job's HTTP request. Some HTTP request headers will be ignored or replaced. A partial list of headers that will be ignored or replaced is below: - Host: This will be computed by Cloud Scheduler and derived from uri. * `Content-Length`: This will be computed by Cloud Scheduler. * `User-Agent`: This will be set to `"Google-Cloud-Scheduler"`. * `X-Google-*`: Google internal use only. * `X-AppEngine-*`: Google internal use only. The total size of headers must be less than 80KB.

See: hTTPTargetHeaders smart constructor.

Creates a value of HTTPTargetHeaders with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• httpthAddtional

A message that is published by publishers and consumed by subscribers. The message must contain either a non-empty data field or at least one attribute. Note that client libraries represent this object differently depending on the language. See the corresponding client library documentation for more information. See Quotas and limits for more information about message limits.

See: pubsubMessage smart constructor.

Creates a value of PubsubMessage with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• pmData
• pmPublishTime
• pmAttributes
• pmMessageId

The message data field. If this field is empty, the message must contain at least one attribute.

The time at which the message was published, populated by the server when it receives the `Publish` call. It must not be populated by the publisher in a `Publish` call.

Optional attributes for this message.

ID of this message, assigned by the server when the message is published. Guaranteed to be unique within the topic. This value may be read by a subscriber that receives a `PubsubMessage` via a `Pull` call or a push delivery. It must not be populated by the publisher in a `Publish` call.

Output only. State of the job.

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

Properties of the object. Contains field 'type with type URL.

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.

See: appEngineHTTPTarget smart constructor.

Creates a value of AppEngineHTTPTarget with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• aehttptHTTPMethod
• aehttptRelativeURI
• aehttptBody
• aehttptHeaders
• aehttptAppEngineRouting

The HTTP method to use for the request. PATCH and OPTIONS are not permitted.

The relative URI. The relative URL must begin with "/" and must be a valid HTTP relative URL. It can contain a path, query string arguments, and `#` fragments. If the relative URL is empty, then the root path "/" will be used. No spaces are allowed, and the maximum length allowed is 2083 characters.

Body. HTTP request body. A request body is allowed only if the HTTP method is POST or PUT. It will result in invalid argument error to set a body on a job with an incompatible HttpMethod.

HTTP request headers. This map contains the header field names and values. Headers can be set when the job is created. Cloud Scheduler 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 Scheduler will append `"AppEngine-Google; (+http://code.google.com/appengine)"` to the modified `User-Agent`. * `X-CloudScheduler`: This header will be set to true. If the job has an body, Cloud Scheduler sets the following headers: * `Content-Type`: By default, the `Content-Type` header is set to `"application/octet-stream"`. The default can be overridden by explictly setting `Content-Type` to a particular media type when the job is created. For example, `Content-Type` can be set to `"application/json"`. * `Content-Length`: This is computed by Cloud Scheduler. This value is output only. It cannot be changed. The headers below are output only. They cannot be set or overridden: * `X-Google-*`: For Google internal use only. * `X-AppEngine-*`: For Google internal use only. In addition, some App Engine headers, which contain job-specific information, are also be sent to the job handler.

App Engine Routing setting for the job.

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.

See: hTTPTarget smart constructor.

Creates a value of HTTPTarget with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• httptHTTPMethod
• httptBody
• httptURI
• httptHeaders

Which HTTP method to use for the request.

HTTP request body. A request body is allowed only if the HTTP method is POST, PUT, or PATCH. It is an error to set body on a job with an incompatible HttpMethod.

Required. The full URI path that the request will be sent to. This string must begin with either "http://" or "https://". Some examples of valid values for uri are: `http://acme.com` and `https://acme.com/sales:8080`. Cloud Scheduler will encode some characters for safety and compatibility. The maximum allowed URL length is 2083 characters after encoding.

The user can specify HTTP request headers to send with the job's HTTP request. This map contains the header field names and values. Repeated headers are not supported, but a header value can contain commas. These headers represent a subset of the headers that will accompany the job's HTTP request. Some HTTP request headers will be ignored or replaced. A partial list of headers that will be ignored or replaced is below: - Host: This will be computed by Cloud Scheduler and derived from uri. * `Content-Length`: This will be computed by Cloud Scheduler. * `User-Agent`: This will be set to `"Google-Cloud-Scheduler"`. * `X-Google-*`: Google internal use only. * `X-AppEngine-*`: Google internal use only. The total size of headers must be less than 80KB.

Request message for forcing a job to run now using RunJob.

See: runJobRequest smart constructor.

Creates a value of RunJobRequest with the minimum fields required to make a request.

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

See: job smart constructor.

Creates a value of Job with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• jStatus
• jState
• jLastAttemptTime
• jRetryConfig
• jSchedule
• jScheduleTime
• jAppEngineHTTPTarget
• jHTTPTarget
• jName
• jPubsubTarget
• jUserUpdateTime
• jTimeZone
• jDescription

Output only. The response from the target for the last attempted execution.

Output only. State of the job.

Output only. The time the last job attempt started.

Settings that determine the retry behavior.

Required. Describes the schedule on which the job will be executed. As a general rule, execution `n + 1` of a job will not begin until execution `n` has finished. Cloud Scheduler will never allow two simultaneously outstanding executions. For example, this implies that if the `n+1`th execution is scheduled to run at 16:00 but the `n`th execution takes until 16:15, the `n+1`th execution will not start until `16:15`. A scheduled start time will be delayed if the previous execution has not ended when its scheduled time occurs. If retry_count > 0 and a job attempt fails, the job will be tried a total of retry_count times, with exponential backoff, until the next scheduled start time. The schedule can be either of the following types: * Crontab * English-like schedule