Struct ngrok_api::types::IPRestriction

pub struct IPRestriction {
    pub id: String,
    pub uri: String,
    pub created_at: String,
    pub description: String,
    pub metadata: String,
    pub enforced: bool,
    pub type: String,
    pub ip_policies: Vec<Ref>,
}

Fields

id: String

unique identifier for this IP restriction

uri: String

URI of the IP restriction API resource

created_at: String

timestamp when the IP restriction was created, RFC 3339 format

description: String

human-readable description of this IP restriction. optional, max 255 bytes.

metadata: String

arbitrary user-defined machine-readable data of this IP restriction. optional, max 4096 bytes.

enforced: bool

true if the IP restriction will be enforced. if false, only warnings will be issued

type: String

the type of IP restriction. this defines what traffic will be restricted with the attached policies. four values are currently supported: dashboard, api, agent, and endpoints

ip_policies: Vec<Ref>

the set of IP policies that are used to enforce the restriction

Trait Implementations

impl Clone for IPRestriction

fn clone(&self) -> IPRestriction

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for IPRestriction

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

Formats the value using the given formatter.

impl Default for IPRestriction

fn default() -> IPRestriction

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for IPRestriction

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

Deserialize this value from the given Serde deserializer.

impl Serialize for IPRestriction

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

Serialize this value into the given Serde serializer.