software.amazon.awssdk.services.kendra.model

Interface ConfluenceConfiguration.Builder

All Superinterfaces:

Buildable, CopyableBuilder<ConfluenceConfiguration.Builder,ConfluenceConfiguration>, SdkBuilder<ConfluenceConfiguration.Builder,ConfluenceConfiguration>, SdkPojo

Enclosing class:

ConfluenceConfiguration

public static interface ConfluenceConfiguration.Builder
extends SdkPojo, CopyableBuilder<ConfluenceConfiguration.Builder,ConfluenceConfiguration>

Method Summary

Modifier and Type	Method and Description
ConfluenceConfiguration.Builder	attachmentConfiguration(ConfluenceAttachmentConfiguration attachmentConfiguration) Specifies configuration information for indexing attachments to Confluence blogs and pages.
default ConfluenceConfiguration.Builder	attachmentConfiguration(Consumer<ConfluenceAttachmentConfiguration.Builder> attachmentConfiguration) Specifies configuration information for indexing attachments to Confluence blogs and pages.
ConfluenceConfiguration.Builder	blogConfiguration(ConfluenceBlogConfiguration blogConfiguration) Specifies configuration information for indexing Confluence blogs.
default ConfluenceConfiguration.Builder	blogConfiguration(Consumer<ConfluenceBlogConfiguration.Builder> blogConfiguration) Specifies configuration information for indexing Confluence blogs.
ConfluenceConfiguration.Builder	exclusionPatterns(Collection<String> exclusionPatterns) A list of regular expression patterns that apply to a URL on the Confluence server.
ConfluenceConfiguration.Builder	exclusionPatterns(String... exclusionPatterns) A list of regular expression patterns that apply to a URL on the Confluence server.
ConfluenceConfiguration.Builder	inclusionPatterns(Collection<String> inclusionPatterns) A list of regular expression patterns that apply to a URL on the Confluence server.
ConfluenceConfiguration.Builder	inclusionPatterns(String... inclusionPatterns) A list of regular expression patterns that apply to a URL on the Confluence server.
ConfluenceConfiguration.Builder	pageConfiguration(ConfluencePageConfiguration pageConfiguration) Specifies configuration information for indexing Confluence pages.
default ConfluenceConfiguration.Builder	pageConfiguration(Consumer<ConfluencePageConfiguration.Builder> pageConfiguration) Specifies configuration information for indexing Confluence pages.
ConfluenceConfiguration.Builder	secretArn(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.Builder	serverUrl(String serverUrl) The URL of your Confluence instance.
ConfluenceConfiguration.Builder	spaceConfiguration(ConfluenceSpaceConfiguration spaceConfiguration) Specifies configuration information for indexing Confluence spaces.
default ConfluenceConfiguration.Builder	spaceConfiguration(Consumer<ConfluenceSpaceConfiguration.Builder> spaceConfiguration) Specifies configuration information for indexing Confluence spaces.
ConfluenceConfiguration.Builder	version(ConfluenceVersion version) Specifies the version of the Confluence installation that you are connecting to.
ConfluenceConfiguration.Builder	version(String version) Specifies the version of the Confluence installation that you are connecting to.
default ConfluenceConfiguration.Builder	vpcConfiguration(Consumer<DataSourceVpcConfiguration.Builder> vpcConfiguration) Specifies the information for connecting to an Amazon VPC.
ConfluenceConfiguration.Builder	vpcConfiguration(DataSourceVpcConfiguration vpcConfiguration) Specifies the information for connecting to an Amazon VPC.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

serverUrl

ConfluenceConfiguration.Builder serverUrl(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.

secretArn

ConfluenceConfiguration.Builder secretArn(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.

version

ConfluenceConfiguration.Builder version(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, ConfluenceVersion

version

ConfluenceConfiguration.Builder version(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, ConfluenceVersion

spaceConfiguration

ConfluenceConfiguration.Builder spaceConfiguration(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.

spaceConfiguration

default ConfluenceConfiguration.Builder spaceConfiguration(Consumer<ConfluenceSpaceConfiguration.Builder> spaceConfiguration)

Specifies configuration information for indexing Confluence spaces.

This is a convenience that creates an instance of the ConfluenceSpaceConfiguration.Builder avoiding the need to create one manually via ConfluenceSpaceConfiguration.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to spaceConfiguration(ConfluenceSpaceConfiguration).

Parameters:

spaceConfiguration - a consumer that will call methods on ConfluenceSpaceConfiguration.Builder

Returns:

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

See Also:

spaceConfiguration(ConfluenceSpaceConfiguration)

pageConfiguration

ConfluenceConfiguration.Builder pageConfiguration(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.

pageConfiguration

default ConfluenceConfiguration.Builder pageConfiguration(Consumer<ConfluencePageConfiguration.Builder> pageConfiguration)

Specifies configuration information for indexing Confluence pages.

This is a convenience that creates an instance of the ConfluencePageConfiguration.Builder avoiding the need to create one manually via ConfluencePageConfiguration.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to pageConfiguration(ConfluencePageConfiguration).

Parameters:

pageConfiguration - a consumer that will call methods on ConfluencePageConfiguration.Builder

Returns:

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

See Also:

pageConfiguration(ConfluencePageConfiguration)

blogConfiguration

ConfluenceConfiguration.Builder blogConfiguration(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.

blogConfiguration

default ConfluenceConfiguration.Builder blogConfiguration(Consumer<ConfluenceBlogConfiguration.Builder> blogConfiguration)

Specifies configuration information for indexing Confluence blogs.

This is a convenience that creates an instance of the ConfluenceBlogConfiguration.Builder avoiding the need to create one manually via ConfluenceBlogConfiguration.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to blogConfiguration(ConfluenceBlogConfiguration).

Parameters:

blogConfiguration - a consumer that will call methods on ConfluenceBlogConfiguration.Builder

Returns:

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

See Also:

blogConfiguration(ConfluenceBlogConfiguration)

attachmentConfiguration

ConfluenceConfiguration.Builder attachmentConfiguration(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.

attachmentConfiguration

default ConfluenceConfiguration.Builder attachmentConfiguration(Consumer<ConfluenceAttachmentConfiguration.Builder> attachmentConfiguration)

Specifies configuration information for indexing attachments to Confluence blogs and pages.

This is a convenience that creates an instance of the ConfluenceAttachmentConfiguration.Builder avoiding the need to create one manually via ConfluenceAttachmentConfiguration.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to attachmentConfiguration(ConfluenceAttachmentConfiguration).

Parameters:

attachmentConfiguration - a consumer that will call methods on ConfluenceAttachmentConfiguration.Builder

Returns:

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

See Also:

attachmentConfiguration(ConfluenceAttachmentConfiguration)

vpcConfiguration

ConfluenceConfiguration.Builder vpcConfiguration(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.

vpcConfiguration

default ConfluenceConfiguration.Builder vpcConfiguration(Consumer<DataSourceVpcConfiguration.Builder> vpcConfiguration)

Specifies the information for connecting to an Amazon VPC.

This is a convenience that creates an instance of the DataSourceVpcConfiguration.Builder avoiding the need to create one manually via DataSourceVpcConfiguration.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to vpcConfiguration(DataSourceVpcConfiguration).

Parameters:

vpcConfiguration - a consumer that will call methods on DataSourceVpcConfiguration.Builder

Returns:

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

See Also:

vpcConfiguration(DataSourceVpcConfiguration)

inclusionPatterns

ConfluenceConfiguration.Builder inclusionPatterns(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.

inclusionPatterns

ConfluenceConfiguration.Builder inclusionPatterns(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.

exclusionPatterns

ConfluenceConfiguration.Builder exclusionPatterns(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.

exclusionPatterns

ConfluenceConfiguration.Builder exclusionPatterns(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.