LongRunning

com.google.api.client.MethodSettings.LongRunning
See theLongRunning companion object
final case class LongRunning(initialPollDelay: Option[Duration], pollDelayMultiplier: Float, maxPollDelay: Option[Duration], totalPollTimeout: Option[Duration], unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[LongRunning]

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](https://github.com/googleapis/gapic-generator-java/blob/04c2faa191a9b5a10b92392fe8482279c4404803/src/main/java/com/google/api/generator/gapic/composer/common/RetrySettingsComposer.java)).

Value parameters

initialPollDelay

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

maxPollDelay

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

pollDelayMultiplier

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

totalPollTimeout

Total polling timeout. Default value: 5 minutes.

Attributes

Companion
object
Source
MethodSettings.scala
Graph
Supertypes
trait Updatable[LongRunning]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all

Members list

Value members

Concrete methods

Attributes

Source
MethodSettings.scala
def getField(`__field`: FieldDescriptor): PValue

Attributes

Source
MethodSettings.scala
def getFieldByNumber(`__fieldNumber`: Int): Any

Attributes

Source
MethodSettings.scala
override def serializedSize: Int

Attributes

Definition Classes
GeneratedMessage
Source
MethodSettings.scala
def toProtoString: String

Returns a human-readable ASCII format representation of this message.

Returns a human-readable ASCII format representation of this message.

The original message can be decoded from this format by using fromAscii on the companion object.

Attributes

Returns

human-readable representation of this message.

Source
MethodSettings.scala

Attributes

Source
MethodSettings.scala
def withUnknownFields(`__v`: UnknownFieldSet): LongRunning

Attributes

Source
MethodSettings.scala
def writeTo(`_output__`: CodedOutputStream): Unit

Serializes the message into the given coded output stream

Serializes the message into the given coded output stream

Attributes

Source
MethodSettings.scala

Inherited methods

def productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product
final def toByteArray: Array[Byte]

Serializes the message and returns a byte array containing its raw bytes

Serializes the message and returns a byte array containing its raw bytes

Attributes

Inherited from:
GeneratedMessage
Source
GeneratedMessageCompanion.scala
final def toByteString: ByteString

Serializes the message and returns a ByteString containing its raw bytes

Serializes the message and returns a ByteString containing its raw bytes

Attributes

Inherited from:
GeneratedMessage
Source
GeneratedMessageCompanion.scala
final def toPMessage: PMessage

Attributes

Inherited from:
GeneratedMessage
Source
GeneratedMessageCompanion.scala
def update(ms: Lens[LongRunning, LongRunning] => () => LongRunning*): A

Attributes

Inherited from:
Updatable
Source
Lenses.scala
final def writeDelimitedTo(output: OutputStream): Unit

Attributes

Inherited from:
GeneratedMessage
Source
GeneratedMessageCompanion.scala
final def writeTo(output: OutputStream): Unit

Serializes the message into the given output stream

Serializes the message into the given output stream

Attributes

Inherited from:
GeneratedMessage
Source
GeneratedMessageCompanion.scala