AlfrescoConfiguration (AWS Java SDK :: Services

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

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<AlfrescoConfiguration.Builder,AlfrescoConfiguration>
```
@Generated(value="software.amazon.awssdk:codegen")
public final class AlfrescoConfiguration
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<AlfrescoConfiguration.Builder,AlfrescoConfiguration>
```
Provides the configuration information to connect to Alfresco as your data source.

Support for AlfrescoConfiguration ended May 2023. We recommend migrating to or using the Alfresco data source template schema / TemplateConfiguration API.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface AlfrescoConfiguration.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`List<DataSourceToIndexFieldMapping>`	`blogFieldMappings()` A list of `DataSourceToIndexFieldMapping` objects that map attributes or field names of Alfresco blogs to Amazon Kendra index field names.
`static AlfrescoConfiguration.Builder`	`builder()`
`Boolean`	`crawlComments()` `TRUE` to index comments of blogs and other content.
`Boolean`	`crawlSystemFolders()` `TRUE` to index shared files.
`List<DataSourceToIndexFieldMapping>`	`documentLibraryFieldMappings()` A list of `DataSourceToIndexFieldMapping` objects that map attributes or field names of Alfresco document libraries to Amazon Kendra index field names.
`List<AlfrescoEntity>`	`entityFilter()` Specify whether to index document libraries, wikis, or blogs.
`List<String>`	`entityFilterAsStrings()` Specify whether to index document libraries, wikis, or blogs.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`List<String>`	`exclusionPatterns()` A list of regular expression patterns to exclude certain files in your Alfresco data source.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasBlogFieldMappings()` For responses, this returns true if the service returned a value for the BlogFieldMappings property.
`boolean`	`hasDocumentLibraryFieldMappings()` For responses, this returns true if the service returned a value for the DocumentLibraryFieldMappings property.
`boolean`	`hasEntityFilter()` For responses, this returns true if the service returned a value for the EntityFilter property.
`boolean`	`hasExclusionPatterns()` For responses, this returns true if the service returned a value for the ExclusionPatterns property.
`int`	`hashCode()`
`boolean`	`hasInclusionPatterns()` For responses, this returns true if the service returned a value for the InclusionPatterns property.
`boolean`	`hasWikiFieldMappings()` For responses, this returns true if the service returned a value for the WikiFieldMappings property.
`List<String>`	`inclusionPatterns()` A list of regular expression patterns to include certain files in your Alfresco data source.
`List<SdkField<?>>`	`sdkFields()`
`String`	`secretArn()` The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the key-value pairs required to connect to your Alfresco data source.
`static Class<? extends AlfrescoConfiguration.Builder>`	`serializableBuilderClass()`
`String`	`siteId()` The identifier of the Alfresco site.
`String`	`siteUrl()` The URL of the Alfresco site.
`S3Path`	`sslCertificateS3Path()` The path to the SSL certificate stored in an Amazon S3 bucket.
`AlfrescoConfiguration.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`DataSourceVpcConfiguration`	`vpcConfiguration()` Configuration information for an Amazon Virtual Private Cloud to connect to your Alfresco.
`List<DataSourceToIndexFieldMapping>`	`wikiFieldMappings()` A list of `DataSourceToIndexFieldMapping` objects that map attributes or field names of Alfresco wikis to Amazon Kendra index field names.

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
  - siteUrl
```
public final String siteUrl()
```
    The URL of the Alfresco site. For example, https://hostname:8080.
    
    Returns:
    
    The URL of the Alfresco site. For example, https://hostname:8080.
  - siteId
```
public final String siteId()
```
    The identifier of the Alfresco site. For example, my-site.
    
    Returns:
    
    The identifier of the Alfresco site. For example, my-site.
  - secretArn
```
public final String secretArn()
```
    The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the key-value pairs required to connect to your Alfresco data source. The secret must contain a JSON structure with the following keys:
    - username—The user name of the Alfresco account.
    - password—The password of the Alfresco account.
    Returns:
    The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the key-value pairs required to connect to your Alfresco data source. The secret must contain a JSON structure with the following keys:
    
    username—The user name of the Alfresco account.
    
    password—The password of the Alfresco account.
  - sslCertificateS3Path
```
public final S3Path sslCertificateS3Path()
```
    The path to the SSL certificate stored in an Amazon S3 bucket. You use this to connect to Alfresco if you require a secure SSL connection.
    
    You can simply generate a self-signed X509 certificate on any computer using OpenSSL. For an example of using OpenSSL to create an X509 certificate, see Create and sign an X509 certificate.
    
    Returns:
    
    The path to the SSL certificate stored in an Amazon S3 bucket. You use this to connect to Alfresco if you require a secure SSL connection.
    
    You can simply generate a self-signed X509 certificate on any computer using OpenSSL. For an example of using OpenSSL to create an X509 certificate, see Create and sign an X509 certificate.
  - crawlSystemFolders
```
public final Boolean crawlSystemFolders()
```
    TRUE to index shared files.
    
    Returns:
    
    TRUE to index shared files.
  - crawlComments
```
public final Boolean crawlComments()
```
    TRUE to index comments of blogs and other content.
    
    Returns:
    
    TRUE to index comments of blogs and other content.
  - entityFilter
```
public final List<AlfrescoEntity> entityFilter()
```
    Specify whether to index document libraries, wikis, or blogs. You can specify one or more of these options.
    
    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 hasEntityFilter() method.
    
    Returns:
    
    Specify whether to index document libraries, wikis, or blogs. You can specify one or more of these options.
  - hasEntityFilter
```
public final boolean hasEntityFilter()
```
    For responses, this returns true if the service returned a value for the EntityFilter 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.
  - entityFilterAsStrings
```
public final List<String> entityFilterAsStrings()
```
    Specify whether to index document libraries, wikis, or blogs. You can specify one or more of these options.
    
    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 hasEntityFilter() method.
    
    Returns:
    
    Specify whether to index document libraries, wikis, or blogs. You can specify one or more of these options.
  - hasDocumentLibraryFieldMappings
```
public final boolean hasDocumentLibraryFieldMappings()
```
    For responses, this returns true if the service returned a value for the DocumentLibraryFieldMappings 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.
  - documentLibraryFieldMappings
```
public final List<DataSourceToIndexFieldMapping> documentLibraryFieldMappings()
```
    A list of DataSourceToIndexFieldMapping objects that map attributes or field names of Alfresco document libraries to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Alfresco fields. For more information, see Mapping data source fields. The Alfresco data source field names must exist in your Alfresco custom metadata.
    
    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 hasDocumentLibraryFieldMappings() method.
    
    Returns:
    
    A list of DataSourceToIndexFieldMapping objects that map attributes or field names of Alfresco document libraries to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Alfresco fields. For more information, see Mapping data source fields. The Alfresco data source field names must exist in your Alfresco custom metadata.
  - hasBlogFieldMappings
```
public final boolean hasBlogFieldMappings()
```
    For responses, this returns true if the service returned a value for the BlogFieldMappings 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.
  - blogFieldMappings
```
public final List<DataSourceToIndexFieldMapping> blogFieldMappings()
```
    A list of DataSourceToIndexFieldMapping objects that map attributes or field names of Alfresco blogs to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Alfresco fields. For more information, see Mapping data source fields. The Alfresco data source field names must exist in your Alfresco custom metadata.
    
    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 hasBlogFieldMappings() method.
    
    Returns:
    
    A list of DataSourceToIndexFieldMapping objects that map attributes or field names of Alfresco blogs to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Alfresco fields. For more information, see Mapping data source fields. The Alfresco data source field names must exist in your Alfresco custom metadata.
  - hasWikiFieldMappings
```
public final boolean hasWikiFieldMappings()
```
    For responses, this returns true if the service returned a value for the WikiFieldMappings 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.
  - wikiFieldMappings
```
public final List<DataSourceToIndexFieldMapping> wikiFieldMappings()
```
    A list of DataSourceToIndexFieldMapping objects that map attributes or field names of Alfresco wikis to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Alfresco fields. For more information, see Mapping data source fields. The Alfresco data source field names must exist in your Alfresco custom metadata.
    
    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 hasWikiFieldMappings() method.
    
    Returns:
    
    A list of DataSourceToIndexFieldMapping objects that map attributes or field names of Alfresco wikis to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Alfresco fields. For more information, see Mapping data source fields. The Alfresco data source field names must exist in your Alfresco custom metadata.
  - 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 files in your Alfresco data source. Files that match the patterns are included in the index. Files that don't match the patterns are excluded from the index. If a file matches both an inclusion pattern and an exclusion pattern, the exclusion pattern takes precedence and the file 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 files in your Alfresco data source. Files that match the patterns are included in the index. Files that don't match the patterns are excluded from the index. If a file matches both an inclusion pattern and an exclusion pattern, the exclusion pattern takes precedence and the file 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 files in your Alfresco data source. Files that match the patterns are excluded from the index. Files that don't match the patterns are included in the index. If a file matches both an inclusion pattern and an exclusion pattern, the exclusion pattern takes precedence and the file 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 files in your Alfresco data source. Files that match the patterns are excluded from the index. Files that don't match the patterns are included in the index. If a file matches both an inclusion pattern and an exclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index.
  - vpcConfiguration
```
public final DataSourceVpcConfiguration vpcConfiguration()
```
    Configuration information for an Amazon Virtual Private Cloud to connect to your Alfresco. For more information, see Configuring a VPC.
    
    Returns:
    
    Configuration information for an Amazon Virtual Private Cloud to connect to your Alfresco. For more information, see Configuring a VPC.
  - toBuilder
```
public AlfrescoConfiguration.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<AlfrescoConfiguration.Builder,AlfrescoConfiguration>
  - builder
```
public static AlfrescoConfiguration.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends AlfrescoConfiguration.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 AlfrescoConfiguration

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

siteUrl

siteId

secretArn

sslCertificateS3Path

crawlSystemFolders

crawlComments

entityFilter

hasEntityFilter

entityFilterAsStrings

hasDocumentLibraryFieldMappings

documentLibraryFieldMappings

hasBlogFieldMappings

blogFieldMappings

hasWikiFieldMappings

wikiFieldMappings

hasInclusionPatterns

inclusionPatterns

hasExclusionPatterns

exclusionPatterns

vpcConfiguration

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields