Package software.amazon.awssdk.services.qbusiness.model

Class AccessControl

java.lang.Object

software.amazon.awssdk.services.qbusiness.model.AccessControl

All Implemented Interfaces:

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

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

A list of principals. Each principal can be either a USER or a GROUP and can be designated document access permissions of either ALLOW or DENY.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AccessControl.Builder

Method Summary

Modifier and Type	Method	Description
static AccessControl.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasPrincipals()	For responses, this returns true if the service returned a value for the Principals property.
MemberRelation	memberRelation()	Describes the member relation within a principal list.
String	memberRelationAsString()	Describes the member relation within a principal list.
List<Principal>	principals()	Contains a list of principals, where a principal can be either a USER or a GROUP.
List<SdkField<?>>	sdkFields()
static Class<? extends AccessControl.Builder>	serializableBuilderClass()
AccessControl.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

hasPrincipals

public final boolean hasPrincipals()

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

principals

public final List<Principal> principals()

Contains a list of principals, where a principal can be either a USER or a GROUP. Each principal can be have the following type of document access: ALLOW or DENY.

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

Returns:

Contains a list of principals, where a principal can be either a USER or a GROUP. Each principal can be have the following type of document access: ALLOW or DENY.

memberRelation

public final MemberRelation memberRelation()

Describes the member relation within a principal list.

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

Returns:

Describes the member relation within a principal list.

See Also:

MemberRelation

memberRelationAsString

public final String memberRelationAsString()

Describes the member relation within a principal list.

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

Returns:

Describes the member relation within a principal list.

See Also:

MemberRelation

toBuilder

public AccessControl.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AccessControl.Builder,AccessControl>

builder

public static AccessControl.Builder builder()

serializableBuilderClass

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

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo