Package software.amazon.awssdk.services.kendra.model

Class ConfluenceConfiguration

java.lang.Object
software.amazon.awssdk.services.kendra.model.ConfluenceConfiguration
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ConfluenceConfiguration.Builder,ConfluenceConfiguration>
@Generated("software.amazon.awssdk:codegen") public final class ConfluenceConfiguration extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ConfluenceConfiguration.Builder,ConfluenceConfiguration>

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

See Also:

  • Method Details

    • 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 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.

      You can also provide authentication credentials in the form of a personal access token. 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.

      You can also provide authentication credentials in the form of a personal access token. For more information, see Using a Confluence data source.

    • version

      public final ConfluenceVersion version()

      The version or the type of Confluence installation to connect 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:
      The version or the type of Confluence installation to connect to.
      See Also:

    • versionAsString

      public final String versionAsString()

      The version or the type of Confluence installation to connect 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:
      The version or the type of Confluence installation to connect to.
      See Also:

    • spaceConfiguration

      public final ConfluenceSpaceConfiguration spaceConfiguration()

      Configuration information for indexing Confluence spaces.

      Returns:
      Configuration information for indexing Confluence spaces.

    • pageConfiguration

      public final ConfluencePageConfiguration pageConfiguration()

      Configuration information for indexing Confluence pages.

      Returns:
      Configuration information for indexing Confluence pages.

    • blogConfiguration

      public final ConfluenceBlogConfiguration blogConfiguration()

      Configuration information for indexing Confluence blogs.

      Returns:
      Configuration information for indexing Confluence blogs.

    • attachmentConfiguration

      public final ConfluenceAttachmentConfiguration attachmentConfiguration()

      Configuration information for indexing attachments to Confluence blogs and pages.

      Returns:
      Configuration information for indexing attachments to Confluence blogs and pages.

    • vpcConfiguration

      public final DataSourceVpcConfiguration vpcConfiguration()

      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.

    • hasInclusionPatterns

      public final boolean hasInclusionPatterns()
      For responses, this returns true if the service returned a value for the InclusionPatterns property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • inclusionPatterns

      public final List<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.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasInclusionPatterns() method.

      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.

    • hasExclusionPatterns

      public final boolean hasExclusionPatterns()
      For responses, this returns true if the service returned a value for the ExclusionPatterns property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • exclusionPatterns

      public final List<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.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasExclusionPatterns() method.

      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.

    • proxyConfiguration

      public final ProxyConfiguration proxyConfiguration()

      Configuration information to connect to your Confluence URL instance via a web proxy. You can use this option for Confluence Server.

      You must provide the website host name and port number. For example, the host name of https://a.example.com/page1.html is "a.example.com" and the port is 443, the standard port for HTTPS.

      Web proxy credentials are optional and you can use them to connect to a web proxy server that requires basic authentication of user name and password. To store web proxy credentials, you use a secret in Secrets Manager.

      It is recommended that you follow best security practices when configuring your web proxy. This includes setting up throttling, setting up logging and monitoring, and applying security patches on a regular basis. If you use your web proxy with multiple data sources, sync jobs that occur at the same time could strain the load on your proxy. It is recommended you prepare your proxy beforehand for any security and load requirements.

      Returns:
      Configuration information to connect to your Confluence URL instance via a web proxy. You can use this option for Confluence Server.

      You must provide the website host name and port number. For example, the host name of https://a.example.com/page1.html is "a.example.com" and the port is 443, the standard port for HTTPS.

      Web proxy credentials are optional and you can use them to connect to a web proxy server that requires basic authentication of user name and password. To store web proxy credentials, you use a secret in Secrets Manager.

      It is recommended that you follow best security practices when configuring your web proxy. This includes setting up throttling, setting up logging and monitoring, and applying security patches on a regular basis. If you use your web proxy with multiple data sources, sync jobs that occur at the same time could strain the load on your proxy. It is recommended you prepare your proxy beforehand for any security and load requirements.

    • authenticationType

      public final ConfluenceAuthenticationType authenticationType()

      Whether you want to connect to Confluence using basic authentication of user name and password, or a personal access token. You can use a personal access token for Confluence Server.

      If the service returns an enum value that is not available in the current SDK version, authenticationType will return ConfluenceAuthenticationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from authenticationTypeAsString().

      Returns:
      Whether you want to connect to Confluence using basic authentication of user name and password, or a personal access token. You can use a personal access token for Confluence Server.
      See Also:

    • authenticationTypeAsString

      public final String authenticationTypeAsString()

      Whether you want to connect to Confluence using basic authentication of user name and password, or a personal access token. You can use a personal access token for Confluence Server.

      If the service returns an enum value that is not available in the current SDK version, authenticationType will return ConfluenceAuthenticationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from authenticationTypeAsString().

      Returns:
      Whether you want to connect to Confluence using basic authentication of user name and password, or a personal access token. You can use a personal access token for Confluence Server.
      See Also:

    • toBuilder

      public ConfluenceConfiguration.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<ConfluenceConfiguration.Builder,ConfluenceConfiguration>
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.