Package com.google.api

Class MethodSettings.LongRunning.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder<MessageType,BuilderType>
com.google.protobuf.GeneratedMessageLite.Builder<MethodSettings.LongRunning,MethodSettings.LongRunning.Builder>
com.google.api.MethodSettings.LongRunning.Builder
All Implemented Interfaces:
MethodSettings.LongRunningOrBuilder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, Cloneable
Enclosing class:
MethodSettings.LongRunning
public static final class MethodSettings.LongRunning.Builder extends com.google.protobuf.GeneratedMessageLite.Builder<MethodSettings.LongRunning,MethodSettings.LongRunning.Builder> 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

  • Method Details

    • 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 [json_name = "initialPollDelay"];
      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 [json_name = "initialPollDelay"];
      Specified by:
      getInitialPollDelay in interface MethodSettings.LongRunningOrBuilder
      Returns:
      The initialPollDelay.

    • setInitialPollDelay

      public MethodSettings.LongRunning.Builder setInitialPollDelay(com.google.protobuf.Duration value)
       Initial delay after which the first poll request will be made.
 Default value: 5 seconds.
      .google.protobuf.Duration initial_poll_delay = 1 [json_name = "initialPollDelay"];

    • setInitialPollDelay

      public MethodSettings.LongRunning.Builder setInitialPollDelay(com.google.protobuf.Duration.Builder builderForValue)
       Initial delay after which the first poll request will be made.
 Default value: 5 seconds.
      .google.protobuf.Duration initial_poll_delay = 1 [json_name = "initialPollDelay"];

    • mergeInitialPollDelay

      public MethodSettings.LongRunning.Builder mergeInitialPollDelay(com.google.protobuf.Duration value)
       Initial delay after which the first poll request will be made.
 Default value: 5 seconds.
      .google.protobuf.Duration initial_poll_delay = 1 [json_name = "initialPollDelay"];

    • clearInitialPollDelay

      public MethodSettings.LongRunning.Builder clearInitialPollDelay()
       Initial delay after which the first poll request will be made.
 Default value: 5 seconds.
      .google.protobuf.Duration initial_poll_delay = 1 [json_name = "initialPollDelay"];

    • 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 [json_name = "pollDelayMultiplier"];
      Specified by:
      getPollDelayMultiplier in interface MethodSettings.LongRunningOrBuilder
      Returns:
      The pollDelayMultiplier.

    • setPollDelayMultiplier

      public MethodSettings.LongRunning.Builder setPollDelayMultiplier(float value)
       Multiplier to gradually increase delay between subsequent polls until it
 reaches max_poll_delay.
 Default value: 1.5.
      float poll_delay_multiplier = 2 [json_name = "pollDelayMultiplier"];
      Parameters:
      value - The pollDelayMultiplier to set.
      Returns:
      This builder for chaining.

    • clearPollDelayMultiplier

      public MethodSettings.LongRunning.Builder clearPollDelayMultiplier()
       Multiplier to gradually increase delay between subsequent polls until it
 reaches max_poll_delay.
 Default value: 1.5.
      float poll_delay_multiplier = 2 [json_name = "pollDelayMultiplier"];
      Returns:
      This builder for chaining.

    • hasMaxPollDelay

      public boolean hasMaxPollDelay()
       Maximum time between two subsequent poll requests.
 Default value: 45 seconds.
      .google.protobuf.Duration max_poll_delay = 3 [json_name = "maxPollDelay"];
      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 [json_name = "maxPollDelay"];
      Specified by:
      getMaxPollDelay in interface MethodSettings.LongRunningOrBuilder
      Returns:
      The maxPollDelay.

    • setMaxPollDelay

      public MethodSettings.LongRunning.Builder setMaxPollDelay(com.google.protobuf.Duration value)
       Maximum time between two subsequent poll requests.
 Default value: 45 seconds.
      .google.protobuf.Duration max_poll_delay = 3 [json_name = "maxPollDelay"];

    • setMaxPollDelay

      public MethodSettings.LongRunning.Builder setMaxPollDelay(com.google.protobuf.Duration.Builder builderForValue)
       Maximum time between two subsequent poll requests.
 Default value: 45 seconds.
      .google.protobuf.Duration max_poll_delay = 3 [json_name = "maxPollDelay"];

    • mergeMaxPollDelay

      public MethodSettings.LongRunning.Builder mergeMaxPollDelay(com.google.protobuf.Duration value)
       Maximum time between two subsequent poll requests.
 Default value: 45 seconds.
      .google.protobuf.Duration max_poll_delay = 3 [json_name = "maxPollDelay"];

    • clearMaxPollDelay

      public MethodSettings.LongRunning.Builder clearMaxPollDelay()
       Maximum time between two subsequent poll requests.
 Default value: 45 seconds.
      .google.protobuf.Duration max_poll_delay = 3 [json_name = "maxPollDelay"];

    • hasTotalPollTimeout

      public boolean hasTotalPollTimeout()
       Total polling timeout.
 Default value: 5 minutes.
      .google.protobuf.Duration total_poll_timeout = 4 [json_name = "totalPollTimeout"];
      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 [json_name = "totalPollTimeout"];
      Specified by:
      getTotalPollTimeout in interface MethodSettings.LongRunningOrBuilder
      Returns:
      The totalPollTimeout.

    • setTotalPollTimeout

      public MethodSettings.LongRunning.Builder setTotalPollTimeout(com.google.protobuf.Duration value)
       Total polling timeout.
 Default value: 5 minutes.
      .google.protobuf.Duration total_poll_timeout = 4 [json_name = "totalPollTimeout"];

    • setTotalPollTimeout

      public MethodSettings.LongRunning.Builder setTotalPollTimeout(com.google.protobuf.Duration.Builder builderForValue)
       Total polling timeout.
 Default value: 5 minutes.
      .google.protobuf.Duration total_poll_timeout = 4 [json_name = "totalPollTimeout"];

    • mergeTotalPollTimeout

      public MethodSettings.LongRunning.Builder mergeTotalPollTimeout(com.google.protobuf.Duration value)
       Total polling timeout.
 Default value: 5 minutes.
      .google.protobuf.Duration total_poll_timeout = 4 [json_name = "totalPollTimeout"];

    • clearTotalPollTimeout

      public MethodSettings.LongRunning.Builder clearTotalPollTimeout()
       Total polling timeout.
 Default value: 5 minutes.
      .google.protobuf.Duration total_poll_timeout = 4 [json_name = "totalPollTimeout"];