Class MethodSettings.LongRunning.Builder (2.33.0)

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

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public MethodSettings.LongRunning.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
MethodSettings.LongRunning.Builder
Overrides

build()

public MethodSettings.LongRunning build()
Returns
TypeDescription
MethodSettings.LongRunning

buildPartial()

public MethodSettings.LongRunning buildPartial()
Returns
TypeDescription
MethodSettings.LongRunning

clear()

public MethodSettings.LongRunning.Builder clear()
Returns
TypeDescription
MethodSettings.LongRunning.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public MethodSettings.LongRunning.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
MethodSettings.LongRunning.Builder
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;

Returns
TypeDescription
MethodSettings.LongRunning.Builder

clearMaxPollDelay()

public MethodSettings.LongRunning.Builder clearMaxPollDelay()

Maximum time between two subsequent poll requests. Default value: 45 seconds.

.google.protobuf.Duration max_poll_delay = 3;

Returns
TypeDescription
MethodSettings.LongRunning.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public MethodSettings.LongRunning.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
MethodSettings.LongRunning.Builder
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;

Returns
TypeDescription
MethodSettings.LongRunning.Builder

This builder for chaining.

clearTotalPollTimeout()

public MethodSettings.LongRunning.Builder clearTotalPollTimeout()

Total polling timeout. Default value: 5 minutes.

.google.protobuf.Duration total_poll_timeout = 4;

Returns
TypeDescription
MethodSettings.LongRunning.Builder

clone()

public MethodSettings.LongRunning.Builder clone()
Returns
TypeDescription
MethodSettings.LongRunning.Builder
Overrides

getDefaultInstanceForType()

public MethodSettings.LongRunning getDefaultInstanceForType()
Returns
TypeDescription
MethodSettings.LongRunning

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
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
TypeDescription
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;

Returns
TypeDescription
Builder

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;

Returns
TypeDescription
DurationOrBuilder

getMaxPollDelay()

public Duration getMaxPollDelay()

Maximum time between two subsequent poll requests. Default value: 45 seconds.

.google.protobuf.Duration max_poll_delay = 3;

Returns
TypeDescription
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;

Returns
TypeDescription
Builder

getMaxPollDelayOrBuilder()

public DurationOrBuilder getMaxPollDelayOrBuilder()

Maximum time between two subsequent poll requests. Default value: 45 seconds.

.google.protobuf.Duration max_poll_delay = 3;

Returns
TypeDescription
DurationOrBuilder

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
TypeDescription
float

The pollDelayMultiplier.

getTotalPollTimeout()

public Duration getTotalPollTimeout()

Total polling timeout. Default value: 5 minutes.

.google.protobuf.Duration total_poll_timeout = 4;

Returns
TypeDescription
Duration

The totalPollTimeout.

getTotalPollTimeoutBuilder()

public Duration.Builder getTotalPollTimeoutBuilder()

Total polling timeout. Default value: 5 minutes.

.google.protobuf.Duration total_poll_timeout = 4;

Returns
TypeDescription
Builder

getTotalPollTimeoutOrBuilder()

public DurationOrBuilder getTotalPollTimeoutOrBuilder()

Total polling timeout. Default value: 5 minutes.

.google.protobuf.Duration total_poll_timeout = 4;

Returns
TypeDescription
DurationOrBuilder

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
TypeDescription
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
TypeDescription
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
TypeDescription
boolean

Whether the totalPollTimeout field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(MethodSettings.LongRunning other)

public MethodSettings.LongRunning.Builder mergeFrom(MethodSettings.LongRunning other)
Parameter
NameDescription
otherMethodSettings.LongRunning
Returns
TypeDescription
MethodSettings.LongRunning.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public MethodSettings.LongRunning.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
MethodSettings.LongRunning.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public MethodSettings.LongRunning.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
MethodSettings.LongRunning.Builder
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;

Parameter
NameDescription
valueDuration
Returns
TypeDescription
MethodSettings.LongRunning.Builder

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;

Parameter
NameDescription
valueDuration
Returns
TypeDescription
MethodSettings.LongRunning.Builder

mergeTotalPollTimeout(Duration value)

public MethodSettings.LongRunning.Builder mergeTotalPollTimeout(Duration value)

Total polling timeout. Default value: 5 minutes.

.google.protobuf.Duration total_poll_timeout = 4;

Parameter
NameDescription
valueDuration
Returns
TypeDescription
MethodSettings.LongRunning.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final MethodSettings.LongRunning.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
MethodSettings.LongRunning.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public MethodSettings.LongRunning.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
MethodSettings.LongRunning.Builder
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;

Parameter
NameDescription
valueDuration
Returns
TypeDescription
MethodSettings.LongRunning.Builder

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
NameDescription
builderForValueBuilder
Returns
TypeDescription
MethodSettings.LongRunning.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;

Parameter
NameDescription
valueDuration
Returns
TypeDescription
MethodSettings.LongRunning.Builder

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
NameDescription
builderForValueBuilder
Returns
TypeDescription
MethodSettings.LongRunning.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
NameDescription
valuefloat

The pollDelayMultiplier to set.

Returns
TypeDescription
MethodSettings.LongRunning.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public MethodSettings.LongRunning.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
MethodSettings.LongRunning.Builder
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;

Parameter
NameDescription
valueDuration
Returns
TypeDescription
MethodSettings.LongRunning.Builder

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
NameDescription
builderForValueBuilder
Returns
TypeDescription
MethodSettings.LongRunning.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final MethodSettings.LongRunning.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
MethodSettings.LongRunning.Builder
Overrides