Class ApprovalAction

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

An approval decision supplied when resuming a paused agent execution. When an agent execution pauses to request approval for an elevated action, SendMessage streams an approval request carrying interrupt identifiers. This structure carries the decision back to the service — which paused tool invocation is being resumed, the opaque interrupt identifier that resumes it, the identifier of the approval request being resolved, optional display text of the control the user chose, and the action taken (APPROVED or REJECTED) — so the service can resume the paused execution. All members are optional on the wire; service-side validation is applied against the populated subset.

See Also:

  • Method Details

    • toolUseId

      public final String toolUseId()

      Identifier of the specific paused tool invocation that requested approval. Correlates the approval decision back to the paused invocation.

      Returns:
      Identifier of the specific paused tool invocation that requested approval. Correlates the approval decision back to the paused invocation.

    • interruptId

      public final String interruptId()

      An opaque resume identifier issued by the service when an agent execution pauses for approval. Provide it when resuming so the service can resume the correct paused execution.

      Returns:
      An opaque resume identifier issued by the service when an agent execution pauses for approval. Provide it when resuming so the service can resume the correct paused execution.

    • approvalId

      public final String approvalId()

      Identifier of the approval request being resolved.

      Returns:
      Identifier of the approval request being resolved.

    • buttonText

      public final String buttonText()

      Optional display text of the UI control the user chose (for example, "Approve Exact", "Approve Broader", or "Reject"), provided as auxiliary decision context.

      Returns:
      Optional display text of the UI control the user chose (for example, "Approve Exact", "Approve Broader", or "Reject"), provided as auxiliary decision context.

    • action

      public final ApprovalActionType action()

      The action taken on the approval request — APPROVED or REJECTED.

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

      Returns:
      The action taken on the approval request — APPROVED or REJECTED.
      See Also:

    • actionAsString

      public final String actionAsString()

      The action taken on the approval request — APPROVED or REJECTED.

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

      Returns:
      The action taken on the approval request — APPROVED or REJECTED.
      See Also:

    • toBuilder

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

    • builder

      public static ApprovalAction.Builder builder()

    • serializableBuilderClass

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