Class FailurePolicy (2.11.0)

public final class FailurePolicy extends GeneratedMessageV3 implements FailurePolicyOrBuilder

Describes the policy in case of function's execution failure. If empty, then defaults to ignoring failures (i.e. not retrying them).

Protobuf type google.cloud.functions.v1.FailurePolicy

Static Fields

RETRY_FIELD_NUMBER

public static final int RETRY_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static FailurePolicy getDefaultInstance()
Returns
TypeDescription
FailurePolicy

getDescriptor()

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

newBuilder()

public static FailurePolicy.Builder newBuilder()
Returns
TypeDescription
FailurePolicy.Builder

newBuilder(FailurePolicy prototype)

public static FailurePolicy.Builder newBuilder(FailurePolicy prototype)
Parameter
NameDescription
prototypeFailurePolicy
Returns
TypeDescription
FailurePolicy.Builder

parseDelimitedFrom(InputStream input)

public static FailurePolicy parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
FailurePolicy
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

public static FailurePolicy parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
FailurePolicy
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

public static FailurePolicy parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
FailurePolicy
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

public static FailurePolicy parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
FailurePolicy
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

public static FailurePolicy parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
FailurePolicy
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

public static Parser<FailurePolicy> parser()
Returns
TypeDescription
Parser<FailurePolicy>

Methods

equals(Object obj)

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

getActionCase()

public FailurePolicy.ActionCase getActionCase()
Returns
TypeDescription
FailurePolicy.ActionCase

getDefaultInstanceForType()

public FailurePolicy getDefaultInstanceForType()
Returns
TypeDescription
FailurePolicy

getParserForType()

public Parser<FailurePolicy> getParserForType()
Returns
TypeDescription
Parser<FailurePolicy>
Overrides

getRetry()

public FailurePolicy.Retry getRetry()

If specified, then the function will be retried in case of a failure.

.google.cloud.functions.v1.FailurePolicy.Retry retry = 1;

Returns
TypeDescription
FailurePolicy.Retry

The retry.

getRetryOrBuilder()

public FailurePolicy.RetryOrBuilder getRetryOrBuilder()

If specified, then the function will be retried in case of a failure.

.google.cloud.functions.v1.FailurePolicy.Retry retry = 1;

Returns
TypeDescription
FailurePolicy.RetryOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

hasRetry()

public boolean hasRetry()

If specified, then the function will be retried in case of a failure.

.google.cloud.functions.v1.FailurePolicy.Retry retry = 1;

Returns
TypeDescription
boolean

Whether the retry 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 FailurePolicy.Builder newBuilderForType()
Returns
TypeDescription
FailurePolicy.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

public FailurePolicy.Builder toBuilder()
Returns
TypeDescription
FailurePolicy.Builder

writeTo(CodedOutputStream output)

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