Package com.google.api
Class MethodSettings.LongRunning
java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.google.api.MethodSettings.LongRunning
- All Implemented Interfaces:
MethodSettings.LongRunningOrBuilder
,com.google.protobuf.Message
,com.google.protobuf.MessageLite
,com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
,Serializable
- Enclosing class:
- MethodSettings
public static final class MethodSettings.LongRunning
extends com.google.protobuf.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](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
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic final class
Describes settings to use when generating API methods that use the long-running operation pattern.Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,
BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT, BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum
-
Field Summary
Modifier and TypeFieldDescriptionstatic final int
static final int
static final int
static final int
Fields inherited from class com.google.protobuf.GeneratedMessageV3
alwaysUseFieldBuilders, unknownFields
Fields inherited from class com.google.protobuf.AbstractMessage
memoizedSize
Fields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode
-
Method Summary
Modifier and TypeMethodDescriptionboolean
static MethodSettings.LongRunning
static final com.google.protobuf.Descriptors.Descriptor
com.google.protobuf.Duration
Initial delay after which the first poll request will be made.com.google.protobuf.DurationOrBuilder
Initial delay after which the first poll request will be made.com.google.protobuf.Duration
Maximum time between two subsequent poll requests.com.google.protobuf.DurationOrBuilder
Maximum time between two subsequent poll requests.com.google.protobuf.Parser<MethodSettings.LongRunning>
float
Multiplier to gradually increase delay between subsequent polls until it reaches max_poll_delay.int
com.google.protobuf.Duration
Total polling timeout.com.google.protobuf.DurationOrBuilder
Total polling timeout.int
hashCode()
boolean
Initial delay after which the first poll request will be made.boolean
Maximum time between two subsequent poll requests.boolean
Total polling timeout.protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
final boolean
newBuilder
(MethodSettings.LongRunning prototype) protected MethodSettings.LongRunning.Builder
newBuilderForType
(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) protected Object
newInstance
(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) static MethodSettings.LongRunning
parseDelimitedFrom
(InputStream input) static MethodSettings.LongRunning
parseDelimitedFrom
(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static MethodSettings.LongRunning
parseFrom
(byte[] data) static MethodSettings.LongRunning
parseFrom
(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static MethodSettings.LongRunning
parseFrom
(com.google.protobuf.ByteString data) static MethodSettings.LongRunning
parseFrom
(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static MethodSettings.LongRunning
parseFrom
(com.google.protobuf.CodedInputStream input) static MethodSettings.LongRunning
parseFrom
(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static MethodSettings.LongRunning
parseFrom
(InputStream input) static MethodSettings.LongRunning
parseFrom
(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static MethodSettings.LongRunning
parseFrom
(ByteBuffer data) static MethodSettings.LongRunning
parseFrom
(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static com.google.protobuf.Parser<MethodSettings.LongRunning>
parser()
void
writeTo
(com.google.protobuf.CodedOutputStream output) Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag
Methods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString
Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeTo
Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Field Details
-
INITIAL_POLL_DELAY_FIELD_NUMBER
public static final int INITIAL_POLL_DELAY_FIELD_NUMBER- See Also:
-
POLL_DELAY_MULTIPLIER_FIELD_NUMBER
public static final int POLL_DELAY_MULTIPLIER_FIELD_NUMBER- See Also:
-
MAX_POLL_DELAY_FIELD_NUMBER
public static final int MAX_POLL_DELAY_FIELD_NUMBER- See Also:
-
TOTAL_POLL_TIMEOUT_FIELD_NUMBER
public static final int TOTAL_POLL_TIMEOUT_FIELD_NUMBER- See Also:
-
-
Method Details
-
newInstance
- Overrides:
newInstance
in classcom.google.protobuf.GeneratedMessageV3
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTable
in classcom.google.protobuf.GeneratedMessageV3
-
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 interfaceMethodSettings.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 interfaceMethodSettings.LongRunningOrBuilder
- Returns:
- The initialPollDelay.
-
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 interfaceMethodSettings.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 interfaceMethodSettings.LongRunningOrBuilder
- Returns:
- The pollDelayMultiplier.
-
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 interfaceMethodSettings.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 interfaceMethodSettings.LongRunningOrBuilder
- Returns:
- The maxPollDelay.
-
getMaxPollDelayOrBuilder
public com.google.protobuf.DurationOrBuilder getMaxPollDelayOrBuilder()Maximum time between two subsequent poll requests. Default value: 45 seconds.
.google.protobuf.Duration max_poll_delay = 3;
- Specified by:
getMaxPollDelayOrBuilder
in interfaceMethodSettings.LongRunningOrBuilder
-
hasTotalPollTimeout
public boolean hasTotalPollTimeout()Total polling timeout. Default value: 5 minutes.
.google.protobuf.Duration total_poll_timeout = 4;
- Specified by:
hasTotalPollTimeout
in interfaceMethodSettings.LongRunningOrBuilder
- Returns:
- Whether the totalPollTimeout field is set.
-
getTotalPollTimeout
public com.google.protobuf.Duration getTotalPollTimeout()Total polling timeout. Default value: 5 minutes.
.google.protobuf.Duration total_poll_timeout = 4;
- Specified by:
getTotalPollTimeout
in interfaceMethodSettings.LongRunningOrBuilder
- Returns:
- The totalPollTimeout.
-
getTotalPollTimeoutOrBuilder
public com.google.protobuf.DurationOrBuilder getTotalPollTimeoutOrBuilder()Total polling timeout. Default value: 5 minutes.
.google.protobuf.Duration total_poll_timeout = 4;
- Specified by:
getTotalPollTimeoutOrBuilder
in interfaceMethodSettings.LongRunningOrBuilder
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitialized
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Overrides:
isInitialized
in classcom.google.protobuf.GeneratedMessageV3
-
writeTo
- Specified by:
writeTo
in interfacecom.google.protobuf.MessageLite
- Overrides:
writeTo
in classcom.google.protobuf.GeneratedMessageV3
- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()- Specified by:
getSerializedSize
in interfacecom.google.protobuf.MessageLite
- Overrides:
getSerializedSize
in classcom.google.protobuf.GeneratedMessageV3
-
equals
- Specified by:
equals
in interfacecom.google.protobuf.Message
- Overrides:
equals
in classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()- Specified by:
hashCode
in interfacecom.google.protobuf.Message
- Overrides:
hashCode
in classcom.google.protobuf.AbstractMessage
-
parseFrom
public static MethodSettings.LongRunning parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static MethodSettings.LongRunning parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static MethodSettings.LongRunning parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static MethodSettings.LongRunning parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static MethodSettings.LongRunning parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static MethodSettings.LongRunning parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
- Throws:
IOException
-
parseFrom
public static MethodSettings.LongRunning parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
- Throws:
IOException
-
parseDelimitedFrom
public static MethodSettings.LongRunning parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseFrom
public static MethodSettings.LongRunning parseFrom(com.google.protobuf.CodedInputStream input) throws IOException - Throws:
IOException
-
parseFrom
public static MethodSettings.LongRunning parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
newBuilderForType
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.Message
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.MessageLite
-
newBuilder
-
newBuilder
-
toBuilder
- Specified by:
toBuilder
in interfacecom.google.protobuf.Message
- Specified by:
toBuilder
in interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected MethodSettings.LongRunning.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) - Specified by:
newBuilderForType
in classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstance
-
parser
-
getParserForType
- Specified by:
getParserForType
in interfacecom.google.protobuf.Message
- Specified by:
getParserForType
in interfacecom.google.protobuf.MessageLite
- Overrides:
getParserForType
in classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageOrBuilder
-