Struct google_cloudscheduler1::HttpTarget

pub struct HttpTarget {
    pub body: Option<String>,
    pub headers: Option<HashMap<String, String>>,
    pub http_method: Option<String>,
    pub oidc_token: Option<OidcToken>,
    pub uri: Option<String>,
    pub oauth_token: Option<OAuthToken>,
}

Http target. The job will be pushed to the 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]. A failure to receive a response constitutes a failed execution. For a redirected request, the response returned by the redirected request is considered.

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

Fields

body: Option<String>

HTTP request body. A request body is allowed only if the HTTP method is POST, PUT, or PATCH. It is an error to set body on a job with an incompatible HttpMethod.

headers: Option<HashMap<String, String>>

The user can specify HTTP request headers to send with the job's HTTP request. This map contains the header field names and values. Repeated headers are not supported, but a header value can contain commas. These headers represent a subset of the headers that will accompany the job's HTTP request. Some HTTP request headers will be ignored or replaced. A partial list of headers that will be ignored or replaced is below:

• Host: This will be computed by Cloud Scheduler and derived from uri.

• Content-Length: This will be computed by Cloud Scheduler.
• User-Agent: This will be set to "Google-Cloud-Scheduler".
• X-Google-*: Google internal use only.
• X-AppEngine-*: Google internal use only.

The total size of headers must be less than 80KB.

http_method: Option<String>

Which HTTP method to use for the request.

oidc_token: Option<OidcToken>

If specified, an OIDC token will be generated and attached as an Authorization header in the HTTP request.

This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself.

uri: Option<String>

Required.

The full URI path that the request will be sent to. This string must begin with either "http://" or "https://". Some examples of valid values for uri are: http://acme.com and https://acme.com/sales:8080. Cloud Scheduler will encode some characters for safety and compatibility. The maximum allowed URL length is 2083 characters after encoding.

oauth_token: Option<OAuthToken>

If specified, an OAuth token will be generated and attached as an Authorization header in the HTTP request.

This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com.

Trait Implementations

impl Part for HttpTarget

impl Default for HttpTarget

fn default() -> HttpTarget

Returns the "default value" for a type.

impl Clone for HttpTarget

fn clone(&self) -> HttpTarget

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for HttpTarget

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

Formats the value using the given formatter.

impl Serialize for HttpTarget

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 HttpTarget

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

Deserialize this value from the given Serde deserializer.