com.amazonaws.services.kendra.model

Class SiteMapsConfiguration

java.lang.Object

com.amazonaws.services.kendra.model.SiteMapsConfiguration

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class SiteMapsConfiguration
extends Object
implements Serializable, Cloneable, StructuredPojo

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:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
SiteMapsConfiguration()

Method Summary

Modifier and Type	Method and Description
SiteMapsConfiguration	clone()
boolean	equals(Object obj)
List<String>	getSiteMaps() The list of sitemap URLs of the websites you want to crawl.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setSiteMaps(Collection<String> siteMaps) The list of sitemap URLs of the websites you want to crawl.
String	toString() Returns a string representation of this object.
SiteMapsConfiguration	withSiteMaps(Collection<String> siteMaps) The list of sitemap URLs of the websites you want to crawl.
SiteMapsConfiguration	withSiteMaps(String... siteMaps) The list of sitemap URLs of the websites you want to crawl.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SiteMapsConfiguration

public SiteMapsConfiguration()

Method Detail

getSiteMaps

public List<String> getSiteMaps()

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

The list can include a maximum of three sitemap URLs.

Returns:

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

The list can include a maximum of three sitemap URLs.

setSiteMaps

public void setSiteMaps(Collection<String> siteMaps)

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

The list can include a maximum of three sitemap URLs.

Parameters:

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

The list can include a maximum of three sitemap URLs.

withSiteMaps

public SiteMapsConfiguration withSiteMaps(String... siteMaps)

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

The list can include a maximum of three sitemap URLs.

NOTE: This method appends the values to the existing list (if any). Use setSiteMaps(java.util.Collection) or withSiteMaps(java.util.Collection) if you want to override the existing values.

Parameters:

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

The list can include a maximum of three sitemap URLs.

Returns:

Returns a reference to this object so that method calls can be chained together.

withSiteMaps

public SiteMapsConfiguration withSiteMaps(Collection<String> siteMaps)

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

The list can include a maximum of three sitemap URLs.

Parameters:

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

The list can include a maximum of three sitemap URLs.

Returns:

Returns a reference to this object so that method calls can be chained together.

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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public SiteMapsConfiguration clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.