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

Class DocumentAttributeConfiguration

java.lang.Object

software.amazon.awssdk.services.qbusiness.model.DocumentAttributeConfiguration

All Implemented Interfaces:

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

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

Configuration information for document attributes. Document attributes are metadata or fields associated with your documents. For example, the company department name associated with each document.

For more information, see Understanding document attributes.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DocumentAttributeConfiguration.Builder

Method Summary

Modifier and Type	Method	Description
static DocumentAttributeConfiguration.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	name()	The name of the document attribute.
List<SdkField<?>>	sdkFields()
Status	search()	Information about whether the document attribute can be used by an end user to search for information on their web experience.
String	searchAsString()	Information about whether the document attribute can be used by an end user to search for information on their web experience.
static Class<? extends DocumentAttributeConfiguration.Builder>	serializableBuilderClass()
DocumentAttributeConfiguration.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
AttributeType	type()	The type of document attribute.
String	typeAsString()	The type of document attribute.

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

name

public final String name()

The name of the document attribute.

Returns:

The name of the document attribute.

type

public final AttributeType type()

The type of document attribute.

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

Returns:

The type of document attribute.

See Also:

AttributeType

typeAsString

public final String typeAsString()

The type of document attribute.

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

Returns:

The type of document attribute.

See Also:

AttributeType

search

public final Status search()

Information about whether the document attribute can be used by an end user to search for information on their web experience.

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

Returns:

Information about whether the document attribute can be used by an end user to search for information on their web experience.

See Also:

Status

searchAsString

public final String searchAsString()

Information about whether the document attribute can be used by an end user to search for information on their web experience.

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

Returns:

Information about whether the document attribute can be used by an end user to search for information on their web experience.

See Also:

Status

toBuilder

public DocumentAttributeConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DocumentAttributeConfiguration.Builder,DocumentAttributeConfiguration>

builder

public static DocumentAttributeConfiguration.Builder builder()

serializableBuilderClass

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