ConfluenceConfiguration (AWS SDK for Java

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 configuration information for data sources that connect to Confluence.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

ConfluenceConfiguration()

Constructors
Constructor and Description
`ConfluenceConfiguration()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ConfluenceConfiguration`	`clone()`
`boolean`	`equals(Object obj)`
`ConfluenceAttachmentConfiguration`	`getAttachmentConfiguration()` Specifies configuration information for indexing attachments to Confluence blogs and pages.
`ConfluenceBlogConfiguration`	`getBlogConfiguration()` Specifies configuration information for indexing Confluence blogs.
`List<String>`	`getExclusionPatterns()` A list of regular expression patterns that apply to a URL on the Confluence server.
`List<String>`	`getInclusionPatterns()` A list of regular expression patterns that apply to a URL on the Confluence server.
`ConfluencePageConfiguration`	`getPageConfiguration()` Specifies configuration information for indexing Confluence pages.
`String`	`getSecretArn()` The Amazon Resource Name (ARN) of an AWS Secrets Manager secret that contains the key/value pairs required to connect to your Confluence server.
`String`	`getServerUrl()` The URL of your Confluence instance.
`ConfluenceSpaceConfiguration`	`getSpaceConfiguration()` Specifies configuration information for indexing Confluence spaces.
`String`	`getVersion()` Specifies the version of the Confluence installation that you are connecting to.
`DataSourceVpcConfiguration`	`getVpcConfiguration()` Specifies the information for connecting to an Amazon VPC.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAttachmentConfiguration(ConfluenceAttachmentConfiguration attachmentConfiguration)` Specifies configuration information for indexing attachments to Confluence blogs and pages.
`void`	`setBlogConfiguration(ConfluenceBlogConfiguration blogConfiguration)` Specifies configuration information for indexing Confluence blogs.
`void`	`setExclusionPatterns(Collection<String> exclusionPatterns)` A list of regular expression patterns that apply to a URL on the Confluence server.
`void`	`setInclusionPatterns(Collection<String> inclusionPatterns)` A list of regular expression patterns that apply to a URL on the Confluence server.
`void`	`setPageConfiguration(ConfluencePageConfiguration pageConfiguration)` Specifies configuration information for indexing Confluence pages.
`void`	`setSecretArn(String secretArn)` The Amazon Resource Name (ARN) of an AWS Secrets Manager secret that contains the key/value pairs required to connect to your Confluence server.
`void`	`setServerUrl(String serverUrl)` The URL of your Confluence instance.
`void`	`setSpaceConfiguration(ConfluenceSpaceConfiguration spaceConfiguration)` Specifies configuration information for indexing Confluence spaces.
`void`	`setVersion(String version)` Specifies the version of the Confluence installation that you are connecting to.
`void`	`setVpcConfiguration(DataSourceVpcConfiguration vpcConfiguration)` Specifies the information for connecting to an Amazon VPC.
`String`	`toString()` Returns a string representation of this object.
`ConfluenceConfiguration`	`withAttachmentConfiguration(ConfluenceAttachmentConfiguration attachmentConfiguration)` Specifies configuration information for indexing attachments to Confluence blogs and pages.
`ConfluenceConfiguration`	`withBlogConfiguration(ConfluenceBlogConfiguration blogConfiguration)` Specifies configuration information for indexing Confluence blogs.
`ConfluenceConfiguration`	`withExclusionPatterns(Collection<String> exclusionPatterns)` A list of regular expression patterns that apply to a URL on the Confluence server.
`ConfluenceConfiguration`	`withExclusionPatterns(String... exclusionPatterns)` A list of regular expression patterns that apply to a URL on the Confluence server.
`ConfluenceConfiguration`	`withInclusionPatterns(Collection<String> inclusionPatterns)` A list of regular expression patterns that apply to a URL on the Confluence server.
`ConfluenceConfiguration`	`withInclusionPatterns(String... inclusionPatterns)` A list of regular expression patterns that apply to a URL on the Confluence server.
`ConfluenceConfiguration`	`withPageConfiguration(ConfluencePageConfiguration pageConfiguration)` Specifies configuration information for indexing Confluence pages.
`ConfluenceConfiguration`	`withSecretArn(String secretArn)` The Amazon Resource Name (ARN) of an AWS Secrets Manager secret that contains the key/value pairs required to connect to your Confluence server.
`ConfluenceConfiguration`	`withServerUrl(String serverUrl)` The URL of your Confluence instance.
`ConfluenceConfiguration`	`withSpaceConfiguration(ConfluenceSpaceConfiguration spaceConfiguration)` Specifies configuration information for indexing Confluence spaces.
`ConfluenceConfiguration`	`withVersion(ConfluenceVersion version)` Specifies the version of the Confluence installation that you are connecting to.
`ConfluenceConfiguration`	`withVersion(String version)` Specifies the version of the Confluence installation that you are connecting to.
`ConfluenceConfiguration`	`withVpcConfiguration(DataSourceVpcConfiguration vpcConfiguration)` Specifies the information for connecting to an Amazon VPC.

Methods inherited from class java.lang.Object
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 AWS Secrets Manager secret that contains the key/value pairs required to connect to your Confluence server. The secret must contain a JSON structure with the following keys:
    - username - The user name or email address of a user with administrative privileges for the Confluence server.
    - password - The password associated with the user logging in to the Confluence server.
    Parameters:
    secretArn - The Amazon Resource Name (ARN) of an AWS Secrets Manager secret that contains the key/value pairs required to connect to your Confluence server. The secret must contain a JSON structure with the following keys:
    
    username - The user name or email address of a user with administrative privileges for the Confluence server.
    
    password - The password associated with the user logging in to the Confluence server.
  - getSecretArn
```
public String getSecretArn()
```
    The Amazon Resource Name (ARN) of an AWS Secrets Manager secret that contains the key/value pairs required to connect to your Confluence server. The secret must contain a JSON structure with the following keys:
    - username - The user name or email address of a user with administrative privileges for the Confluence server.
    - password - The password associated with the user logging in to the Confluence server.
    Returns:
    The Amazon Resource Name (ARN) of an AWS Secrets Manager secret that contains the key/value pairs required to connect to your Confluence server. The secret must contain a JSON structure with the following keys:
    
    username - The user name or email address of a user with administrative privileges for the Confluence server.
    
    password - The password associated with the user logging in to the Confluence server.
  - withSecretArn
```
public ConfluenceConfiguration withSecretArn(String secretArn)
```
    The Amazon Resource Name (ARN) of an AWS Secrets Manager secret that contains the key/value pairs required to connect to your Confluence server. The secret must contain a JSON structure with the following keys:
    - username - The user name or email address of a user with administrative privileges for the Confluence server.
    - password - The password associated with the user logging in to the Confluence server.
    Parameters:
    secretArn - The Amazon Resource Name (ARN) of an AWS Secrets Manager secret that contains the key/value pairs required to connect to your Confluence server. The secret must contain a JSON structure with the following keys:
    
    username - The user name or email address of a user with administrative privileges for the Confluence server.
    
    password - The password associated with the user logging in to the Confluence server.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setVersion
```
public void setVersion(String version)
```
    Specifies the version of the Confluence installation that you are connecting to.
    
    Parameters:
    
    version - Specifies the version of the Confluence installation that you are connecting to.
    
    See Also:
    
    ConfluenceVersion
  - getVersion
```
public String getVersion()
```
    Specifies the version of the Confluence installation that you are connecting to.
    
    Returns:
    
    Specifies the version of the Confluence installation that you are connecting to.
    
    See Also:
    
    ConfluenceVersion
  - withVersion
```
public ConfluenceConfiguration withVersion(String version)
```
    Specifies the version of the Confluence installation that you are connecting to.
    
    Parameters:
    
    version - Specifies the version of the Confluence installation that you are connecting 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)
```
    Specifies the version of the Confluence installation that you are connecting to.
    
    Parameters:
    
    version - Specifies the version of the Confluence installation that you are connecting 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)
```
    Specifies configuration information for indexing Confluence spaces.
    
    Parameters:
    
    spaceConfiguration - Specifies configuration information for indexing Confluence spaces.
  - getSpaceConfiguration
```
public ConfluenceSpaceConfiguration getSpaceConfiguration()
```
    Specifies configuration information for indexing Confluence spaces.
    
    Returns:
    
    Specifies configuration information for indexing Confluence spaces.
  - withSpaceConfiguration
```
public ConfluenceConfiguration withSpaceConfiguration(ConfluenceSpaceConfiguration spaceConfiguration)
```
    Specifies configuration information for indexing Confluence spaces.
    
    Parameters:
    
    spaceConfiguration - Specifies 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)
```
    Specifies configuration information for indexing Confluence pages.
    
    Parameters:
    
    pageConfiguration - Specifies configuration information for indexing Confluence pages.
  - getPageConfiguration
```
public ConfluencePageConfiguration getPageConfiguration()
```
    Specifies configuration information for indexing Confluence pages.
    
    Returns:
    
    Specifies configuration information for indexing Confluence pages.
  - withPageConfiguration
```
public ConfluenceConfiguration withPageConfiguration(ConfluencePageConfiguration pageConfiguration)
```
    Specifies configuration information for indexing Confluence pages.
    
    Parameters:
    
    pageConfiguration - Specifies 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)
```
    Specifies configuration information for indexing Confluence blogs.
    
    Parameters:
    
    blogConfiguration - Specifies configuration information for indexing Confluence blogs.
  - getBlogConfiguration
```
public ConfluenceBlogConfiguration getBlogConfiguration()
```
    Specifies configuration information for indexing Confluence blogs.
    
    Returns:
    
    Specifies configuration information for indexing Confluence blogs.
  - withBlogConfiguration
```
public ConfluenceConfiguration withBlogConfiguration(ConfluenceBlogConfiguration blogConfiguration)
```
    Specifies configuration information for indexing Confluence blogs.
    
    Parameters:
    
    blogConfiguration - Specifies 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)
```
    Specifies configuration information for indexing attachments to Confluence blogs and pages.
    
    Parameters:
    
    attachmentConfiguration - Specifies configuration information for indexing attachments to Confluence blogs and pages.
  - getAttachmentConfiguration
```
public ConfluenceAttachmentConfiguration getAttachmentConfiguration()
```
    Specifies configuration information for indexing attachments to Confluence blogs and pages.
    
    Returns:
    
    Specifies configuration information for indexing attachments to Confluence blogs and pages.
  - withAttachmentConfiguration
```
public ConfluenceConfiguration withAttachmentConfiguration(ConfluenceAttachmentConfiguration attachmentConfiguration)
```
    Specifies configuration information for indexing attachments to Confluence blogs and pages.
    
    Parameters:
    
    attachmentConfiguration - Specifies 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)
```
    Specifies the information for connecting to an Amazon VPC.
    
    Parameters:
    
    vpcConfiguration - Specifies the information for connecting to an Amazon VPC.
  - getVpcConfiguration
```
public DataSourceVpcConfiguration getVpcConfiguration()
```
    Specifies the information for connecting to an Amazon VPC.
    
    Returns:
    
    Specifies the information for connecting to an Amazon VPC.
  - withVpcConfiguration
```
public ConfluenceConfiguration withVpcConfiguration(DataSourceVpcConfiguration vpcConfiguration)
```
    Specifies the information for connecting to an Amazon VPC.
    
    Parameters:
    
    vpcConfiguration - Specifies the information for connecting to an Amazon 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 that apply to a URL on the Confluence server. An inclusion pattern can apply to a blog post, a page, a space, or an attachment. Items that match the patterns are included in the index. Items that don't match the pattern are excluded from the index. If an item matches both an inclusion pattern and an exclusion pattern, the item isn't included in the index.
    
    Returns:
    
    A list of regular expression patterns that apply to a URL on the Confluence server. An inclusion pattern can apply to a blog post, a page, a space, or an attachment. Items that match the patterns are included in the index. Items that don't match the pattern are excluded from the index. If an item matches both an inclusion pattern and an exclusion pattern, the item isn't included in the index.
  - setInclusionPatterns
```
public void setInclusionPatterns(Collection<String> inclusionPatterns)
```
    A list of regular expression patterns that apply to a URL on the Confluence server. An inclusion pattern can apply to a blog post, a page, a space, or an attachment. Items that match the patterns are included in the index. Items that don't match the pattern are excluded from the index. If an item matches both an inclusion pattern and an exclusion pattern, the item isn't included in the index.
    
    Parameters:
    
    inclusionPatterns - A list of regular expression patterns that apply to a URL on the Confluence server. An inclusion pattern can apply to a blog post, a page, a space, or an attachment. Items that match the patterns are included in the index. Items that don't match the pattern are excluded from the index. If an item matches both an inclusion pattern and an exclusion pattern, the item isn't included in the index.
  - withInclusionPatterns
```
public ConfluenceConfiguration withInclusionPatterns(String... inclusionPatterns)
```
    A list of regular expression patterns that apply to a URL on the Confluence server. An inclusion pattern can apply to a blog post, a page, a space, or an attachment. Items that match the patterns are included in the index. Items that don't match the pattern are excluded from the index. If an item matches both an inclusion pattern and an exclusion pattern, the item 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 that apply to a URL on the Confluence server. An inclusion pattern can apply to a blog post, a page, a space, or an attachment. Items that match the patterns are included in the index. Items that don't match the pattern are excluded from the index. If an item matches both an inclusion pattern and an exclusion pattern, the item 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 that apply to a URL on the Confluence server. An inclusion pattern can apply to a blog post, a page, a space, or an attachment. Items that match the patterns are included in the index. Items that don't match the pattern are excluded from the index. If an item matches both an inclusion pattern and an exclusion pattern, the item isn't included in the index.
    
    Parameters:
    
    inclusionPatterns - A list of regular expression patterns that apply to a URL on the Confluence server. An inclusion pattern can apply to a blog post, a page, a space, or an attachment. Items that match the patterns are included in the index. Items that don't match the pattern are excluded from the index. If an item matches both an inclusion pattern and an exclusion pattern, the item 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 that apply to a URL on the Confluence server. An exclusion pattern can apply to a blog post, a page, a space, or an attachment. Items that match the pattern are excluded from the index. Items that don't match the pattern are included in the index. If a item matches both an exclusion pattern and an inclusion pattern, the item isn't included in the index.
    
    Returns:
    
    A list of regular expression patterns that apply to a URL on the Confluence server. An exclusion pattern can apply to a blog post, a page, a space, or an attachment. Items that match the pattern are excluded from the index. Items that don't match the pattern are included in the index. If a item matches both an exclusion pattern and an inclusion pattern, the item isn't included in the index.
  - setExclusionPatterns
```
public void setExclusionPatterns(Collection<String> exclusionPatterns)
```
    A list of regular expression patterns that apply to a URL on the Confluence server. An exclusion pattern can apply to a blog post, a page, a space, or an attachment. Items that match the pattern are excluded from the index. Items that don't match the pattern are included in the index. If a item matches both an exclusion pattern and an inclusion pattern, the item isn't included in the index.
    
    Parameters:
    
    exclusionPatterns - A list of regular expression patterns that apply to a URL on the Confluence server. An exclusion pattern can apply to a blog post, a page, a space, or an attachment. Items that match the pattern are excluded from the index. Items that don't match the pattern are included in the index. If a item matches both an exclusion pattern and an inclusion pattern, the item isn't included in the index.
  - withExclusionPatterns
```
public ConfluenceConfiguration withExclusionPatterns(String... exclusionPatterns)
```
    A list of regular expression patterns that apply to a URL on the Confluence server. An exclusion pattern can apply to a blog post, a page, a space, or an attachment. Items that match the pattern are excluded from the index. Items that don't match the pattern are included in the index. If a item matches both an exclusion pattern and an inclusion pattern, the item 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 that apply to a URL on the Confluence server. An exclusion pattern can apply to a blog post, a page, a space, or an attachment. Items that match the pattern are excluded from the index. Items that don't match the pattern are included in the index. If a item matches both an exclusion pattern and an inclusion pattern, the item 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 that apply to a URL on the Confluence server. An exclusion pattern can apply to a blog post, a page, a space, or an attachment. Items that match the pattern are excluded from the index. Items that don't match the pattern are included in the index. If a item matches both an exclusion pattern and an inclusion pattern, the item isn't included in the index.
    
    Parameters:
    
    exclusionPatterns - A list of regular expression patterns that apply to a URL on the Confluence server. An exclusion pattern can apply to a blog post, a page, a space, or an attachment. Items that match the pattern are excluded from the index. Items that don't match the pattern are included in the index. If a item matches both an exclusion pattern and an inclusion pattern, the item 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)
```
    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.

Did this page help you?

Class ConfluenceConfiguration

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ConfluenceConfiguration

Method Detail

setServerUrl

getServerUrl

withServerUrl

setSecretArn

getSecretArn

withSecretArn

setVersion

getVersion

withVersion

withVersion

setSpaceConfiguration

getSpaceConfiguration

withSpaceConfiguration

setPageConfiguration

getPageConfiguration

withPageConfiguration

setBlogConfiguration

getBlogConfiguration

withBlogConfiguration

setAttachmentConfiguration

getAttachmentConfiguration

withAttachmentConfiguration

setVpcConfiguration

getVpcConfiguration

withVpcConfiguration

getInclusionPatterns

setInclusionPatterns

withInclusionPatterns

withInclusionPatterns

getExclusionPatterns

setExclusionPatterns

withExclusionPatterns

withExclusionPatterns

toString

equals

hashCode

clone

marshall