Struct AttributeContext 

#[non_exhaustive]
pub struct AttributeContext {
    pub origin: Option<Peer>,
    pub source: Option<Peer>,
    pub destination: Option<Peer>,
    pub request: Option<Request>,
    pub response: Option<Response>,
    pub resource: Option<Resource>,
    pub api: Option<Api>,
    pub extensions: Vec<Any>,
    /* private fields */
}

This message defines the standard attribute vocabulary for Google APIs.

An attribute is a piece of metadata that describes an activity on a network service. For example, the size of an HTTP request, or the status code of an HTTP response.

Each attribute has a type and a name, which is logically defined as a proto message field in AttributeContext. The field type becomes the attribute type, and the field path becomes the attribute name. For example, the attribute source.ip maps to field AttributeContext.source.ip.

This message definition is guaranteed not to have any wire breaking change. So you can use it directly for passing attributes across different systems.

NOTE: Different system may generate different subset of attributes. Please verify the system specification before relying on an attribute generated a system.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

origin: Option<Peer>

The origin of a network activity. In a multi hop network activity, the origin represents the sender of the first hop. For the first hop, the source and the origin must have the same content.

source: Option<Peer>

The source of a network activity, such as starting a TCP connection. In a multi hop network activity, the source represents the sender of the last hop.

destination: Option<Peer>

The destination of a network activity, such as accepting a TCP connection. In a multi hop network activity, the destination represents the receiver of the last hop.

request: Option<Request>

Represents a network request, such as an HTTP request.

response: Option<Response>

Represents a network response, such as an HTTP response.

resource: Option<Resource>

Represents a target resource that is involved with a network activity. If multiple resources are involved with an activity, this must be the primary one.

api: Option<Api>

Represents an API operation that is involved to a network activity.

extensions: Vec<Any>

Supports extensions for advanced use cases, such as logs and metrics.

Implementations

impl AttributeContext

pub fn new() -> Self

pub fn set_origin<T>(self, v: T) -> Self

where T: Into<Peer>,

Sets the value of origin.

Example

use google_cloud_rpc_context::model::attribute_context::Peer;
let x = AttributeContext::new().set_origin(Peer::default()/* use setters */);

pub fn set_or_clear_origin<T>(self, v: Option<T>) -> Self

where T: Into<Peer>,

Sets or clears the value of origin.

Example

use google_cloud_rpc_context::model::attribute_context::Peer;
let x = AttributeContext::new().set_or_clear_origin(Some(Peer::default()/* use setters */));
let x = AttributeContext::new().set_or_clear_origin(None::<Peer>);

pub fn set_source<T>(self, v: T) -> Self

where T: Into<Peer>,

Sets the value of source.

Example

use google_cloud_rpc_context::model::attribute_context::Peer;
let x = AttributeContext::new().set_source(Peer::default()/* use setters */);

pub fn set_or_clear_source<T>(self, v: Option<T>) -> Self

where T: Into<Peer>,

Sets or clears the value of source.

Example

use google_cloud_rpc_context::model::attribute_context::Peer;
let x = AttributeContext::new().set_or_clear_source(Some(Peer::default()/* use setters */));
let x = AttributeContext::new().set_or_clear_source(None::<Peer>);

pub fn set_destination<T>(self, v: T) -> Self

where T: Into<Peer>,

Sets the value of destination.

Example

use google_cloud_rpc_context::model::attribute_context::Peer;
let x = AttributeContext::new().set_destination(Peer::default()/* use setters */);

pub fn set_or_clear_destination<T>(self, v: Option<T>) -> Self

where T: Into<Peer>,

Sets or clears the value of destination.

Example

use google_cloud_rpc_context::model::attribute_context::Peer;
let x = AttributeContext::new().set_or_clear_destination(Some(Peer::default()/* use setters */));
let x = AttributeContext::new().set_or_clear_destination(None::<Peer>);

pub fn set_request<T>(self, v: T) -> Self

where T: Into<Request>,

Sets the value of request.

Example

use google_cloud_rpc_context::model::attribute_context::Request;
let x = AttributeContext::new().set_request(Request::default()/* use setters */);

pub fn set_or_clear_request<T>(self, v: Option<T>) -> Self

where T: Into<Request>,

Sets or clears the value of request.

Example

use google_cloud_rpc_context::model::attribute_context::Request;
let x = AttributeContext::new().set_or_clear_request(Some(Request::default()/* use setters */));
let x = AttributeContext::new().set_or_clear_request(None::<Request>);

pub fn set_response<T>(self, v: T) -> Self

where T: Into<Response>,

Sets the value of response.

Example

use google_cloud_rpc_context::model::attribute_context::Response;
let x = AttributeContext::new().set_response(Response::default()/* use setters */);

pub fn set_or_clear_response<T>(self, v: Option<T>) -> Self

where T: Into<Response>,

Sets or clears the value of response.

Example

use google_cloud_rpc_context::model::attribute_context::Response;
let x = AttributeContext::new().set_or_clear_response(Some(Response::default()/* use setters */));
let x = AttributeContext::new().set_or_clear_response(None::<Response>);

pub fn set_resource<T>(self, v: T) -> Self

where T: Into<Resource>,

Sets the value of resource.

Example

use google_cloud_rpc_context::model::attribute_context::Resource;
let x = AttributeContext::new().set_resource(Resource::default()/* use setters */);

pub fn set_or_clear_resource<T>(self, v: Option<T>) -> Self

where T: Into<Resource>,

Sets or clears the value of resource.

Example

use google_cloud_rpc_context::model::attribute_context::Resource;
let x = AttributeContext::new().set_or_clear_resource(Some(Resource::default()/* use setters */));
let x = AttributeContext::new().set_or_clear_resource(None::<Resource>);

pub fn set_api<T>(self, v: T) -> Self

where T: Into<Api>,

Sets the value of api.

Example

use google_cloud_rpc_context::model::attribute_context::Api;
let x = AttributeContext::new().set_api(Api::default()/* use setters */);

pub fn set_or_clear_api<T>(self, v: Option<T>) -> Self

where T: Into<Api>,

Sets or clears the value of api.

Example

use google_cloud_rpc_context::model::attribute_context::Api;
let x = AttributeContext::new().set_or_clear_api(Some(Api::default()/* use setters */));
let x = AttributeContext::new().set_or_clear_api(None::<Api>);

pub fn set_extensions<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<Any>,

Sets the value of extensions.

Example

use wkt::Any;
let x = AttributeContext::new()
    .set_extensions([
        Any::default()/* use setters */,
        Any::default()/* use (different) setters */,
    ]);

Trait Implementations

impl Clone for AttributeContext

fn clone(&self) -> AttributeContext

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AttributeContext

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

Formats the value using the given formatter.

impl Default for AttributeContext

fn default() -> AttributeContext

Returns the “default value” for a type.

impl Message for AttributeContext

fn typename() -> &'static str

The typename of this message.

impl PartialEq for AttributeContext

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