WebCrawlerConfiguration (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.bedrockagent.model.WebCrawlerConfiguration

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class WebCrawlerConfiguration
extends Object
implements Serializable, Cloneable, StructuredPojo
```
The configuration of web URLs that you want to crawl. You should be authorized to crawl the URLs.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

WebCrawlerConfiguration()

Constructors
Constructor and Description
`WebCrawlerConfiguration()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`WebCrawlerConfiguration`	`clone()`
`boolean`	`equals(Object obj)`
`WebCrawlerLimits`	`getCrawlerLimits()` The configuration of crawl limits for the web URLs.
`List<String>`	`getExclusionFilters()` A list of one or more exclusion regular expression patterns to exclude certain URLs.
`List<String>`	`getInclusionFilters()` A list of one or more inclusion regular expression patterns to include certain URLs.
`String`	`getScope()` The scope of what is crawled for your URLs.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setCrawlerLimits(WebCrawlerLimits crawlerLimits)` The configuration of crawl limits for the web URLs.
`void`	`setExclusionFilters(Collection<String> exclusionFilters)` A list of one or more exclusion regular expression patterns to exclude certain URLs.
`void`	`setInclusionFilters(Collection<String> inclusionFilters)` A list of one or more inclusion regular expression patterns to include certain URLs.
`void`	`setScope(String scope)` The scope of what is crawled for your URLs.
`String`	`toString()` Returns a string representation of this object.
`WebCrawlerConfiguration`	`withCrawlerLimits(WebCrawlerLimits crawlerLimits)` The configuration of crawl limits for the web URLs.
`WebCrawlerConfiguration`	`withExclusionFilters(Collection<String> exclusionFilters)` A list of one or more exclusion regular expression patterns to exclude certain URLs.
`WebCrawlerConfiguration`	`withExclusionFilters(String... exclusionFilters)` A list of one or more exclusion regular expression patterns to exclude certain URLs.
`WebCrawlerConfiguration`	`withInclusionFilters(Collection<String> inclusionFilters)` A list of one or more inclusion regular expression patterns to include certain URLs.
`WebCrawlerConfiguration`	`withInclusionFilters(String... inclusionFilters)` A list of one or more inclusion regular expression patterns to include certain URLs.
`WebCrawlerConfiguration`	`withScope(String scope)` The scope of what is crawled for your URLs.
`WebCrawlerConfiguration`	`withScope(WebScopeType scope)` The scope of what is crawled for your URLs.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - WebCrawlerConfiguration
```
public WebCrawlerConfiguration()
```
- Method Detail
  - setCrawlerLimits
```
public void setCrawlerLimits(WebCrawlerLimits crawlerLimits)
```
    The configuration of crawl limits for the web URLs.
    
    Parameters:
    
    crawlerLimits - The configuration of crawl limits for the web URLs.
  - getCrawlerLimits
```
public WebCrawlerLimits getCrawlerLimits()
```
    The configuration of crawl limits for the web URLs.
    
    Returns:
    
    The configuration of crawl limits for the web URLs.
  - withCrawlerLimits
```
public WebCrawlerConfiguration withCrawlerLimits(WebCrawlerLimits crawlerLimits)
```
    The configuration of crawl limits for the web URLs.
    
    Parameters:
    
    crawlerLimits - The configuration of crawl limits for the web URLs.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getExclusionFilters
```
public List<String> getExclusionFilters()
```
    A list of one or more exclusion regular expression patterns to exclude certain URLs. If you specify an inclusion and exclusion filter/pattern and both match a URL, the exclusion filter takes precedence and the web content of the URL isn’t crawled.
    
    Returns:
    
    A list of one or more exclusion regular expression patterns to exclude certain URLs. If you specify an inclusion and exclusion filter/pattern and both match a URL, the exclusion filter takes precedence and the web content of the URL isn’t crawled.
  - setExclusionFilters
```
public void setExclusionFilters(Collection<String> exclusionFilters)
```
    A list of one or more exclusion regular expression patterns to exclude certain URLs. If you specify an inclusion and exclusion filter/pattern and both match a URL, the exclusion filter takes precedence and the web content of the URL isn’t crawled.
    
    Parameters:
    
    exclusionFilters - A list of one or more exclusion regular expression patterns to exclude certain URLs. If you specify an inclusion and exclusion filter/pattern and both match a URL, the exclusion filter takes precedence and the web content of the URL isn’t crawled.
  - withExclusionFilters
```
public WebCrawlerConfiguration withExclusionFilters(String... exclusionFilters)
```
    A list of one or more exclusion regular expression patterns to exclude certain URLs. If you specify an inclusion and exclusion filter/pattern and both match a URL, the exclusion filter takes precedence and the web content of the URL isn’t crawled.
    
    NOTE: This method appends the values to the existing list (if any). Use setExclusionFilters(java.util.Collection) or withExclusionFilters(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    exclusionFilters - A list of one or more exclusion regular expression patterns to exclude certain URLs. If you specify an inclusion and exclusion filter/pattern and both match a URL, the exclusion filter takes precedence and the web content of the URL isn’t crawled.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withExclusionFilters
```
public WebCrawlerConfiguration withExclusionFilters(Collection<String> exclusionFilters)
```
    A list of one or more exclusion regular expression patterns to exclude certain URLs. If you specify an inclusion and exclusion filter/pattern and both match a URL, the exclusion filter takes precedence and the web content of the URL isn’t crawled.
    
    Parameters:
    
    exclusionFilters - A list of one or more exclusion regular expression patterns to exclude certain URLs. If you specify an inclusion and exclusion filter/pattern and both match a URL, the exclusion filter takes precedence and the web content of the URL isn’t crawled.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getInclusionFilters
```
public List<String> getInclusionFilters()
```
    A list of one or more inclusion regular expression patterns to include certain URLs. If you specify an inclusion and exclusion filter/pattern and both match a URL, the exclusion filter takes precedence and the web content of the URL isn’t crawled.
    
    Returns:
    
    A list of one or more inclusion regular expression patterns to include certain URLs. If you specify an inclusion and exclusion filter/pattern and both match a URL, the exclusion filter takes precedence and the web content of the URL isn’t crawled.
  - setInclusionFilters
```
public void setInclusionFilters(Collection<String> inclusionFilters)
```
    A list of one or more inclusion regular expression patterns to include certain URLs. If you specify an inclusion and exclusion filter/pattern and both match a URL, the exclusion filter takes precedence and the web content of the URL isn’t crawled.
    
    Parameters:
    
    inclusionFilters - A list of one or more inclusion regular expression patterns to include certain URLs. If you specify an inclusion and exclusion filter/pattern and both match a URL, the exclusion filter takes precedence and the web content of the URL isn’t crawled.
  - withInclusionFilters
```
public WebCrawlerConfiguration withInclusionFilters(String... inclusionFilters)
```
    A list of one or more inclusion regular expression patterns to include certain URLs. If you specify an inclusion and exclusion filter/pattern and both match a URL, the exclusion filter takes precedence and the web content of the URL isn’t crawled.
    
    NOTE: This method appends the values to the existing list (if any). Use setInclusionFilters(java.util.Collection) or withInclusionFilters(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    inclusionFilters - A list of one or more inclusion regular expression patterns to include certain URLs. If you specify an inclusion and exclusion filter/pattern and both match a URL, the exclusion filter takes precedence and the web content of the URL isn’t crawled.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withInclusionFilters
```
public WebCrawlerConfiguration withInclusionFilters(Collection<String> inclusionFilters)
```
    A list of one or more inclusion regular expression patterns to include certain URLs. If you specify an inclusion and exclusion filter/pattern and both match a URL, the exclusion filter takes precedence and the web content of the URL isn’t crawled.
    
    Parameters:
    
    inclusionFilters - A list of one or more inclusion regular expression patterns to include certain URLs. If you specify an inclusion and exclusion filter/pattern and both match a URL, the exclusion filter takes precedence and the web content of the URL isn’t crawled.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setScope
```
public void setScope(String scope)
```
    The scope of what is crawled for your URLs.
    
    You can choose to crawl only web pages that belong to the same host or primary domain. For example, only web pages that contain the seed URL "https://docs.aws.amazon.com/bedrock/latest/userguide/" and no other domains. You can choose to include sub domains in addition to the host or primary domain. For example, web pages that contain "aws.amazon.com" can also include sub domain "docs.aws.amazon.com".
    
    Parameters:
    
    scope - The scope of what is crawled for your URLs.
    
    You can choose to crawl only web pages that belong to the same host or primary domain. For example, only web pages that contain the seed URL "https://docs.aws.amazon.com/bedrock/latest/userguide/" and no other domains. You can choose to include sub domains in addition to the host or primary domain. For example, web pages that contain "aws.amazon.com" can also include sub domain "docs.aws.amazon.com".
    
    See Also:
    
    WebScopeType
  - getScope
```
public String getScope()
```
    The scope of what is crawled for your URLs.
    
    You can choose to crawl only web pages that belong to the same host or primary domain. For example, only web pages that contain the seed URL "https://docs.aws.amazon.com/bedrock/latest/userguide/" and no other domains. You can choose to include sub domains in addition to the host or primary domain. For example, web pages that contain "aws.amazon.com" can also include sub domain "docs.aws.amazon.com".
    
    Returns:
    
    The scope of what is crawled for your URLs.
    
    You can choose to crawl only web pages that belong to the same host or primary domain. For example, only web pages that contain the seed URL "https://docs.aws.amazon.com/bedrock/latest/userguide/" and no other domains. You can choose to include sub domains in addition to the host or primary domain. For example, web pages that contain "aws.amazon.com" can also include sub domain "docs.aws.amazon.com".
    
    See Also:
    
    WebScopeType
  - withScope
```
public WebCrawlerConfiguration withScope(String scope)
```
    The scope of what is crawled for your URLs.
    
    You can choose to crawl only web pages that belong to the same host or primary domain. For example, only web pages that contain the seed URL "https://docs.aws.amazon.com/bedrock/latest/userguide/" and no other domains. You can choose to include sub domains in addition to the host or primary domain. For example, web pages that contain "aws.amazon.com" can also include sub domain "docs.aws.amazon.com".
    
    Parameters:
    
    scope - The scope of what is crawled for your URLs.
    
    You can choose to crawl only web pages that belong to the same host or primary domain. For example, only web pages that contain the seed URL "https://docs.aws.amazon.com/bedrock/latest/userguide/" and no other domains. You can choose to include sub domains in addition to the host or primary domain. For example, web pages that contain "aws.amazon.com" can also include sub domain "docs.aws.amazon.com".
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    WebScopeType
  - withScope
```
public WebCrawlerConfiguration withScope(WebScopeType scope)
```
    The scope of what is crawled for your URLs.
    
    You can choose to crawl only web pages that belong to the same host or primary domain. For example, only web pages that contain the seed URL "https://docs.aws.amazon.com/bedrock/latest/userguide/" and no other domains. You can choose to include sub domains in addition to the host or primary domain. For example, web pages that contain "aws.amazon.com" can also include sub domain "docs.aws.amazon.com".
    
    Parameters:
    
    scope - The scope of what is crawled for your URLs.
    
    You can choose to crawl only web pages that belong to the same host or primary domain. For example, only web pages that contain the seed URL "https://docs.aws.amazon.com/bedrock/latest/userguide/" and no other domains. You can choose to include sub domains in addition to the host or primary domain. For example, web pages that contain "aws.amazon.com" can also include sub domain "docs.aws.amazon.com".
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    WebScopeType
  - 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 WebCrawlerConfiguration 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.

AWS SDK for Java 1.x API Reference - 1.12.772

Class WebCrawlerConfiguration

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

WebCrawlerConfiguration

Method Detail

setCrawlerLimits

getCrawlerLimits

withCrawlerLimits

getExclusionFilters

setExclusionFilters

withExclusionFilters

withExclusionFilters

getInclusionFilters

setInclusionFilters

withInclusionFilters

withInclusionFilters

setScope

getScope

withScope

withScope

toString

equals

hashCode

clone

marshall