Struct UpstreamBuilder

pub struct UpstreamBuilder {
    pub id: Option<String>,
    pub retries: Option<i32>,
    pub retry_timeout: Option<i32>,
    pub timeout: Option<ApisixTimeout>,
    pub nodes: Option<Value>,
    pub service_name: Option<String>,
    pub discovery_type: Option<String>,
    pub type_field: Option<UpstreamType>,
    pub name: Option<String>,
    pub desc: Option<String>,
    pub scheme: Option<UpstreamSchema>,
}

Fields

id: Option<String>

retries: Option<i32>

retry_timeout: Option<i32>

timeout: Option<ApisixTimeout>

nodes: Option<Value>

service_name: Option<String>

discovery_type: Option<String>

type_field: Option<UpstreamType>

name: Option<String>

desc: Option<String>

scheme: Option<UpstreamSchema>

Implementations

impl UpstreamBuilder

pub fn new() -> Self

pub fn id(self, id: String) -> Self

Upstream ID TODO validate id See [generate_identifier]

pub fn u_type(self, u_type: UpstreamType) -> Self

Load balancing algorithm to be used, and the default value is roundrobin. See UpstreamType

pub fn nodes(self, nodes: Value) -> Self

IP addresses (with optional ports) of the Upstream nodes represented as a hash table or an array. In the hash table, the key is the IP address and the value is the weight of the node for the load balancing algorithm. For hash table case, if the key is IPv6 address with port, then the IPv6 address must be quoted with square brackets. In the array, each item is a hash table with keys host, weight, and the optional port and priority (defaults to 0). Nodes with lower priority are used only when all nodes with a higher priority are tried and are unavailable. Empty nodes are treated as placeholders and clients trying to access this Upstream will receive a 502 response.

Restrictions: can not be used with service_name

Example: 192.168.1.100:80, [::1]:80

pub fn service_name(self, service_name: String) -> Self

Service name used for service discovery

Restrictions: can not be used with nodes

pub fn discovery_type(self, discovery_type: String) -> Self

The type of service discovery to be used. The default value is eureka. Required when service_name is defined

pub fn retries(self, retries: i32) -> Self

Sets the number of retries while passing the request to Upstream using the underlying Nginx mechanism. Set according to the number of available backend nodes by default. Setting this to 0 disables retry.

pub fn retry_timeout(self, retry_timeout: i32) -> Self

Timeout to continue with retries. Setting this to 0 disables the retry timeout.

pub fn timeout(self, timeout: ApisixTimeout) -> Self

Sets the timeout (in seconds) for connecting to, and sending and receiving messages to and from the Upstream.

Example: {“connect”: 0.5,“send”: 0.5,“read”: 0.5}

pub fn name(self, name: String) -> Self

Identifier for the Upstream

pub fn desc(self, desc: String) -> Self

Description of usage scenarios

pub fn schema(self, scheme: UpstreamSchema) -> Self

The scheme used when communicating with the Upstream. For an L7 proxy, this value can be one of http, https, grpc, grpcs. For an L4 proxy, this value could be one of tcp, udp, tls. Defaults to http.

pub fn build(&self) -> Result<UpstreamRequest, ApisixClientError>

Trait Implementations

impl Clone for UpstreamBuilder

fn clone(&self) -> UpstreamBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UpstreamBuilder

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

Formats the value using the given formatter.

impl Default for UpstreamBuilder

fn default() -> UpstreamBuilder

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for UpstreamBuilder

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<UpstreamRequest> for UpstreamBuilder

fn from(upstream: UpstreamRequest) -> Self

Converts to this type from the input type.

impl PartialEq for UpstreamBuilder

fn eq(&self, other: &UpstreamBuilder) -> 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 Serialize for UpstreamBuilder

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for UpstreamBuilder