Struct Endpoint 

#[non_exhaustive]
pub struct Endpoint {
    pub name: String,
    pub aliases: Vec<String>,
    pub target: String,
    pub allow_cors: bool,
    /* private fields */
}

Endpoint describes a network address of a service that serves a set of APIs. It is commonly known as a service endpoint. A service may expose any number of service endpoints, and all service endpoints share the same service definition, such as quota limits and monitoring metrics.

Example:

type: google.api.Service
name: library-example.googleapis.com
endpoints:
  # Declares network address `https://library-example.googleapis.com`
  # for service `library-example.googleapis.com`. The `https` scheme
  # is implicit for all service endpoints. Other schemes may be
  # supported in the future.
- name: library-example.googleapis.com
  allow_cors: false
- name: content-staging-library-example.googleapis.com
  # Allows HTTP OPTIONS calls to be passed to the API frontend, for it
  # to decide whether the subsequent cross-origin request is allowed
  # to proceed.
  allow_cors: true

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.

name: String

The canonical name of this endpoint.

aliases: Vec<String>

Aliases for this endpoint, these will be served by the same UrlMap as the parent endpoint, and will be provisioned in the GCP stack for the Regional Endpoints.

target: String

The specification of an Internet routable address of API frontend that will handle requests to this API Endpoint. It should be either a valid IPv4 address or a fully-qualified domain name. For example, “8.8.8.8” or “myservice.appspot.com”.

allow_cors: bool

Allowing CORS, aka cross-domain traffic, would allow the backends served from this endpoint to receive and respond to HTTP OPTIONS requests. The response will be used by the browser to determine whether the subsequent cross-origin request is allowed to proceed.

Implementations

impl Endpoint

pub fn new() -> Self

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

Sets the value of name.

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

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

Sets the value of aliases.

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

Sets the value of target.

pub fn set_allow_cors<T: Into<bool>>(self, v: T) -> Self

Sets the value of allow_cors.

Trait Implementations

impl Clone for Endpoint

fn clone(&self) -> Endpoint

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Endpoint

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

Formats the value using the given formatter.

impl Default for Endpoint

fn default() -> Endpoint

Returns the “default value” for a type.

impl Message for Endpoint

fn typename() -> &'static str

The typename of this message.

impl PartialEq for Endpoint

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