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

Class ContextDefinition

java.lang.Object

software.amazon.awssdk.services.verifiedpermissions.model.ContextDefinition

All Implemented Interfaces:

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

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

Contains additional details about the context of the request. Verified Permissions evaluates this information in an authorization request as part of the when and unless clauses in a policy.

This data type is used as a request parameter for the IsAuthorized, BatchIsAuthorized , and IsAuthorizedWithToken operations.

If you're passing context as part of the request, exactly one instance of context must be passed. If you don't want to pass context, omit the context parameter from your request rather than sending context {}.

Example: "context":{"contextMap":{"<KeyName1>":{"boolean":true},"<KeyName2>":{"long":1234}}}

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static ContextDefinition.Builder	builder()
String	cedarJson()	A Cedar JSON string representation of the context needed to successfully evaluate an authorization request.
Map<String,AttributeValue>	contextMap()	An list of attributes that are needed to successfully evaluate an authorization request.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
static ContextDefinition	fromCedarJson(String cedarJson)	Create an instance of this class with cedarJson() initialized to the given value.
static ContextDefinition	fromContextMap(Map<String,AttributeValue> contextMap)	Create an instance of this class with contextMap() initialized to the given value.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasContextMap()	For responses, this returns true if the service returned a value for the ContextMap property.
int	hashCode()
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends ContextDefinition.Builder>	serializableBuilderClass()
ContextDefinition.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
ContextDefinition.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

hasContextMap

public final boolean hasContextMap()

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

contextMap

public final Map<String,AttributeValue> contextMap()

An list of attributes that are needed to successfully evaluate an authorization request. Each attribute in this array must include a map of a data type and its value.

Example: "contextMap":{"<KeyName1>":{"boolean":true},"<KeyName2>":{"long":1234}}

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

Returns:

An list of attributes that are needed to successfully evaluate an authorization request. Each attribute in this array must include a map of a data type and its value.

Example: "contextMap":{"<KeyName1>":{"boolean":true},"<KeyName2>":{"long":1234}}

cedarJson

public final String cedarJson()

A Cedar JSON string representation of the context needed to successfully evaluate an authorization request.

Example: {"cedarJson":"{\"<KeyName1>\": true, \"<KeyName2>\": 1234}" }

Returns:

A Cedar JSON string representation of the context needed to successfully evaluate an authorization request.

Example: {"cedarJson":"{\"<KeyName1>\": true, \"<KeyName2>\": 1234}" }

toBuilder

public ContextDefinition.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ContextDefinition.Builder,ContextDefinition>

builder

public static ContextDefinition.Builder builder()

serializableBuilderClass

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

fromContextMap

public static ContextDefinition fromContextMap(Map<String,AttributeValue> contextMap)

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

An list of attributes that are needed to successfully evaluate an authorization request. Each attribute in this array must include a map of a data type and its value.

Example: "contextMap":{"<KeyName1>":{"boolean":true},"<KeyName2>":{"long":1234}}

Parameters:

contextMap - An list of attributes that are needed to successfully evaluate an authorization request. Each attribute in this array must include a map of a data type and its value.

Example: "contextMap":{"<KeyName1>":{"boolean":true},"<KeyName2>":{"long":1234}}

fromCedarJson

public static ContextDefinition fromCedarJson(String cedarJson)

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

A Cedar JSON string representation of the context needed to successfully evaluate an authorization request.

Example: {"cedarJson":"{\"<KeyName1>\": true, \"<KeyName2>\": 1234}" }

Parameters:

cedarJson - A Cedar JSON string representation of the context needed to successfully evaluate an authorization request.

Example: {"cedarJson":"{\"<KeyName1>\": true, \"<KeyName2>\": 1234}" }

type

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo