Google Cloud Scheduler v1 API - Class AppEngineHttpTarget (3.3.0) 

public sealed class AppEngineHttpTarget : IMessage<AppEngineHttpTarget>, IEquatable<AppEngineHttpTarget>, IDeepCloneable<AppEngineHttpTarget>, IBufferMessage, IMessage

Reference documentation and code samples for the Google Cloud Scheduler v1 API class 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.

Inheritance

object > AppEngineHttpTarget

Namespace

Google.Cloud.Scheduler.V1

Assembly

Google.Cloud.Scheduler.V1.dll

Constructors

AppEngineHttpTarget()

public AppEngineHttpTarget()

AppEngineHttpTarget(AppEngineHttpTarget)

public AppEngineHttpTarget(AppEngineHttpTarget other)
Parameter
NameDescription
otherAppEngineHttpTarget

Properties

AppEngineRouting

public AppEngineRouting AppEngineRouting { get; set; }

App Engine Routing setting for the job.

Property Value
TypeDescription
AppEngineRouting

Body

public ByteString Body { get; set; }

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][google.cloud.scheduler.v1.HttpMethod].

Property Value
TypeDescription
ByteString

Headers

public MapField<string, string> Headers { get; }

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.
  • X-CloudScheduler-JobName: This header will contain the job name.
  • X-CloudScheduler-ScheduleTime: For Cloud Scheduler jobs specified in the unix-cron format, this header will contain the job schedule as an offset of UTC parsed according to RFC3339.

If the job has an [body][google.cloud.scheduler.v1.AppEngineHttpTarget.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.

Property Value
TypeDescription
MapFieldstringstring

HttpMethod

public HttpMethod HttpMethod { get; set; }

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

Property Value
TypeDescription
HttpMethod

RelativeUri

public string RelativeUri { get; set; }

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.

Property Value
TypeDescription
string