@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.
Modifier and Type | Class and Description |
---|---|
static interface |
SharePointConfiguration.Builder |
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 . |
Boolean |
disableLocalGroups()
A Boolean value that specifies whether local groups are disabled (
True ) or enabled (
False ). |
String |
documentTitleFieldName()
The Microsoft SharePoint attribute field that contains the title of the document.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj)
Indicates whether some other object is "equal to" this one by SDK fields.
|
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()
Take this object and create a builder that contains all of the current property values of this object.
|
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.
|
copy
public final 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()
.
SharePointVersion
public final 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()
.
SharePointVersion
public final boolean hasUrls()
public final 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.
public final 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.
public final Boolean crawlAttachments()
TRUE
to include attachments to documents stored in your Microsoft SharePoint site in the index;
otherwise, FALSE
.
TRUE
to include attachments to documents stored in your Microsoft SharePoint site in the
index; otherwise, FALSE
.public final 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.
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.public final boolean hasInclusionPatterns()
public final 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.
The regex is applied to the display URL of the SharePoint document.
public final boolean hasExclusionPatterns()
public final 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.
The regex is applied to the display URL of the SharePoint document.
public final DataSourceVpcConfiguration vpcConfiguration()
public final boolean hasFieldMappings()
public final 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.
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.public final String documentTitleFieldName()
The Microsoft SharePoint attribute field that contains the title of the document.
public final Boolean disableLocalGroups()
A Boolean value that specifies whether local groups are disabled (True
) or enabled (
False
).
True
) or enabled (
False
).public SharePointConfiguration.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<SharePointConfiguration.Builder,SharePointConfiguration>
public static SharePointConfiguration.Builder builder()
public static Class<? extends SharePointConfiguration.Builder> serializableBuilderClass()
public final boolean equalsBySdkFields(Object obj)
SdkPojo
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.
equalsBySdkFields
in interface SdkPojo
obj
- the object to be compared withpublic final String toString()
Copyright © 2021 Amazon Web Services, Inc. All Rights Reserved.