Struct ResourceReference

pub struct ResourceReference {
    pub type: String,
    pub child_type: String,
}

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

Fields

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"
   };
}

Trait Implementations

impl Clone for ResourceReference

fn clone(&self) -> ResourceReference

Returns a copy 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() -> Self

Returns the “default value” for a type.

impl Message for ResourceReference

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

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