Reference documentation and code samples for the Google API Common Protos Client class MethodSettings.
Describes the generator configuration for a method.
Generated from protobuf messagegoogle.api.MethodSettings
Namespace
Google \ Api
Methods
__construct
Constructor.
Parameters
Name
Description
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...
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...
Returns
Type
Description
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...
Parameter
Name
Description
var
string
Returns
Type
Description
$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:
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:
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:
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:
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google API Common Protos Client - Class MethodSettings (4.12.3)\n\nVersion latestkeyboard_arrow_down\n\n- [4.12.3 (latest)](/php/docs/reference/common-protos/latest/Api.MethodSettings)\n- [4.12.2](/php/docs/reference/common-protos/4.12.2/Api.MethodSettings)\n- [4.11.0](/php/docs/reference/common-protos/4.11.0/Api.MethodSettings)\n- [4.10.0](/php/docs/reference/common-protos/4.10.0/Api.MethodSettings)\n- [4.9.0](/php/docs/reference/common-protos/4.9.0/Api.MethodSettings)\n- [4.8.3](/php/docs/reference/common-protos/4.8.3/Api.MethodSettings) \nReference documentation and code samples for the Google API Common Protos Client class MethodSettings.\n\nDescribes the generator configuration for a method.\n\nGenerated from protobuf message `google.api.MethodSettings`\n\nNamespace\n---------\n\nGoogle \\\\ Api\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getSelector\n\nThe fully qualified name of the method, for which the options below apply.\n\nThis is used to find the method to apply the options.\nExample:\npublishing:\nmethod_settings:\n\n- selector: google.storage.control.v2.StorageControl.CreateFolder # method settings for CreateFolder...\n\n### setSelector\n\nThe fully qualified name of the method, for which the options below apply.\n\nThis is used to find the method to apply the options.\nExample:\npublishing:\nmethod_settings:\n\n- selector: google.storage.control.v2.StorageControl.CreateFolder # method settings for CreateFolder...\n\n### getLongRunning\n\nDescribes settings to use for long-running operations when generating\nAPI methods for RPCs. Complements RPCs that use the annotations in\ngoogle/longrunning/operations.proto.\n\nExample of a YAML configuration::\npublishing:\nmethod_settings:\n\n- 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\n\n### hasLongRunning\n\n### clearLongRunning\n\n### setLongRunning\n\nDescribes settings to use for long-running operations when generating\nAPI methods for RPCs. Complements RPCs that use the annotations in\ngoogle/longrunning/operations.proto.\n\nExample of a YAML configuration::\npublishing:\nmethod_settings:\n\n- 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\n\n### getAutoPopulatedFields\n\nList of top-level fields of the request message, that should be\nautomatically populated by the client libraries based on their\n(google.api.field_info).format. Currently supported format: UUID4.\n\nExample of a YAML configuration:\npublishing:\nmethod_settings:\n\n- selector: google.example.v1.ExampleService.CreateExample auto_populated_fields:\n - request_id\n\n### setAutoPopulatedFields\n\nList of top-level fields of the request message, that should be\nautomatically populated by the client libraries based on their\n(google.api.field_info).format. Currently supported format: UUID4.\n\nExample of a YAML configuration:\npublishing:\nmethod_settings:\n\n- selector: google.example.v1.ExampleService.CreateExample auto_populated_fields:\n - request_id"]]
