Struct FieldPolicy

#[non_exhaustive]
pub struct FieldPolicy {
    pub selector: String,
    pub resource_permission: String,
    pub resource_type: String,
    /* private fields */
}

Google API Policy Annotation

This message defines a simple API policy annotation that can be used to annotate API request and response message fields with applicable policies. One field may have multiple applicable policies that must all be satisfied before a request can be processed. This policy annotation is used to generate the overall policy that will be used for automatic runtime policy enforcement and documentation generation.

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 one or more request or response message fields to apply this FieldPolicy.

When a FieldPolicy is used in proto annotation, the selector must be left as empty. The service config generator will automatically fill the correct value.

When a FieldPolicy is used in service config, the selector must be a comma-separated string with valid request or response field paths, such as “foo.bar” or “foo.bar,foo.baz”.

resource_permission: String

Specifies the required permission(s) for the resource referred to by the field. It requires the field contains a valid resource reference, and the request must pass the permission checks to proceed. For example, “resourcemanager.projects.get”.

resource_type: String

Specifies the resource type for the resource referred to by the field.

Implementations

impl FieldPolicy

pub fn new() -> Self

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

Sets the value of selector.

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

Sets the value of resource_permission.

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

Sets the value of resource_type.

Trait Implementations

impl Clone for FieldPolicy

fn clone(&self) -> FieldPolicy

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FieldPolicy

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

Formats the value using the given formatter.

impl Default for FieldPolicy

fn default() -> FieldPolicy

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for FieldPolicy

where FieldPolicy: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Message for FieldPolicy

fn typename() -> &'static str

The typename of this message.

impl PartialEq for FieldPolicy

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for FieldPolicy