@Generated(value="software.amazon.awssdk:codegen") public final class DocumentMetadataConfiguration extends Object implements SdkPojo, Serializable, ToCopyableBuilder<DocumentMetadataConfiguration.Builder,DocumentMetadataConfiguration>
Specifies the properties of a custom index field.
Modifier and Type | Class and Description |
---|---|
static interface |
DocumentMetadataConfiguration.Builder |
Modifier and Type | Method and Description |
---|---|
static DocumentMetadataConfiguration.Builder |
builder() |
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj)
Indicates whether some other object is "equal to" this one by SDK fields.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
String |
name()
The name of the index field.
|
Relevance |
relevance()
Provides manual tuning parameters to determine how the field affects the search results.
|
List<SdkField<?>> |
sdkFields() |
Search |
search()
Provides information about how the field is used during a search.
|
static Class<? extends DocumentMetadataConfiguration.Builder> |
serializableBuilderClass() |
DocumentMetadataConfiguration.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString()
Returns a string representation of this object.
|
DocumentAttributeValueType |
type()
The data type of the index field.
|
String |
typeAsString()
The data type of the index field.
|
copy
public final String name()
The name of the index field.
public final DocumentAttributeValueType type()
The data type of the index field.
If the service returns an enum value that is not available in the current SDK version, type
will return
DocumentAttributeValueType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from typeAsString()
.
DocumentAttributeValueType
public final String typeAsString()
The data type of the index field.
If the service returns an enum value that is not available in the current SDK version, type
will return
DocumentAttributeValueType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from typeAsString()
.
DocumentAttributeValueType
public final Relevance relevance()
Provides manual tuning parameters to determine how the field affects the search results.
public final Search search()
Provides information about how the field is used during a search.
public DocumentMetadataConfiguration.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<DocumentMetadataConfiguration.Builder,DocumentMetadataConfiguration>
public static DocumentMetadataConfiguration.Builder builder()
public static Class<? extends DocumentMetadataConfiguration.Builder> serializableBuilderClass()
public final boolean equalsBySdkFields(Object obj)
SdkPojo
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.
equalsBySdkFields
in interface SdkPojo
obj
- the object to be compared withpublic final String toString()
Copyright © 2021 Amazon Web Services, Inc. All Rights Reserved.