Class ServiceNowKnowledgeArticleConfiguration
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<ServiceNowKnowledgeArticleConfiguration.Builder,
ServiceNowKnowledgeArticleConfiguration>
Provides the configuration information for crawling knowledge articles in the ServiceNow site.
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic interface
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final Boolean
TRUE
to index attachments to knowledge articles.final String
The name of the ServiceNow field that is mapped to the index document contents field in the Amazon Kendra index.final String
The name of the ServiceNow field that is mapped to the index document title field.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.A list of regular expression patterns applied to exclude certain knowledge article attachments.Maps attributes or field names of knoweldge articles to Amazon Kendra index field names.final String
A query that selects the knowledge articles to index.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the ExcludeAttachmentFilePatterns property.final boolean
For responses, this returns true if the service returned a value for the FieldMappings property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the IncludeAttachmentFilePatterns property.A list of regular expression patterns applied to include knowledge article attachments.static Class
<? extends ServiceNowKnowledgeArticleConfiguration.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
crawlAttachments
TRUE
to index attachments to knowledge articles.- Returns:
TRUE
to index attachments to knowledge articles.
-
hasIncludeAttachmentFilePatterns
public final boolean hasIncludeAttachmentFilePatterns()For responses, this returns true if the service returned a value for the IncludeAttachmentFilePatterns property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
includeAttachmentFilePatterns
A list of regular expression patterns applied to include knowledge article attachments. Attachments that match the patterns are included in the index. Items that don't match the patterns are excluded from the index. If an item matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the item isn't included in the index.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasIncludeAttachmentFilePatterns()
method.- Returns:
- A list of regular expression patterns applied to include knowledge article attachments. Attachments that match the patterns are included in the index. Items that don't match the patterns are excluded from the index. If an item matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the item isn't included in the index.
-
hasExcludeAttachmentFilePatterns
public final boolean hasExcludeAttachmentFilePatterns()For responses, this returns true if the service returned a value for the ExcludeAttachmentFilePatterns property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
excludeAttachmentFilePatterns
A list of regular expression patterns applied to exclude certain knowledge article attachments. Attachments that match the patterns are excluded from the index. Items that don't match the patterns are included in the index. If an item matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the item isn't included in the index.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasExcludeAttachmentFilePatterns()
method.- Returns:
- A list of regular expression patterns applied to exclude certain knowledge article attachments. Attachments that match the patterns are excluded from the index. Items that don't match the patterns are included in the index. If an item matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the item isn't included in the index.
-
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
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()For responses, this returns true if the service returned a value for the FieldMappings property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
fieldMappings
Maps attributes or field names of knoweldge articles to Amazon Kendra index field names. To create custom fields, use the
UpdateIndex
API before you map to ServiceNow fields. For more information, see Mapping data source fields. The ServiceNow data source field names must exist in your ServiceNow custom metadata.Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasFieldMappings()
method.- Returns:
- Maps attributes or field names of knoweldge articles to Amazon Kendra index field names. To create custom
fields, use the
UpdateIndex
API before you map to ServiceNow fields. For more information, see Mapping data source fields. The ServiceNow data source field names must exist in your ServiceNow custom metadata.
-
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
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<ServiceNowKnowledgeArticleConfiguration.Builder,
ServiceNowKnowledgeArticleConfiguration> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
public static Class<? extends ServiceNowKnowledgeArticleConfiguration.Builder> serializableBuilderClass() -
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-