Class DocumentAccessControlEntry

java.lang.Object

software.amazon.awssdk.services.bedrockagent.model.DocumentAccessControlEntry

All Implemented Interfaces:

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

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

An access control entry specifying a principal and their access level.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DocumentAccessControlEntry.Builder

Method Summary

Modifier and Type	Method	Description
final AccessControlAccess	access()	Whether to allow or deny access.
final String	accessAsString()	Whether to allow or deny access.
static DocumentAccessControlEntry.Builder	builder()
final boolean	equals(Object obj)
final boolean	equalsBySdkFields(Object obj)	Indicates whether some other object is "equal to" this one by SDK fields.
final <T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
final int	hashCode()
final String	name()	The user identifier.
final Map<String,SdkField<?>>	sdkFieldNameToField()
final List<SdkField<?>>	sdkFields()
static Class<? extends DocumentAccessControlEntry.Builder>	serializableBuilderClass()
DocumentAccessControlEntry.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
final String	toString()	Returns a string representation of this object.
final AccessControlPrincipalType	type()	The type of principal.
final String	typeAsString()	The type of principal.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Details

name

public final String name()

The user identifier.

Returns:

The user identifier.

type

public final AccessControlPrincipalType type()

The type of principal.

If the service returns an enum value that is not available in the current SDK version, type will return AccessControlPrincipalType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

Returns:

The type of principal.

See Also:

• AccessControlPrincipalType

typeAsString

public final String typeAsString()

The type of principal.

If the service returns an enum value that is not available in the current SDK version, type will return AccessControlPrincipalType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

Returns:

The type of principal.

See Also:

• AccessControlPrincipalType

access

public final AccessControlAccess access()

Whether to allow or deny access.

If the service returns an enum value that is not available in the current SDK version, access will return AccessControlAccess.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from accessAsString().

Returns:

Whether to allow or deny access.

See Also:

• AccessControlAccess

accessAsString

public final String accessAsString()

Whether to allow or deny access.

If the service returns an enum value that is not available in the current SDK version, access will return AccessControlAccess.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from accessAsString().

Returns:

Whether to allow or deny access.

See Also:

• AccessControlAccess

toBuilder

public DocumentAccessControlEntry.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<DocumentAccessControlEntry.Builder,DocumentAccessControlEntry>

Returns:

a builder for type T

builder

public static DocumentAccessControlEntry.Builder builder()

serializableBuilderClass

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

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

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

Returns:

List of SdkField in this POJO. May be empty list but should never be null.

sdkFieldNameToField

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

Specified by:

sdkFieldNameToField in interface SdkPojo

Returns:

The mapping between the field name and its corresponding field.