com.amazonaws.services.kendra.model

Class SeedUrlConfiguration

java.lang.Object

com.amazonaws.services.kendra.model.SeedUrlConfiguration

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

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

Provides the configuration information for the seed or starting point 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
SeedUrlConfiguration()

Method Summary

Modifier and Type	Method and Description
SeedUrlConfiguration	clone()
boolean	equals(Object obj)
List<String>	getSeedUrls() The list of seed or starting point URLs of the websites you want to crawl.
String	getWebCrawlerMode() You can choose one of the following modes:
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setSeedUrls(Collection<String> seedUrls) The list of seed or starting point URLs of the websites you want to crawl.
void	setWebCrawlerMode(String webCrawlerMode) You can choose one of the following modes:
String	toString() Returns a string representation of this object.
SeedUrlConfiguration	withSeedUrls(Collection<String> seedUrls) The list of seed or starting point URLs of the websites you want to crawl.
SeedUrlConfiguration	withSeedUrls(String... seedUrls) The list of seed or starting point URLs of the websites you want to crawl.
SeedUrlConfiguration	withWebCrawlerMode(String webCrawlerMode) You can choose one of the following modes:
SeedUrlConfiguration	withWebCrawlerMode(WebCrawlerMode webCrawlerMode) You can choose one of the following modes:

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SeedUrlConfiguration

public SeedUrlConfiguration()

Method Detail

getSeedUrls

public List<String> getSeedUrls()

The list of seed or starting point URLs of the websites you want to crawl.

The list can include a maximum of 100 seed URLs.

Returns:

The list of seed or starting point URLs of the websites you want to crawl.

The list can include a maximum of 100 seed URLs.

setSeedUrls

public void setSeedUrls(Collection<String> seedUrls)

The list of seed or starting point URLs of the websites you want to crawl.

The list can include a maximum of 100 seed URLs.

Parameters:

seedUrls - The list of seed or starting point URLs of the websites you want to crawl.

The list can include a maximum of 100 seed URLs.

withSeedUrls

public SeedUrlConfiguration withSeedUrls(String... seedUrls)

The list of seed or starting point URLs of the websites you want to crawl.

The list can include a maximum of 100 seed URLs.

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

Parameters:

seedUrls - The list of seed or starting point URLs of the websites you want to crawl.

The list can include a maximum of 100 seed URLs.

Returns:

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

withSeedUrls

public SeedUrlConfiguration withSeedUrls(Collection<String> seedUrls)

The list of seed or starting point URLs of the websites you want to crawl.

The list can include a maximum of 100 seed URLs.

Parameters:

seedUrls - The list of seed or starting point URLs of the websites you want to crawl.

The list can include a maximum of 100 seed URLs.

Returns:

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

setWebCrawlerMode

public void setWebCrawlerMode(String webCrawlerMode)

You can choose one of the following modes:

• HOST_ONLY—crawl only the website host names. For example, if the seed URL is "abc.example.com", then only URLs with host name "abc.example.com" are crawled.

• SUBDOMAINS—crawl the website host names with subdomains. For example, if the seed URL is "abc.example.com", then "a.abc.example.com" and "b.abc.example.com" are also crawled.

• EVERYTHING—crawl the website host names with subdomains and other domains that the web pages link to.

The default mode is set to HOST_ONLY.

Parameters:

webCrawlerMode - You can choose one of the following modes:

• HOST_ONLY—crawl only the website host names. For example, if the seed URL is "abc.example.com", then only URLs with host name "abc.example.com" are crawled.

• SUBDOMAINS—crawl the website host names with subdomains. For example, if the seed URL is "abc.example.com", then "a.abc.example.com" and "b.abc.example.com" are also crawled.

• EVERYTHING—crawl the website host names with subdomains and other domains that the web pages link to.

The default mode is set to HOST_ONLY.

See Also:

WebCrawlerMode

getWebCrawlerMode

public String getWebCrawlerMode()

You can choose one of the following modes:

• HOST_ONLY—crawl only the website host names. For example, if the seed URL is "abc.example.com", then only URLs with host name "abc.example.com" are crawled.

• SUBDOMAINS—crawl the website host names with subdomains. For example, if the seed URL is "abc.example.com", then "a.abc.example.com" and "b.abc.example.com" are also crawled.

• EVERYTHING—crawl the website host names with subdomains and other domains that the web pages link to.

The default mode is set to HOST_ONLY.

Returns:

You can choose one of the following modes:

• HOST_ONLY—crawl only the website host names. For example, if the seed URL is "abc.example.com", then only URLs with host name "abc.example.com" are crawled.

• SUBDOMAINS—crawl the website host names with subdomains. For example, if the seed URL is "abc.example.com", then "a.abc.example.com" and "b.abc.example.com" are also crawled.

• EVERYTHING—crawl the website host names with subdomains and other domains that the web pages link to.

The default mode is set to HOST_ONLY.

See Also:

WebCrawlerMode

withWebCrawlerMode

public SeedUrlConfiguration withWebCrawlerMode(String webCrawlerMode)

You can choose one of the following modes:

• HOST_ONLY—crawl only the website host names. For example, if the seed URL is "abc.example.com", then only URLs with host name "abc.example.com" are crawled.

• SUBDOMAINS—crawl the website host names with subdomains. For example, if the seed URL is "abc.example.com", then "a.abc.example.com" and "b.abc.example.com" are also crawled.

• EVERYTHING—crawl the website host names with subdomains and other domains that the web pages link to.

The default mode is set to HOST_ONLY.

Parameters:

webCrawlerMode - You can choose one of the following modes:

• HOST_ONLY—crawl only the website host names. For example, if the seed URL is "abc.example.com", then only URLs with host name "abc.example.com" are crawled.

• SUBDOMAINS—crawl the website host names with subdomains. For example, if the seed URL is "abc.example.com", then "a.abc.example.com" and "b.abc.example.com" are also crawled.

• EVERYTHING—crawl the website host names with subdomains and other domains that the web pages link to.

The default mode is set to HOST_ONLY.

Returns:

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

See Also:

WebCrawlerMode

withWebCrawlerMode

public SeedUrlConfiguration withWebCrawlerMode(WebCrawlerMode webCrawlerMode)

You can choose one of the following modes:

• HOST_ONLY—crawl only the website host names. For example, if the seed URL is "abc.example.com", then only URLs with host name "abc.example.com" are crawled.

• SUBDOMAINS—crawl the website host names with subdomains. For example, if the seed URL is "abc.example.com", then "a.abc.example.com" and "b.abc.example.com" are also crawled.

• EVERYTHING—crawl the website host names with subdomains and other domains that the web pages link to.

The default mode is set to HOST_ONLY.

Parameters:

webCrawlerMode - You can choose one of the following modes:

• HOST_ONLY—crawl only the website host names. For example, if the seed URL is "abc.example.com", then only URLs with host name "abc.example.com" are crawled.

• SUBDOMAINS—crawl the website host names with subdomains. For example, if the seed URL is "abc.example.com", then "a.abc.example.com" and "b.abc.example.com" are also crawled.

• EVERYTHING—crawl the website host names with subdomains and other domains that the web pages link to.

The default mode is set to HOST_ONLY.

Returns:

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

See Also:

WebCrawlerMode

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