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
MAX_POLL_DELAY_FIELD_NUMBER
public static final int MAX_POLL_DELAY_FIELD_NUMBER
Field Value
POLL_DELAY_MULTIPLIER_FIELD_NUMBER
public static final int POLL_DELAY_MULTIPLIER_FIELD_NUMBER
Field Value
TOTAL_POLL_TIMEOUT_FIELD_NUMBER
public static final int TOTAL_POLL_TIMEOUT_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static MethodSettings.LongRunning getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static MethodSettings.LongRunning.Builder newBuilder()
Returns
newBuilder(MethodSettings.LongRunning prototype)
public static MethodSettings.LongRunning.Builder newBuilder(MethodSettings.LongRunning prototype)
Parameter
Returns
public static MethodSettings.LongRunning parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static MethodSettings.LongRunning parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static MethodSettings.LongRunning parseFrom(byte[] data)
Parameter
Name | Description |
data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static MethodSettings.LongRunning parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static MethodSettings.LongRunning parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static MethodSettings.LongRunning parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static MethodSettings.LongRunning parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static MethodSettings.LongRunning parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static MethodSettings.LongRunning parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static MethodSettings.LongRunning parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static MethodSettings.LongRunning parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static MethodSettings.LongRunning parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<MethodSettings.LongRunning> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getDefaultInstanceForType()
public MethodSettings.LongRunning getDefaultInstanceForType()
Returns
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.
|
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
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.
|
getMaxPollDelayOrBuilder()
public DurationOrBuilder getMaxPollDelayOrBuilder()
Maximum time between two subsequent poll requests.
Default value: 45 seconds.
.google.protobuf.Duration max_poll_delay = 3;
Returns
getParserForType()
public Parser<MethodSettings.LongRunning> getParserForType()
Returns
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
Type | Description |
float | The pollDelayMultiplier.
|
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getTotalPollTimeout()
public Duration getTotalPollTimeout()
Total polling timeout.
Default value: 5 minutes.
.google.protobuf.Duration total_poll_timeout = 4;
Returns
Type | Description |
Duration | The totalPollTimeout.
|
getTotalPollTimeoutOrBuilder()
public DurationOrBuilder getTotalPollTimeoutOrBuilder()
Total polling timeout.
Default value: 5 minutes.
.google.protobuf.Duration total_poll_timeout = 4;
Returns
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
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.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public MethodSettings.LongRunning.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected MethodSettings.LongRunning.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public MethodSettings.LongRunning.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions