Class MethodSettings.Types.LongRunning (2.15.0)

Version latest

• 2.15.0 (latest)
• 2.10.0
• 2.2.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

Implements

IMessageMethodSettingsTypesLongRunning, IEquatableMethodSettingsTypesLongRunning, IDeepCloneableMethodSettingsTypesLongRunning, IBufferMessage, IMessage

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

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()

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.Types.LongRunning Clone()

Creates a deep clone of this object.

Returns
Type	Description
MethodSettingsTypesLongRunning	A deep clone of this object.

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

object.Equals(object)

GetHashCode()

public override int GetHashCode()

Returns
Type	Description
int

Overrides

object.GetHashCode()

MergeFrom(LongRunning)

public void MergeFrom(MethodSettings.Types.LongRunning other)

Merges the given message into this one.

Parameter
Name	Description
other	MethodSettingsTypesLongRunning

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.