ConfluenceConfiguration (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.services.kendra.model.ConfluenceConfiguration

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ConfluenceConfiguration.Builder,ConfluenceConfiguration>
```
@Generated(value="software.amazon.awssdk:codegen")
public final class ConfluenceConfiguration
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ConfluenceConfiguration.Builder,ConfluenceConfiguration>
```
Provides configuration information for data sources that connect to Confluence.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface ConfluenceConfiguration.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`ConfluenceConfiguration.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ConfluenceAttachmentConfiguration`	`attachmentConfiguration()` Specifies configuration information for indexing attachments to Confluence blogs and pages.
`ConfluenceBlogConfiguration`	`blogConfiguration()` Specifies configuration information for indexing Confluence blogs.
`static ConfluenceConfiguration.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`List<String>`	`exclusionPatterns()` A list of regular expression patterns that apply to a URL on the Confluence server.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasExclusionPatterns()` Returns true if the ExclusionPatterns property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`int`	`hashCode()`
`boolean`	`hasInclusionPatterns()` Returns true if the InclusionPatterns property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`List<String>`	`inclusionPatterns()` A list of regular expression patterns that apply to a URL on the Confluence server.
`ConfluencePageConfiguration`	`pageConfiguration()` Specifies configuration information for indexing Confluence pages.
`List<SdkField<?>>`	`sdkFields()`
`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.
`static Class<? extends ConfluenceConfiguration.Builder>`	`serializableBuilderClass()`
`String`	`serverUrl()` The URL of your Confluence instance.
`ConfluenceSpaceConfiguration`	`spaceConfiguration()` Specifies configuration information for indexing Confluence spaces.
`ConfluenceConfiguration.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`ConfluenceVersion`	`version()` Specifies the version of the Confluence installation that you are connecting to.
`String`	`versionAsString()` Specifies the version of the Confluence installation that you are connecting to.
`DataSourceVpcConfiguration`	`vpcConfiguration()` Specifies the information for connecting to an Amazon VPC.

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - serverUrl
```
public final 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/.
    
    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/.
  - secretArn
```
public final 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.
    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.
  - version
```
public final ConfluenceVersion version()
```
    Specifies the version of the Confluence installation that you are connecting to.
    
    If the service returns an enum value that is not available in the current SDK version, version will return ConfluenceVersion.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from versionAsString().
    
    Returns:
    
    Specifies the version of the Confluence installation that you are connecting to.
    
    See Also:
    
    ConfluenceVersion
  - versionAsString
```
public final String versionAsString()
```
    Specifies the version of the Confluence installation that you are connecting to.
    
    If the service returns an enum value that is not available in the current SDK version, version will return ConfluenceVersion.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from versionAsString().
    
    Returns:
    
    Specifies the version of the Confluence installation that you are connecting to.
    
    See Also:
    
    ConfluenceVersion
  - spaceConfiguration
```
public final ConfluenceSpaceConfiguration spaceConfiguration()
```
    Specifies configuration information for indexing Confluence spaces.
    
    Returns:
    
    Specifies configuration information for indexing Confluence spaces.
  - pageConfiguration
```
public final ConfluencePageConfiguration pageConfiguration()
```
    Specifies configuration information for indexing Confluence pages.
    
    Returns:
    
    Specifies configuration information for indexing Confluence pages.
  - blogConfiguration
```
public final ConfluenceBlogConfiguration blogConfiguration()
```
    Specifies configuration information for indexing Confluence blogs.
    
    Returns:
    
    Specifies configuration information for indexing Confluence blogs.
  - attachmentConfiguration
```
public final ConfluenceAttachmentConfiguration attachmentConfiguration()
```
    Specifies configuration information for indexing attachments to Confluence blogs and pages.
    
    Returns:
    
    Specifies configuration information for indexing attachments to Confluence blogs and pages.
  - vpcConfiguration
```
public final DataSourceVpcConfiguration vpcConfiguration()
```
    Specifies the information for connecting to an Amazon VPC.
    
    Returns:
    
    Specifies the information for connecting to an Amazon VPC.
  - hasInclusionPatterns
```
public final boolean hasInclusionPatterns()
```
    Returns true if the InclusionPatterns property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - inclusionPatterns
```
public final List<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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasInclusionPatterns() to see if a value was sent in this field.
    
    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.
  - hasExclusionPatterns
```
public final boolean hasExclusionPatterns()
```
    Returns true if the ExclusionPatterns property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - exclusionPatterns
```
public final List<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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasExclusionPatterns() to see if a value was sent in this field.
    
    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.
  - toBuilder
```
public ConfluenceConfiguration.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ConfluenceConfiguration.Builder,ConfluenceConfiguration>
  - builder
```
public static ConfluenceConfiguration.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends ConfluenceConfiguration.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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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

Class ConfluenceConfiguration

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

serverUrl

secretArn

version

versionAsString

spaceConfiguration

pageConfiguration

blogConfiguration

attachmentConfiguration

vpcConfiguration

hasInclusionPatterns

inclusionPatterns

hasExclusionPatterns

exclusionPatterns

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields