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
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > MethodSettings.LongRunningImplements
MethodSettings.LongRunningOrBuilderInherited Members
Static Fields
INITIAL_POLL_DELAY_FIELD_NUMBER
public static final int INITIAL_POLL_DELAY_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
MAX_POLL_DELAY_FIELD_NUMBER
public static final int MAX_POLL_DELAY_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
POLL_DELAY_MULTIPLIER_FIELD_NUMBER
public static final int POLL_DELAY_MULTIPLIER_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
TOTAL_POLL_TIMEOUT_FIELD_NUMBER
public static final int TOTAL_POLL_TIMEOUT_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
Static Methods
getDefaultInstance()
public static MethodSettings.LongRunning getDefaultInstance()
Returns | |
---|---|
Type | Description |
MethodSettings.LongRunning |
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
newBuilder()
public static MethodSettings.LongRunning.Builder newBuilder()
Returns | |
---|---|
Type | Description |
MethodSettings.LongRunning.Builder |
newBuilder(MethodSettings.LongRunning prototype)
public static MethodSettings.LongRunning.Builder newBuilder(MethodSettings.LongRunning prototype)
Parameter | |
---|---|
Name | Description |
prototype | MethodSettings.LongRunning |
Returns | |
---|---|
Type | Description |
MethodSettings.LongRunning.Builder |
parseDelimitedFrom(InputStream input)
public static MethodSettings.LongRunning parseDelimitedFrom(InputStream input)
Parameter | |
---|---|
Name | Description |
input | InputStream |
Returns | |
---|---|
Type | Description |
MethodSettings.LongRunning |
Exceptions | |
---|---|
Type | Description |
IOException |
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static MethodSettings.LongRunning parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input | InputStream |
extensionRegistry | ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
MethodSettings.LongRunning |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(byte[] data)
public static MethodSettings.LongRunning parseFrom(byte[] data)
Parameter | |
---|---|
Name | Description |
data | byte[] |
Returns | |
---|---|
Type | Description |
MethodSettings.LongRunning |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static MethodSettings.LongRunning parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
data | byte[] |
extensionRegistry | ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
MethodSettings.LongRunning |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteString data)
public static MethodSettings.LongRunning parseFrom(ByteString data)
Parameter | |
---|---|
Name | Description |
data | ByteString |
Returns | |
---|---|
Type | Description |
MethodSettings.LongRunning |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static MethodSettings.LongRunning parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
data | ByteString |
extensionRegistry | ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
MethodSettings.LongRunning |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(CodedInputStream input)
public static MethodSettings.LongRunning parseFrom(CodedInputStream input)
Parameter | |
---|---|
Name | Description |
input | CodedInputStream |
Returns | |
---|---|
Type | Description |
MethodSettings.LongRunning |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static MethodSettings.LongRunning parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
MethodSettings.LongRunning |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(InputStream input)
public static MethodSettings.LongRunning parseFrom(InputStream input)
Parameter | |
---|---|
Name | Description |
input | InputStream |
Returns | |
---|---|
Type | Description |
MethodSettings.LongRunning |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static MethodSettings.LongRunning parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input | InputStream |
extensionRegistry | ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
MethodSettings.LongRunning |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(ByteBuffer data)
public static MethodSettings.LongRunning parseFrom(ByteBuffer data)
Parameter | |
---|---|
Name | Description |
data | ByteBuffer |
Returns | |
---|---|
Type | Description |
MethodSettings.LongRunning |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static MethodSettings.LongRunning parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
data | ByteBuffer |
extensionRegistry | ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
MethodSettings.LongRunning |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parser()
public static Parser<MethodSettings.LongRunning> parser()
Returns | |
---|---|
Type | Description |
Parser<LongRunning> |
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter | |
---|---|
Name | Description |
obj | Object |
Returns | |
---|---|
Type | Description |
boolean |
getDefaultInstanceForType()
public MethodSettings.LongRunning getDefaultInstanceForType()
Returns | |
---|---|
Type | Description |
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 | |
---|---|
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 | |
---|---|
Type | Description |
DurationOrBuilder |
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 | |
---|---|
Type | Description |
DurationOrBuilder |
getParserForType()
public Parser<MethodSettings.LongRunning> getParserForType()
Returns | |
---|---|
Type | Description |
Parser<LongRunning> |
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 | |
---|---|
Type | Description |
int |
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 | |
---|---|
Type | Description |
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 | |
---|---|
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()
public int hashCode()
Returns | |
---|---|
Type | Description |
int |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns | |
---|---|
Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
newBuilderForType()
public MethodSettings.LongRunning.Builder newBuilderForType()
Returns | |
---|---|
Type | Description |
MethodSettings.LongRunning.Builder |
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected MethodSettings.LongRunning.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter | |
---|---|
Name | Description |
parent | BuilderParent |
Returns | |
---|---|
Type | Description |
MethodSettings.LongRunning.Builder |
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter | |
---|---|
Name | Description |
unused | UnusedPrivateParameter |
Returns | |
---|---|
Type | Description |
Object |
toBuilder()
public MethodSettings.LongRunning.Builder toBuilder()
Returns | |
---|---|
Type | Description |
MethodSettings.LongRunning.Builder |
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter | |
---|---|
Name | Description |
output | CodedOutputStream |
Exceptions | |
---|---|
Type | Description |
IOException |