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:

  • Method Details

    • 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()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<Urls.Builder,Urls>
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.