Package com.google.api
Class MethodSettings.LongRunning.Builder
java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<MethodSettings.LongRunning.Builder>
com.google.api.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.GeneratedMessage.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 Summary
Modifier and TypeMethodDescriptionbuild()clear()Initial delay after which the first poll request will be made.Maximum time between two subsequent poll requests.Multiplier to gradually increase delay between subsequent polls until it reaches max_poll_delay.Total polling timeout.static final com.google.protobuf.Descriptors.Descriptorcom.google.protobuf.Descriptors.Descriptorcom.google.protobuf.DurationInitial delay after which the first poll request will be made.com.google.protobuf.Duration.BuilderInitial delay after which the first poll request will be made.com.google.protobuf.DurationOrBuilderInitial delay after which the first poll request will be made.com.google.protobuf.DurationMaximum time between two subsequent poll requests.com.google.protobuf.Duration.BuilderMaximum time between two subsequent poll requests.com.google.protobuf.DurationOrBuilderMaximum time between two subsequent poll requests.floatMultiplier to gradually increase delay between subsequent polls until it reaches max_poll_delay.com.google.protobuf.DurationTotal polling timeout.com.google.protobuf.Duration.BuilderTotal polling timeout.com.google.protobuf.DurationOrBuilderTotal polling timeout.booleanInitial delay after which the first poll request will be made.booleanMaximum time between two subsequent poll requests.booleanTotal polling timeout.protected com.google.protobuf.GeneratedMessage.FieldAccessorTablefinal booleanmergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) mergeFrom(com.google.protobuf.Message other) mergeInitialPollDelay(com.google.protobuf.Duration value) Initial delay after which the first poll request will be made.mergeMaxPollDelay(com.google.protobuf.Duration value) Maximum time between two subsequent poll requests.mergeTotalPollTimeout(com.google.protobuf.Duration value) Total polling timeout.setInitialPollDelay(com.google.protobuf.Duration value) Initial delay after which the first poll request will be made.setInitialPollDelay(com.google.protobuf.Duration.Builder builderForValue) Initial delay after which the first poll request will be made.setMaxPollDelay(com.google.protobuf.Duration value) Maximum time between two subsequent poll requests.setMaxPollDelay(com.google.protobuf.Duration.Builder builderForValue) Maximum time between two subsequent poll requests.setPollDelayMultiplier(float value) Multiplier to gradually increase delay between subsequent polls until it reaches max_poll_delay.setTotalPollTimeout(com.google.protobuf.Duration value) Total polling timeout.setTotalPollTimeout(com.google.protobuf.Duration.Builder builderForValue) Total polling timeout.Methods inherited from class com.google.protobuf.GeneratedMessage.Builder
addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, setUnknownFieldSetBuilder, setUnknownFieldsProto3Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringMethods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageExceptionMethods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.protobuf.Message.Builder
mergeDelimitedFrom, mergeDelimitedFromMethods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFromMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Method Details
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessage.Builder<MethodSettings.LongRunning.Builder>
-
clear
- Specified by:
clearin interfacecom.google.protobuf.Message.Builder- Specified by:
clearin interfacecom.google.protobuf.MessageLite.Builder- Overrides:
clearin classcom.google.protobuf.GeneratedMessage.Builder<MethodSettings.LongRunning.Builder>
-
getDescriptorForType
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.Message.Builder- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.MessageOrBuilder- Overrides:
getDescriptorForTypein classcom.google.protobuf.GeneratedMessage.Builder<MethodSettings.LongRunning.Builder>
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-
build
- Specified by:
buildin interfacecom.google.protobuf.Message.Builder- Specified by:
buildin interfacecom.google.protobuf.MessageLite.Builder
-
buildPartial
- Specified by:
buildPartialin interfacecom.google.protobuf.Message.Builder- Specified by:
buildPartialin interfacecom.google.protobuf.MessageLite.Builder
-
mergeFrom
- Specified by:
mergeFromin interfacecom.google.protobuf.Message.Builder- Overrides:
mergeFromin classcom.google.protobuf.AbstractMessage.Builder<MethodSettings.LongRunning.Builder>
-
mergeFrom
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessage.Builder<MethodSettings.LongRunning.Builder>
-
mergeFrom
public MethodSettings.LongRunning.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Specified by:
mergeFromin interfacecom.google.protobuf.Message.Builder- Specified by:
mergeFromin interfacecom.google.protobuf.MessageLite.Builder- Overrides:
mergeFromin classcom.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:
hasInitialPollDelayin interfaceMethodSettings.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:
getInitialPollDelayin interfaceMethodSettings.LongRunningOrBuilder- Returns:
- The initialPollDelay.
-
setInitialPollDelay
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
Initial delay after which the first poll request will be made. Default value: 5 seconds.
.google.protobuf.Duration initial_poll_delay = 1; -
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:
getInitialPollDelayOrBuilderin interfaceMethodSettings.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:
getPollDelayMultiplierin interfaceMethodSettings.LongRunningOrBuilder- Returns:
- The pollDelayMultiplier.
-
setPollDelayMultiplier
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
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:
hasMaxPollDelayin interfaceMethodSettings.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:
getMaxPollDelayin interfaceMethodSettings.LongRunningOrBuilder- Returns:
- The maxPollDelay.
-
setMaxPollDelay
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
Maximum time between two subsequent poll requests. Default value: 45 seconds.
.google.protobuf.Duration max_poll_delay = 3; -
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:
getMaxPollDelayOrBuilderin interfaceMethodSettings.LongRunningOrBuilder
-
hasTotalPollTimeout
public boolean hasTotalPollTimeout()Total polling timeout. Default value: 5 minutes.
.google.protobuf.Duration total_poll_timeout = 4;- Specified by:
hasTotalPollTimeoutin interfaceMethodSettings.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:
getTotalPollTimeoutin interfaceMethodSettings.LongRunningOrBuilder- Returns:
- The totalPollTimeout.
-
setTotalPollTimeout
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
Total polling timeout. Default value: 5 minutes.
.google.protobuf.Duration total_poll_timeout = 4; -
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; -
getTotalPollTimeoutOrBuilder
public com.google.protobuf.DurationOrBuilder getTotalPollTimeoutOrBuilder()Total polling timeout. Default value: 5 minutes.
.google.protobuf.Duration total_poll_timeout = 4;- Specified by:
getTotalPollTimeoutOrBuilderin interfaceMethodSettings.LongRunningOrBuilder
-