Class ManagedApiEventSummary

java.lang.Object
software.amazon.awssdk.services.apiportal.model.ManagedApiEventSummary
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ManagedApiEventSummary.Builder,ManagedApiEventSummary>

@Generated("software.amazon.awssdk:codegen") public final class ManagedApiEventSummary extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ManagedApiEventSummary.Builder,ManagedApiEventSummary>

Summary of a single security event attributed to a managed API. This is the list view; full per-event detail will come from GetManagedApiEvent in future.

See Also:
  • Method Details

    • eventId

      public final String eventId()

      Event identifier; row identity and input to GetManagedApiEvent.

      Returns:
      Event identifier; row identity and input to GetManagedApiEvent.
    • eventType

      public final EventType eventType()

      Always WAF_API_SECURITY today.

      If the service returns an enum value that is not available in the current SDK version, eventType will return EventType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from eventTypeAsString().

      Returns:
      Always WAF_API_SECURITY today.
      See Also:
    • eventTypeAsString

      public final String eventTypeAsString()

      Always WAF_API_SECURITY today.

      If the service returns an enum value that is not available in the current SDK version, eventType will return EventType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from eventTypeAsString().

      Returns:
      Always WAF_API_SECURITY today.
      See Also:
    • status

      public final EventStatus status()
      Returns the value of the Status property for this object.

      If the service returns an enum value that is not available in the current SDK version, status will return EventStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      The value of the Status property for this object.
      See Also:
    • statusAsString

      public final String statusAsString()
      Returns the value of the Status property for this object.

      If the service returns an enum value that is not available in the current SDK version, status will return EventStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      The value of the Status property for this object.
      See Also:
    • wafApiSecurityEventDetail

      public final WafApiSecurityEventDetail wafApiSecurityEventDetail()

      Detail specific to a WAF API-security event; populated when eventType is WAF_API_SECURITY.

      Returns:
      Detail specific to a WAF API-security event; populated when eventType is WAF_API_SECURITY.
    • startedAt

      public final Instant startedAt()

      When the event was first observed.

      Returns:
      When the event was first observed.
    • endedAt

      public final Instant endedAt()

      When the event completed; absent while it is still in progress.

      Returns:
      When the event completed; absent while it is still in progress.
    • updatedAt

      public final Instant updatedAt()

      When the event was last updated.

      Returns:
      When the event was last updated.
    • toBuilder

      public ManagedApiEventSummary.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<ManagedApiEventSummary.Builder,ManagedApiEventSummary>
      Returns:
      a builder for type T
    • builder

      public static ManagedApiEventSummary.Builder builder()
    • serializableBuilderClass

      public static Class<? extends ManagedApiEventSummary.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.
    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.