software.amazon.awssdk.services.kendra.model

Class SalesforceCustomKnowledgeArticleTypeConfiguration

java.lang.Object

software.amazon.awssdk.services.kendra.model.SalesforceCustomKnowledgeArticleTypeConfiguration

All Implemented Interfaces:

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

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

Provides configuration information for indexing Salesforce custom articles.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SalesforceCustomKnowledgeArticleTypeConfiguration.Builder

Method Summary

Modifier and Type	Method and Description
static SalesforceCustomKnowledgeArticleTypeConfiguration.Builder	builder()
String	documentDataFieldName() The name of the field in the custom knowledge article that contains the document data to index.
String	documentTitleFieldName() The name of the field in the custom knowledge article that contains the document title.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<DataSourceToIndexFieldMapping>	fieldMappings() One or more objects that map fields in the custom knowledge article to fields in the Amazon Kendra index.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasFieldMappings() Returns true if the FieldMappings property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
int	hashCode()
String	name() The name of the configuration.
List<SdkField<?>>	sdkFields()
static Class<? extends SalesforceCustomKnowledgeArticleTypeConfiguration.Builder>	serializableBuilderClass()
SalesforceCustomKnowledgeArticleTypeConfiguration.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

name

public final String name()

The name of the configuration.

Returns:

The name of the configuration.

documentDataFieldName

public final String documentDataFieldName()

The name of the field in the custom knowledge article that contains the document data to index.

Returns:

The name of the field in the custom knowledge article that contains the document data to index.

documentTitleFieldName

public final String documentTitleFieldName()

The name of the field in the custom knowledge article that contains the document title.

Returns:

The name of the field in the custom knowledge article that contains the document title.

hasFieldMappings

public final boolean hasFieldMappings()

Returns true if the FieldMappings property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

fieldMappings

public final List<DataSourceToIndexFieldMapping> fieldMappings()

One or more objects that map fields in the custom knowledge article to fields in the Amazon Kendra index.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasFieldMappings() to see if a value was sent in this field.

Returns:

One or more objects that map fields in the custom knowledge article to fields in the Amazon Kendra index.

toBuilder

public SalesforceCustomKnowledgeArticleTypeConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SalesforceCustomKnowledgeArticleTypeConfiguration.Builder,SalesforceCustomKnowledgeArticleTypeConfiguration>

builder

public static SalesforceCustomKnowledgeArticleTypeConfiguration.Builder builder()

serializableBuilderClass

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