Class AttributeValue

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

The value of an attribute.

Contains information about the runtime context for a request for which an authorization decision is made.

This data type is used as a member of the ContextDefinition structure which is uses as a request parameter for the IsAuthorized, BatchIsAuthorized , and IsAuthorizedWithToken operations.

See Also:

  • Method Details

    • booleanValue

      public final Boolean booleanValue()

      An attribute value of Boolean type.

      Example: {"boolean": true}

      Returns:
      An attribute value of Boolean type.

      Example: {"boolean": true}

    • entityIdentifier

      public final EntityIdentifier entityIdentifier()

      An attribute value of type EntityIdentifier.

      Example: "entityIdentifier": { "entityId": "<id>", "entityType": "<entity type>"}

      Returns:
      An attribute value of type EntityIdentifier.

      Example: "entityIdentifier": { "entityId": "<id>", "entityType": "<entity type>"}

    • longValue

      public final Long longValue()

      An attribute value of Long type.

      Example: {"long": 0}

      Returns:
      An attribute value of Long type.

      Example: {"long": 0}

    • string

      public final String string()

      An attribute value of String type.

      Example: {"string": "abc"}

      Returns:
      An attribute value of String type.

      Example: {"string": "abc"}

    • hasSet

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

    • set

      public final List<AttributeValue> set()

      An attribute value of Set type.

      Example: {"set": [ {} ] }

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

      Returns:
      An attribute value of Set type.

      Example: {"set": [ {} ] }

    • hasRecord

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

    • record

      public final Map<String,AttributeValue> record()

      An attribute value of Record type.

      Example: {"record": { "keyName": {} } }

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

      Returns:
      An attribute value of Record type.

      Example: {"record": { "keyName": {} } }

    • ipaddr

      public final String ipaddr()

      An attribute value of ipaddr type.

      Example: {"ip": "192.168.1.100"}

      Returns:
      An attribute value of ipaddr type.

      Example: {"ip": "192.168.1.100"}

    • decimal

      public final String decimal()

      An attribute value of decimal type.

      Example: {"decimal": "1.1"}

      Returns:
      An attribute value of decimal type.

      Example: {"decimal": "1.1"}

    • toBuilder

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

    • builder

      public static AttributeValue.Builder builder()

    • serializableBuilderClass

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

    • fromBooleanValue

      public static AttributeValue fromBooleanValue(Boolean booleanValue)
      Create an instance of this class with booleanValue() initialized to the given value.

      An attribute value of Boolean type.

      Example: {"boolean": true}

      Parameters:
      booleanValue - An attribute value of Boolean type.

      Example: {"boolean": true}

    • fromEntityIdentifier

      public static AttributeValue fromEntityIdentifier(EntityIdentifier entityIdentifier)
      Create an instance of this class with entityIdentifier() initialized to the given value.

      An attribute value of type EntityIdentifier.

      Example: "entityIdentifier": { "entityId": "<id>", "entityType": "<entity type>"}

      Parameters:
      entityIdentifier - An attribute value of type EntityIdentifier.

      Example: "entityIdentifier": { "entityId": "<id>", "entityType": "<entity type>"}

    • fromEntityIdentifier

      public static AttributeValue fromEntityIdentifier(Consumer<EntityIdentifier.Builder> entityIdentifier)
      Create an instance of this class with entityIdentifier() initialized to the given value.

      An attribute value of type EntityIdentifier.

      Example: "entityIdentifier": { "entityId": "<id>", "entityType": "<entity type>"}

      Parameters:
      entityIdentifier - An attribute value of type EntityIdentifier.

      Example: "entityIdentifier": { "entityId": "<id>", "entityType": "<entity type>"}

    • fromLongValue

      public static AttributeValue fromLongValue(Long longValue)
      Create an instance of this class with longValue() initialized to the given value.

      An attribute value of Long type.

      Example: {"long": 0}

      Parameters:
      longValue - An attribute value of Long type.

      Example: {"long": 0}

    • fromString

      public static AttributeValue fromString(String string)
      Create an instance of this class with string() initialized to the given value.

      An attribute value of String type.

      Example: {"string": "abc"}

      Parameters:
      string - An attribute value of String type.

      Example: {"string": "abc"}

    • fromSet

      public static AttributeValue fromSet(List<AttributeValue> set)
      Create an instance of this class with set() initialized to the given value.

      An attribute value of Set type.

      Example: {"set": [ {} ] }

      Parameters:
      set - An attribute value of Set type.

      Example: {"set": [ {} ] }

    • fromRecord

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

      An attribute value of Record type.

      Example: {"record": { "keyName": {} } }

      Parameters:
      record - An attribute value of Record type.

      Example: {"record": { "keyName": {} } }

    • fromIpaddr

      public static AttributeValue fromIpaddr(String ipaddr)
      Create an instance of this class with ipaddr() initialized to the given value.

      An attribute value of ipaddr type.

      Example: {"ip": "192.168.1.100"}

      Parameters:
      ipaddr - An attribute value of ipaddr type.

      Example: {"ip": "192.168.1.100"}

    • fromDecimal

      public static AttributeValue fromDecimal(String decimal)
      Create an instance of this class with decimal() initialized to the given value.

      An attribute value of decimal type.

      Example: {"decimal": "1.1"}

      Parameters:
      decimal - An attribute value of decimal type.

      Example: {"decimal": "1.1"}

    • type

      public AttributeValue.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 AttributeValue.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 AttributeValue.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.