Struct Api

#[non_exhaustive]
pub struct Api {
    pub service: String,
    pub operation: String,
    pub protocol: String,
    pub version: String,
    /* private fields */
}

This message defines attributes associated with API operations, such as a network API request. The terminology is based on the conventions used by Google APIs, Istio, and OpenAPI.

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.

service: String

The API service name. It is a logical identifier for a networked API, such as “pubsub.googleapis.com”. The naming syntax depends on the API management system being used for handling the request.

operation: String

The API operation name. For gRPC requests, it is the fully qualified API method name, such as “google.pubsub.v1.Publisher.Publish”. For OpenAPI requests, it is the operationId, such as “getPet”.

protocol: String

The API protocol used for sending the request, such as “http”, “https”, “grpc”, or “internal”.

version: String

The API version associated with the API operation above, such as “v1” or “v1alpha1”.

Implementations

impl Api

pub fn new() -> Self

pub fn set_service<T: Into<String>>(self, v: T) -> Self

Sets the value of service.

pub fn set_operation<T: Into<String>>(self, v: T) -> Self

Sets the value of operation.

pub fn set_protocol<T: Into<String>>(self, v: T) -> Self

Sets the value of protocol.

pub fn set_version<T: Into<String>>(self, v: T) -> Self

Sets the value of version.

Trait Implementations

impl Clone for Api

fn clone(&self) -> Api

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Api

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

Formats the value using the given formatter.

impl Default for Api

fn default() -> Api

Returns the “default value” for a type.

impl Message for Api

fn typename() -> &'static str

The typename of this message.

impl PartialEq for Api

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