Class HarnessHookEvent

java.lang.Object
software.amazon.awssdk.services.bedrockagentcore.model.HarnessHookEvent
All Implemented Interfaces:
Serializable, SdkPojo, InvokeHarnessStreamOutput, ToCopyableBuilder<HarnessHookEvent.Builder,HarnessHookEvent>
Direct Known Subclasses:
DefaultHookEvent
@Generated("software.amazon.awssdk:codegen") public class HarnessHookEvent extends Object implements SdkPojo, Serializable, ToCopyableBuilder<HarnessHookEvent.Builder,HarnessHookEvent>, InvokeHarnessStreamOutput

A lifecycle hook event emitted in the invocation stream for visibility into hook decisions.

See Also:

  • Method Details

    • hookEventId

      public final String hookEventId()

      The unique identifier for this hook event.

      Returns:
      The unique identifier for this hook event.

    • name

      public final String name()

      The name of the hook that ran.

      Returns:
      The name of the hook that ran.

    • type

      public final HarnessHookEventType type()

      The type of lifecycle hook event.

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

      Returns:
      The type of lifecycle hook event.
      See Also:

    • typeAsString

      public final String typeAsString()

      The type of lifecycle hook event.

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

      Returns:
      The type of lifecycle hook event.
      See Also:

    • decision

      public final HarnessHookDecision decision()

      The decision applied to the hook event. This field is present only for blocking Lambda targets.

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

      Returns:
      The decision applied to the hook event. This field is present only for blocking Lambda targets.
      See Also:

    • decisionAsString

      public final String decisionAsString()

      The decision applied to the hook event. This field is present only for blocking Lambda targets.

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

      Returns:
      The decision applied to the hook event. This field is present only for blocking Lambda targets.
      See Also:

    • reason

      public final String reason()

      The optional reason for the applied decision.

      Returns:
      The optional reason for the applied decision.

    • toBuilder

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

    • builder

      public static HarnessHookEvent.Builder builder()

    • serializableBuilderClass

      public static Class<? extends HarnessHookEvent.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)

    • copy

      public final HarnessHookEvent copy(Consumer<? super HarnessHookEvent.Builder> modifier)
      Description copied from interface: ToCopyableBuilder
      A convenience method for calling ToCopyableBuilder.toBuilder(), updating the returned builder and then calling SdkBuilder.build(). This is useful for making small modifications to the existing object.
      Specified by:
      copy in interface ToCopyableBuilder<HarnessHookEvent.Builder,HarnessHookEvent>
      Parameters:
      modifier - A function that mutates this immutable object using the provided builder.
      Returns:
      A new copy of this object with the requested modifications.

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

    • accept

      public void accept(InvokeHarnessResponseHandler.Visitor visitor)
      Calls the appropriate visit method depending on the subtype of HarnessHookEvent.
      Specified by:
      accept in interface InvokeHarnessStreamOutput
      Parameters:
      visitor - Visitor to invoke.