Struct google_api_proto::google::cloud::scheduler::v1beta1::AppEngineHttpTarget

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

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.v1beta1.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.

Fields

http_method: i32

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

app_engine_routing: Option<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: BTreeMap<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.
• 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.v1beta1.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.

body: Bytes

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.v1beta1.HttpMethod].

Implementations

impl AppEngineHttpTarget

pub fn http_method(&self) -> HttpMethod

Returns the enum value of http_method, or the default if the field is set to an invalid enum value.

pub fn set_http_method(&mut self, value: HttpMethod)

Sets http_method to the provided enum value.

Trait Implementations

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 Default for AppEngineHttpTarget

fn default() -> Self

Returns the “default value” for a type.

impl Message for AppEngineHttpTarget

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for AppEngineHttpTarget

fn eq(&self, other: &AppEngineHttpTarget) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for AppEngineHttpTarget