SharePointConfiguration (AWS Java SDK :: Services

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

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<SharePointConfiguration.Builder,SharePointConfiguration>
```
@Generated(value="software.amazon.awssdk:codegen")
public final class SharePointConfiguration
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<SharePointConfiguration.Builder,SharePointConfiguration>
```
Provides configuration information for connecting to a Microsoft SharePoint data source.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface SharePointConfiguration.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static SharePointConfiguration.Builder`	`builder()`
`Boolean`	`crawlAttachments()` `TRUE` to include attachments to documents stored in your Microsoft SharePoint site in the index; otherwise, `FALSE`.
`String`	`documentTitleFieldName()` The Microsoft SharePoint attribute field that contains the title of the document.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`List<String>`	`exclusionPatterns()` A list of regular expression patterns.
`List<DataSourceToIndexFieldMapping>`	`fieldMappings()` A list of `DataSourceToIndexFieldMapping` objects that map Microsoft SharePoint attributes to custom fields in the Amazon Kendra index.
`<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).
`boolean`	`hasFieldMappings()` Returns true if the FieldMappings 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).
`boolean`	`hasUrls()` Returns true if the Urls 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.
`List<SdkField<?>>`	`sdkFields()`
`String`	`secretArn()` The Amazon Resource Name (ARN) of credentials stored in AWS Secrets Manager.
`static Class<? extends SharePointConfiguration.Builder>`	`serializableBuilderClass()`
`SharePointVersion`	`sharePointVersion()` The version of Microsoft SharePoint that you are using as a data source.
`String`	`sharePointVersionAsString()` The version of Microsoft SharePoint that you are using as a data source.
`SharePointConfiguration.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`List<String>`	`urls()` The URLs of the Microsoft SharePoint site that contains the documents that should be indexed.
`Boolean`	`useChangeLog()` Set to `TRUE` to use the Microsoft SharePoint change log to determine the documents that need to be updated in the index.
`DataSourceVpcConfiguration`	`vpcConfiguration()` Returns the value of the VpcConfiguration property for this object.

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
  - sharePointVersion
```
public SharePointVersion sharePointVersion()
```
    The version of Microsoft SharePoint that you are using as a data source.
    
    If the service returns an enum value that is not available in the current SDK version, sharePointVersion will return SharePointVersion.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sharePointVersionAsString().
    
    Returns:
    
    The version of Microsoft SharePoint that you are using as a data source.
    
    See Also:
    
    SharePointVersion
  - sharePointVersionAsString
```
public String sharePointVersionAsString()
```
    The version of Microsoft SharePoint that you are using as a data source.
    
    If the service returns an enum value that is not available in the current SDK version, sharePointVersion will return SharePointVersion.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sharePointVersionAsString().
    
    Returns:
    
    The version of Microsoft SharePoint that you are using as a data source.
    
    See Also:
    
    SharePointVersion
  - hasUrls
```
public boolean hasUrls()
```
    Returns true if the Urls 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.
  - urls
```
public List<String> urls()
```
    The URLs of the Microsoft SharePoint site that contains the documents that should be indexed.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasUrls() to see if a value was sent in this field.
    
    Returns:
    
    The URLs of the Microsoft SharePoint site that contains the documents that should be indexed.
  - secretArn
```
public String secretArn()
```
    The Amazon Resource Name (ARN) of credentials stored in AWS Secrets Manager. The credentials should be a user/password pair. For more information, see Using a Microsoft SharePoint Data Source. For more information about AWS Secrets Manager, see What Is AWS Secrets Manager in the AWS Secrets Manager user guide.
    
    Returns:
    
    The Amazon Resource Name (ARN) of credentials stored in AWS Secrets Manager. The credentials should be a user/password pair. For more information, see Using a Microsoft SharePoint Data Source. For more information about AWS Secrets Manager, see What Is AWS Secrets Manager in the AWS Secrets Manager user guide.
  - crawlAttachments
```
public Boolean crawlAttachments()
```
    TRUE to include attachments to documents stored in your Microsoft SharePoint site in the index; otherwise, FALSE.
    
    Returns:
    
    TRUE to include attachments to documents stored in your Microsoft SharePoint site in the index; otherwise, FALSE.
  - useChangeLog
```
public Boolean useChangeLog()
```
    Set to TRUE to use the Microsoft SharePoint change log to determine the documents that need to be updated in the index. Depending on the size of the SharePoint change log, it may take longer for Amazon Kendra to use the change log than it takes it to determine the changed documents using the Amazon Kendra document crawler.
    
    Returns:
    
    Set to TRUE to use the Microsoft SharePoint change log to determine the documents that need to be updated in the index. Depending on the size of the SharePoint change log, it may take longer for Amazon Kendra to use the change log than it takes it to determine the changed documents using the Amazon Kendra document crawler.
  - hasInclusionPatterns
```
public 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 List<String> inclusionPatterns()
```
    A list of regular expression patterns. Documents that match the patterns are included in the index. Documents that don't match the patterns are excluded from the index. If a document matches both an inclusion pattern and an exclusion pattern, the document is not included in the index.
    
    The regex is applied to the display URL of the SharePoint document.
    
    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. Documents that match the patterns are included in the index. Documents that don't match the patterns are excluded from the index. If a document matches both an inclusion pattern and an exclusion pattern, the document is not included in the index.
    
    The regex is applied to the display URL of the SharePoint document.
  - hasExclusionPatterns
```
public 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 List<String> exclusionPatterns()
```
    A list of regular expression patterns. Documents that match the patterns are excluded from the index. Documents that don't match the patterns are included in the index. If a document matches both an exclusion pattern and an inclusion pattern, the document is not included in the index.
    
    The regex is applied to the display URL of the SharePoint document.
    
    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. Documents that match the patterns are excluded from the index. Documents that don't match the patterns are included in the index. If a document matches both an exclusion pattern and an inclusion pattern, the document is not included in the index.
    
    The regex is applied to the display URL of the SharePoint document.
  - vpcConfiguration
```
public DataSourceVpcConfiguration vpcConfiguration()
```
    Returns the value of the VpcConfiguration property for this object.
    
    Returns:
    
    The value of the VpcConfiguration property for this object.
  - hasFieldMappings
```
public boolean hasFieldMappings()
```
    Returns true if the FieldMappings 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.
  - fieldMappings
```
public List<DataSourceToIndexFieldMapping> fieldMappings()
```
    A list of DataSourceToIndexFieldMapping objects that map Microsoft SharePoint attributes to custom fields in the Amazon Kendra index. You must first create the index fields using the operation before you map SharePoint attributes. For more information, see Mapping Data Source Fields.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasFieldMappings() to see if a value was sent in this field.
    
    Returns:
    
    A list of DataSourceToIndexFieldMapping objects that map Microsoft SharePoint attributes to custom fields in the Amazon Kendra index. You must first create the index fields using the operation before you map SharePoint attributes. For more information, see Mapping Data Source Fields.
  - documentTitleFieldName
```
public String documentTitleFieldName()
```
    The Microsoft SharePoint attribute field that contains the title of the document.
    
    Returns:
    
    The Microsoft SharePoint attribute field that contains the title of the document.
  - toBuilder
```
public SharePointConfiguration.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<SharePointConfiguration.Builder,SharePointConfiguration>
  - builder
```
public static SharePointConfiguration.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends SharePointConfiguration.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class SharePointConfiguration

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

sharePointVersion

sharePointVersionAsString

hasUrls

urls

secretArn

crawlAttachments

useChangeLog

hasInclusionPatterns

inclusionPatterns

hasExclusionPatterns

exclusionPatterns

vpcConfiguration

hasFieldMappings

fieldMappings

documentTitleFieldName

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields