Class MethodSettings.LongRunning

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.protobuf.GeneratedMessage.ExtendableMessage<com.google.protobuf.GeneratedMessageV3>
com.google.protobuf.GeneratedMessageV3
com.google.api.MethodSettings.LongRunning
All Implemented Interfaces:
MethodSettings.LongRunningOrBuilder, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<com.google.protobuf.GeneratedMessageV3>, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
Enclosing class:
MethodSettings

public static final class MethodSettings.LongRunning extends com.google.protobuf.GeneratedMessageV3 implements MethodSettings.LongRunningOrBuilder
 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)).
 
Protobuf type google.api.MethodSettings.LongRunning
See Also:
  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    Describes settings to use when generating API methods that use the long-running operation pattern.

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

    com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage.ExtendableMessage

    com.google.protobuf.GeneratedMessage.ExtendableMessage.ExtensionSerializer, com.google.protobuf.GeneratedMessage.ExtendableMessage.ExtensionWriter

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

    com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T>

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
     
    static final int
     
    static final int
     
    static final int
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode
  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
     
     
     
    static final com.google.protobuf.Descriptors.Descriptor
     
    com.google.protobuf.Duration
    Initial delay after which the first poll request will be made.
    com.google.protobuf.DurationOrBuilder
    Initial delay after which the first poll request will be made.
    com.google.protobuf.Duration
    Maximum time between two subsequent poll requests.
    com.google.protobuf.DurationOrBuilder
    Maximum time between two subsequent poll requests.
    com.google.protobuf.Parser<MethodSettings.LongRunning>
     
    float
    Multiplier to gradually increase delay between subsequent polls until it reaches max_poll_delay.
    int
     
    com.google.protobuf.Duration
    Total polling timeout.
    com.google.protobuf.DurationOrBuilder
    Total polling timeout.
    int
     
    boolean
    Initial delay after which the first poll request will be made.
    boolean
    Maximum time between two subsequent poll requests.
    boolean
    Total polling timeout.
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
     
    final boolean
     
     
     
     
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
     
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    parseFrom(byte[] data)
     
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    parseFrom(com.google.protobuf.ByteString data)
     
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
     
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
     
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<MethodSettings.LongRunning>
     
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessageV3

    mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBuilderForType

    Methods inherited from class com.google.protobuf.GeneratedMessage.ExtendableMessage

    extensionsAreInitialized, extensionsSerializedSize, extensionsSerializedSizeAsMessageSet, getAllFields, getAllFieldsRaw, getExtension, getExtension, getExtensionCount, getExtensionFields, getField, getRepeatedField, getRepeatedFieldCount, hasExtension, hasField, newExtensionSerializer, newExtensionWriter, newMessageSetExtensionSerializer, newMessageSetExtensionWriter

    Methods inherited from class com.google.protobuf.GeneratedMessage

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getDescriptorForType, getOneofFieldDescriptor, getUnknownFields, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashFields, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
  • Field Details

    • INITIAL_POLL_DELAY_FIELD_NUMBER

      public static final int INITIAL_POLL_DELAY_FIELD_NUMBER
      See Also:
    • POLL_DELAY_MULTIPLIER_FIELD_NUMBER

      public static final int POLL_DELAY_MULTIPLIER_FIELD_NUMBER
      See Also:
    • MAX_POLL_DELAY_FIELD_NUMBER

      public static final int MAX_POLL_DELAY_FIELD_NUMBER
      See Also:
    • TOTAL_POLL_TIMEOUT_FIELD_NUMBER

      public static final int TOTAL_POLL_TIMEOUT_FIELD_NUMBER
      See Also:
  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3
    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Overrides:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3
    • hasInitialPollDelay

      public boolean hasInitialPollDelay()
       Initial delay after which the first poll request will be made.
       Default value: 5 seconds.
       
      .google.protobuf.Duration initial_poll_delay = 1;
      Specified by:
      hasInitialPollDelay in interface MethodSettings.LongRunningOrBuilder
      Returns:
      Whether the initialPollDelay field is set.
    • getInitialPollDelay

      public com.google.protobuf.Duration getInitialPollDelay()
       Initial delay after which the first poll request will be made.
       Default value: 5 seconds.
       
      .google.protobuf.Duration initial_poll_delay = 1;
      Specified by:
      getInitialPollDelay in interface MethodSettings.LongRunningOrBuilder
      Returns:
      The initialPollDelay.
    • getInitialPollDelayOrBuilder

      public com.google.protobuf.DurationOrBuilder getInitialPollDelayOrBuilder()
       Initial delay after which the first poll request will be made.
       Default value: 5 seconds.
       
      .google.protobuf.Duration initial_poll_delay = 1;
      Specified by:
      getInitialPollDelayOrBuilder in interface MethodSettings.LongRunningOrBuilder
    • getPollDelayMultiplier

      public float getPollDelayMultiplier()
       Multiplier to gradually increase delay between subsequent polls until it
       reaches max_poll_delay.
       Default value: 1.5.
       
      float poll_delay_multiplier = 2;
      Specified by:
      getPollDelayMultiplier in interface MethodSettings.LongRunningOrBuilder
      Returns:
      The pollDelayMultiplier.
    • hasMaxPollDelay

      public boolean hasMaxPollDelay()
       Maximum time between two subsequent poll requests.
       Default value: 45 seconds.
       
      .google.protobuf.Duration max_poll_delay = 3;
      Specified by:
      hasMaxPollDelay in interface MethodSettings.LongRunningOrBuilder
      Returns:
      Whether the maxPollDelay field is set.
    • getMaxPollDelay

      public com.google.protobuf.Duration getMaxPollDelay()
       Maximum time between two subsequent poll requests.
       Default value: 45 seconds.
       
      .google.protobuf.Duration max_poll_delay = 3;
      Specified by:
      getMaxPollDelay in interface MethodSettings.LongRunningOrBuilder
      Returns:
      The maxPollDelay.
    • getMaxPollDelayOrBuilder

      public com.google.protobuf.DurationOrBuilder getMaxPollDelayOrBuilder()
       Maximum time between two subsequent poll requests.
       Default value: 45 seconds.
       
      .google.protobuf.Duration max_poll_delay = 3;
      Specified by:
      getMaxPollDelayOrBuilder in interface MethodSettings.LongRunningOrBuilder
    • hasTotalPollTimeout

      public boolean hasTotalPollTimeout()
       Total polling timeout.
       Default value: 5 minutes.
       
      .google.protobuf.Duration total_poll_timeout = 4;
      Specified by:
      hasTotalPollTimeout in interface MethodSettings.LongRunningOrBuilder
      Returns:
      Whether the totalPollTimeout field is set.
    • getTotalPollTimeout

      public com.google.protobuf.Duration getTotalPollTimeout()
       Total polling timeout.
       Default value: 5 minutes.
       
      .google.protobuf.Duration total_poll_timeout = 4;
      Specified by:
      getTotalPollTimeout in interface MethodSettings.LongRunningOrBuilder
      Returns:
      The totalPollTimeout.
    • getTotalPollTimeoutOrBuilder

      public com.google.protobuf.DurationOrBuilder getTotalPollTimeoutOrBuilder()
       Total polling timeout.
       Default value: 5 minutes.
       
      .google.protobuf.Duration total_poll_timeout = 4;
      Specified by:
      getTotalPollTimeoutOrBuilder in interface MethodSettings.LongRunningOrBuilder
    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.ExtendableMessage<com.google.protobuf.GeneratedMessageV3>
    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException
    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage
    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage
    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage
    • parseFrom

      public static MethodSettings.LongRunning parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static MethodSettings.LongRunning parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static MethodSettings.LongRunning parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static MethodSettings.LongRunning parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static MethodSettings.LongRunning parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static MethodSettings.LongRunning parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static MethodSettings.LongRunning parseFrom(InputStream input) throws IOException
      Throws:
      IOException
    • parseFrom

      public static MethodSettings.LongRunning parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • parseDelimitedFrom

      public static MethodSettings.LongRunning parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException
    • parseDelimitedFrom

      public static MethodSettings.LongRunning parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • parseFrom

      public static MethodSettings.LongRunning parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException
    • parseFrom

      public static MethodSettings.LongRunning parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • newBuilderForType

      public MethodSettings.LongRunning.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite
    • newBuilder

      public static MethodSettings.LongRunning.Builder newBuilder()
    • newBuilder

      public static MethodSettings.LongRunning.Builder newBuilder(MethodSettings.LongRunning prototype)
    • toBuilder

      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite
    • newBuilderForType

      protected MethodSettings.LongRunning.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3
    • getDefaultInstance

      public static MethodSettings.LongRunning getDefaultInstance()
    • parser

      public static com.google.protobuf.Parser<MethodSettings.LongRunning> parser()
    • getParserForType

      public com.google.protobuf.Parser<MethodSettings.LongRunning> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage
    • getDefaultInstanceForType

      public MethodSettings.LongRunning getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<com.google.protobuf.GeneratedMessageV3>
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder