Struct ApiConfigSource

pub struct ApiConfigSource {
    pub api_type: i32,
    pub transport_api_version: i32,
    pub cluster_names: Vec<String>,
    pub grpc_services: Vec<GrpcService>,
    pub refresh_delay: Option<Duration>,
    pub request_timeout: Option<Duration>,
    pub rate_limit_settings: Option<RateLimitSettings>,
    pub set_node_on_first_message_only: bool,
    pub config_validators: Vec<TypedExtensionConfig>,
}

API configuration source. This identifies the API type and cluster that Envoy will use to fetch an xDS API. [#next-free-field: 10]

Fields

api_type: i32

API type (gRPC, REST, delta gRPC)

transport_api_version: i32

API version for xDS transport protocol. This describes the xDS gRPC/REST endpoint and version of [Delta]DiscoveryRequest/Response used on the wire.

cluster_names: Vec<String>

Cluster names should be used only with REST. If > 1 cluster is defined, clusters will be cycled through if any kind of failure occurs.

.. note::

The cluster with name cluster_name must be statically defined and its type must not be EDS.

grpc_services: Vec<GrpcService>

Multiple gRPC services be provided for GRPC. If > 1 cluster is defined, services will be cycled through if any kind of failure occurs.

refresh_delay: Option<Duration>

For REST APIs, the delay between successive polls.

request_timeout: Option<Duration>

For REST APIs, the request timeout. If not set, a default value of 1s will be used.

rate_limit_settings: Option<RateLimitSettings>

For GRPC APIs, the rate limit settings. If present, discovery requests made by Envoy will be rate limited.

set_node_on_first_message_only: bool

Skip the node identifier in subsequent discovery requests for streaming gRPC config types.

config_validators: Vec<TypedExtensionConfig>

A list of config validators that will be executed when a new update is received from the ApiConfigSource. Note that each validator handles a specific xDS service type, and only the validators corresponding to the type url (in :ref: DiscoveryResponse or :ref: DeltaDiscoveryResponse) will be invoked. If the validator returns false or throws an exception, the config will be rejected by the client, and a NACK will be sent. [#extension-category: envoy.config.validators]

Implementations

impl ApiConfigSource

pub fn api_type(&self) -> ApiType

Returns the enum value of api_type, or the default if the field is set to an invalid enum value.

pub fn set_api_type(&mut self, value: ApiType)

Sets api_type to the provided enum value.

pub fn transport_api_version(&self) -> ApiVersion

Returns the enum value of transport_api_version, or the default if the field is set to an invalid enum value.

pub fn set_transport_api_version(&mut self, value: ApiVersion)

Sets transport_api_version to the provided enum value.

Trait Implementations

impl Clone for ApiConfigSource

fn clone(&self) -> ApiConfigSource

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ApiConfigSource

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

Formats the value using the given formatter.

impl Default for ApiConfigSource

fn default() -> Self

Returns the “default value” for a type.

impl Message for ApiConfigSource

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl Name for ApiConfigSource

const NAME: &'static str = "ApiConfigSource"

Simple name for this Message. This name is the same as it appears in the source .proto file, e.g. FooBar.

const PACKAGE: &'static str = "envoy.config.core.v3"

Package name this message type is contained in. They are domain-like and delimited by ., e.g. google.protobuf.

fn full_name() -> String

Fully-qualified unique name for this Message. It’s prefixed with the package name and names of any parent messages, e.g. google.rpc.BadRequest.FieldViolation. By default, this is the package name followed by the message name. Fully-qualified names must be unique within a domain of Type URLs.

fn type_url() -> String

Type URL for this Message, which by default is the full name with a leading slash, but may also include a leading domain name, e.g. type.googleapis.com/google.profile.Person. This can be used when serializing into the google.protobuf.Any type.

impl PartialEq for ApiConfigSource

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