Struct Resource

pub struct Resource {
    pub name: String,
    pub resource_name: Option<ResourceName>,
    pub aliases: Vec<String>,
    pub version: String,
    pub resource: Option<Any>,
    pub ttl: Option<Duration>,
    pub cache_control: Option<CacheControl>,
    pub metadata: Option<Metadata>,
}

[#next-free-field: 10]

Fields

name: String

The resource’s name, to distinguish it from others of the same type of resource. Only one of name or resource_name may be set.

resource_name: Option<ResourceName>

Alternative to the name field, to be used when the server supports multiple variants of the named resource that are differentiated by dynamic parameter constraints. Only one of name or resource_name may be set.

aliases: Vec<String>

The aliases are a list of other names that this resource can go by.

version: String

The resource level version. It allows xDS to track the state of individual resources.

resource: Option<Any>

The resource being tracked.

ttl: Option<Duration>

Time-to-live value for the resource. For each resource, a timer is started. The timer is reset each time the resource is received with a new TTL. If the resource is received with no TTL set, the timer is removed for the resource. Upon expiration of the timer, the configuration for the resource will be removed.

The TTL can be refreshed or changed by sending a response that doesn’t change the resource version. In this case the resource field does not need to be populated, which allows for light-weight “heartbeat” updates to keep a resource with a TTL alive.

The TTL feature is meant to support configurations that should be removed in the event of a management server failure. For example, the feature may be used for fault injection testing where the fault injection should be terminated in the event that Envoy loses contact with the management server.

cache_control: Option<CacheControl>

Cache control properties for the resource. [#not-implemented-hide:]

metadata: Option<Metadata>

The Metadata field can be used to provide additional information for the resource. E.g. the trace data for debugging.

Trait Implementations

impl Clone for Resource

fn clone(&self) -> Resource

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Resource

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

Formats the value using the given formatter.

impl Default for Resource

fn default() -> Self

Returns the “default value” for a type.

impl Message for Resource

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 Resource

const NAME: &'static str = "Resource"

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.service.discovery.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 Resource

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