Package com.google.api

Class MethodSettings.LongRunning

  • All Implemented Interfaces:
    MethodSettings.LongRunningOrBuilder, 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:
    Serialized Form

    • Field Detail

      • INITIAL_POLL_DELAY_FIELD_NUMBER

        public static final int INITIAL_POLL_DELAY_FIELD_NUMBER
        See Also:
        Constant Field Values

      • POLL_DELAY_MULTIPLIER_FIELD_NUMBER

        public static final int POLL_DELAY_MULTIPLIER_FIELD_NUMBER
        See Also:
        Constant Field Values

      • MAX_POLL_DELAY_FIELD_NUMBER

        public static final int MAX_POLL_DELAY_FIELD_NUMBER
        See Also:
        Constant Field Values

      • TOTAL_POLL_TIMEOUT_FIELD_NUMBER

        public static final int TOTAL_POLL_TIMEOUT_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

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

      • getUnknownFields

        public final com.google.protobuf.UnknownFieldSet getUnknownFields()
        Specified by:
        getUnknownFields in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getUnknownFields in class com.google.protobuf.GeneratedMessageV3

      • 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

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

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class 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.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

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

      • 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

      • newBuilderForType

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

      • toBuilder

        public MethodSettings.LongRunning.Builder 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

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

      • getDefaultInstanceForType

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