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

Class AccessConfiguration

java.lang.Object

software.amazon.awssdk.services.qbusiness.model.AccessConfiguration

All Implemented Interfaces:

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

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

Used to configure access permissions for a document.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AccessConfiguration.Builder

Method Summary

Modifier and Type	Method	Description
List<AccessControl>	accessControls()	A list of AccessControlList objects.
static AccessConfiguration.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAccessControls()	For responses, this returns true if the service returned a value for the AccessControls property.
int	hashCode()
MemberRelation	memberRelation()	Describes the member relation within the AccessControlList object.
String	memberRelationAsString()	Describes the member relation within the AccessControlList object.
List<SdkField<?>>	sdkFields()
static Class<? extends AccessConfiguration.Builder>	serializableBuilderClass()
AccessConfiguration.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

hasAccessControls

public final boolean hasAccessControls()

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

accessControls

public final List<AccessControl> accessControls()

A list of AccessControlList objects.

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

Returns:

A list of AccessControlList objects.

memberRelation

public final MemberRelation memberRelation()

Describes the member relation within the AccessControlList object.

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 the AccessControlList object.

See Also:

MemberRelation

memberRelationAsString

public final String memberRelationAsString()

Describes the member relation within the AccessControlList object.

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 the AccessControlList object.

See Also:

MemberRelation

toBuilder

public AccessConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AccessConfiguration.Builder,AccessConfiguration>

builder

public static AccessConfiguration.Builder builder()

serializableBuilderClass

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