Class MethodSettings (2.15.0)

Version latest

• 2.15.0 (latest)
• 2.10.0
• 2.2.0

public sealed class MethodSettings : IMessage<MethodSettings>, IEquatable<MethodSettings>, IDeepCloneable<MethodSettings>, IBufferMessage, IMessage

Describes the generator configuration for a method.

Inheritance

object > MethodSettings

Implements

IMessageMethodSettings, IEquatableMethodSettings, IDeepCloneableMethodSettings, IBufferMessage, IMessage

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Namespace

Google.Api

Assembly

Google.Api.CommonProtos.dll

Constructors

MethodSettings()

public MethodSettings()

MethodSettings(MethodSettings)

public MethodSettings(MethodSettings other)

Parameter
Name	Description
other	MethodSettings

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:
  • request_id

Property Value
Type	Description
RepeatedFieldstring

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value
Type	Description
MessageDescriptor

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: seconds: 60 # 1 minute poll_delay_multiplier: 1.5 max_poll_delay: seconds: 360 # 6 minutes total_poll_timeout: seconds: 54000 # 90 minutes

Property Value
Type	Description
MethodSettingsTypesLongRunning

Parser

public static MessageParser<MethodSettings> Parser { get; }

Property Value
Type	Description
MessageParserMethodSettings

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.

Property Value
Type	Description
string

Methods

CalculateSize()

public int CalculateSize()

Calculates the size of this message in Protocol Buffer wire format, in bytes.

Returns
Type	Description
int	The number of bytes required to write this message to a coded output stream.

Clone()

public MethodSettings Clone()

Creates a deep clone of this object.

Returns
Type	Description
MethodSettings	A deep clone of this object.

Equals(MethodSettings)

public bool Equals(MethodSettings other)

Parameter
Name	Description
other	MethodSettings

Returns
Type	Description
bool

Equals(object)

public override bool Equals(object other)

Parameter
Name	Description
other	object

Returns
Type	Description
bool

Overrides

object.Equals(object)

GetHashCode()

public override int GetHashCode()

Returns
Type	Description
int

Overrides

object.GetHashCode()

MergeFrom(MethodSettings)

public void MergeFrom(MethodSettings other)

Merges the given message into this one.

Parameter
Name	Description
other	MethodSettings

Remarks

See the user guide for precise merge semantics.

MergeFrom(CodedInputStream)

public void MergeFrom(CodedInputStream input)

Merges the data from the specified coded input stream with the current message.

Parameter
Name	Description
input	CodedInputStream

Remarks

See the user guide for precise merge semantics.

ToString()

public override string ToString()

Returns
Type	Description
string

Overrides

object.ToString()

WriteTo(CodedOutputStream)

public void WriteTo(CodedOutputStream output)

Writes the data to the given coded output stream.

Parameter
Name	Description
output	CodedOutputStream Coded output stream to write the data to. Must not be null.