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

Class EntityReference

java.lang.Object

software.amazon.awssdk.services.verifiedpermissions.model.EntityReference

All Implemented Interfaces:

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

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

Contains information about a principal or resource that can be referenced in a Cedar policy.

This data type is used as part of the PolicyFilter structure that is used as a request parameter for the ListPolicies operation..

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static EntityReference.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
static EntityReference	fromIdentifier(Consumer<EntityIdentifier.Builder> identifier)	Create an instance of this class with identifier() initialized to the given value.
static EntityReference	fromIdentifier(EntityIdentifier identifier)	Create an instance of this class with identifier() initialized to the given value.
static EntityReference	fromUnspecified(Boolean unspecified)	Create an instance of this class with unspecified() initialized to the given value.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
EntityIdentifier	identifier()	The identifier of the entity.
List<SdkField<?>>	sdkFields()
static Class<? extends EntityReference.Builder>	serializableBuilderClass()
EntityReference.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
EntityReference.Type	type()	Retrieve an enum value representing which member of this object is populated.
Boolean	unspecified()	Used to indicate that a principal or resource is not specified.

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

unspecified

public final Boolean unspecified()

Used to indicate that a principal or resource is not specified. This can be used to search for policies that are not associated with a specific principal or resource.

Returns:

Used to indicate that a principal or resource is not specified. This can be used to search for policies that are not associated with a specific principal or resource.

identifier

public final EntityIdentifier identifier()

The identifier of the entity. It can consist of either an EntityType and EntityId, a principal, or a resource.

Returns:

The identifier of the entity. It can consist of either an EntityType and EntityId, a principal, or a resource.

toBuilder

public EntityReference.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<EntityReference.Builder,EntityReference>

builder

public static EntityReference.Builder builder()

serializableBuilderClass

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

fromUnspecified

public static EntityReference fromUnspecified(Boolean unspecified)

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

Used to indicate that a principal or resource is not specified. This can be used to search for policies that are not associated with a specific principal or resource.

Parameters:

unspecified - Used to indicate that a principal or resource is not specified. This can be used to search for policies that are not associated with a specific principal or resource.

fromIdentifier

public static EntityReference fromIdentifier(EntityIdentifier identifier)

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

The identifier of the entity. It can consist of either an EntityType and EntityId, a principal, or a resource.

Parameters:

identifier - The identifier of the entity. It can consist of either an EntityType and EntityId, a principal, or a resource.

fromIdentifier

public static EntityReference fromIdentifier(Consumer<EntityIdentifier.Builder> identifier)

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

The identifier of the entity. It can consist of either an EntityType and EntityId, a principal, or a resource.

Parameters:

identifier - The identifier of the entity. It can consist of either an EntityType and EntityId, a principal, or a resource.

type

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