Class BatchIsAuthorizedOutputItem

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

The decision, based on policy evaluation, from an individual authorization request in a BatchIsAuthorized API request.

See Also:

  • Method Details

    • request

      public final BatchIsAuthorizedInputItem request()

      The authorization request that initiated the decision.

      Returns:
      The authorization request that initiated the decision.

    • decision

      public final Decision decision()

      An authorization decision that indicates if the authorization request should be allowed or denied.

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

      Returns:
      An authorization decision that indicates if the authorization request should be allowed or denied.
      See Also:

    • decisionAsString

      public final String decisionAsString()

      An authorization decision that indicates if the authorization request should be allowed or denied.

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

      Returns:
      An authorization decision that indicates if the authorization request should be allowed or denied.
      See Also:

    • hasDeterminingPolicies

      public final boolean hasDeterminingPolicies()
      For responses, this returns true if the service returned a value for the DeterminingPolicies property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • determiningPolicies

      public final List<DeterminingPolicyItem> determiningPolicies()

      The list of determining policies used to make the authorization decision. For example, if there are two matching policies, where one is a forbid and the other is a permit, then the forbid policy will be the determining policy. In the case of multiple matching permit policies then there would be multiple determining policies. In the case that no policies match, and hence the response is DENY, there would be no determining policies.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasDeterminingPolicies() method.

      Returns:
      The list of determining policies used to make the authorization decision. For example, if there are two matching policies, where one is a forbid and the other is a permit, then the forbid policy will be the determining policy. In the case of multiple matching permit policies then there would be multiple determining policies. In the case that no policies match, and hence the response is DENY, there would be no determining policies.

    • hasErrors

      public final boolean hasErrors()
      For responses, this returns true if the service returned a value for the Errors property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • errors

      public final List<EvaluationErrorItem> errors()

      Errors that occurred while making an authorization decision. For example, a policy might reference an entity or attribute that doesn't exist in the request.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasErrors() method.

      Returns:
      Errors that occurred while making an authorization decision. For example, a policy might reference an entity or attribute that doesn't exist in the request.

    • toBuilder

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

    • builder

      public static BatchIsAuthorizedOutputItem.Builder builder()

    • serializableBuilderClass

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