Class MethodSettings.LongRunning (2.33.0)

public static final class MethodSettings.LongRunning extends GeneratedMessageV3 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 Fields

INITIAL_POLL_DELAY_FIELD_NUMBER

public static final int INITIAL_POLL_DELAY_FIELD_NUMBER
Field Value
TypeDescription
int

MAX_POLL_DELAY_FIELD_NUMBER

public static final int MAX_POLL_DELAY_FIELD_NUMBER
Field Value
TypeDescription
int

POLL_DELAY_MULTIPLIER_FIELD_NUMBER

public static final int POLL_DELAY_MULTIPLIER_FIELD_NUMBER
Field Value
TypeDescription
int

TOTAL_POLL_TIMEOUT_FIELD_NUMBER

public static final int TOTAL_POLL_TIMEOUT_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static MethodSettings.LongRunning getDefaultInstance()
Returns
TypeDescription
MethodSettings.LongRunning

getDescriptor()

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

newBuilder()

public static MethodSettings.LongRunning.Builder newBuilder()
Returns
TypeDescription
MethodSettings.LongRunning.Builder

newBuilder(MethodSettings.LongRunning prototype)

public static MethodSettings.LongRunning.Builder newBuilder(MethodSettings.LongRunning prototype)
Parameter
NameDescription
prototypeMethodSettings.LongRunning
Returns
TypeDescription
MethodSettings.LongRunning.Builder

parseDelimitedFrom(InputStream input)

public static MethodSettings.LongRunning parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
MethodSettings.LongRunning
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static MethodSettings.LongRunning parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
MethodSettings.LongRunning
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static MethodSettings.LongRunning parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
MethodSettings.LongRunning
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static MethodSettings.LongRunning parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
MethodSettings.LongRunning
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static MethodSettings.LongRunning parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
MethodSettings.LongRunning
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static MethodSettings.LongRunning parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
MethodSettings.LongRunning
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static MethodSettings.LongRunning parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
MethodSettings.LongRunning
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static MethodSettings.LongRunning parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
MethodSettings.LongRunning
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static MethodSettings.LongRunning parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
MethodSettings.LongRunning
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static MethodSettings.LongRunning parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
MethodSettings.LongRunning
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static MethodSettings.LongRunning parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
MethodSettings.LongRunning
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static MethodSettings.LongRunning parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
MethodSettings.LongRunning
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<MethodSettings.LongRunning> parser()
Returns
TypeDescription
Parser<LongRunning>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

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

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.

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.

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

getParserForType()

public Parser<MethodSettings.LongRunning> getParserForType()
Returns
TypeDescription
Parser<LongRunning>
Overrides

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.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getTotalPollTimeout()

public Duration getTotalPollTimeout()

Total polling timeout. Default value: 5 minutes.

.google.protobuf.Duration total_poll_timeout = 4;

Returns
TypeDescription
Duration

The totalPollTimeout.

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.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public MethodSettings.LongRunning.Builder newBuilderForType()
Returns
TypeDescription
MethodSettings.LongRunning.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected MethodSettings.LongRunning.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
MethodSettings.LongRunning.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public MethodSettings.LongRunning.Builder toBuilder()
Returns
TypeDescription
MethodSettings.LongRunning.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException