Package com.google.api

Class MethodSettings.LongRunning.Builder

  • All Implemented Interfaces:
    MethodSettings.LongRunningOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
    Enclosing class:
    MethodSettings.LongRunning
    public static final class MethodSettings.LongRunning.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<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 Detail

      • getDescriptor

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

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<MethodSettings.LongRunning.Builder>

      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<MethodSettings.LongRunning.Builder>

      • getDefaultInstanceForType

        public MethodSettings.LongRunning getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

      • build

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

      • buildPartial

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

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<MethodSettings.LongRunning.Builder>

      • mergeFrom

        public MethodSettings.LongRunning.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                             throws IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<MethodSettings.LongRunning.Builder>
        Throws:
        IOException

      • 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.

      • 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;

      • 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;

      • 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;

      • 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;

      • getInitialPollDelayBuilder

        public com.google.protobuf.Duration.Builder getInitialPollDelayBuilder()
         Initial delay after which the first poll request will be made.
 Default value: 5 seconds.
        .google.protobuf.Duration initial_poll_delay = 1;

      • 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.

      • 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;
        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;
        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;
        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.

      • 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;

      • 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;

      • 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;

      • clearMaxPollDelay

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

      • getMaxPollDelayBuilder

        public com.google.protobuf.Duration.Builder getMaxPollDelayBuilder()
         Maximum time between two subsequent poll requests.
 Default value: 45 seconds.
        .google.protobuf.Duration max_poll_delay = 3;

      • 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.

      • 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;

      • 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;

      • 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;

      • clearTotalPollTimeout

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

      • getTotalPollTimeoutBuilder

        public com.google.protobuf.Duration.Builder getTotalPollTimeoutBuilder()
         Total polling timeout.
 Default value: 5 minutes.
        .google.protobuf.Duration total_poll_timeout = 4;

      • setUnknownFields

        public final MethodSettings.LongRunning.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<MethodSettings.LongRunning.Builder>

      • mergeUnknownFields

        public final MethodSettings.LongRunning.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<MethodSettings.LongRunning.Builder>