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.
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].
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.
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[[["\u003cp\u003eThe latest version of the \u003ccode\u003eAppEngineHttpTarget\u003c/code\u003e class in the Google Cloud Scheduler v1 API is version 3.5.0, with previous versions available for reference.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eAppEngineHttpTarget\u003c/code\u003e defines a target for a Cloud Scheduler job that dispatches an HTTP request to an App Engine job handler, and the request method can be set to HTTP POST, HTTP GET, or other similar methods.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eAppEngineHttpTarget\u003c/code\u003e class includes properties for setting routing, request body, headers, HTTP method, and relative URI, which enables customization of HTTP requests sent to the App Engine target.\u003c/p\u003e\n"],["\u003cp\u003eCloud Scheduler automatically sets certain headers in requests, such as \u003ccode\u003eUser-Agent\u003c/code\u003e, \u003ccode\u003eX-CloudScheduler\u003c/code\u003e, and \u003ccode\u003eContent-Type\u003c/code\u003e, with some being overridable and others reserved for internal use.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eAppEngineHttpTarget\u003c/code\u003e class inherits from \u003ccode\u003eobject\u003c/code\u003e and implements interfaces such as \u003ccode\u003eIMessage\u003c/code\u003e, \u003ccode\u003eIEquatable\u003c/code\u003e, \u003ccode\u003eIDeepCloneable\u003c/code\u003e, and \u003ccode\u003eIBufferMessage\u003c/code\u003e, providing functionalities for message handling, comparison, cloning, and buffering.\u003c/p\u003e\n"]]],[],null,["# Google Cloud Scheduler v1 API - Class AppEngineHttpTarget (3.5.0)\n\nVersion latestkeyboard_arrow_down\n\n- [3.5.0 (latest)](/dotnet/docs/reference/Google.Cloud.Scheduler.V1/latest/Google.Cloud.Scheduler.V1.AppEngineHttpTarget)\n- [3.4.0](/dotnet/docs/reference/Google.Cloud.Scheduler.V1/3.4.0/Google.Cloud.Scheduler.V1.AppEngineHttpTarget)\n- [3.3.0](/dotnet/docs/reference/Google.Cloud.Scheduler.V1/3.3.0/Google.Cloud.Scheduler.V1.AppEngineHttpTarget)\n- [3.2.0](/dotnet/docs/reference/Google.Cloud.Scheduler.V1/3.2.0/Google.Cloud.Scheduler.V1.AppEngineHttpTarget)\n- [3.1.0](/dotnet/docs/reference/Google.Cloud.Scheduler.V1/3.1.0/Google.Cloud.Scheduler.V1.AppEngineHttpTarget)\n- [3.0.0](/dotnet/docs/reference/Google.Cloud.Scheduler.V1/3.0.0/Google.Cloud.Scheduler.V1.AppEngineHttpTarget)\n- [2.3.0](/dotnet/docs/reference/Google.Cloud.Scheduler.V1/2.3.0/Google.Cloud.Scheduler.V1.AppEngineHttpTarget)\n- [2.2.0](/dotnet/docs/reference/Google.Cloud.Scheduler.V1/2.2.0/Google.Cloud.Scheduler.V1.AppEngineHttpTarget) \n\n public sealed class AppEngineHttpTarget : IMessage\u003cAppEngineHttpTarget\u003e, IEquatable\u003cAppEngineHttpTarget\u003e, IDeepCloneable\u003cAppEngineHttpTarget\u003e, IBufferMessage, IMessage\n\nReference documentation and code samples for the Google Cloud Scheduler v1 API class AppEngineHttpTarget.\n\nApp Engine target. The job will be pushed to a job handler by means\nof an HTTP request via an\n\\[http_method\\]\\[google.cloud.scheduler.v1.AppEngineHttpTarget.http_method\\] such\nas HTTP POST, HTTP GET, etc. The job is acknowledged by means of an\nHTTP response code in the range \\[200 - 299\\]. Error 503 is\nconsidered an App Engine system error instead of an application\nerror. Requests returning error 503 will be retried regardless of\nretry configuration and not counted against retry counts. Any other\nresponse code, or a failure to receive a response before the\ndeadline, constitutes a failed attempt. \n\nInheritance\n-----------\n\n[object](https://learn.microsoft.com/dotnet/api/system.object) \\\u003e AppEngineHttpTarget \n\nImplements\n----------\n\n[IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage-1.html)[AppEngineHttpTarget](/dotnet/docs/reference/Google.Cloud.Scheduler.V1/latest/Google.Cloud.Scheduler.V1.AppEngineHttpTarget), [IEquatable](https://learn.microsoft.com/dotnet/api/system.iequatable-1)[AppEngineHttpTarget](/dotnet/docs/reference/Google.Cloud.Scheduler.V1/latest/Google.Cloud.Scheduler.V1.AppEngineHttpTarget), [IDeepCloneable](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IDeepCloneable-1.html)[AppEngineHttpTarget](/dotnet/docs/reference/Google.Cloud.Scheduler.V1/latest/Google.Cloud.Scheduler.V1.AppEngineHttpTarget), [IBufferMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IBufferMessage.html), [IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage.html) \n\nInherited Members\n-----------------\n\n[object.GetHashCode()](https://learn.microsoft.com/dotnet/api/system.object.gethashcode) \n[object.GetType()](https://learn.microsoft.com/dotnet/api/system.object.gettype) \n[object.ToString()](https://learn.microsoft.com/dotnet/api/system.object.tostring)\n\nNamespace\n---------\n\n[Google.Cloud.Scheduler.V1](/dotnet/docs/reference/Google.Cloud.Scheduler.V1/latest/Google.Cloud.Scheduler.V1)\n\nAssembly\n--------\n\nGoogle.Cloud.Scheduler.V1.dll\n\nConstructors\n------------\n\n### AppEngineHttpTarget()\n\n public AppEngineHttpTarget()\n\n### AppEngineHttpTarget(AppEngineHttpTarget)\n\n public AppEngineHttpTarget(AppEngineHttpTarget other)\n\nProperties\n----------\n\n### AppEngineRouting\n\n public AppEngineRouting AppEngineRouting { get; set; }\n\nApp Engine Routing setting for the job.\n\n### Body\n\n public ByteString Body { get; set; }\n\nBody.\n\nHTTP request body. A request body is allowed only if the HTTP method is\nPOST or PUT. It will result in invalid argument error to set a body on a\njob with an incompatible\n\\[HttpMethod\\]\\[google.cloud.scheduler.v1.HttpMethod\\].\n\n### Headers\n\n public MapField\u003cstring, string\u003e Headers { get; }\n\nHTTP request headers.\n\nThis map contains the header field names and values. Headers can be set\nwhen the job is created.\n\nCloud Scheduler sets some headers to default values:\n\n- `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`.\n- `X-CloudScheduler`: This header will be set to true.\n- `X-CloudScheduler-JobName`: This header will contain the job name.\n- `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.\n\nIf the job has an\n\\[body\\]\\[google.cloud.scheduler.v1.AppEngineHttpTarget.body\\], Cloud Scheduler\nsets the following headers:\n\n- `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\"`.\n- `Content-Length`: This is computed by Cloud Scheduler. This value is output only. It cannot be changed.\n\nThe headers below are output only. They cannot be set or overridden:\n\n- `X-Google-*`: For Google internal use only.\n- `X-AppEngine-*`: For Google internal use only.\n\nIn addition, some App Engine headers, which contain\njob-specific information, are also be sent to the job handler.\n\n### HttpMethod\n\n public HttpMethod HttpMethod { get; set; }\n\nThe HTTP method to use for the request. PATCH and OPTIONS are not\npermitted.\n\n### RelativeUri\n\n public string RelativeUri { get; set; }\n\nThe relative URI.\n\nThe relative URL must begin with \"/\" and must be a valid HTTP relative URL.\nIt can contain a path, query string arguments, and `#` fragments.\nIf the relative URL is empty, then the root path \"/\" will be used.\nNo spaces are allowed, and the maximum length allowed is 2083 characters."]]
