software.amazon.awssdk.services.verifiedpermissions.model

Class AttributeValue

java.lang.Object

software.amazon.awssdk.services.verifiedpermissions.model.AttributeValue

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<AttributeValue.Builder,AttributeValue>

@Generated(value="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 and IsAuthorizedWithToken operations.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AttributeValue.Builder
static class	AttributeValue.Type

Method Summary

Modifier and Type	Method and Description
Boolean	booleanValue() An attribute value of Boolean type.
static AttributeValue.Builder	builder()
EntityIdentifier	entityIdentifier() An attribute value of type EntityIdentifier.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
static AttributeValue	fromBooleanValue(Boolean booleanValue) Create an instance of this class with booleanValue() initialized to the given value.
static AttributeValue	fromEntityIdentifier(Consumer<EntityIdentifier.Builder> entityIdentifier) Create an instance of this class with entityIdentifier() initialized to the given value.
static AttributeValue	fromEntityIdentifier(EntityIdentifier entityIdentifier) Create an instance of this class with entityIdentifier() initialized to the given value.
static AttributeValue	fromLongValue(Long longValue) Create an instance of this class with longValue() initialized to the given value.
static AttributeValue	fromRecord(Map<String,AttributeValue> record) Create an instance of this class with record() initialized to the given value.
static AttributeValue	fromSet(List<AttributeValue> set) Create an instance of this class with set() initialized to the given value.
static AttributeValue	fromString(String string) Create an instance of this class with string() initialized to the given value.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasRecord() For responses, this returns true if the service returned a value for the Record property.
boolean	hasSet() For responses, this returns true if the service returned a value for the Set property.
Long	longValue() An attribute value of Long type.
Map<String,AttributeValue>	record() An attribute value of Record type.
List<SdkField<?>>	sdkFields()
static Class<? extends AttributeValue.Builder>	serializableBuilderClass()
List<AttributeValue>	set() An attribute value of Set type.
String	string() An attribute value of String type.
AttributeValue.Builder	toBuilder()
String	toString() Returns a string representation of this object.
AttributeValue.Type	type() Retrieve an enum value representing which member of this object is populated.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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": {} } }

toBuilder

public AttributeValue.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AttributeValue.Builder,AttributeValue>

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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": {} } }

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