software.amazon.awssdk.services.kendra.model

Class SiteMapsConfiguration

java.lang.Object

software.amazon.awssdk.services.kendra.model.SiteMapsConfiguration

All Implemented Interfaces:

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

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

Provides the configuration information for the sitemap URLs to crawl.

When selecting websites to index, you must adhere to the Amazon Acceptable Use Policy and all other Amazon terms. Remember that you must only use Amazon Kendra Web Crawler to index your own web pages, or web pages that you have authorization to index.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SiteMapsConfiguration.Builder

Method Summary

Modifier and Type	Method and Description
static SiteMapsConfiguration.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasSiteMaps() For responses, this returns true if the service returned a value for the SiteMaps property.
List<SdkField<?>>	sdkFields()
static Class<? extends SiteMapsConfiguration.Builder>	serializableBuilderClass()
List<String>	siteMaps() The list of sitemap URLs of the websites you want to crawl.
SiteMapsConfiguration.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

hasSiteMaps

public final boolean hasSiteMaps()

For responses, this returns true if the service returned a value for the SiteMaps 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.

siteMaps

public final List<String> siteMaps()

The list of sitemap URLs of the websites you want to crawl.

The list can include a maximum of three sitemap URLs.

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 hasSiteMaps() method.

Returns:

The list of sitemap URLs of the websites you want to crawl.

The list can include a maximum of three sitemap URLs.

toBuilder

public SiteMapsConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SiteMapsConfiguration.Builder,SiteMapsConfiguration>

builder

public static SiteMapsConfiguration.Builder builder()

serializableBuilderClass

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