Reference documentation and code samples for the Cloud Scheduler V1 Client class AppEngineHttpTarget.
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.
Generated from protobuf message google.cloud.scheduler.v1.AppEngineHttpTarget
Namespace
Google \ Cloud \ Scheduler \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ http_method
int
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.
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 a body and the following headers are not set by the user, Cloud Scheduler sets default values: * * Content-Type: This will be set to "application/octet-stream". You can override this default by explicitly setting Content-Type to a particular media type when creating the job. For example, you can set Content-Type to "application/json". The headers below are output only. They cannot be set or overridden: * * Content-Length: This is computed by Cloud Scheduler. * * 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.
↳ body
string
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.
getHttpMethod
The HTTP method to use for the request. PATCH and OPTIONS are not
permitted.
Returns
Type
Description
int
setHttpMethod
The HTTP method to use for the request. PATCH and OPTIONS are not
permitted.
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.
Returns
Type
Description
string
setRelativeUri
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.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getHeaders
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 a body
and the following headers are not set by the user, Cloud Scheduler sets
default values:
Content-Type: This will be set to "application/octet-stream". You
can override this default by explicitly setting Content-Type to a
particular media type when creating the job. For example, you can set
Content-Type to "application/json".
The headers below are output only. They cannot be set or overridden:
Content-Length: This is computed by Cloud Scheduler.
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.
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 a body
and the following headers are not set by the user, Cloud Scheduler sets
default values:
Content-Type: This will be set to "application/octet-stream". You
can override this default by explicitly setting Content-Type to a
particular media type when creating the job. For example, you can set
Content-Type to "application/json".
The headers below are output only. They cannot be set or overridden:
Content-Length: This is computed by Cloud Scheduler.
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.
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.
Returns
Type
Description
string
setBody
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.
[[["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."],[],[],null,["# Cloud Scheduler V1 Client - Class AppEngineHttpTarget (2.0.5)\n\nVersion latestkeyboard_arrow_down\n\n- [2.0.5 (latest)](/php/docs/reference/cloud-scheduler/latest/V1.AppEngineHttpTarget)\n- [2.0.4](/php/docs/reference/cloud-scheduler/2.0.4/V1.AppEngineHttpTarget)\n- [1.10.5](/php/docs/reference/cloud-scheduler/1.10.5/V1.AppEngineHttpTarget)\n- [1.9.4](/php/docs/reference/cloud-scheduler/1.9.4/V1.AppEngineHttpTarget)\n- [1.8.3](/php/docs/reference/cloud-scheduler/1.8.3/V1.AppEngineHttpTarget)\n- [1.7.1](/php/docs/reference/cloud-scheduler/1.7.1/V1.AppEngineHttpTarget)\n- [1.6.8](/php/docs/reference/cloud-scheduler/1.6.8/V1.AppEngineHttpTarget) \nReference documentation and code samples for the Cloud Scheduler V1 Client 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](/php/docs/reference/cloud-scheduler/latest/V1.AppEngineHttpTarget#_Google_Cloud_Scheduler_V1_AppEngineHttpTarget__getHttpMethod__) 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\nGenerated from protobuf message `google.cloud.scheduler.v1.AppEngineHttpTarget`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Scheduler \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getHttpMethod\n\nThe HTTP method to use for the request. PATCH and OPTIONS are not\npermitted.\n\n### setHttpMethod\n\nThe HTTP method to use for the request. PATCH and OPTIONS are not\npermitted.\n\n### getAppEngineRouting\n\nApp Engine Routing setting for the job.\n\n### hasAppEngineRouting\n\n### clearAppEngineRouting\n\n### setAppEngineRouting\n\nApp Engine Routing setting for the job.\n\n### getRelativeUri\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.\n\n### setRelativeUri\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.\n\n### getHeaders\n\nHTTP request headers.\n\nThis map contains the header field names and values. Headers can be set\nwhen the job is created.\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. If the job has a [body](/php/docs/reference/cloud-scheduler/latest/V1.AppEngineHttpTarget#_Google_Cloud_Scheduler_V1_AppEngineHttpTarget__getBody__) and the following headers are not set by the user, Cloud Scheduler sets default values:\n- `Content-Type`: This will be set to `\"application/octet-stream\"`. You can override this default by explicitly setting `Content-Type` to a particular media type when creating the job. For example, you can set `Content-Type` to `\"application/json\"`. The headers below are output only. They cannot be set or overridden:\n- `Content-Length`: This is computed by Cloud Scheduler.\n- `X-Google-*`: For Google internal use only.\n- `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.\n\n### setHeaders\n\nHTTP request headers.\n\nThis map contains the header field names and values. Headers can be set\nwhen the job is created.\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. If the job has a [body](/php/docs/reference/cloud-scheduler/latest/V1.AppEngineHttpTarget#_Google_Cloud_Scheduler_V1_AppEngineHttpTarget__getBody__) and the following headers are not set by the user, Cloud Scheduler sets default values:\n- `Content-Type`: This will be set to `\"application/octet-stream\"`. You can override this default by explicitly setting `Content-Type` to a particular media type when creating the job. For example, you can set `Content-Type` to `\"application/json\"`. The headers below are output only. They cannot be set or overridden:\n- `Content-Length`: This is computed by Cloud Scheduler.\n- `X-Google-*`: For Google internal use only.\n- `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.\n\n### getBody\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](/php/docs/reference/cloud-scheduler/latest/V1.HttpMethod).\n\n### setBody\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](/php/docs/reference/cloud-scheduler/latest/V1.HttpMethod)."]]
