Package com.google.api
Class MethodSettings.LongRunning
java.lang.Object
com.google.protobuf.AbstractMessageLite<MessageType,BuilderType>
com.google.protobuf.GeneratedMessageLite<MethodSettings.LongRunning,MethodSettings.LongRunning.Builder>
com.google.api.MethodSettings.LongRunning
- All Implemented Interfaces:
MethodSettings.LongRunningOrBuilder,com.google.protobuf.MessageLite,com.google.protobuf.MessageLiteOrBuilder
- Enclosing class:
- MethodSettings
public static final class MethodSettings.LongRunning
extends com.google.protobuf.GeneratedMessageLite<MethodSettings.LongRunning,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-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final classDescribes settings to use when generating API methods that use the long-running operation pattern.Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageLite
com.google.protobuf.GeneratedMessageLite.DefaultInstanceBasedParser<T extends com.google.protobuf.GeneratedMessageLite<T,?>>, com.google.protobuf.GeneratedMessageLite.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageLite.ExtendableMessage<MessageType, BuilderType>, BuilderType extends com.google.protobuf.GeneratedMessageLite.ExtendableBuilder<MessageType, BuilderType>>, com.google.protobuf.GeneratedMessageLite.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageLite.ExtendableMessage<MessageType, BuilderType>, BuilderType extends com.google.protobuf.GeneratedMessageLite.ExtendableBuilder<MessageType, BuilderType>>, com.google.protobuf.GeneratedMessageLite.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageLite.ExtendableMessage<MessageType, BuilderType>, BuilderType extends com.google.protobuf.GeneratedMessageLite.ExtendableBuilder<MessageType, BuilderType>>, com.google.protobuf.GeneratedMessageLite.GeneratedExtension<ContainingType extends com.google.protobuf.MessageLite, Type extends Object>, com.google.protobuf.GeneratedMessageLite.MethodToInvoke, com.google.protobuf.GeneratedMessageLite.SerializedForm Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intstatic final intstatic final intstatic final intFields inherited from class com.google.protobuf.GeneratedMessageLite
unknownFieldsFields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode -
Method Summary
Modifier and TypeMethodDescriptionprotected final ObjectdynamicMethod(com.google.protobuf.GeneratedMessageLite.MethodToInvoke method, Object arg0, Object arg1) static MethodSettings.LongRunningcom.google.protobuf.DurationInitial delay after which the first poll request will be made.com.google.protobuf.DurationMaximum time between two subsequent poll requests.floatMultiplier to gradually increase delay between subsequent polls until it reaches max_poll_delay.com.google.protobuf.DurationTotal polling timeout.booleanInitial delay after which the first poll request will be made.booleanMaximum time between two subsequent poll requests.booleanTotal polling timeout.newBuilder(MethodSettings.LongRunning prototype) static MethodSettings.LongRunningparseDelimitedFrom(InputStream input) static MethodSettings.LongRunningparseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static MethodSettings.LongRunningparseFrom(byte[] data) static MethodSettings.LongRunningparseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static MethodSettings.LongRunningparseFrom(com.google.protobuf.ByteString data) static MethodSettings.LongRunningparseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static MethodSettings.LongRunningparseFrom(com.google.protobuf.CodedInputStream input) static MethodSettings.LongRunningparseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static MethodSettings.LongRunningparseFrom(InputStream input) static MethodSettings.LongRunningparseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static MethodSettings.LongRunningparseFrom(ByteBuffer data) static MethodSettings.LongRunningparseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static com.google.protobuf.Parser<MethodSettings.LongRunning>parser()Methods inherited from class com.google.protobuf.GeneratedMessageLite
createBuilder, createBuilder, dynamicMethod, dynamicMethod, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, emptyProtobufList, equals, getDefaultInstanceForType, getParserForType, getSerializedSize, hashCode, isInitialized, isInitialized, makeImmutable, mergeLengthDelimitedField, mergeUnknownFields, mergeVarintField, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBuilderForType, newMessageInfo, newRepeatedGeneratedExtension, newSingularGeneratedExtension, parseDelimitedFrom, parseDelimitedFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parsePartialFrom, parseUnknownField, registerDefaultInstance, toBuilder, toString, writeToMethods inherited from class com.google.protobuf.AbstractMessageLite
addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.protobuf.MessageLiteOrBuilder
getDefaultInstanceForType, isInitialized
-
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
-
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 [json_name = "initialPollDelay"];- Specified by:
hasInitialPollDelayin 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 [json_name = "initialPollDelay"];- Specified by:
getInitialPollDelayin interfaceMethodSettings.LongRunningOrBuilder- Returns:
- The initialPollDelay.
-
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 [json_name = "pollDelayMultiplier"];- Specified by:
getPollDelayMultiplierin 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 [json_name = "maxPollDelay"];- Specified by:
hasMaxPollDelayin 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 [json_name = "maxPollDelay"];- Specified by:
getMaxPollDelayin interfaceMethodSettings.LongRunningOrBuilder- Returns:
- The maxPollDelay.
-
hasTotalPollTimeout
public boolean hasTotalPollTimeout()Total polling timeout. Default value: 5 minutes.
.google.protobuf.Duration total_poll_timeout = 4 [json_name = "totalPollTimeout"];- Specified by:
hasTotalPollTimeoutin 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 [json_name = "totalPollTimeout"];- Specified by:
getTotalPollTimeoutin interfaceMethodSettings.LongRunningOrBuilder- Returns:
- The totalPollTimeout.
-
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
-
newBuilder
-
newBuilder
-
dynamicMethod
protected final Object dynamicMethod(com.google.protobuf.GeneratedMessageLite.MethodToInvoke method, Object arg0, Object arg1) - Specified by:
dynamicMethodin classcom.google.protobuf.GeneratedMessageLite<MethodSettings.LongRunning,MethodSettings.LongRunning.Builder>
-
getDefaultInstance
-
parser
-