Package io.temporal.api.failure.v1

Class Failure

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, FailureOrBuilder, java.io.Serializable
    @Generated(value="protoc",
           comments="annotations:Failure.java.pb.meta")
public final class Failure
extends com.google.protobuf.GeneratedMessageV3
implements FailureOrBuilder
    Protobuf type temporal.api.failure.v1.Failure
    See Also:
    Serialized Form

    • Field Detail

      • STACK_TRACE_FIELD_NUMBER

        public static final int STACK_TRACE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • ENCODED_ATTRIBUTES_FIELD_NUMBER

        public static final int ENCODED_ATTRIBUTES_FIELD_NUMBER
        See Also:
        Constant Field Values

      • APPLICATION_FAILURE_INFO_FIELD_NUMBER

        public static final int APPLICATION_FAILURE_INFO_FIELD_NUMBER
        See Also:
        Constant Field Values

      • TIMEOUT_FAILURE_INFO_FIELD_NUMBER

        public static final int TIMEOUT_FAILURE_INFO_FIELD_NUMBER
        See Also:
        Constant Field Values

      • CANCELED_FAILURE_INFO_FIELD_NUMBER

        public static final int CANCELED_FAILURE_INFO_FIELD_NUMBER
        See Also:
        Constant Field Values

      • TERMINATED_FAILURE_INFO_FIELD_NUMBER

        public static final int TERMINATED_FAILURE_INFO_FIELD_NUMBER
        See Also:
        Constant Field Values

      • SERVER_FAILURE_INFO_FIELD_NUMBER

        public static final int SERVER_FAILURE_INFO_FIELD_NUMBER
        See Also:
        Constant Field Values

      • RESET_WORKFLOW_FAILURE_INFO_FIELD_NUMBER

        public static final int RESET_WORKFLOW_FAILURE_INFO_FIELD_NUMBER
        See Also:
        Constant Field Values

      • ACTIVITY_FAILURE_INFO_FIELD_NUMBER

        public static final int ACTIVITY_FAILURE_INFO_FIELD_NUMBER
        See Also:
        Constant Field Values

      • CHILD_WORKFLOW_EXECUTION_FAILURE_INFO_FIELD_NUMBER

        public static final int CHILD_WORKFLOW_EXECUTION_FAILURE_INFO_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected java.lang.Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getUnknownFields

        public final com.google.protobuf.UnknownFieldSet getUnknownFields()
        Specified by:
        getUnknownFields in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getUnknownFields in class com.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 class com.google.protobuf.GeneratedMessageV3

      • getMessage

        public java.lang.String getMessage()
        string message = 1;
        Specified by:
        getMessage in interface FailureOrBuilder
        Returns:
        The message.

      • getMessageBytes

        public com.google.protobuf.ByteString getMessageBytes()
        string message = 1;
        Specified by:
        getMessageBytes in interface FailureOrBuilder
        Returns:
        The bytes for message.

      • getSource

        public java.lang.String getSource()
         The source this Failure originated in, e.g. TypeScriptSDK / JavaSDK
 In some SDKs this is used to rehydrate the stack trace into an exception object.
        string source = 2;
        Specified by:
        getSource in interface FailureOrBuilder
        Returns:
        The source.

      • getSourceBytes

        public com.google.protobuf.ByteString getSourceBytes()
         The source this Failure originated in, e.g. TypeScriptSDK / JavaSDK
 In some SDKs this is used to rehydrate the stack trace into an exception object.
        string source = 2;
        Specified by:
        getSourceBytes in interface FailureOrBuilder
        Returns:
        The bytes for source.

      • getStackTrace

        public java.lang.String getStackTrace()
        string stack_trace = 3;
        Specified by:
        getStackTrace in interface FailureOrBuilder
        Returns:
        The stackTrace.

      • getStackTraceBytes

        public com.google.protobuf.ByteString getStackTraceBytes()
        string stack_trace = 3;
        Specified by:
        getStackTraceBytes in interface FailureOrBuilder
        Returns:
        The bytes for stackTrace.

      • hasEncodedAttributes

        public boolean hasEncodedAttributes()
         Alternative way to supply `message` and `stack_trace` and possibly other attributes, used for encryption of
 errors originating in user code which might contain sensitive information.
 The `encoded_attributes` Payload could represent any serializable object, e.g. JSON object or a `Failure` proto
 message.
 SDK authors: 
 - The SDK should provide a default `encodeFailureAttributes` and `decodeFailureAttributes` implementation that:
   - Uses a JSON object to represent `{ message, stack_trace }`.
   - Overwrites the original message with "Encoded failure" to indicate that more information could be extracted.
   - Overwrites the original stack_trace with an empty string.
   - The resulting JSON object is converted to Payload using the default PayloadConverter and should be processed
     by the user-provided PayloadCodec
 - If there's demand, we could allow overriding the default SDK implementation to encode other opaque Failure attributes.
 (-- api-linter: core::0203::optional=disabled --)
        .temporal.api.common.v1.Payload encoded_attributes = 20;
        Specified by:
        hasEncodedAttributes in interface FailureOrBuilder
        Returns:
        Whether the encodedAttributes field is set.

      • getEncodedAttributes

        public Payload getEncodedAttributes()
         Alternative way to supply `message` and `stack_trace` and possibly other attributes, used for encryption of
 errors originating in user code which might contain sensitive information.
 The `encoded_attributes` Payload could represent any serializable object, e.g. JSON object or a `Failure` proto
 message.
 SDK authors: 
 - The SDK should provide a default `encodeFailureAttributes` and `decodeFailureAttributes` implementation that:
   - Uses a JSON object to represent `{ message, stack_trace }`.
   - Overwrites the original message with "Encoded failure" to indicate that more information could be extracted.
   - Overwrites the original stack_trace with an empty string.
   - The resulting JSON object is converted to Payload using the default PayloadConverter and should be processed
     by the user-provided PayloadCodec
 - If there's demand, we could allow overriding the default SDK implementation to encode other opaque Failure attributes.
 (-- api-linter: core::0203::optional=disabled --)
        .temporal.api.common.v1.Payload encoded_attributes = 20;
        Specified by:
        getEncodedAttributes in interface FailureOrBuilder
        Returns:
        The encodedAttributes.

      • getEncodedAttributesOrBuilder

        public PayloadOrBuilder getEncodedAttributesOrBuilder()
         Alternative way to supply `message` and `stack_trace` and possibly other attributes, used for encryption of
 errors originating in user code which might contain sensitive information.
 The `encoded_attributes` Payload could represent any serializable object, e.g. JSON object or a `Failure` proto
 message.
 SDK authors: 
 - The SDK should provide a default `encodeFailureAttributes` and `decodeFailureAttributes` implementation that:
   - Uses a JSON object to represent `{ message, stack_trace }`.
   - Overwrites the original message with "Encoded failure" to indicate that more information could be extracted.
   - Overwrites the original stack_trace with an empty string.
   - The resulting JSON object is converted to Payload using the default PayloadConverter and should be processed
     by the user-provided PayloadCodec
 - If there's demand, we could allow overriding the default SDK implementation to encode other opaque Failure attributes.
 (-- api-linter: core::0203::optional=disabled --)
        .temporal.api.common.v1.Payload encoded_attributes = 20;
        Specified by:
        getEncodedAttributesOrBuilder in interface FailureOrBuilder

      • hasCause

        public boolean hasCause()
        .temporal.api.failure.v1.Failure cause = 4;
        Specified by:
        hasCause in interface FailureOrBuilder
        Returns:
        Whether the cause field is set.

      • getCause

        public Failure getCause()
        .temporal.api.failure.v1.Failure cause = 4;
        Specified by:
        getCause in interface FailureOrBuilder
        Returns:
        The cause.

      • hasApplicationFailureInfo

        public boolean hasApplicationFailureInfo()
        .temporal.api.failure.v1.ApplicationFailureInfo application_failure_info = 5;
        Specified by:
        hasApplicationFailureInfo in interface FailureOrBuilder
        Returns:
        Whether the applicationFailureInfo field is set.

      • hasTimeoutFailureInfo

        public boolean hasTimeoutFailureInfo()
        .temporal.api.failure.v1.TimeoutFailureInfo timeout_failure_info = 6;
        Specified by:
        hasTimeoutFailureInfo in interface FailureOrBuilder
        Returns:
        Whether the timeoutFailureInfo field is set.

      • hasCanceledFailureInfo

        public boolean hasCanceledFailureInfo()
        .temporal.api.failure.v1.CanceledFailureInfo canceled_failure_info = 7;
        Specified by:
        hasCanceledFailureInfo in interface FailureOrBuilder
        Returns:
        Whether the canceledFailureInfo field is set.

      • hasTerminatedFailureInfo

        public boolean hasTerminatedFailureInfo()
        .temporal.api.failure.v1.TerminatedFailureInfo terminated_failure_info = 8;
        Specified by:
        hasTerminatedFailureInfo in interface FailureOrBuilder
        Returns:
        Whether the terminatedFailureInfo field is set.

      • hasServerFailureInfo

        public boolean hasServerFailureInfo()
        .temporal.api.failure.v1.ServerFailureInfo server_failure_info = 9;
        Specified by:
        hasServerFailureInfo in interface FailureOrBuilder
        Returns:
        Whether the serverFailureInfo field is set.

      • hasResetWorkflowFailureInfo

        public boolean hasResetWorkflowFailureInfo()
        .temporal.api.failure.v1.ResetWorkflowFailureInfo reset_workflow_failure_info = 10;
        Specified by:
        hasResetWorkflowFailureInfo in interface FailureOrBuilder
        Returns:
        Whether the resetWorkflowFailureInfo field is set.

      • hasActivityFailureInfo

        public boolean hasActivityFailureInfo()
        .temporal.api.failure.v1.ActivityFailureInfo activity_failure_info = 11;
        Specified by:
        hasActivityFailureInfo in interface FailureOrBuilder
        Returns:
        Whether the activityFailureInfo field is set.

      • hasChildWorkflowExecutionFailureInfo

        public boolean hasChildWorkflowExecutionFailureInfo()
        .temporal.api.failure.v1.ChildWorkflowExecutionFailureInfo child_workflow_execution_failure_info = 12;
        Specified by:
        hasChildWorkflowExecutionFailureInfo in interface FailureOrBuilder
        Returns:
        Whether the childWorkflowExecutionFailureInfo field is set.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws java.io.IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        java.io.IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(java.lang.Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static Failure parseFrom​(java.nio.ByteBuffer data)
                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Failure parseFrom​(java.nio.ByteBuffer data,
                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Failure parseFrom​(com.google.protobuf.ByteString data)
                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Failure parseFrom​(com.google.protobuf.ByteString data,
                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Failure parseFrom​(byte[] data)
                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Failure parseFrom​(byte[] data,
                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Failure parseFrom​(java.io.InputStream input)
                         throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static Failure parseFrom​(java.io.InputStream input,
                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                         throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

        public static Failure parseDelimitedFrom​(java.io.InputStream input)
                                  throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

        public static Failure parseDelimitedFrom​(java.io.InputStream input,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static Failure parseFrom​(com.google.protobuf.CodedInputStream input)
                         throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static Failure parseFrom​(com.google.protobuf.CodedInputStream input,
                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                         throws java.io.IOException
        Throws:
        java.io.IOException

      • newBuilderForType

        public Failure.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public Failure.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected Failure.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstance

        public static Failure getDefaultInstance()

      • parser

        public static com.google.protobuf.Parser<Failure> parser()

      • getParserForType

        public com.google.protobuf.Parser<Failure> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public Failure getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder