Struct ResourceReference 

#[non_exhaustive]
pub struct ResourceReference {
    pub type: String,
    pub child_type: String,
    /* private fields */
}

Defines a proto annotation that describes a string field that refers to an API resource.

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.

type: String

The resource type that the annotated field references.

Example:

message Subscription {
  string topic = 2 [(google.api.resource_reference) = {
    type: "pubsub.googleapis.com/Topic"
  }];
}

Occasionally, a field may reference an arbitrary resource. In this case, APIs use the special value * in their resource reference.

Example:

message GetIamPolicyRequest {
  string resource = 2 [(google.api.resource_reference) = {
    type: "*"
  }];
}

child_type: String

The resource type of a child collection that the annotated field references. This is useful for annotating the parent field that doesn’t have a fixed resource type.

Example:

message ListLogEntriesRequest {
  string parent = 1 [(google.api.resource_reference) = {
    child_type: "logging.googleapis.com/LogEntry"
  };
}

Implementations

impl ResourceReference

pub fn new() -> Self

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

Sets the value of r#type.

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

Sets the value of child_type.

Trait Implementations

impl Clone for ResourceReference

fn clone(&self) -> ResourceReference

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ResourceReference

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

Formats the value using the given formatter.

impl Default for ResourceReference

fn default() -> ResourceReference

Returns the “default value” for a type.

impl Message for ResourceReference

fn typename() -> &'static str

The typename of this message.

impl PartialEq for ResourceReference

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