Class FailurePolicy (2.45.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
Type Description
int

Static Methods

getDefaultInstance()

public static FailurePolicy getDefaultInstance()
Returns
Type Description
FailurePolicy

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static FailurePolicy.Builder newBuilder()
Returns
Type Description
FailurePolicy.Builder

newBuilder(FailurePolicy prototype)

public static FailurePolicy.Builder newBuilder(FailurePolicy prototype)
Parameter
Name Description
prototype FailurePolicy
Returns
Type Description
FailurePolicy.Builder

parseDelimitedFrom(InputStream input)

public static FailurePolicy parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
FailurePolicy
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static FailurePolicy parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FailurePolicy
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static FailurePolicy parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
FailurePolicy
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static FailurePolicy parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FailurePolicy
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static FailurePolicy parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
FailurePolicy
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static FailurePolicy parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FailurePolicy
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static FailurePolicy parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
FailurePolicy
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static FailurePolicy parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FailurePolicy
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static FailurePolicy parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
FailurePolicy
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static FailurePolicy parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FailurePolicy
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static FailurePolicy parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
FailurePolicy
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static FailurePolicy parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FailurePolicy
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<FailurePolicy> parser()
Returns
Type Description
Parser<FailurePolicy>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getActionCase()

public FailurePolicy.ActionCase getActionCase()
Returns
Type Description
FailurePolicy.ActionCase

getDefaultInstanceForType()

public FailurePolicy getDefaultInstanceForType()
Returns
Type Description
FailurePolicy

getParserForType()

public Parser<FailurePolicy> getParserForType()
Returns
Type Description
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
Type Description
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
Type Description
FailurePolicy.RetryOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
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
Type Description
boolean

Whether the retry field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public FailurePolicy.Builder newBuilderForType()
Returns
Type Description
FailurePolicy.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected FailurePolicy.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
FailurePolicy.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public FailurePolicy.Builder toBuilder()
Returns
Type Description
FailurePolicy.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException