Struct HttpTarget 

#[non_exhaustive]
pub struct HttpTarget {
    pub uri_override: Option<UriOverride>,
    pub http_method: HttpMethod,
    pub header_overrides: Vec<HeaderOverride>,
    pub authorization_header: Option<AuthorizationHeader>,
    /* private fields */
}

HTTP target.

When specified at the Queue level, all tasks with HttpRequest are overridden according to the target.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

uri_override: Option<UriOverride>

URI override.

When specified, overrides the execution URI for all the tasks in the queue.

http_method: HttpMethod

The HTTP method to use for the request.

When specified, it overrides HttpRequest for the task. Note that if the value is set to [HttpMethod][GET] the [HttpRequest][body] of the task will be ignored at execution time.

header_overrides: Vec<HeaderOverride>

HTTP target headers.

This map contains the header field names and values. Headers will be set when running the CreateTask and/or [BufferTask][google.cloud.tasks.v2.CloudTasks.BufferTask].

These headers represent a subset of the headers that will be configured for the task’s HTTP request. Some HTTP request headers will be ignored or replaced.

A partial list of headers that will be ignored or replaced is:

• Several predefined headers, prefixed with “X-CloudTasks-”, can be used to define properties of the task.
• Host: This will be computed by Cloud Tasks and derived from [HttpRequest.url][google.cloud.tasks.v2.Target.HttpRequest.url].
• Content-Length: This will be computed by Cloud Tasks.

Content-Type won’t be set by Cloud Tasks. You can explicitly set Content-Type to a media type when the task is created. For example, Content-Type can be set to "application/octet-stream" or "application/json". The default value is set to "application/json".

• User-Agent: This will be set to "Google-Cloud-Tasks".

Headers which can have multiple values (according to RFC2616) can be specified using comma-separated values.

The size of the headers must be less than 80KB. Queue-level headers to override headers of all the tasks in the queue.

Do not put business sensitive or personally identifying data in the HTTP Header Override Configuration or other similar fields in accordance with Section 12 (Resource Fields) of the Service Specific Terms.

authorization_header: Option<AuthorizationHeader>

The mode for generating an Authorization header for HTTP requests.

If specified, all Authorization headers in the HttpRequest.headers field are overridden.

Implementations

impl HttpTarget

pub fn new() -> Self

Creates a new default instance.

pub fn set_uri_override<T>(self, v: T) -> Self

where T: Into<UriOverride>,

Sets the value of uri_override.

Example

use google_cloud_tasks_v2::model::UriOverride;
let x = HttpTarget::new().set_uri_override(UriOverride::default()/* use setters */);

pub fn set_or_clear_uri_override<T>(self, v: Option<T>) -> Self

where T: Into<UriOverride>,

Sets or clears the value of uri_override.

Example

use google_cloud_tasks_v2::model::UriOverride;
let x = HttpTarget::new().set_or_clear_uri_override(Some(UriOverride::default()/* use setters */));
let x = HttpTarget::new().set_or_clear_uri_override(None::<UriOverride>);

pub fn set_http_method<T: Into<HttpMethod>>(self, v: T) -> Self

Sets the value of http_method.

Example

use google_cloud_tasks_v2::model::HttpMethod;
let x0 = HttpTarget::new().set_http_method(HttpMethod::Post);
let x1 = HttpTarget::new().set_http_method(HttpMethod::Get);
let x2 = HttpTarget::new().set_http_method(HttpMethod::Head);

pub fn set_header_overrides<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<HeaderOverride>,

Sets the value of header_overrides.

Example

use google_cloud_tasks_v2::model::http_target::HeaderOverride;
let x = HttpTarget::new()
    .set_header_overrides([
        HeaderOverride::default()/* use setters */,
        HeaderOverride::default()/* use (different) setters */,
    ]);

pub fn set_authorization_header<T: Into<Option<AuthorizationHeader>>>( self, v: T, ) -> Self

Sets the value of authorization_header.

Note that all the setters affecting authorization_header are mutually exclusive.

Example

use google_cloud_tasks_v2::model::OAuthToken;
let x = HttpTarget::new().set_authorization_header(Some(
    google_cloud_tasks_v2::model::http_target::AuthorizationHeader::OauthToken(OAuthToken::default().into())));

pub fn oauth_token(&self) -> Option<&Box<OAuthToken>>

The value of authorization_header if it holds a OauthToken, None if the field is not set or holds a different branch.

pub fn set_oauth_token<T: Into<Box<OAuthToken>>>(self, v: T) -> Self

Sets the value of authorization_header to hold a OauthToken.

Note that all the setters affecting authorization_header are mutually exclusive.

Example

use google_cloud_tasks_v2::model::OAuthToken;
let x = HttpTarget::new().set_oauth_token(OAuthToken::default()/* use setters */);
assert!(x.oauth_token().is_some());
assert!(x.oidc_token().is_none());

pub fn oidc_token(&self) -> Option<&Box<OidcToken>>

The value of authorization_header if it holds a OidcToken, None if the field is not set or holds a different branch.

pub fn set_oidc_token<T: Into<Box<OidcToken>>>(self, v: T) -> Self

Sets the value of authorization_header to hold a OidcToken.

Note that all the setters affecting authorization_header are mutually exclusive.

Example

use google_cloud_tasks_v2::model::OidcToken;
let x = HttpTarget::new().set_oidc_token(OidcToken::default()/* use setters */);
assert!(x.oidc_token().is_some());
assert!(x.oauth_token().is_none());

Trait Implementations

impl Clone for HttpTarget

fn clone(&self) -> Self

Returns a duplicate 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 Default for HttpTarget

fn default() -> Self

Returns the “default value” for a type.

impl Message for HttpTarget

fn typename() -> &'static str

The typename of this message.

impl PartialEq for HttpTarget

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for HttpTarget