Struct Endpoint

pub struct Endpoint {

    pub id: String,
    pub region: String,
    pub created_at: String,
    pub updated_at: String,
    pub public_url: String,
    pub proto: String,
    pub scheme: String,
    pub hostport: String,
    pub host: String,
    pub port: i64,
    pub type: String,
    pub metadata: String,
    pub description: String,
    pub domain: Option<Ref>,
    pub tcp_addr: Option<Ref>,
    pub tunnel: Option<Ref>,
    pub edge: Option<Ref>,
    pub upstream_url: String,
    pub upstream_proto: String,
    pub url: String,
    pub principal: Option<Ref>,
    pub principal_id: Option<Ref>,
    pub traffic_policy: String,
    pub bindings: Option<Vec<String>>,
    pub tunnel_session: Option<Ref>,
    pub uri: String,
    pub name: String,
}

Fields

id: String

unique endpoint resource identifier

region: String

identifier of the region this endpoint belongs to

created_at: String

timestamp when the endpoint was created in RFC 3339 format

updated_at: String

timestamp when the endpoint was updated in RFC 3339 format

public_url: String

URL of the hostport served by this endpoint

proto: String

protocol served by this endpoint. one of http, https, tcp, or tls

scheme: String

hostport: String

hostport served by this endpoint (hostname:port) -> soon to be deprecated

host: String

port: i64

type: String

whether the endpoint is ephemeral (served directly by an agent-initiated tunnel) or edge (served by an edge) or cloud (represents a cloud endpoint)

metadata: String

user-supplied metadata of the associated tunnel or edge object

description: String

user-supplied description of the associated tunnel

domain: Option<Ref>

the domain reserved for this endpoint

tcp_addr: Option<Ref>

the address reserved for this endpoint

tunnel: Option<Ref>

the tunnel serving requests to this endpoint, if this is an ephemeral endpoint

edge: Option<Ref>

the edge serving requests to this endpoint, if this is an edge endpoint

upstream_url: String

the local address the tunnel forwards to

upstream_proto: String

the protocol the agent uses to forward with

url: String

the url of the endpoint

principal: Option<Ref>

The ID of the owner (bot or user) that owns this endpoint

principal_id: Option<Ref>

TODO: deprecate me!

traffic_policy: String

The traffic policy attached to this endpoint

bindings: Option<Vec<String>>

the bindings associated with this endpoint

tunnel_session: Option<Ref>

The tunnel session of the agent for this endpoint

uri: String

URI of the clep API resource

name: String

user supplied name for the endpoint

Trait Implementations

impl Clone for Endpoint

fn clone(&self) -> Endpoint

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Endpoint

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

Formats the value using the given formatter.

impl Default for Endpoint

fn default() -> Endpoint

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Endpoint

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Endpoint

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

where __S: Serializer,

Serialize this value into the given Serde serializer.