Struct Tunnel

pub struct Tunnel {
    pub id: String,
    pub public_url: String,
    pub started_at: String,
    pub metadata: String,
    pub proto: String,
    pub region: String,
    pub tunnel_session: Ref,
    pub endpoint: Option<Ref>,
    pub labels: Option<HashMap<String, String>>,
    pub backends: Option<Vec<Ref>>,
    pub forwards_to: String,
}

Fields

id: String

unique tunnel resource identifier

public_url: String

URL of the ephemeral tunnel’s public endpoint

started_at: String

timestamp when the tunnel was initiated in RFC 3339 format

metadata: String

user-supplied metadata for the tunnel defined in the ngrok configuration file. See the tunnel metadata configuration option In API version 0, this value was instead pulled from the top-level metadata configuration option.

proto: String

tunnel protocol for ephemeral tunnels. one of http, https, tcp or tls

region: String

identifier of tune region where the tunnel is running

tunnel_session: Ref

reference object pointing to the tunnel session on which this tunnel was started

endpoint: Option<Ref>

the ephemeral endpoint this tunnel is associated with, if this is an agent-initiated tunnel

labels: Option<HashMap<String, String>>

the labels the tunnel group backends will match against, if this is a backend tunnel

backends: Option<Vec<Ref>>

tunnel group backends served by this backend tunnel

forwards_to: String

upstream address the ngrok agent forwards traffic over this tunnel to. this may be expressed as a URL or a network address.

Trait Implementations

impl Clone for Tunnel

fn clone(&self) -> Tunnel

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Tunnel

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

Formats the value using the given formatter.

impl Default for Tunnel

fn default() -> Tunnel

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Tunnel

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Tunnel

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

where __S: Serializer,

Serialize this value into the given Serde serializer.