software.amazon.awssdk.services.kendra.model

Class ServiceNowKnowledgeArticleConfiguration

java.lang.Object

software.amazon.awssdk.services.kendra.model.ServiceNowKnowledgeArticleConfiguration

All Implemented Interfaces:

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

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

Provides configuration information for crawling knowledge articles in the ServiceNow site.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ServiceNowKnowledgeArticleConfiguration.Builder

Method Summary

Modifier and Type	Method and Description
static ServiceNowKnowledgeArticleConfiguration.Builder	builder()
Boolean	crawlAttachments() Indicates whether Amazon Kendra should index attachments to knowledge articles.
String	documentDataFieldName() The name of the ServiceNow field that is mapped to the index document contents field in the Amazon Kendra index.
String	documentTitleFieldName() The name of the ServiceNow field that is mapped to the index document title field.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<String>	excludeAttachmentFilePatterns() List of regular expressions applied to knowledge articles.
List<DataSourceToIndexFieldMapping>	fieldMappings() Mapping between ServiceNow fields and Amazon Kendra index fields.
String	filterQuery() A query that selects the knowledge articles to index.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasExcludeAttachmentFilePatterns() Returns true if the ExcludeAttachmentFilePatterns property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
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()
boolean	hasIncludeAttachmentFilePatterns() Returns true if the IncludeAttachmentFilePatterns property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
List<String>	includeAttachmentFilePatterns() List of regular expressions applied to knowledge articles.
List<SdkField<?>>	sdkFields()
static Class<? extends ServiceNowKnowledgeArticleConfiguration.Builder>	serializableBuilderClass()
ServiceNowKnowledgeArticleConfiguration.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

crawlAttachments

public final Boolean crawlAttachments()

Indicates whether Amazon Kendra should index attachments to knowledge articles.

Returns:

Indicates whether Amazon Kendra should index attachments to knowledge articles.

hasIncludeAttachmentFilePatterns

public final boolean hasIncludeAttachmentFilePatterns()

Returns true if the IncludeAttachmentFilePatterns 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.

includeAttachmentFilePatterns

public final List<String> includeAttachmentFilePatterns()

List of regular expressions applied to knowledge articles. Items that don't match the inclusion pattern are not indexed. The regex is applied to the field specified in the PatternTargetField.

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

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

Returns:

List of regular expressions applied to knowledge articles. Items that don't match the inclusion pattern are not indexed. The regex is applied to the field specified in the PatternTargetField.

hasExcludeAttachmentFilePatterns

public final boolean hasExcludeAttachmentFilePatterns()

Returns true if the ExcludeAttachmentFilePatterns 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.

excludeAttachmentFilePatterns

public final List<String> excludeAttachmentFilePatterns()

List of regular expressions applied to knowledge articles. Items that don't match the inclusion pattern are not indexed. The regex is applied to the field specified in the PatternTargetField

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

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

Returns:

List of regular expressions applied to knowledge articles. Items that don't match the inclusion pattern are not indexed. The regex is applied to the field specified in the PatternTargetField

documentDataFieldName

public final String documentDataFieldName()

The name of the ServiceNow field that is mapped to the index document contents field in the Amazon Kendra index.

Returns:

The name of the ServiceNow field that is mapped to the index document contents field in the Amazon Kendra index.

documentTitleFieldName

public final String documentTitleFieldName()

The name of the ServiceNow field that is mapped to the index document title field.

Returns:

The name of the ServiceNow field that is mapped to the index document title field.

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()

Mapping between ServiceNow fields and Amazon Kendra index fields. You must create the index field before you map the field.

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:

Mapping between ServiceNow fields and Amazon Kendra index fields. You must create the index field before you map the field.

filterQuery

public final String filterQuery()

A query that selects the knowledge articles to index. The query can return articles from multiple knowledge bases, and the knowledge bases can be public or private.

The query string must be one generated by the ServiceNow console. For more information, see Specifying documents to index with a query.

Returns:

A query that selects the knowledge articles to index. The query can return articles from multiple knowledge bases, and the knowledge bases can be public or private.

The query string must be one generated by the ServiceNow console. For more information, see Specifying documents to index with a query.

toBuilder

public ServiceNowKnowledgeArticleConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ServiceNowKnowledgeArticleConfiguration.Builder,ServiceNowKnowledgeArticleConfiguration>

builder

public static ServiceNowKnowledgeArticleConfiguration.Builder builder()

serializableBuilderClass

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