Class ContextDefinition

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

Contains additional details about the context of the request. Verified Permissions evaluates this information in an authorization request as part of the when and unless clauses in a policy.

This data type is used as a request parameter for the IsAuthorized, BatchIsAuthorized , and IsAuthorizedWithToken operations.

If you're passing context as part of the request, exactly one instance of context must be passed. If you don't want to pass context, omit the context parameter from your request rather than sending context {}.

Example: "context":{"contextMap":{"<KeyName1>":{"boolean":true},"<KeyName2>":{"long":1234}}}

See Also:

  • Method Details

    • hasContextMap

      public final boolean hasContextMap()
      For responses, this returns true if the service returned a value for the ContextMap 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.

    • contextMap

      public final Map<String,AttributeValue> contextMap()

      An list of attributes that are needed to successfully evaluate an authorization request. Each attribute in this array must include a map of a data type and its value.

      Example: "contextMap":{"<KeyName1>":{"boolean":true},"<KeyName2>":{"long":1234}}

      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 hasContextMap() method.

      Returns:
      An list of attributes that are needed to successfully evaluate an authorization request. Each attribute in this array must include a map of a data type and its value.

      Example: "contextMap":{"<KeyName1>":{"boolean":true},"<KeyName2>":{"long":1234}}

    • cedarJson

      public final String cedarJson()

      A Cedar JSON string representation of the context needed to successfully evaluate an authorization request.

      Example: {"cedarJson":"{\"<KeyName1>\": true, \"<KeyName2>\": 1234}" }

      Returns:
      A Cedar JSON string representation of the context needed to successfully evaluate an authorization request.

      Example: {"cedarJson":"{\"<KeyName1>\": true, \"<KeyName2>\": 1234}" }

    • toBuilder

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

    • builder

      public static ContextDefinition.Builder builder()

    • serializableBuilderClass

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

    • fromContextMap

      public static ContextDefinition fromContextMap(Map<String,AttributeValue> contextMap)
      Create an instance of this class with contextMap() initialized to the given value.

      An list of attributes that are needed to successfully evaluate an authorization request. Each attribute in this array must include a map of a data type and its value.

      Example: "contextMap":{"<KeyName1>":{"boolean":true},"<KeyName2>":{"long":1234}}

      Parameters:
      contextMap - An list of attributes that are needed to successfully evaluate an authorization request. Each attribute in this array must include a map of a data type and its value.

      Example: "contextMap":{"<KeyName1>":{"boolean":true},"<KeyName2>":{"long":1234}}

    • fromCedarJson

      public static ContextDefinition fromCedarJson(String cedarJson)
      Create an instance of this class with cedarJson() initialized to the given value.

      A Cedar JSON string representation of the context needed to successfully evaluate an authorization request.

      Example: {"cedarJson":"{\"<KeyName1>\": true, \"<KeyName2>\": 1234}" }

      Parameters:
      cedarJson - A Cedar JSON string representation of the context needed to successfully evaluate an authorization request.

      Example: {"cedarJson":"{\"<KeyName1>\": true, \"<KeyName2>\": 1234}" }

    • type

      public ContextDefinition.Type type()
      Retrieve an enum value representing which member of this object is populated. When this class is returned in a service response, this will be ContextDefinition.Type.UNKNOWN_TO_SDK_VERSION if the service returned a member that is only known to a newer SDK version. When this class is created directly in your code, this will be ContextDefinition.Type.UNKNOWN_TO_SDK_VERSION if zero members are set, and null if more than one member is set.

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