Cloud Scheduler V1 Client - Class AppEngineHttpTarget (2.0.1)

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.
↳ app_engine_routing AppEngineRouting

App Engine Routing setting for the job.
↳ relative_uri string

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.
↳ headers array|Google\Protobuf\Internal\MapField

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, 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.
↳ 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.

Parameter
Name Description
var int
Returns
Type Description
$this

getAppEngineRouting

App Engine Routing setting for the job.

Returns
Type Description
AppEngineRouting|null

hasAppEngineRouting

clearAppEngineRouting

setAppEngineRouting

App Engine Routing setting for the job.

Parameter
Name Description
var AppEngineRouting
Returns
Type Description
$this

getRelativeUri

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.

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 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.
Returns
Type Description
Google\Protobuf\Internal\MapField

setHeaders

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, 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.
Parameter
Name Description
var array|Google\Protobuf\Internal\MapField
Returns
Type Description
$this

getBody

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.

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.

Parameter
Name Description
var string
Returns
Type Description
$this