software.amazon.awssdk.services.verifiedpermissions.model

Class EntityItem

java.lang.Object

software.amazon.awssdk.services.verifiedpermissions.model.EntityItem

All Implemented Interfaces:

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

@Generated(value="software.amazon.awssdk:codegen")
public final class EntityItem
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<EntityItem.Builder,EntityItem>

Contains information about an entity that can be referenced in a Cedar policy.

This data type is used as one of the fields in the EntitiesDefinition structure.

{ "identifier": { "entityType": "Photo", "entityId": "VacationPhoto94.jpg" }, "attributes": {}, "parents": [ { "entityType": "Album", "entityId": "alice_folder" } ] }

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	EntityItem.Builder

Method Summary

Modifier and Type	Method and Description
Map<String,AttributeValue>	attributes() A list of attributes for the entity.
static EntityItem.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAttributes() For responses, this returns true if the service returned a value for the Attributes property.
int	hashCode()
boolean	hasParents() For responses, this returns true if the service returned a value for the Parents property.
EntityIdentifier	identifier() The identifier of the entity.
List<EntityIdentifier>	parents() The parents in the hierarchy that contains the entity.
List<SdkField<?>>	sdkFields()
static Class<? extends EntityItem.Builder>	serializableBuilderClass()
EntityItem.Builder	toBuilder()
String	toString() Returns a string representation of this object.

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

identifier

public final EntityIdentifier identifier()

The identifier of the entity.

Returns:

The identifier of the entity.

hasAttributes

public final boolean hasAttributes()

For responses, this returns true if the service returned a value for the Attributes 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.

attributes

public final Map<String,AttributeValue> attributes()

A list of attributes for the entity.

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

Returns:

A list of attributes for the entity.

hasParents

public final boolean hasParents()

For responses, this returns true if the service returned a value for the Parents 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.

parents

public final List<EntityIdentifier> parents()

The parents in the hierarchy that contains the entity.

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

Returns:

The parents in the hierarchy that contains the entity.

toBuilder

public EntityItem.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<EntityItem.Builder,EntityItem>

builder

public static EntityItem.Builder builder()

serializableBuilderClass

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

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo