Struct MethodSettings

pub struct MethodSettings {
    pub selector: String,
    pub long_running: Option<LongRunning>,
    pub auto_populated_fields: Vec<String>,
}

Describes the generator configuration for a method.

Fields

selector: String

The fully qualified name of the method, for which the options below apply. This is used to find the method to apply the options.

Example:

publishing:
  method_settings:
  - selector: google.storage.control.v2.StorageControl.CreateFolder

long_running: Option<LongRunning>

Describes settings to use for long-running operations when generating API methods for RPCs. Complements RPCs that use the annotations in google/longrunning/operations.proto.

Example of a YAML configuration::

publishing:
  method_settings:
  - selector: google.cloud.speech.v2.Speech.BatchRecognize
    long_running:
      initial_poll_delay: 60s # 1 minute
      poll_delay_multiplier: 1.5
      max_poll_delay: 360s # 6 minutes
      total_poll_timeout: 54000s # 90 minutes

auto_populated_fields: Vec<String>

List of top-level fields of the request message, that should be automatically populated by the client libraries based on their (google.api.field_info).format. Currently supported format: UUID4.

Example of a YAML configuration:

publishing:
  method_settings:
  - selector: google.example.v1.ExampleService.CreateExample
    auto_populated_fields:
    - request_id

Trait Implementations

impl Clone for MethodSettings

fn clone(&self) -> MethodSettings

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MethodSettings

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

Formats the value using the given formatter.

impl Default for MethodSettings

fn default() -> MethodSettings

Returns the “default value” for a type.

impl Message for MethodSettings

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 MethodSettings

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