Class IsAuthorizedWithTokenResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.verifiedpermissions.model.VerifiedPermissionsResponse
software.amazon.awssdk.services.verifiedpermissions.model.IsAuthorizedWithTokenResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<IsAuthorizedWithTokenResponse.Builder,IsAuthorizedWithTokenResponse>
@Generated("software.amazon.awssdk:codegen") public final class IsAuthorizedWithTokenResponse extends VerifiedPermissionsResponse implements ToCopyableBuilder<IsAuthorizedWithTokenResponse.Builder,IsAuthorizedWithTokenResponse>

  • Method Details

    • 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 multiple matching policies, where at least one is a forbid policy, then because forbid always overrides permit the forbid policies are the determining policies. If all matching policies are permit policies, then those policies are the determining policies. When no policies match and the response is the default DENY, there are 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 multiple matching policies, where at least one is a forbid policy, then because forbid always overrides permit the forbid policies are the determining policies. If all matching policies are permit policies, then those policies are the determining policies. When no policies match and the response is the default DENY, there are 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 references an entity or entity attribute that does not exist in the slice.

      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 references an entity or entity attribute that does not exist in the slice.

    • principal

      public final EntityIdentifier principal()

      The identifier of the principal in the ID or access token.

      Returns:
      The identifier of the principal in the ID or access token.

    • toBuilder

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

    • builder

      public static IsAuthorizedWithTokenResponse.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. 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 SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      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.