Class MethodSettings.Types.LongRunning (2.10.0) 

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

Describes settings to use when generating API methods that use the long-running operation pattern. All default values below are from those used in the client library generators (e.g. Java).

Inheritance

object > MethodSettings.Types.LongRunning

Namespace

Google.Api

Assembly

Google.Api.CommonProtos.dll

Constructors

LongRunning()

public LongRunning()

LongRunning(LongRunning)

public LongRunning(MethodSettings.Types.LongRunning other)
Parameter
Name Description
other MethodSettingsTypesLongRunning

Fields

InitialPollDelayFieldNumber

public const int InitialPollDelayFieldNumber = 1

Field number for the "initial_poll_delay" field.

Field Value
Type Description
int

MaxPollDelayFieldNumber

public const int MaxPollDelayFieldNumber = 3

Field number for the "max_poll_delay" field.

Field Value
Type Description
int

PollDelayMultiplierFieldNumber

public const int PollDelayMultiplierFieldNumber = 2

Field number for the "poll_delay_multiplier" field.

Field Value
Type Description
int

TotalPollTimeoutFieldNumber

public const int TotalPollTimeoutFieldNumber = 4

Field number for the "total_poll_timeout" field.

Field Value
Type Description
int

Properties

Descriptor

public static MessageDescriptor Descriptor { get; }
Property Value
Type Description
MessageDescriptor

InitialPollDelay

public Duration InitialPollDelay { get; set; }

Initial delay after which the first poll request will be made. Default value: 5 seconds.

Property Value
Type Description
Duration

MaxPollDelay

public Duration MaxPollDelay { get; set; }

Maximum time between two subsequent poll requests. Default value: 45 seconds.

Property Value
Type Description
Duration

Parser

public static MessageParser<MethodSettings.Types.LongRunning> Parser { get; }
Property Value
Type Description
MessageParserMethodSettingsTypesLongRunning

PollDelayMultiplier

public float PollDelayMultiplier { get; set; }

Multiplier to gradually increase delay between subsequent polls until it reaches max_poll_delay. Default value: 1.5.

Property Value
Type Description
float

TotalPollTimeout

public Duration TotalPollTimeout { get; set; }

Total polling timeout. Default value: 5 minutes.

Property Value
Type Description
Duration

Methods

CalculateSize()

public int CalculateSize()
Returns
Type Description
int

Clone()

public MethodSettings.Types.LongRunning Clone()
Returns
Type Description
MethodSettingsTypesLongRunning

Equals(LongRunning)

public bool Equals(MethodSettings.Types.LongRunning other)
Parameter
Name Description
other MethodSettingsTypesLongRunning
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(LongRunning)

public void MergeFrom(MethodSettings.Types.LongRunning other)
Parameter
Name Description
other MethodSettingsTypesLongRunning

MergeFrom(CodedInputStream)

public void MergeFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream

ToString()

public override string ToString()
Returns
Type Description
string
Overrides

WriteTo(CodedOutputStream)

public void WriteTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream