Google Cloud Support V2 API - Class Google::Api::MethodSettings (v1.1.0)

Reference documentation and code samples for the Google Cloud Support V2 API class Google::Api::MethodSettings.

Describes the generator configuration for a method.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#auto_populated_fields

def auto_populated_fields() -> ::Array<::String>
Returns
  • (::Array<::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

#auto_populated_fields=

def auto_populated_fields=(value) -> ::Array<::String>
Parameter
  • value (::Array<::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

Returns
  • (::Array<::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

#long_running

def long_running() -> ::Google::Api::MethodSettings::LongRunning
Returns
  • (::Google::Api::MethodSettings::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

#long_running=

def long_running=(value) -> ::Google::Api::MethodSettings::LongRunning
Parameter
  • value (::Google::Api::MethodSettings::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

Returns
  • (::Google::Api::MethodSettings::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

#selector

def selector() -> ::String
Returns
  • (::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...

#selector=

def selector=(value) -> ::String
Parameter
  • value (::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...

Returns
  • (::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...