GoogleApi.CloudScheduler.V1.Model.AppEngineHttpTarget (google_api_cloud_scheduler v0.7.2) View Source

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.


  • appEngineRouting (type: GoogleApi.CloudScheduler.V1.Model.AppEngineRouting.t, default: nil) - App Engine Routing setting for the job.
  • body (type: String.t, default: nil) - 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.
  • headers (type: map(), default: nil) - 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; (+". This header can be modified, but Cloud Scheduler will append "AppEngine-Google; (+" 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.
  • httpMethod (type: String.t, default: nil) - The HTTP method to use for the request. PATCH and OPTIONS are not permitted.
  • relativeUri (type: String.t, default: nil) - 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.

Link to this section Summary


Unwrap a decoded JSON object into its complex fields.

Link to this section Types


t() :: %GoogleApi.CloudScheduler.V1.Model.AppEngineHttpTarget{
    GoogleApi.CloudScheduler.V1.Model.AppEngineRouting.t() | nil,
  body: String.t() | nil,
  headers: map() | nil,
  httpMethod: String.t() | nil,
  relativeUri: String.t() | nil

Link to this section Functions


decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.