Class ServiceNowKnowledgeArticleConfiguration

java.lang.Object
software.amazon.awssdk.services.kendra.model.ServiceNowKnowledgeArticleConfiguration
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ServiceNowKnowledgeArticleConfiguration.Builder,ServiceNowKnowledgeArticleConfiguration>
@Generated("software.amazon.awssdk:codegen") public final class ServiceNowKnowledgeArticleConfiguration extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ServiceNowKnowledgeArticleConfiguration.Builder,ServiceNowKnowledgeArticleConfiguration>

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

See Also:

  • Method Details

    • crawlAttachments

      public final Boolean 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 the isEmpty() 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

      public final List<String> 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 the isEmpty() 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

      public final List<String> 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

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

      public final List<DataSourceToIndexFieldMapping> 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

      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()
      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 interface ToCopyableBuilder<ServiceNowKnowledgeArticleConfiguration.Builder,ServiceNowKnowledgeArticleConfiguration>
      Returns:
      a builder for type T

    • 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)
      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 an 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.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.