Struct MethodSettings 

#[non_exhaustive]
pub struct MethodSettings {
    pub selector: String,
    pub long_running: Option<LongRunning>,
    pub auto_populated_fields: Vec<String>,
    pub batching: Option<BatchingConfigProto>,
    /* private fields */
}

Describes the generator configuration for a method.

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

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
    # method settings for 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

batching: Option<BatchingConfigProto>

Batching configuration for an API method in client libraries.

Example of a YAML configuration:

publishing:
  method_settings:
  - selector: google.example.v1.ExampleService.BatchCreateExample
    batching:
      element_count_threshold: 1000
      request_byte_threshold: 100000000
      delay_threshold_millis: 10

Implementations

impl MethodSettings

pub fn new() -> Self

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

Sets the value of selector.

Example

let x = MethodSettings::new().set_selector("example");

pub fn set_long_running<T>(self, v: T) -> Self

where T: Into<LongRunning>,

Sets the value of long_running.

Example

use google_cloud_api::model::method_settings::LongRunning;
let x = MethodSettings::new().set_long_running(LongRunning::default()/* use setters */);

pub fn set_or_clear_long_running<T>(self, v: Option<T>) -> Self

where T: Into<LongRunning>,

Sets or clears the value of long_running.

Example

use google_cloud_api::model::method_settings::LongRunning;
let x = MethodSettings::new().set_or_clear_long_running(Some(LongRunning::default()/* use setters */));
let x = MethodSettings::new().set_or_clear_long_running(None::<LongRunning>);

pub fn set_auto_populated_fields<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<String>,

Sets the value of auto_populated_fields.

Example

let x = MethodSettings::new().set_auto_populated_fields(["a", "b", "c"]);

pub fn set_batching<T>(self, v: T) -> Self

where T: Into<BatchingConfigProto>,

Sets the value of batching.

Example

use google_cloud_api::model::BatchingConfigProto;
let x = MethodSettings::new().set_batching(BatchingConfigProto::default()/* use setters */);

pub fn set_or_clear_batching<T>(self, v: Option<T>) -> Self

where T: Into<BatchingConfigProto>,

Sets or clears the value of batching.

Example

use google_cloud_api::model::BatchingConfigProto;
let x = MethodSettings::new().set_or_clear_batching(Some(BatchingConfigProto::default()/* use setters */));
let x = MethodSettings::new().set_or_clear_batching(None::<BatchingConfigProto>);

Trait Implementations

impl Clone for MethodSettings

fn clone(&self) -> MethodSettings

Returns a duplicate 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

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 typename() -> &'static str

The typename of this message.

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