Reference documentation and code samples for the Google API Common Protos Client class MethodSettings.
Describes the generator configuration for a method.
Generated from protobuf message google.api.MethodSettings
Namespace
Google \ ApiMethods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ 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
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
↳ auto_populated_fields
array
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
getSelector
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...
string
setSelector
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...
var
string
$this
getLongRunning
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
hasLongRunning
clearLongRunning
setLongRunning
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
$this
getAutoPopulatedFields
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
setAutoPopulatedFields
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
var
string[]
$this