Class Failure

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.temporal.api.failure.v1.Failure
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, FailureOrBuilder, 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:

  • Field Details

    • MESSAGE_FIELD_NUMBER

      public static final int MESSAGE_FIELD_NUMBER
      See Also:

    • SOURCE_FIELD_NUMBER

      public static final int SOURCE_FIELD_NUMBER
      See Also:

    • STACK_TRACE_FIELD_NUMBER

      public static final int STACK_TRACE_FIELD_NUMBER
      See Also:

    • ENCODED_ATTRIBUTES_FIELD_NUMBER

      public static final int ENCODED_ATTRIBUTES_FIELD_NUMBER
      See Also:

    • CAUSE_FIELD_NUMBER

      public static final int CAUSE_FIELD_NUMBER
      See Also:

    • APPLICATION_FAILURE_INFO_FIELD_NUMBER

      public static final int APPLICATION_FAILURE_INFO_FIELD_NUMBER
      See Also:

    • TIMEOUT_FAILURE_INFO_FIELD_NUMBER

      public static final int TIMEOUT_FAILURE_INFO_FIELD_NUMBER
      See Also:

    • CANCELED_FAILURE_INFO_FIELD_NUMBER

      public static final int CANCELED_FAILURE_INFO_FIELD_NUMBER
      See Also:

    • TERMINATED_FAILURE_INFO_FIELD_NUMBER

      public static final int TERMINATED_FAILURE_INFO_FIELD_NUMBER
      See Also:

    • SERVER_FAILURE_INFO_FIELD_NUMBER

      public static final int SERVER_FAILURE_INFO_FIELD_NUMBER
      See Also:

    • RESET_WORKFLOW_FAILURE_INFO_FIELD_NUMBER

      public static final int RESET_WORKFLOW_FAILURE_INFO_FIELD_NUMBER
      See Also:

    • ACTIVITY_FAILURE_INFO_FIELD_NUMBER

      public static final int ACTIVITY_FAILURE_INFO_FIELD_NUMBER
      See Also:

    • CHILD_WORKFLOW_EXECUTION_FAILURE_INFO_FIELD_NUMBER

      public static final int CHILD_WORKFLOW_EXECUTION_FAILURE_INFO_FIELD_NUMBER
      See Also:

    • NEXUS_OPERATION_EXECUTION_FAILURE_INFO_FIELD_NUMBER

      public static final int NEXUS_OPERATION_EXECUTION_FAILURE_INFO_FIELD_NUMBER
      See Also:

    • NEXUS_HANDLER_FAILURE_INFO_FIELD_NUMBER

      public static final int NEXUS_HANDLER_FAILURE_INFO_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance 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

    • getFailureInfoCase

      public Failure.FailureInfoCase getFailureInfoCase()
      Specified by:
      getFailureInfoCase in interface FailureOrBuilder

    • getMessage

      public 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 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 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.

    • getCauseOrBuilder

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

    • 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.

    • getApplicationFailureInfo

      public ApplicationFailureInfo getApplicationFailureInfo()
      .temporal.api.failure.v1.ApplicationFailureInfo application_failure_info = 5;
      Specified by:
      getApplicationFailureInfo in interface FailureOrBuilder
      Returns:
      The applicationFailureInfo.

    • getApplicationFailureInfoOrBuilder

      public ApplicationFailureInfoOrBuilder getApplicationFailureInfoOrBuilder()
      .temporal.api.failure.v1.ApplicationFailureInfo application_failure_info = 5;
      Specified by:
      getApplicationFailureInfoOrBuilder in interface FailureOrBuilder

    • 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.

    • getTimeoutFailureInfo

      public TimeoutFailureInfo getTimeoutFailureInfo()
      .temporal.api.failure.v1.TimeoutFailureInfo timeout_failure_info = 6;
      Specified by:
      getTimeoutFailureInfo in interface FailureOrBuilder
      Returns:
      The timeoutFailureInfo.

    • getTimeoutFailureInfoOrBuilder

      public TimeoutFailureInfoOrBuilder getTimeoutFailureInfoOrBuilder()
      .temporal.api.failure.v1.TimeoutFailureInfo timeout_failure_info = 6;
      Specified by:
      getTimeoutFailureInfoOrBuilder in interface FailureOrBuilder

    • 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.

    • getCanceledFailureInfo

      public CanceledFailureInfo getCanceledFailureInfo()
      .temporal.api.failure.v1.CanceledFailureInfo canceled_failure_info = 7;
      Specified by:
      getCanceledFailureInfo in interface FailureOrBuilder
      Returns:
      The canceledFailureInfo.

    • getCanceledFailureInfoOrBuilder

      public CanceledFailureInfoOrBuilder getCanceledFailureInfoOrBuilder()
      .temporal.api.failure.v1.CanceledFailureInfo canceled_failure_info = 7;
      Specified by:
      getCanceledFailureInfoOrBuilder in interface FailureOrBuilder

    • 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.

    • getTerminatedFailureInfo

      public TerminatedFailureInfo getTerminatedFailureInfo()
      .temporal.api.failure.v1.TerminatedFailureInfo terminated_failure_info = 8;
      Specified by:
      getTerminatedFailureInfo in interface FailureOrBuilder
      Returns:
      The terminatedFailureInfo.

    • getTerminatedFailureInfoOrBuilder

      public TerminatedFailureInfoOrBuilder getTerminatedFailureInfoOrBuilder()
      .temporal.api.failure.v1.TerminatedFailureInfo terminated_failure_info = 8;
      Specified by:
      getTerminatedFailureInfoOrBuilder in interface FailureOrBuilder

    • 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.

    • getServerFailureInfo

      public ServerFailureInfo getServerFailureInfo()
      .temporal.api.failure.v1.ServerFailureInfo server_failure_info = 9;
      Specified by:
      getServerFailureInfo in interface FailureOrBuilder
      Returns:
      The serverFailureInfo.

    • getServerFailureInfoOrBuilder

      public ServerFailureInfoOrBuilder getServerFailureInfoOrBuilder()
      .temporal.api.failure.v1.ServerFailureInfo server_failure_info = 9;
      Specified by:
      getServerFailureInfoOrBuilder in interface FailureOrBuilder

    • 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.

    • getResetWorkflowFailureInfo

      public ResetWorkflowFailureInfo getResetWorkflowFailureInfo()
      .temporal.api.failure.v1.ResetWorkflowFailureInfo reset_workflow_failure_info = 10;
      Specified by:
      getResetWorkflowFailureInfo in interface FailureOrBuilder
      Returns:
      The resetWorkflowFailureInfo.

    • getResetWorkflowFailureInfoOrBuilder

      public ResetWorkflowFailureInfoOrBuilder getResetWorkflowFailureInfoOrBuilder()
      .temporal.api.failure.v1.ResetWorkflowFailureInfo reset_workflow_failure_info = 10;
      Specified by:
      getResetWorkflowFailureInfoOrBuilder in interface FailureOrBuilder

    • 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.

    • getActivityFailureInfo

      public ActivityFailureInfo getActivityFailureInfo()
      .temporal.api.failure.v1.ActivityFailureInfo activity_failure_info = 11;
      Specified by:
      getActivityFailureInfo in interface FailureOrBuilder
      Returns:
      The activityFailureInfo.

    • getActivityFailureInfoOrBuilder

      public ActivityFailureInfoOrBuilder getActivityFailureInfoOrBuilder()
      .temporal.api.failure.v1.ActivityFailureInfo activity_failure_info = 11;
      Specified by:
      getActivityFailureInfoOrBuilder in interface FailureOrBuilder

    • 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.

    • getChildWorkflowExecutionFailureInfo

      public ChildWorkflowExecutionFailureInfo getChildWorkflowExecutionFailureInfo()
      .temporal.api.failure.v1.ChildWorkflowExecutionFailureInfo child_workflow_execution_failure_info = 12;
      Specified by:
      getChildWorkflowExecutionFailureInfo in interface FailureOrBuilder
      Returns:
      The childWorkflowExecutionFailureInfo.

    • getChildWorkflowExecutionFailureInfoOrBuilder

      public ChildWorkflowExecutionFailureInfoOrBuilder getChildWorkflowExecutionFailureInfoOrBuilder()
      .temporal.api.failure.v1.ChildWorkflowExecutionFailureInfo child_workflow_execution_failure_info = 12;
      Specified by:
      getChildWorkflowExecutionFailureInfoOrBuilder in interface FailureOrBuilder

    • hasNexusOperationExecutionFailureInfo

      public boolean hasNexusOperationExecutionFailureInfo()
      .temporal.api.failure.v1.NexusOperationFailureInfo nexus_operation_execution_failure_info = 13;
      Specified by:
      hasNexusOperationExecutionFailureInfo in interface FailureOrBuilder
      Returns:
      Whether the nexusOperationExecutionFailureInfo field is set.

    • getNexusOperationExecutionFailureInfo

      public NexusOperationFailureInfo getNexusOperationExecutionFailureInfo()
      .temporal.api.failure.v1.NexusOperationFailureInfo nexus_operation_execution_failure_info = 13;
      Specified by:
      getNexusOperationExecutionFailureInfo in interface FailureOrBuilder
      Returns:
      The nexusOperationExecutionFailureInfo.

    • getNexusOperationExecutionFailureInfoOrBuilder

      public NexusOperationFailureInfoOrBuilder getNexusOperationExecutionFailureInfoOrBuilder()
      .temporal.api.failure.v1.NexusOperationFailureInfo nexus_operation_execution_failure_info = 13;
      Specified by:
      getNexusOperationExecutionFailureInfoOrBuilder in interface FailureOrBuilder

    • hasNexusHandlerFailureInfo

      public boolean hasNexusHandlerFailureInfo()
      .temporal.api.failure.v1.NexusHandlerFailureInfo nexus_handler_failure_info = 14;
      Specified by:
      hasNexusHandlerFailureInfo in interface FailureOrBuilder
      Returns:
      Whether the nexusHandlerFailureInfo field is set.

    • getNexusHandlerFailureInfo

      public NexusHandlerFailureInfo getNexusHandlerFailureInfo()
      .temporal.api.failure.v1.NexusHandlerFailureInfo nexus_handler_failure_info = 14;
      Specified by:
      getNexusHandlerFailureInfo in interface FailureOrBuilder
      Returns:
      The nexusHandlerFailureInfo.

    • getNexusHandlerFailureInfoOrBuilder

      public NexusHandlerFailureInfoOrBuilder getNexusHandlerFailureInfoOrBuilder()
      .temporal.api.failure.v1.NexusHandlerFailureInfo nexus_handler_failure_info = 14;
      Specified by:
      getNexusHandlerFailureInfoOrBuilder in interface FailureOrBuilder

    • 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 IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      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(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(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Failure parseFrom(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(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static Failure parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static Failure.Builder newBuilder()

    • newBuilder

      public static Failure.Builder newBuilder(Failure prototype)

    • 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