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<BuilderT>
-
- com.google.protobuf.GeneratedMessage.ExtendableBuilder<com.google.protobuf.GeneratedMessageV3,BuilderT>
-
- com.google.protobuf.GeneratedMessageV3.Builder<MethodSettings.LongRunning.Builder>
-
- com.google.api.MethodSettings.LongRunning.Builder
-
- All Implemented Interfaces:
MethodSettings.LongRunningOrBuilder
,com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<com.google.protobuf.GeneratedMessageV3>
,com.google.protobuf.Message.Builder
,com.google.protobuf.MessageLite.Builder
,com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
,java.lang.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 typegoogle.api.MethodSettings.LongRunning
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description MethodSettings.LongRunning.Builder
addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)
MethodSettings.LongRunning
build()
MethodSettings.LongRunning
buildPartial()
MethodSettings.LongRunning.Builder
clear()
MethodSettings.LongRunning.Builder
clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
MethodSettings.LongRunning.Builder
clearInitialPollDelay()
Initial delay after which the first poll request will be made.MethodSettings.LongRunning.Builder
clearMaxPollDelay()
Maximum time between two subsequent poll requests.MethodSettings.LongRunning.Builder
clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
MethodSettings.LongRunning.Builder
clearPollDelayMultiplier()
Multiplier to gradually increase delay between subsequent polls until it reaches max_poll_delay.MethodSettings.LongRunning.Builder
clearTotalPollTimeout()
Total polling timeout.MethodSettings.LongRunning.Builder
clone()
MethodSettings.LongRunning
getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor
getDescriptor()
com.google.protobuf.Descriptors.Descriptor
getDescriptorForType()
com.google.protobuf.Duration
getInitialPollDelay()
Initial delay after which the first poll request will be made.com.google.protobuf.Duration.Builder
getInitialPollDelayBuilder()
Initial delay after which the first poll request will be made.com.google.protobuf.DurationOrBuilder
getInitialPollDelayOrBuilder()
Initial delay after which the first poll request will be made.com.google.protobuf.Duration
getMaxPollDelay()
Maximum time between two subsequent poll requests.com.google.protobuf.Duration.Builder
getMaxPollDelayBuilder()
Maximum time between two subsequent poll requests.com.google.protobuf.DurationOrBuilder
getMaxPollDelayOrBuilder()
Maximum time between two subsequent poll requests.float
getPollDelayMultiplier()
Multiplier to gradually increase delay between subsequent polls until it reaches max_poll_delay.com.google.protobuf.Duration
getTotalPollTimeout()
Total polling timeout.com.google.protobuf.Duration.Builder
getTotalPollTimeoutBuilder()
Total polling timeout.com.google.protobuf.DurationOrBuilder
getTotalPollTimeoutOrBuilder()
Total polling timeout.boolean
hasInitialPollDelay()
Initial delay after which the first poll request will be made.boolean
hasMaxPollDelay()
Maximum time between two subsequent poll requests.boolean
hasTotalPollTimeout()
Total polling timeout.protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
internalGetFieldAccessorTable()
boolean
isInitialized()
MethodSettings.LongRunning.Builder
mergeFrom(MethodSettings.LongRunning other)
MethodSettings.LongRunning.Builder
mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
MethodSettings.LongRunning.Builder
mergeFrom(com.google.protobuf.Message other)
MethodSettings.LongRunning.Builder
mergeInitialPollDelay(com.google.protobuf.Duration value)
Initial delay after which the first poll request will be made.MethodSettings.LongRunning.Builder
mergeMaxPollDelay(com.google.protobuf.Duration value)
Maximum time between two subsequent poll requests.MethodSettings.LongRunning.Builder
mergeTotalPollTimeout(com.google.protobuf.Duration value)
Total polling timeout.MethodSettings.LongRunning.Builder
mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
MethodSettings.LongRunning.Builder
setField(com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)
MethodSettings.LongRunning.Builder
setInitialPollDelay(com.google.protobuf.Duration value)
Initial delay after which the first poll request will be made.MethodSettings.LongRunning.Builder
setInitialPollDelay(com.google.protobuf.Duration.Builder builderForValue)
Initial delay after which the first poll request will be made.MethodSettings.LongRunning.Builder
setMaxPollDelay(com.google.protobuf.Duration value)
Maximum time between two subsequent poll requests.MethodSettings.LongRunning.Builder
setMaxPollDelay(com.google.protobuf.Duration.Builder builderForValue)
Maximum time between two subsequent poll requests.MethodSettings.LongRunning.Builder
setPollDelayMultiplier(float value)
Multiplier to gradually increase delay between subsequent polls until it reaches max_poll_delay.MethodSettings.LongRunning.Builder
setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, java.lang.Object value)
MethodSettings.LongRunning.Builder
setTotalPollTimeout(com.google.protobuf.Duration value)
Total polling timeout.MethodSettings.LongRunning.Builder
setTotalPollTimeout(com.google.protobuf.Duration.Builder builderForValue)
Total polling timeout.MethodSettings.LongRunning.Builder
setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
-
Methods inherited from class com.google.protobuf.GeneratedMessage.ExtendableBuilder
addExtension, clearExtension, extensionsAreInitialized, getAllFields, getExtension, getExtension, getExtensionCount, getField, getFieldBuilder, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, hasExtension, hasField, mergeExtensionFields, newBuilderForField, parseUnknownField, setExtension, setExtension
-
Methods inherited from class com.google.protobuf.GeneratedMessage.Builder
getOneofFieldDescriptor, getUnknownFields, getUnknownFieldSetBuilder, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, onBuilt, onChanged, setUnknownFieldSetBuilder, setUnknownFieldsProto3
-
Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString
-
Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException
-
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
-
-
-
Method Detail
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
-
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
- Overrides:
internalGetFieldAccessorTable
in classcom.google.protobuf.GeneratedMessageV3.Builder<MethodSettings.LongRunning.Builder>
-
clear
public MethodSettings.LongRunning.Builder clear()
- Specified by:
clear
in interfacecom.google.protobuf.Message.Builder
- Specified by:
clear
in interfacecom.google.protobuf.MessageLite.Builder
- Overrides:
clear
in classcom.google.protobuf.GeneratedMessageV3.Builder<MethodSettings.LongRunning.Builder>
-
getDescriptorForType
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
- Specified by:
getDescriptorForType
in interfacecom.google.protobuf.Message.Builder
- Specified by:
getDescriptorForType
in interfacecom.google.protobuf.MessageOrBuilder
- Overrides:
getDescriptorForType
in classcom.google.protobuf.GeneratedMessage.Builder<MethodSettings.LongRunning.Builder>
-
getDefaultInstanceForType
public MethodSettings.LongRunning getDefaultInstanceForType()
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<com.google.protobuf.GeneratedMessageV3>
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageOrBuilder
-
build
public MethodSettings.LongRunning build()
- Specified by:
build
in interfacecom.google.protobuf.Message.Builder
- Specified by:
build
in interfacecom.google.protobuf.MessageLite.Builder
-
buildPartial
public MethodSettings.LongRunning buildPartial()
- Specified by:
buildPartial
in interfacecom.google.protobuf.Message.Builder
- Specified by:
buildPartial
in interfacecom.google.protobuf.MessageLite.Builder
-
clone
public MethodSettings.LongRunning.Builder clone()
- Specified by:
clone
in interfacecom.google.protobuf.Message.Builder
- Specified by:
clone
in interfacecom.google.protobuf.MessageLite.Builder
- Overrides:
clone
in classcom.google.protobuf.GeneratedMessageV3.Builder<MethodSettings.LongRunning.Builder>
-
setField
public MethodSettings.LongRunning.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)
- Specified by:
setField
in interfacecom.google.protobuf.Message.Builder
- Overrides:
setField
in classcom.google.protobuf.GeneratedMessageV3.Builder<MethodSettings.LongRunning.Builder>
-
clearField
public MethodSettings.LongRunning.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
- Specified by:
clearField
in interfacecom.google.protobuf.Message.Builder
- Overrides:
clearField
in classcom.google.protobuf.GeneratedMessageV3.Builder<MethodSettings.LongRunning.Builder>
-
clearOneof
public MethodSettings.LongRunning.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
- Specified by:
clearOneof
in interfacecom.google.protobuf.Message.Builder
- Overrides:
clearOneof
in classcom.google.protobuf.GeneratedMessageV3.Builder<MethodSettings.LongRunning.Builder>
-
setRepeatedField
public MethodSettings.LongRunning.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, java.lang.Object value)
- Specified by:
setRepeatedField
in interfacecom.google.protobuf.Message.Builder
- Overrides:
setRepeatedField
in classcom.google.protobuf.GeneratedMessageV3.Builder<MethodSettings.LongRunning.Builder>
-
addRepeatedField
public MethodSettings.LongRunning.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)
- Specified by:
addRepeatedField
in interfacecom.google.protobuf.Message.Builder
- Overrides:
addRepeatedField
in classcom.google.protobuf.GeneratedMessageV3.Builder<MethodSettings.LongRunning.Builder>
-
mergeFrom
public MethodSettings.LongRunning.Builder mergeFrom(com.google.protobuf.Message other)
- Specified by:
mergeFrom
in interfacecom.google.protobuf.Message.Builder
- Overrides:
mergeFrom
in classcom.google.protobuf.AbstractMessage.Builder<MethodSettings.LongRunning.Builder>
-
mergeFrom
public MethodSettings.LongRunning.Builder mergeFrom(MethodSettings.LongRunning other)
-
isInitialized
public final boolean isInitialized()
- Specified by:
isInitialized
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Overrides:
isInitialized
in classcom.google.protobuf.GeneratedMessage.ExtendableBuilder<com.google.protobuf.GeneratedMessageV3,MethodSettings.LongRunning.Builder>
-
mergeFrom
public MethodSettings.LongRunning.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
- Specified by:
mergeFrom
in interfacecom.google.protobuf.Message.Builder
- Specified by:
mergeFrom
in interfacecom.google.protobuf.MessageLite.Builder
- Overrides:
mergeFrom
in classcom.google.protobuf.AbstractMessage.Builder<MethodSettings.LongRunning.Builder>
- Throws:
java.io.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 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:
getInitialPollDelay
in interfaceMethodSettings.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 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:
getPollDelayMultiplier
in interfaceMethodSettings.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 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:
getMaxPollDelay
in interfaceMethodSettings.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 interfaceMethodSettings.LongRunningOrBuilder
-
hasTotalPollTimeout
public boolean hasTotalPollTimeout()
Total polling timeout. Default value: 5 minutes.
.google.protobuf.Duration total_poll_timeout = 4;
- Specified by:
hasTotalPollTimeout
in 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:
getTotalPollTimeout
in interfaceMethodSettings.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;
-
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 interfaceMethodSettings.LongRunningOrBuilder
-
setUnknownFields
public final MethodSettings.LongRunning.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
- Specified by:
setUnknownFields
in interfacecom.google.protobuf.Message.Builder
- Overrides:
setUnknownFields
in classcom.google.protobuf.GeneratedMessageV3.Builder<MethodSettings.LongRunning.Builder>
-
mergeUnknownFields
public final MethodSettings.LongRunning.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
- Specified by:
mergeUnknownFields
in interfacecom.google.protobuf.Message.Builder
- Overrides:
mergeUnknownFields
in classcom.google.protobuf.GeneratedMessageV3.Builder<MethodSettings.LongRunning.Builder>
-
-