software.amazon.awssdk.services.verifiedpermissions.model

Class SchemaDefinition

java.lang.Object

software.amazon.awssdk.services.verifiedpermissions.model.SchemaDefinition

All Implemented Interfaces:

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

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

Contains a list of principal types, resource types, and actions that can be specified in policies stored in the same policy store. If the validation mode for the policy store is set to STRICT, then policies that can't be validated by this schema are rejected by Verified Permissions and can't be stored in the policy store.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static SchemaDefinition.Builder	builder()
String	cedarJson() A JSON string representation of the schema supported by applications that use this policy store.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
static SchemaDefinition	fromCedarJson(String cedarJson) Create an instance of this class with cedarJson() initialized to the given value.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends SchemaDefinition.Builder>	serializableBuilderClass()
SchemaDefinition.Builder	toBuilder()
String	toString() Returns a string representation of this object.
SchemaDefinition.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

cedarJson

public final String cedarJson()

A JSON string representation of the schema supported by applications that use this policy store. For more information, see Policy store schema in the Amazon Verified Permissions User Guide.

Returns:

A JSON string representation of the schema supported by applications that use this policy store. For more information, see Policy store schema in the Amazon Verified Permissions User Guide.

toBuilder

public SchemaDefinition.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SchemaDefinition.Builder,SchemaDefinition>

builder

public static SchemaDefinition.Builder builder()

serializableBuilderClass

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

fromCedarJson

public static SchemaDefinition fromCedarJson(String cedarJson)

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

A JSON string representation of the schema supported by applications that use this policy store. For more information, see Policy store schema in the Amazon Verified Permissions User Guide.

Parameters:

cedarJson - A JSON string representation of the schema supported by applications that use this policy store. For more information, see Policy store schema in the Amazon Verified Permissions User Guide.

type

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