Struct UrlMap 

#[non_exhaustive]
pub struct UrlMap {

    pub creation_timestamp: Option<String>,
    pub default_custom_error_response_policy: Option<CustomErrorResponsePolicy>,
    pub default_route_action: Option<HttpRouteAction>,
    pub default_service: Option<String>,
    pub default_url_redirect: Option<HttpRedirectAction>,
    pub description: Option<String>,
    pub fingerprint: Option<Bytes>,
    pub header_action: Option<HttpHeaderAction>,
    pub host_rules: Vec<HostRule>,
    pub id: Option<u64>,
    pub kind: Option<String>,
    pub name: Option<String>,
    pub path_matchers: Vec<PathMatcher>,
    pub region: Option<String>,
    pub self_link: Option<String>,
    pub tests: Vec<UrlMapTest>,
    /* private fields */
}

Available on crate features region-url-maps or url-maps only.

Represents a URL Map resource.

Compute Engine has two URL Map resources:

• Global
• Regional

A URL map resource is a component of certain types of cloud load balancers and Traffic Director:

• urlMaps are used by global external Application Load Balancers, classic Application Load Balancers, and cross-region internal Application Load Balancers.
• regionUrlMaps are used by internal Application Load Balancers, regional external Application Load Balancers and regional internal Application Load Balancers.

For a list of supported URL map features by the load balancer type, see the Load balancing features: Routing and traffic management table.

For a list of supported URL map features for Traffic Director, see the Traffic Director features: Routing and traffic management table.

This resource defines mappings from hostnames and URL paths to either a backend service or a backend bucket.

To use the global urlMaps resource, the backend service must have a loadBalancingScheme of either EXTERNAL,EXTERNAL_MANAGED, or INTERNAL_SELF_MANAGED. To use the regionUrlMaps resource, the backend service must have aloadBalancingScheme of INTERNAL_MANAGED. For more information, read URL Map Concepts.

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.

creation_timestamp: Option<String>

Output only. [Output Only] Creation timestamp inRFC3339 text format.

default_custom_error_response_policy: Option<CustomErrorResponsePolicy>

defaultCustomErrorResponsePolicy specifies how the Load Balancer returns error responses when BackendServiceorBackendBucket responds with an error.

This policy takes effect at the load balancer level and applies only when no policy has been defined for the error code at lower levels like PathMatcher, RouteRule and PathRule within this UrlMap.

For example, consider a UrlMap with the following configuration:

 - defaultCustomErrorResponsePolicy containing policies for
 responding to 5xx and 4xx errors
 - A PathMatcher configured for *.example.com has
 defaultCustomErrorResponsePolicy for 4xx.

If a request for http://www.example.com/ encounters a404, the policy inpathMatcher.defaultCustomErrorResponsePolicy will be enforced. When the request for http://www.example.com/ encounters a502, the policy inUrlMap.defaultCustomErrorResponsePolicy will be enforced. When a request that does not match any host in *.example.com such as http://www.myotherexample.com/, encounters a404, UrlMap.defaultCustomErrorResponsePolicy takes effect.

When used in conjunction withdefaultRouteAction.retryPolicy, retries take precedence. Only once all retries are exhausted, thedefaultCustomErrorResponsePolicy is applied. While attempting a retry, if load balancer is successful in reaching the service, the defaultCustomErrorResponsePolicy is ignored and the response from the service is returned to the client.

defaultCustomErrorResponsePolicy is supported only for global external Application Load Balancers.

default_route_action: Option<HttpRouteAction>

defaultRouteAction takes effect when none of the hostRules match. The load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend.

Only one of defaultUrlRedirect, defaultService or defaultRouteAction.weightedBackendService can be set.

URL maps for classic Application Load Balancers only support the urlRewrite action within defaultRouteAction.

defaultRouteAction has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true.

default_service: Option<String>

The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend.

Only one of defaultUrlRedirect, defaultService or defaultRouteAction.weightedBackendService can be set.

defaultService has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true.

default_url_redirect: Option<HttpRedirectAction>

When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect.

Only one of defaultUrlRedirect, defaultService or defaultRouteAction.weightedBackendService can be set.

Not supported when the URL map is bound to a target gRPC proxy.

description: Option<String>

An optional description of this resource. Provide this property when you create the resource.

fingerprint: Option<Bytes>

Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field is ignored when inserting a UrlMap. An up-to-date fingerprint must be provided in order to update the UrlMap, otherwise the request will fail with error 412 conditionNotMet.

To see the latest fingerprint, make a get() request to retrieve a UrlMap.

header_action: Option<HttpHeaderAction>

Specifies changes to request and response headers that need to take effect for the selected backendService.

The headerAction specified here take effect afterheaderAction specified under pathMatcher.

headerAction is not supported for load balancers that have their loadBalancingScheme set to EXTERNAL.

Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true.

host_rules: Vec<HostRule>

The list of host rules to use against the URL.

id: Option<u64>

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

kind: Option<String>

Output only. [Output Only] Type of the resource. Always compute#urlMaps for url maps.

name: Option<String>

Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply withRFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

path_matchers: Vec<PathMatcher>

The list of named PathMatchers to use against the URL.

region: Option<String>

Output only. [Output Only] URL of the region where the regional URL map resides. This field is not applicable to global URL maps. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

self_link: Option<String>

[Output Only] Server-defined URL for the resource.

tests: Vec<UrlMapTest>

The list of expected URL mapping tests. Request to update theUrlMap succeeds only if all test cases pass. You can specify a maximum of 100 tests per UrlMap.

Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true.

Implementations

impl UrlMap

pub fn new() -> Self

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

where T: Into<String>,

Sets the value of creation_timestamp.

Example

let x = UrlMap::new().set_creation_timestamp("example");

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

where T: Into<String>,

Sets or clears the value of creation_timestamp.

Example

let x = UrlMap::new().set_or_clear_creation_timestamp(Some("example"));
let x = UrlMap::new().set_or_clear_creation_timestamp(None::<String>);

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

where T: Into<CustomErrorResponsePolicy>,

Sets the value of default_custom_error_response_policy.

Example

use google_cloud_compute_v1::model::CustomErrorResponsePolicy;
let x = UrlMap::new().set_default_custom_error_response_policy(CustomErrorResponsePolicy::default()/* use setters */);

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

where T: Into<CustomErrorResponsePolicy>,

Sets or clears the value of default_custom_error_response_policy.

Example

use google_cloud_compute_v1::model::CustomErrorResponsePolicy;
let x = UrlMap::new().set_or_clear_default_custom_error_response_policy(Some(CustomErrorResponsePolicy::default()/* use setters */));
let x = UrlMap::new().set_or_clear_default_custom_error_response_policy(None::<CustomErrorResponsePolicy>);

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

where T: Into<HttpRouteAction>,

Sets the value of default_route_action.

Example

use google_cloud_compute_v1::model::HttpRouteAction;
let x = UrlMap::new().set_default_route_action(HttpRouteAction::default()/* use setters */);

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

where T: Into<HttpRouteAction>,

Sets or clears the value of default_route_action.

Example

use google_cloud_compute_v1::model::HttpRouteAction;
let x = UrlMap::new().set_or_clear_default_route_action(Some(HttpRouteAction::default()/* use setters */));
let x = UrlMap::new().set_or_clear_default_route_action(None::<HttpRouteAction>);

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

where T: Into<String>,

Sets the value of default_service.

Example

let x = UrlMap::new().set_default_service("example");

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

where T: Into<String>,

Sets or clears the value of default_service.

Example

let x = UrlMap::new().set_or_clear_default_service(Some("example"));
let x = UrlMap::new().set_or_clear_default_service(None::<String>);

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

where T: Into<HttpRedirectAction>,

Sets the value of default_url_redirect.

Example

use google_cloud_compute_v1::model::HttpRedirectAction;
let x = UrlMap::new().set_default_url_redirect(HttpRedirectAction::default()/* use setters */);

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

where T: Into<HttpRedirectAction>,

Sets or clears the value of default_url_redirect.

Example

use google_cloud_compute_v1::model::HttpRedirectAction;
let x = UrlMap::new().set_or_clear_default_url_redirect(Some(HttpRedirectAction::default()/* use setters */));
let x = UrlMap::new().set_or_clear_default_url_redirect(None::<HttpRedirectAction>);

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

where T: Into<String>,

Sets the value of description.

Example

let x = UrlMap::new().set_description("example");

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

where T: Into<String>,

Sets or clears the value of description.

Example

let x = UrlMap::new().set_or_clear_description(Some("example"));
let x = UrlMap::new().set_or_clear_description(None::<String>);

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

where T: Into<Bytes>,

Sets the value of fingerprint.

Example

let x = UrlMap::new().set_fingerprint(bytes::Bytes::from_static(b"example"));

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

where T: Into<Bytes>,

Sets or clears the value of fingerprint.

Example

let x = UrlMap::new().set_or_clear_fingerprint(Some(bytes::Bytes::from_static(b"example")));
let x = UrlMap::new().set_or_clear_fingerprint(None::<bytes::Bytes>);

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

where T: Into<HttpHeaderAction>,

Sets the value of header_action.

Example

use google_cloud_compute_v1::model::HttpHeaderAction;
let x = UrlMap::new().set_header_action(HttpHeaderAction::default()/* use setters */);

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

where T: Into<HttpHeaderAction>,

Sets or clears the value of header_action.

Example

use google_cloud_compute_v1::model::HttpHeaderAction;
let x = UrlMap::new().set_or_clear_header_action(Some(HttpHeaderAction::default()/* use setters */));
let x = UrlMap::new().set_or_clear_header_action(None::<HttpHeaderAction>);

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

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

Sets the value of host_rules.

Example

use google_cloud_compute_v1::model::HostRule;
let x = UrlMap::new()
    .set_host_rules([
        HostRule::default()/* use setters */,
        HostRule::default()/* use (different) setters */,
    ]);

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

where T: Into<u64>,

Sets the value of id.

Example

let x = UrlMap::new().set_id(42_u32);

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

where T: Into<u64>,

Sets or clears the value of id.

Example

let x = UrlMap::new().set_or_clear_id(Some(42_u32));
let x = UrlMap::new().set_or_clear_id(None::<u32>);

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

where T: Into<String>,

Sets the value of kind.

Example

let x = UrlMap::new().set_kind("example");

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

where T: Into<String>,

Sets or clears the value of kind.

Example

let x = UrlMap::new().set_or_clear_kind(Some("example"));
let x = UrlMap::new().set_or_clear_kind(None::<String>);

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

where T: Into<String>,

Sets the value of name.

Example

let x = UrlMap::new().set_name("example");

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

where T: Into<String>,

Sets or clears the value of name.

Example

let x = UrlMap::new().set_or_clear_name(Some("example"));
let x = UrlMap::new().set_or_clear_name(None::<String>);

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

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

Sets the value of path_matchers.

Example

use google_cloud_compute_v1::model::PathMatcher;
let x = UrlMap::new()
    .set_path_matchers([
        PathMatcher::default()/* use setters */,
        PathMatcher::default()/* use (different) setters */,
    ]);

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

where T: Into<String>,

Sets the value of region.

Example

let x = UrlMap::new().set_region("example");

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

where T: Into<String>,

Sets or clears the value of region.

Example

let x = UrlMap::new().set_or_clear_region(Some("example"));
let x = UrlMap::new().set_or_clear_region(None::<String>);

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

where T: Into<String>,

Sets the value of self_link.

Example

let x = UrlMap::new().set_self_link("example");

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

where T: Into<String>,

Sets or clears the value of self_link.

Example

let x = UrlMap::new().set_or_clear_self_link(Some("example"));
let x = UrlMap::new().set_or_clear_self_link(None::<String>);

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

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

Sets the value of tests.

Example

use google_cloud_compute_v1::model::UrlMapTest;
let x = UrlMap::new()
    .set_tests([
        UrlMapTest::default()/* use setters */,
        UrlMapTest::default()/* use (different) setters */,
    ]);

Trait Implementations

impl Clone for UrlMap

fn clone(&self) -> UrlMap

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UrlMap

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

Formats the value using the given formatter.

impl Default for UrlMap

fn default() -> UrlMap

Returns the “default value” for a type.

impl Message for UrlMap

fn typename() -> &'static str

The typename of this message.

impl PartialEq for UrlMap

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for UrlMap