com.amazonaws.services.kendra.model

Class ConfluenceConfiguration

java.lang.Object

com.amazonaws.services.kendra.model.ConfluenceConfiguration

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

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

Provides the configuration information to connect to Confluence as your data source.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
ConfluenceConfiguration()

Method Summary

Modifier and Type	Method and Description
ConfluenceConfiguration	clone()
boolean	equals(Object obj)
ConfluenceAttachmentConfiguration	getAttachmentConfiguration() Configuration information for indexing attachments to Confluence blogs and pages.
ConfluenceBlogConfiguration	getBlogConfiguration() Configuration information for indexing Confluence blogs.
List<String>	getExclusionPatterns() A list of regular expression patterns to exclude certain blog posts, pages, spaces, or attachments in your Confluence.
List<String>	getInclusionPatterns() A list of regular expression patterns to include certain blog posts, pages, spaces, or attachments in your Confluence.
ConfluencePageConfiguration	getPageConfiguration() Configuration information for indexing Confluence pages.
String	getSecretArn() The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the user name and password required to connect to the Confluence instance.
String	getServerUrl() The URL of your Confluence instance.
ConfluenceSpaceConfiguration	getSpaceConfiguration() Configuration information for indexing Confluence spaces.
String	getVersion() The version or the type of Confluence installation to connect to.
DataSourceVpcConfiguration	getVpcConfiguration() Configuration information for an Amazon Virtual Private Cloud to connect to your Confluence.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller)
void	setAttachmentConfiguration(ConfluenceAttachmentConfiguration attachmentConfiguration) Configuration information for indexing attachments to Confluence blogs and pages.
void	setBlogConfiguration(ConfluenceBlogConfiguration blogConfiguration) Configuration information for indexing Confluence blogs.
void	setExclusionPatterns(Collection<String> exclusionPatterns) A list of regular expression patterns to exclude certain blog posts, pages, spaces, or attachments in your Confluence.
void	setInclusionPatterns(Collection<String> inclusionPatterns) A list of regular expression patterns to include certain blog posts, pages, spaces, or attachments in your Confluence.
void	setPageConfiguration(ConfluencePageConfiguration pageConfiguration) Configuration information for indexing Confluence pages.
void	setSecretArn(String secretArn) The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the user name and password required to connect to the Confluence instance.
void	setServerUrl(String serverUrl) The URL of your Confluence instance.
void	setSpaceConfiguration(ConfluenceSpaceConfiguration spaceConfiguration) Configuration information for indexing Confluence spaces.
void	setVersion(String version) The version or the type of Confluence installation to connect to.
void	setVpcConfiguration(DataSourceVpcConfiguration vpcConfiguration) Configuration information for an Amazon Virtual Private Cloud to connect to your Confluence.
String	toString() Returns a string representation of this object.
ConfluenceConfiguration	withAttachmentConfiguration(ConfluenceAttachmentConfiguration attachmentConfiguration) Configuration information for indexing attachments to Confluence blogs and pages.
ConfluenceConfiguration	withBlogConfiguration(ConfluenceBlogConfiguration blogConfiguration) Configuration information for indexing Confluence blogs.
ConfluenceConfiguration	withExclusionPatterns(Collection<String> exclusionPatterns) A list of regular expression patterns to exclude certain blog posts, pages, spaces, or attachments in your Confluence.
ConfluenceConfiguration	withExclusionPatterns(String... exclusionPatterns) A list of regular expression patterns to exclude certain blog posts, pages, spaces, or attachments in your Confluence.
ConfluenceConfiguration	withInclusionPatterns(Collection<String> inclusionPatterns) A list of regular expression patterns to include certain blog posts, pages, spaces, or attachments in your Confluence.
ConfluenceConfiguration	withInclusionPatterns(String... inclusionPatterns) A list of regular expression patterns to include certain blog posts, pages, spaces, or attachments in your Confluence.
ConfluenceConfiguration	withPageConfiguration(ConfluencePageConfiguration pageConfiguration) Configuration information for indexing Confluence pages.
ConfluenceConfiguration	withSecretArn(String secretArn) The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the user name and password required to connect to the Confluence instance.
ConfluenceConfiguration	withServerUrl(String serverUrl) The URL of your Confluence instance.
ConfluenceConfiguration	withSpaceConfiguration(ConfluenceSpaceConfiguration spaceConfiguration) Configuration information for indexing Confluence spaces.
ConfluenceConfiguration	withVersion(ConfluenceVersion version) The version or the type of Confluence installation to connect to.
ConfluenceConfiguration	withVersion(String version) The version or the type of Confluence installation to connect to.
ConfluenceConfiguration	withVpcConfiguration(DataSourceVpcConfiguration vpcConfiguration) Configuration information for an Amazon Virtual Private Cloud to connect to your Confluence.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ConfluenceConfiguration

public ConfluenceConfiguration()

Method Detail

setServerUrl

public void setServerUrl(String serverUrl)

The URL of your Confluence instance. Use the full URL of the server. For example, https://server.example.com:port/. You can also use an IP address, for example, https://192.168.1.113/.

Parameters:

serverUrl - The URL of your Confluence instance. Use the full URL of the server. For example, https://server.example.com:port/. You can also use an IP address, for example, https://192.168.1.113/.

getServerUrl

public String getServerUrl()

The URL of your Confluence instance. Use the full URL of the server. For example, https://server.example.com:port/. You can also use an IP address, for example, https://192.168.1.113/.

Returns:

The URL of your Confluence instance. Use the full URL of the server. For example, https://server.example.com:port/. You can also use an IP address, for example, https://192.168.1.113/.

withServerUrl

public ConfluenceConfiguration withServerUrl(String serverUrl)

The URL of your Confluence instance. Use the full URL of the server. For example, https://server.example.com:port/. You can also use an IP address, for example, https://192.168.1.113/.

Parameters:

serverUrl - The URL of your Confluence instance. Use the full URL of the server. For example, https://server.example.com:port/. You can also use an IP address, for example, https://192.168.1.113/.

Returns:

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

setSecretArn

public void setSecretArn(String secretArn)

The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the user name and password required to connect to the Confluence instance. If you use Confluence cloud, you use a generated API token as the password. For more information, see Using a Confluence data source.

Parameters:

secretArn - The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the user name and password required to connect to the Confluence instance. If you use Confluence cloud, you use a generated API token as the password. For more information, see Using a Confluence data source.

getSecretArn

public String getSecretArn()

The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the user name and password required to connect to the Confluence instance. If you use Confluence cloud, you use a generated API token as the password. For more information, see Using a Confluence data source.

Returns:

The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the user name and password required to connect to the Confluence instance. If you use Confluence cloud, you use a generated API token as the password. For more information, see Using a Confluence data source.

withSecretArn

public ConfluenceConfiguration withSecretArn(String secretArn)

The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the user name and password required to connect to the Confluence instance. If you use Confluence cloud, you use a generated API token as the password. For more information, see Using a Confluence data source.

Parameters:

secretArn - The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the user name and password required to connect to the Confluence instance. If you use Confluence cloud, you use a generated API token as the password. For more information, see Using a Confluence data source.

Returns:

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

setVersion

public void setVersion(String version)

The version or the type of Confluence installation to connect to.

Parameters:

version - The version or the type of Confluence installation to connect to.

See Also:

ConfluenceVersion

getVersion

public String getVersion()

The version or the type of Confluence installation to connect to.

Returns:

The version or the type of Confluence installation to connect to.

See Also:

ConfluenceVersion

withVersion

public ConfluenceConfiguration withVersion(String version)

The version or the type of Confluence installation to connect to.

Parameters:

version - The version or the type of Confluence installation to connect to.

Returns:

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

See Also:

ConfluenceVersion

withVersion

public ConfluenceConfiguration withVersion(ConfluenceVersion version)

The version or the type of Confluence installation to connect to.

Parameters:

version - The version or the type of Confluence installation to connect to.

Returns:

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

See Also:

ConfluenceVersion

setSpaceConfiguration

public void setSpaceConfiguration(ConfluenceSpaceConfiguration spaceConfiguration)

Configuration information for indexing Confluence spaces.

Parameters:

spaceConfiguration - Configuration information for indexing Confluence spaces.

getSpaceConfiguration

public ConfluenceSpaceConfiguration getSpaceConfiguration()

Configuration information for indexing Confluence spaces.

Returns:

Configuration information for indexing Confluence spaces.

withSpaceConfiguration

public ConfluenceConfiguration withSpaceConfiguration(ConfluenceSpaceConfiguration spaceConfiguration)

Configuration information for indexing Confluence spaces.

Parameters:

spaceConfiguration - Configuration information for indexing Confluence spaces.

Returns:

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

setPageConfiguration

public void setPageConfiguration(ConfluencePageConfiguration pageConfiguration)

Configuration information for indexing Confluence pages.

Parameters:

pageConfiguration - Configuration information for indexing Confluence pages.

getPageConfiguration

public ConfluencePageConfiguration getPageConfiguration()

Configuration information for indexing Confluence pages.

Returns:

Configuration information for indexing Confluence pages.

withPageConfiguration

public ConfluenceConfiguration withPageConfiguration(ConfluencePageConfiguration pageConfiguration)

Configuration information for indexing Confluence pages.

Parameters:

pageConfiguration - Configuration information for indexing Confluence pages.

Returns:

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

setBlogConfiguration

public void setBlogConfiguration(ConfluenceBlogConfiguration blogConfiguration)

Configuration information for indexing Confluence blogs.

Parameters:

blogConfiguration - Configuration information for indexing Confluence blogs.

getBlogConfiguration

public ConfluenceBlogConfiguration getBlogConfiguration()

Configuration information for indexing Confluence blogs.

Returns:

Configuration information for indexing Confluence blogs.

withBlogConfiguration

public ConfluenceConfiguration withBlogConfiguration(ConfluenceBlogConfiguration blogConfiguration)

Configuration information for indexing Confluence blogs.

Parameters:

blogConfiguration - Configuration information for indexing Confluence blogs.

Returns:

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

setAttachmentConfiguration

public void setAttachmentConfiguration(ConfluenceAttachmentConfiguration attachmentConfiguration)

Configuration information for indexing attachments to Confluence blogs and pages.

Parameters:

attachmentConfiguration - Configuration information for indexing attachments to Confluence blogs and pages.

getAttachmentConfiguration

public ConfluenceAttachmentConfiguration getAttachmentConfiguration()

Configuration information for indexing attachments to Confluence blogs and pages.

Returns:

Configuration information for indexing attachments to Confluence blogs and pages.

withAttachmentConfiguration

public ConfluenceConfiguration withAttachmentConfiguration(ConfluenceAttachmentConfiguration attachmentConfiguration)

Configuration information for indexing attachments to Confluence blogs and pages.

Parameters:

attachmentConfiguration - Configuration information for indexing attachments to Confluence blogs and pages.

Returns:

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

setVpcConfiguration

public void setVpcConfiguration(DataSourceVpcConfiguration vpcConfiguration)

Configuration information for an Amazon Virtual Private Cloud to connect to your Confluence. For more information, see Configuring a VPC.

Parameters:

vpcConfiguration - Configuration information for an Amazon Virtual Private Cloud to connect to your Confluence. For more information, see Configuring a VPC.

getVpcConfiguration

public DataSourceVpcConfiguration getVpcConfiguration()

Configuration information for an Amazon Virtual Private Cloud to connect to your Confluence. For more information, see Configuring a VPC.

Returns:

Configuration information for an Amazon Virtual Private Cloud to connect to your Confluence. For more information, see Configuring a VPC.

withVpcConfiguration

public ConfluenceConfiguration withVpcConfiguration(DataSourceVpcConfiguration vpcConfiguration)

Configuration information for an Amazon Virtual Private Cloud to connect to your Confluence. For more information, see Configuring a VPC.

Parameters:

vpcConfiguration - Configuration information for an Amazon Virtual Private Cloud to connect to your Confluence. For more information, see Configuring a VPC.

Returns:

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

getInclusionPatterns

public List<String> getInclusionPatterns()

A list of regular expression patterns to include certain blog posts, pages, spaces, or attachments in your Confluence. Content that matches the patterns are included in the index. Content that doesn't match the patterns is excluded from the index. If content matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the content isn't included in the index.

Returns:

A list of regular expression patterns to include certain blog posts, pages, spaces, or attachments in your Confluence. Content that matches the patterns are included in the index. Content that doesn't match the patterns is excluded from the index. If content matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the content isn't included in the index.

setInclusionPatterns

public void setInclusionPatterns(Collection<String> inclusionPatterns)

A list of regular expression patterns to include certain blog posts, pages, spaces, or attachments in your Confluence. Content that matches the patterns are included in the index. Content that doesn't match the patterns is excluded from the index. If content matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the content isn't included in the index.

Parameters:

inclusionPatterns - A list of regular expression patterns to include certain blog posts, pages, spaces, or attachments in your Confluence. Content that matches the patterns are included in the index. Content that doesn't match the patterns is excluded from the index. If content matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the content isn't included in the index.

withInclusionPatterns

public ConfluenceConfiguration withInclusionPatterns(String... inclusionPatterns)

A list of regular expression patterns to include certain blog posts, pages, spaces, or attachments in your Confluence. Content that matches the patterns are included in the index. Content that doesn't match the patterns is excluded from the index. If content matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the content isn't included in the index.

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

Parameters:

inclusionPatterns - A list of regular expression patterns to include certain blog posts, pages, spaces, or attachments in your Confluence. Content that matches the patterns are included in the index. Content that doesn't match the patterns is excluded from the index. If content matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the content isn't included in the index.

Returns:

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

withInclusionPatterns

public ConfluenceConfiguration withInclusionPatterns(Collection<String> inclusionPatterns)

A list of regular expression patterns to include certain blog posts, pages, spaces, or attachments in your Confluence. Content that matches the patterns are included in the index. Content that doesn't match the patterns is excluded from the index. If content matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the content isn't included in the index.

Parameters:

inclusionPatterns - A list of regular expression patterns to include certain blog posts, pages, spaces, or attachments in your Confluence. Content that matches the patterns are included in the index. Content that doesn't match the patterns is excluded from the index. If content matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the content isn't included in the index.

Returns:

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

getExclusionPatterns

public List<String> getExclusionPatterns()

A list of regular expression patterns to exclude certain blog posts, pages, spaces, or attachments in your Confluence. Content that matches the patterns are excluded from the index. Content that doesn't match the patterns is included in the index. If content matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the content isn't included in the index.

Returns:

A list of regular expression patterns to exclude certain blog posts, pages, spaces, or attachments in your Confluence. Content that matches the patterns are excluded from the index. Content that doesn't match the patterns is included in the index. If content matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the content isn't included in the index.

setExclusionPatterns

public void setExclusionPatterns(Collection<String> exclusionPatterns)

A list of regular expression patterns to exclude certain blog posts, pages, spaces, or attachments in your Confluence. Content that matches the patterns are excluded from the index. Content that doesn't match the patterns is included in the index. If content matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the content isn't included in the index.

Parameters:

exclusionPatterns - A list of regular expression patterns to exclude certain blog posts, pages, spaces, or attachments in your Confluence. Content that matches the patterns are excluded from the index. Content that doesn't match the patterns is included in the index. If content matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the content isn't included in the index.

withExclusionPatterns

public ConfluenceConfiguration withExclusionPatterns(String... exclusionPatterns)

A list of regular expression patterns to exclude certain blog posts, pages, spaces, or attachments in your Confluence. Content that matches the patterns are excluded from the index. Content that doesn't match the patterns is included in the index. If content matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the content isn't included in the index.

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

Parameters:

exclusionPatterns - A list of regular expression patterns to exclude certain blog posts, pages, spaces, or attachments in your Confluence. Content that matches the patterns are excluded from the index. Content that doesn't match the patterns is included in the index. If content matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the content isn't included in the index.

Returns:

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

withExclusionPatterns

public ConfluenceConfiguration withExclusionPatterns(Collection<String> exclusionPatterns)

A list of regular expression patterns to exclude certain blog posts, pages, spaces, or attachments in your Confluence. Content that matches the patterns are excluded from the index. Content that doesn't match the patterns is included in the index. If content matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the content isn't included in the index.

Parameters:

exclusionPatterns - A list of regular expression patterns to exclude certain blog posts, pages, spaces, or attachments in your Confluence. Content that matches the patterns are excluded from the index. Content that doesn't match the patterns is included in the index. If content matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the content isn't included in the index.

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 ConfluenceConfiguration clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Specified by:

marshall in interface StructuredPojo