Class UpdateApprovalActionRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.devopsagent.model.DevOpsAgentRequest
software.amazon.awssdk.services.devopsagent.model.UpdateApprovalActionRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<UpdateApprovalActionRequest.Builder,UpdateApprovalActionRequest>
@Generated("software.amazon.awssdk:codegen") public final class UpdateApprovalActionRequest extends DevOpsAgentRequest implements ToCopyableBuilder<UpdateApprovalActionRequest.Builder,UpdateApprovalActionRequest>

Request structure for UpdateApprovalAction. Submits the terminal decision (APPROVED or REJECTED) against an approval request, optionally carrying the finalized pattern and time-to-live when the action is APPROVED, or a free-text rationale when the action is REJECTED. Cross-field invariants between `action` and the approve-only / reject-only members are enforced by service-side validation.

  • Method Details

    • agentSpaceId

      public final String agentSpaceId()

      The agent space identifier — multi-tenant workspace scope. Bound from the request URI.

      Returns:
      The agent space identifier — multi-tenant workspace scope. Bound from the request URI.

    • approvalId

      public final String approvalId()

      Identifier of the approval request being resolved. A UUID. Bound from the request URI.

      Returns:
      Identifier of the approval request being resolved. A UUID. Bound from the request URI.

    • action

      public final ApprovalActionType action()

      The action to take 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 to take on the approval request — APPROVED or REJECTED.
      See Also:

    • actionAsString

      public final String actionAsString()

      The action to take 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 to take on the approval request — APPROVED or REJECTED.
      See Also:

    • finalPattern

      public final ApprovalPattern finalPattern()

      The finalized pattern (tool + argumentPins) that scopes the approval. Required when `action` is APPROVED; must be absent when `action` is REJECTED. The pattern narrows, and must not widen, the invocation originally requested by the agent. This cross-field invariant is enforced by service-side validation.

      Returns:
      The finalized pattern (tool + argumentPins) that scopes the approval. Required when `action` is APPROVED; must be absent when `action` is REJECTED. The pattern narrows, and must not widen, the invocation originally requested by the agent. This cross-field invariant is enforced by service-side validation.

    • reason

      public final String reason()

      Optional free-text rationale for the decision. Permitted when `action` is REJECTED; ignored when `action` is APPROVED.

      Returns:
      Optional free-text rationale for the decision. Permitted when `action` is REJECTED; ignored when `action` is APPROVED.

    • ttlSeconds

      public final Integer ttlSeconds()

      Approval lifetime in seconds, starting from when the decision is submitted. Required when `action` is APPROVED AND `singleUse` is false; must be absent when `action` is REJECTED or when `singleUse` is true (a single-use approval backs one executed action and the redemption window collapses). Cross-field invariants are enforced by service-side validation; the @range bound here is the operation-boundary check that always applies (a maximum of 4 hours).

      Returns:
      Approval lifetime in seconds, starting from when the decision is submitted. Required when `action` is APPROVED AND `singleUse` is false; must be absent when `action` is REJECTED or when `singleUse` is true (a single-use approval backs one executed action and the redemption window collapses). Cross-field invariants are enforced by service-side validation; the @range bound here is the operation-boundary check that always applies (a maximum of 4 hours).

    • singleUse

      public final Boolean singleUse()

      Whether the approved action backs a single executed tool call (true) or is reusable within ttlSeconds (false). Required when `action` is APPROVED; must be absent when `action` is REJECTED. When true, ttlSeconds must be absent (the redemption window collapses to the single use). When false, ttlSeconds is required and bounds the reuse window. Cross-field invariants are enforced by service-side validation.

      Returns:
      Whether the approved action backs a single executed tool call (true) or is reusable within ttlSeconds (false). Required when `action` is APPROVED; must be absent when `action` is REJECTED. When true, ttlSeconds must be absent (the redemption window collapses to the single use). When false, ttlSeconds is required and bounds the reuse window. Cross-field invariants are enforced by service-side validation.

    • toBuilder

      public UpdateApprovalActionRequest.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<UpdateApprovalActionRequest.Builder,UpdateApprovalActionRequest>
      Specified by:
      toBuilder in class DevOpsAgentRequest
      Returns:
      a builder for type T

    • builder

      public static UpdateApprovalActionRequest.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

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