MethodSettings.LongRunning.Builder (proto-google-common-protos 2.11.0 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite.Builder
- - com.google.protobuf.AbstractMessage.Builder<BuilderType>
  - - com.google.protobuf.GeneratedMessageV3.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.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 Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`MethodSettings.LongRunning.Builder`	`addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, 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(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`MethodSettings.LongRunning.Builder`	`mergeFrom(com.google.protobuf.Message other)`
`MethodSettings.LongRunning.Builder`	`mergeFrom(MethodSettings.LongRunning 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, Object value)`
`MethodSettings.LongRunning.Builder`	`setInitialPollDelay(com.google.protobuf.Duration.Builder builderForValue)` Initial delay after which the first poll request will be made.
`MethodSettings.LongRunning.Builder`	`setInitialPollDelay(com.google.protobuf.Duration value)` Initial delay after which the first poll request will be made.
`MethodSettings.LongRunning.Builder`	`setMaxPollDelay(com.google.protobuf.Duration.Builder builderForValue)` Maximum time between two subsequent poll requests.
`MethodSettings.LongRunning.Builder`	`setMaxPollDelay(com.google.protobuf.Duration value)` 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, Object value)`
`MethodSettings.LongRunning.Builder`	`setTotalPollTimeout(com.google.protobuf.Duration.Builder builderForValue)` Total polling timeout.
`MethodSettings.LongRunning.Builder`	`setTotalPollTimeout(com.google.protobuf.Duration value)` Total polling timeout.
`MethodSettings.LongRunning.Builder`	`setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, 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

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.Message.Builder
mergeDelimitedFrom, mergeDelimitedFrom

Methods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFrom

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>

clear
```
public MethodSettings.LongRunning.Builder clear()
```
Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear 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

clone
```
public MethodSettings.LongRunning.Builder clone()
```
Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<MethodSettings.LongRunning.Builder>

setField

public MethodSettings.LongRunning.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                   Object value)

Specified by:: setField in interface com.google.protobuf.Message.Builder
Overrides:: setField in class com.google.protobuf.GeneratedMessageV3.Builder<MethodSettings.LongRunning.Builder>

clearField
```
public MethodSettings.LongRunning.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
```
Specified by:

clearField in interface com.google.protobuf.Message.Builder

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<MethodSettings.LongRunning.Builder>

clearOneof
```
public MethodSettings.LongRunning.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
```
Specified by:

clearOneof in interface com.google.protobuf.Message.Builder

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<MethodSettings.LongRunning.Builder>

setRepeatedField

public MethodSettings.LongRunning.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                           int index,
                                                           Object value)

Specified by:: setRepeatedField in interface com.google.protobuf.Message.Builder
Overrides:: setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<MethodSettings.LongRunning.Builder>

addRepeatedField

public MethodSettings.LongRunning.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                           Object value)

Specified by:: addRepeatedField in interface com.google.protobuf.Message.Builder
Overrides:: addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<MethodSettings.LongRunning.Builder>

mergeFrom
```
public MethodSettings.LongRunning.Builder mergeFrom(com.google.protobuf.Message other)
```
Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.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 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.