software.amazon.awssdk.services.kendra.model

Class ServiceNowServiceCatalogConfiguration

java.lang.Object

software.amazon.awssdk.services.kendra.model.ServiceNowServiceCatalogConfiguration

All Implemented Interfaces:

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

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

Provides configuration information for crawling service catalog items in the ServiceNow site

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ServiceNowServiceCatalogConfiguration.Builder

Method Summary

Modifier and Type	Method and Description
static ServiceNowServiceCatalogConfiguration.Builder	builder()
Boolean	crawlAttachments() Indicates whether Amazon Kendra should crawl attachments to the service catalog items.
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() Determines the types of file attachments that are excluded from the index.
List<DataSourceToIndexFieldMapping>	fieldMappings() Mapping between ServiceNow fields and Amazon Kendra index fields.
<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() Determines the types of file attachments that are included in the index.
List<SdkField<?>>	sdkFields()
static Class<? extends ServiceNowServiceCatalogConfiguration.Builder>	serializableBuilderClass()
ServiceNowServiceCatalogConfiguration.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 Boolean crawlAttachments()

Indicates whether Amazon Kendra should crawl attachments to the service catalog items.

Returns:

Indicates whether Amazon Kendra should crawl attachments to the service catalog items.

hasIncludeAttachmentFilePatterns

public 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 List<String> includeAttachmentFilePatterns()

Determines the types of file attachments that are included in the index.

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:

Determines the types of file attachments that are included in the index.

hasExcludeAttachmentFilePatterns

public 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 List<String> excludeAttachmentFilePatterns()

Determines the types of file attachments that are excluded from the index.

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:

Determines the types of file attachments that are excluded from the index.

documentDataFieldName

public 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 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 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 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.

toBuilder

public ServiceNowServiceCatalogConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ServiceNowServiceCatalogConfiguration.Builder,ServiceNowServiceCatalogConfiguration>

builder

public static ServiceNowServiceCatalogConfiguration.Builder builder()

serializableBuilderClass

public static Class<? extends ServiceNowServiceCatalogConfiguration.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo