Struct ngrok_api::types::HTTPSEdgeRoute

pub struct HTTPSEdgeRoute {

    pub edge_id: String,
    pub id: String,
    pub created_at: String,
    pub match_type: String,
    pub match: String,
    pub uri: String,
    pub description: String,
    pub metadata: String,
    pub backend: Option<EndpointBackend>,
    pub ip_restriction: Option<EndpointIPPolicy>,
    pub circuit_breaker: Option<EndpointCircuitBreaker>,
    pub compression: Option<EndpointCompression>,
    pub request_headers: Option<EndpointRequestHeaders>,
    pub response_headers: Option<EndpointResponseHeaders>,
    pub webhook_verification: Option<EndpointWebhookValidation>,
    pub oauth: Option<EndpointOAuth>,
    pub saml: Option<EndpointSAML>,
    pub oidc: Option<EndpointOIDC>,
    pub websocket_tcp_converter: Option<EndpointWebsocketTCPConverter>,
}

Fields

edge_id: String

unique identifier of this edge

id: String

unique identifier of this edge route

created_at: String

timestamp when the edge configuration was created, RFC 3339 format

match_type: String

Type of match to use for this route. Valid values are “exact_path” and “path_prefix”.

match: String

Route selector: “/blog” or “example.com” or “example.com/blog”

uri: String

URI of the edge API resource

description: String

human-readable description of what this edge will be used for; optional, max 255 bytes.

metadata: String

arbitrary user-defined machine-readable data of this edge. Optional, max 4096 bytes.

backend: Option<EndpointBackend>

backend module configuration or null

ip_restriction: Option<EndpointIPPolicy>

ip restriction module configuration or null

circuit_breaker: Option<EndpointCircuitBreaker>

circuit breaker module configuration or null

compression: Option<EndpointCompression>

compression module configuration or null

request_headers: Option<EndpointRequestHeaders>

request headers module configuration or null

response_headers: Option<EndpointResponseHeaders>

response headers module configuration or null

webhook_verification: Option<EndpointWebhookValidation>

webhook verification module configuration or null

oauth: Option<EndpointOAuth>

oauth module configuration or null

saml: Option<EndpointSAML>

saml module configuration or null

oidc: Option<EndpointOIDC>

oidc module configuration or null

websocket_tcp_converter: Option<EndpointWebsocketTCPConverter>

websocket to tcp adapter configuration or null

Trait Implementations

impl Clone for HTTPSEdgeRoute

fn clone(&self) -> HTTPSEdgeRoute

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for HTTPSEdgeRoute

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

Formats the value using the given formatter.

impl Default for HTTPSEdgeRoute

fn default() -> HTTPSEdgeRoute

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for HTTPSEdgeRoute

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

Deserialize this value from the given Serde deserializer.

impl Serialize for HTTPSEdgeRoute

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

Serialize this value into the given Serde serializer.