Package software.amazon.awssdk.services.verifiedpermissions.model

Class EntitiesDefinition

java.lang.Object

software.amazon.awssdk.services.verifiedpermissions.model.EntitiesDefinition

All Implemented Interfaces:

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

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

Contains the list of entities to be considered during an authorization request. This includes all principals, resources, and actions required to successfully evaluate the request.

This data type is used as a field in the response parameter for the IsAuthorized and IsAuthorizedWithToken operations.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static EntitiesDefinition.Builder	builder()
List<EntityItem>	entityList()	An array of entities that are needed to successfully evaluate an authorization request.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
static EntitiesDefinition	fromEntityList(List<EntityItem> entityList)	Create an instance of this class with entityList() initialized to the given value.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasEntityList()	For responses, this returns true if the service returned a value for the EntityList property.
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends EntitiesDefinition.Builder>	serializableBuilderClass()
EntitiesDefinition.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
EntitiesDefinition.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

hasEntityList

public final boolean hasEntityList()

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

entityList

public final List<EntityItem> entityList()

An array of entities that are needed to successfully evaluate an authorization request. Each entity in this array must include an identifier for the entity, the attributes of the entity, and a list of any parent entities.

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

Returns:

An array of entities that are needed to successfully evaluate an authorization request. Each entity in this array must include an identifier for the entity, the attributes of the entity, and a list of any parent entities.

toBuilder

public EntitiesDefinition.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<EntitiesDefinition.Builder,EntitiesDefinition>

builder

public static EntitiesDefinition.Builder builder()

serializableBuilderClass

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

fromEntityList

public static EntitiesDefinition fromEntityList(List<EntityItem> entityList)

Create an instance of this class with entityList() initialized to the given value.

An array of entities that are needed to successfully evaluate an authorization request. Each entity in this array must include an identifier for the entity, the attributes of the entity, and a list of any parent entities.

Parameters:

entityList - An array of entities that are needed to successfully evaluate an authorization request. Each entity in this array must include an identifier for the entity, the attributes of the entity, and a list of any parent entities.

type

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