Package software.amazon.awssdk.services.eventbridge.model

Class PutEventsResultEntry

java.lang.Object
software.amazon.awssdk.services.eventbridge.model.PutEventsResultEntry
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<PutEventsResultEntry.Builder,PutEventsResultEntry>
@Generated("software.amazon.awssdk:codegen") public final class PutEventsResultEntry extends Object implements SdkPojo, Serializable, ToCopyableBuilder<PutEventsResultEntry.Builder,PutEventsResultEntry>

Represents the results of an event submitted to an event bus.

If the submission was successful, the entry has the event ID in it. Otherwise, you can use the error code and error message to identify the problem with the entry.

For information about the errors that are common to all actions, see Common Errors.

See Also:

  • Method Details

    • eventId

      public final String eventId()

      The ID of the event.

      Returns:
      The ID of the event.

    • errorCode

      public final String errorCode()

      The error code that indicates why the event submission failed.

      Retryable errors include:

      • InternalFailure

        The request processing has failed because of an unknown error, exception or failure.

      • ThrottlingException

        The request was denied due to request throttling.

      Non-retryable errors include:

      • AccessDeniedException

        You do not have sufficient access to perform this action.

      • InvalidAccountIdException

        The account ID provided is not valid.

      • InvalidArgument

        A specified parameter is not valid.

      • MalformedDetail

        The JSON provided is not valid.

      • RedactionFailure

        Redacting the CloudTrail event failed.

      • NotAuthorizedForSourceException

        You do not have permissions to publish events with this source onto this event bus.

      • NotAuthorizedForDetailTypeException

        You do not have permissions to publish events with this detail type onto this event bus.

      Returns:
      The error code that indicates why the event submission failed.

      Retryable errors include:

      • InternalFailure

        The request processing has failed because of an unknown error, exception or failure.

      • ThrottlingException

        The request was denied due to request throttling.

      Non-retryable errors include:

      • AccessDeniedException

        You do not have sufficient access to perform this action.

      • InvalidAccountIdException

        The account ID provided is not valid.

      • InvalidArgument

        A specified parameter is not valid.

      • MalformedDetail

        The JSON provided is not valid.

      • RedactionFailure

        Redacting the CloudTrail event failed.

      • NotAuthorizedForSourceException

        You do not have permissions to publish events with this source onto this event bus.

      • NotAuthorizedForDetailTypeException

        You do not have permissions to publish events with this detail type onto this event bus.

    • errorMessage

      public final String errorMessage()

      The error message that explains why the event submission failed.

      Returns:
      The error message that explains why the event submission failed.

    • toBuilder

      public PutEventsResultEntry.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<PutEventsResultEntry.Builder,PutEventsResultEntry>
      Returns:
      a builder for type T

    • builder

      public static PutEventsResultEntry.Builder builder()

    • serializableBuilderClass

      public static Class<? extends PutEventsResultEntry.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.