Package software.amazon.awssdk.services.kendra.model

Class Urls

java.lang.Object

software.amazon.awssdk.services.kendra.model.Urls

All Implemented Interfaces:

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

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

Provides the configuration information of the URLs to crawl.

You can only crawl websites that use the secure communication protocol, Hypertext Transfer Protocol Secure (HTTPS). If you receive an error when crawling a website, it could be that the website is blocked from crawling.

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	Description
static interface	Urls.Builder

Method Summary

Modifier and Type	Method	Description
static Urls.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<SdkField<?>>	sdkFields()
SeedUrlConfiguration	seedUrlConfiguration()	Configuration of the seed or starting point URLs of the websites you want to crawl.
static Class<? extends Urls.Builder>	serializableBuilderClass()
SiteMapsConfiguration	siteMapsConfiguration()	Configuration of the sitemap URLs of the websites you want to crawl.
Urls.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

seedUrlConfiguration

public final SeedUrlConfiguration seedUrlConfiguration()

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

You can choose to crawl only the website host names, or the website host names with subdomains, or the website host names with subdomains and other domains that the web pages link to.

You can list up to 100 seed URLs.

Returns:

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

You can choose to crawl only the website host names, or the website host names with subdomains, or the website host names with subdomains and other domains that the web pages link to.

You can list up to 100 seed URLs.

siteMapsConfiguration

public final SiteMapsConfiguration siteMapsConfiguration()

Configuration of the sitemap URLs of the websites you want to crawl.

Only URLs belonging to the same website host names are crawled. You can list up to three sitemap URLs.

Returns:

Configuration of the sitemap URLs of the websites you want to crawl.

Only URLs belonging to the same website host names are crawled. You can list up to three sitemap URLs.

toBuilder

public Urls.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Urls.Builder,Urls>

builder

public static Urls.Builder builder()

serializableBuilderClass

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