Struct google_cloudscheduler1::AppEngineHttpTarget

pub struct AppEngineHttpTarget {
    pub body: Option<String>,
    pub headers: Option<HashMap<String, String>>,
    pub app_engine_routing: Option<AppEngineRouting>,
    pub relative_uri: Option<String>,
    pub http_method: Option<String>,
}

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.

This type is not used in any activity, and only used as part of another schema.

Fields

body: Option<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.

headers: Option<HashMap<String, String>>

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.

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.

app_engine_routing: Option<AppEngineRouting>

App Engine Routing setting for the job.

relative_uri: Option<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.

http_method: Option<String>

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

Trait Implementations

impl Part for AppEngineHttpTarget

impl Default for AppEngineHttpTarget

fn default() -> AppEngineHttpTarget

Returns the "default value" for a type.

impl Clone for AppEngineHttpTarget

fn clone(&self) -> AppEngineHttpTarget

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for AppEngineHttpTarget

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Serialize for AppEngineHttpTarget

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl<'de> Deserialize<'de> for AppEngineHttpTarget

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.