Struct UsageRule 

#[non_exhaustive]
pub struct UsageRule {
    pub selector: String,
    pub allow_unregistered_calls: bool,
    pub skip_service_control: bool,
    /* private fields */
}

Usage configuration rules for the service.

NOTE: Under development.

Use this rule to configure unregistered calls for the service. Unregistered calls are calls that do not contain consumer project identity. (Example: calls that do not contain an API key). By default, API methods do not allow unregistered calls, and each method call must be identified by a consumer project identity. Use this rule to allow/disallow unregistered calls.

Example of an API that wants to allow unregistered calls for entire service.

usage:
  rules:
  - selector: "*"
    allow_unregistered_calls: true

Example of a method that wants to allow unregistered calls.

usage:
  rules:
  - selector: "google.example.library.v1.LibraryService.CreateBook"
    allow_unregistered_calls: 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.

selector: String

Selects the methods to which this rule applies. Use ‘*’ to indicate all methods in all APIs.

Refer to selector for syntax details.

allow_unregistered_calls: bool

If true, the selected method allows unregistered calls, e.g. calls that don’t identify any user or application.

skip_service_control: bool

If true, the selected method should skip service control and the control plane features, such as quota and billing, will not be available. This flag is used by Google Cloud Endpoints to bypass checks for internal methods, such as service health check methods.

Implementations

impl UsageRule

pub fn new() -> Self

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

Sets the value of selector.

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

Sets the value of allow_unregistered_calls.

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

Sets the value of skip_service_control.

Trait Implementations

impl Clone for UsageRule

fn clone(&self) -> UsageRule

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UsageRule

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

Formats the value using the given formatter.

impl Default for UsageRule

fn default() -> UsageRule

Returns the “default value” for a type.

impl Message for UsageRule

fn typename() -> &'static str

The typename of this message.

impl PartialEq for UsageRule

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