public static final class MethodSettings.LongRunning.Builder extends 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).
Protobuf type google.api.MethodSettings.LongRunning
Inherited Members
com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)
com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)
com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)
Static Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public MethodSettings.LongRunning.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Overrides
build()
public MethodSettings.LongRunning build()
buildPartial()
public MethodSettings.LongRunning buildPartial()
clear()
public MethodSettings.LongRunning.Builder clear()
Overrides
clearField(Descriptors.FieldDescriptor field)
public MethodSettings.LongRunning.Builder clearField(Descriptors.FieldDescriptor field)
Overrides
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;
clearMaxPollDelay()
public MethodSettings.LongRunning.Builder clearMaxPollDelay()
Maximum time between two subsequent poll requests.
Default value: 45 seconds.
.google.protobuf.Duration max_poll_delay = 3;
clearOneof(Descriptors.OneofDescriptor oneof)
public MethodSettings.LongRunning.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Overrides
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;
clearTotalPollTimeout()
public MethodSettings.LongRunning.Builder clearTotalPollTimeout()
Total polling timeout.
Default value: 5 minutes.
.google.protobuf.Duration total_poll_timeout = 4;
clone()
public MethodSettings.LongRunning.Builder clone()
Overrides
getDefaultInstanceForType()
public MethodSettings.LongRunning getDefaultInstanceForType()
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Overrides
getInitialPollDelay()
public Duration getInitialPollDelay()
Initial delay after which the first poll request will be made.
Default value: 5 seconds.
.google.protobuf.Duration initial_poll_delay = 1;
| Returns |
|---|
| Type | Description |
Duration | The initialPollDelay.
|
getInitialPollDelayBuilder()
public 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 DurationOrBuilder getInitialPollDelayOrBuilder()
Initial delay after which the first poll request will be made.
Default value: 5 seconds.
.google.protobuf.Duration initial_poll_delay = 1;
getMaxPollDelay()
public Duration getMaxPollDelay()
Maximum time between two subsequent poll requests.
Default value: 45 seconds.
.google.protobuf.Duration max_poll_delay = 3;
| Returns |
|---|
| Type | Description |
Duration | The maxPollDelay.
|
getMaxPollDelayBuilder()
public Duration.Builder getMaxPollDelayBuilder()
Maximum time between two subsequent poll requests.
Default value: 45 seconds.
.google.protobuf.Duration max_poll_delay = 3;
getMaxPollDelayOrBuilder()
public DurationOrBuilder getMaxPollDelayOrBuilder()
Maximum time between two subsequent poll requests.
Default value: 45 seconds.
.google.protobuf.Duration max_poll_delay = 3;
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;
| Returns |
|---|
| Type | Description |
float | The pollDelayMultiplier.
|
getTotalPollTimeout()
public Duration getTotalPollTimeout()
Total polling timeout.
Default value: 5 minutes.
.google.protobuf.Duration total_poll_timeout = 4;
| Returns |
|---|
| Type | Description |
Duration | The totalPollTimeout.
|
getTotalPollTimeoutBuilder()
public Duration.Builder getTotalPollTimeoutBuilder()
Total polling timeout.
Default value: 5 minutes.
.google.protobuf.Duration total_poll_timeout = 4;
getTotalPollTimeoutOrBuilder()
public DurationOrBuilder getTotalPollTimeoutOrBuilder()
Total polling timeout.
Default value: 5 minutes.
.google.protobuf.Duration total_poll_timeout = 4;
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;
| Returns |
|---|
| Type | Description |
boolean | Whether the initialPollDelay field is set.
|
hasMaxPollDelay()
public boolean hasMaxPollDelay()
Maximum time between two subsequent poll requests.
Default value: 45 seconds.
.google.protobuf.Duration max_poll_delay = 3;
| Returns |
|---|
| Type | Description |
boolean | Whether the maxPollDelay field is set.
|
hasTotalPollTimeout()
public boolean hasTotalPollTimeout()
Total polling timeout.
Default value: 5 minutes.
.google.protobuf.Duration total_poll_timeout = 4;
| Returns |
|---|
| Type | Description |
boolean | Whether the totalPollTimeout field is set.
|
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
mergeFrom(MethodSettings.LongRunning other)
public MethodSettings.LongRunning.Builder mergeFrom(MethodSettings.LongRunning other)
public MethodSettings.LongRunning.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Overrides
mergeFrom(Message other)
public MethodSettings.LongRunning.Builder mergeFrom(Message other)
| Parameter |
|---|
| Name | Description |
other | Message
|
Overrides
mergeInitialPollDelay(Duration value)
public MethodSettings.LongRunning.Builder mergeInitialPollDelay(Duration value)
Initial delay after which the first poll request will be made.
Default value: 5 seconds.
.google.protobuf.Duration initial_poll_delay = 1;
mergeMaxPollDelay(Duration value)
public MethodSettings.LongRunning.Builder mergeMaxPollDelay(Duration value)
Maximum time between two subsequent poll requests.
Default value: 45 seconds.
.google.protobuf.Duration max_poll_delay = 3;
mergeTotalPollTimeout(Duration value)
public MethodSettings.LongRunning.Builder mergeTotalPollTimeout(Duration value)
Total polling timeout.
Default value: 5 minutes.
.google.protobuf.Duration total_poll_timeout = 4;
mergeUnknownFields(UnknownFieldSet unknownFields)
public final MethodSettings.LongRunning.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Overrides
setField(Descriptors.FieldDescriptor field, Object value)
public MethodSettings.LongRunning.Builder setField(Descriptors.FieldDescriptor field, Object value)
Overrides
setInitialPollDelay(Duration value)
public MethodSettings.LongRunning.Builder setInitialPollDelay(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(Duration.Builder builderForValue)
public MethodSettings.LongRunning.Builder setInitialPollDelay(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;
| Parameter |
|---|
| Name | Description |
builderForValue | Builder
|
setMaxPollDelay(Duration value)
public MethodSettings.LongRunning.Builder setMaxPollDelay(Duration value)
Maximum time between two subsequent poll requests.
Default value: 45 seconds.
.google.protobuf.Duration max_poll_delay = 3;
setMaxPollDelay(Duration.Builder builderForValue)
public MethodSettings.LongRunning.Builder setMaxPollDelay(Duration.Builder builderForValue)
Maximum time between two subsequent poll requests.
Default value: 45 seconds.
.google.protobuf.Duration max_poll_delay = 3;
| Parameter |
|---|
| Name | Description |
builderForValue | Builder
|
setPollDelayMultiplier(float value)
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;
| Parameter |
|---|
| Name | Description |
value | float
The pollDelayMultiplier to set.
|
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public MethodSettings.LongRunning.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Overrides
setTotalPollTimeout(Duration value)
public MethodSettings.LongRunning.Builder setTotalPollTimeout(Duration value)
Total polling timeout.
Default value: 5 minutes.
.google.protobuf.Duration total_poll_timeout = 4;
setTotalPollTimeout(Duration.Builder builderForValue)
public MethodSettings.LongRunning.Builder setTotalPollTimeout(Duration.Builder builderForValue)
Total polling timeout.
Default value: 5 minutes.
.google.protobuf.Duration total_poll_timeout = 4;
| Parameter |
|---|
| Name | Description |
builderForValue | Builder
|
setUnknownFields(UnknownFieldSet unknownFields)
public final MethodSettings.LongRunning.Builder setUnknownFields(UnknownFieldSet unknownFields)
Overrides
