DocumentMetadataConfiguration (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.kendra.model.DocumentMetadataConfiguration

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DocumentMetadataConfiguration
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Specifies the properties, such as relevance tuning and searchability, of an index field.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

DocumentMetadataConfiguration()

Constructors
Constructor and Description
`DocumentMetadataConfiguration()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DocumentMetadataConfiguration`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getName()` The name of the index field.
`Relevance`	`getRelevance()` Provides tuning parameters to determine how the field affects the search results.
`Search`	`getSearch()` Provides information about how the field is used during a search.
`String`	`getType()` The data type of the index field.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setName(String name)` The name of the index field.
`void`	`setRelevance(Relevance relevance)` Provides tuning parameters to determine how the field affects the search results.
`void`	`setSearch(Search search)` Provides information about how the field is used during a search.
`void`	`setType(String type)` The data type of the index field.
`String`	`toString()` Returns a string representation of this object.
`DocumentMetadataConfiguration`	`withName(String name)` The name of the index field.
`DocumentMetadataConfiguration`	`withRelevance(Relevance relevance)` Provides tuning parameters to determine how the field affects the search results.
`DocumentMetadataConfiguration`	`withSearch(Search search)` Provides information about how the field is used during a search.
`DocumentMetadataConfiguration`	`withType(DocumentAttributeValueType type)` The data type of the index field.
`DocumentMetadataConfiguration`	`withType(String type)` The data type of the index field.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - DocumentMetadataConfiguration
```
public DocumentMetadataConfiguration()
```
- Method Detail
  - setName
```
public void setName(String name)
```
    The name of the index field.
    
    Parameters:
    
    name - The name of the index field.
  - getName
```
public String getName()
```
    The name of the index field.
    
    Returns:
    
    The name of the index field.
  - withName
```
public DocumentMetadataConfiguration withName(String name)
```
    The name of the index field.
    
    Parameters:
    
    name - The name of the index field.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setType
```
public void setType(String type)
```
    The data type of the index field.
    
    Parameters:
    
    type - The data type of the index field.
    
    See Also:
    
    DocumentAttributeValueType
  - getType
```
public String getType()
```
    The data type of the index field.
    
    Returns:
    
    The data type of the index field.
    
    See Also:
    
    DocumentAttributeValueType
  - withType
```
public DocumentMetadataConfiguration withType(String type)
```
    The data type of the index field.
    
    Parameters:
    
    type - The data type of the index field.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    DocumentAttributeValueType
  - withType
```
public DocumentMetadataConfiguration withType(DocumentAttributeValueType type)
```
    The data type of the index field.
    
    Parameters:
    
    type - The data type of the index field.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    DocumentAttributeValueType
  - setRelevance
```
public void setRelevance(Relevance relevance)
```
    Provides tuning parameters to determine how the field affects the search results.
    
    Parameters:
    
    relevance - Provides tuning parameters to determine how the field affects the search results.
  - getRelevance
```
public Relevance getRelevance()
```
    Provides tuning parameters to determine how the field affects the search results.
    
    Returns:
    
    Provides tuning parameters to determine how the field affects the search results.
  - withRelevance
```
public DocumentMetadataConfiguration withRelevance(Relevance relevance)
```
    Provides tuning parameters to determine how the field affects the search results.
    
    Parameters:
    
    relevance - Provides tuning parameters to determine how the field affects the search results.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSearch
```
public void setSearch(Search search)
```
    Provides information about how the field is used during a search.
    
    Parameters:
    
    search - Provides information about how the field is used during a search.
  - getSearch
```
public Search getSearch()
```
    Provides information about how the field is used during a search.
    
    Returns:
    
    Provides information about how the field is used during a search.
  - withSearch
```
public DocumentMetadataConfiguration withSearch(Search search)
```
    Provides information about how the field is used during a search.
    
    Parameters:
    
    search - Provides information about how the field is used during a search.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public DocumentMetadataConfiguration clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.792

Class DocumentMetadataConfiguration

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DocumentMetadataConfiguration

Method Detail

setName

getName

withName

setType

getType

withType

withType

setRelevance

getRelevance

withRelevance

setSearch

getSearch

withSearch

toString

equals

hashCode

clone

marshall