Class MethodSettings (2.17.0)
public sealed class MethodSettings : IMessage<MethodSettings>, IEquatable<MethodSettings>, IDeepCloneable<MethodSettings>, IBufferMessage, IMessage
Describes the generator configuration for a method.
Inheritance
object >
MethodSettings
Namespace
Google.Api
Assembly
Google.Api.CommonProtos.dll
Constructors
MethodSettings()
MethodSettings(MethodSettings)
public MethodSettings(MethodSettings other)
Fields
AutoPopulatedFieldsFieldNumber
public const int AutoPopulatedFieldsFieldNumber = 3
Field number for the "auto_populated_fields" field.
Field Value |
Type |
Description |
int |
|
LongRunningFieldNumber
public const int LongRunningFieldNumber = 2
Field number for the "long_running" field.
Field Value |
Type |
Description |
int |
|
SelectorFieldNumber
public const int SelectorFieldNumber = 1
Field number for the "selector" field.
Field Value |
Type |
Description |
int |
|
Properties
AutoPopulatedFields
public RepeatedField<string> AutoPopulatedFields { get; }
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:
Descriptor
public static MessageDescriptor Descriptor { get; }
LongRunning
public MethodSettings.Types.LongRunning LongRunning { get; set; }
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
Parser
public static MessageParser<MethodSettings> Parser { get; }
Selector
public string Selector { get; set; }
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...
Property Value |
Type |
Description |
string |
|
Methods
CalculateSize()
public int CalculateSize()
Returns |
Type |
Description |
int |
|
Clone()
public MethodSettings Clone()
Equals(MethodSettings)
public bool Equals(MethodSettings other)
Returns |
Type |
Description |
bool |
|
Equals(object)
public override bool Equals(object other)
Parameter |
Name |
Description |
other |
object
|
Returns |
Type |
Description |
bool |
|
Overrides
GetHashCode()
public override int GetHashCode()
Returns |
Type |
Description |
int |
|
Overrides
MergeFrom(MethodSettings)
public void MergeFrom(MethodSettings other)
public void MergeFrom(CodedInputStream input)
ToString()
public override string ToString()
Returns |
Type |
Description |
string |
|
Overrides
WriteTo(CodedOutputStream)
public void WriteTo(CodedOutputStream output)
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-10-10 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-10-10 UTC."],[],[]]