Class SharePointConfiguration
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<SharePointConfiguration.Builder,
SharePointConfiguration>
Provides the configuration information to connect to Microsoft SharePoint as your data source.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionWhether you want to connect to SharePoint Online using basic authentication of user name and password, or OAuth authentication of user name, password, client ID, and client secret, or AD App-only authentication of client secret.final String
Whether you want to connect to SharePoint Online using basic authentication of user name and password, or OAuth authentication of user name, password, client ID, and client secret, or AD App-only authentication of client secret.builder()
final Boolean
TRUE
to index document attachments.final Boolean
TRUE
to disable local groups information.final String
The Microsoft SharePoint attribute field that contains the title of the document.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.A list of regular expression patterns to exclude certain documents in your SharePoint.A list ofDataSourceToIndexFieldMapping
objects that map SharePoint data source attributes or field names to Amazon Kendra index field names.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the ExclusionPatterns property.final boolean
For responses, this returns true if the service returned a value for the FieldMappings property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the InclusionPatterns property.final boolean
hasUrls()
For responses, this returns true if the service returned a value for the Urls property.A list of regular expression patterns to include certain documents in your SharePoint.final ProxyConfiguration
Configuration information to connect to your Microsoft SharePoint site URLs via instance via a web proxy.final String
The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the user name and password required to connect to the SharePoint instance.static Class
<? extends SharePointConfiguration.Builder> final SharePointVersion
The version of Microsoft SharePoint that you use.final String
The version of Microsoft SharePoint that you use.final S3Path
The path to the SSL certificate stored in an Amazon S3 bucket.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.urls()
The Microsoft SharePoint site URLs for the documents you want to index.final Boolean
TRUE
to use the SharePoint change log to determine which documents require updating in the index.Configuration information for an Amazon Virtual Private Cloud to connect to your Microsoft SharePoint.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
hasUrls
public final boolean hasUrls()For responses, this returns true if the service returned a value for the Urls property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
urls
The Microsoft SharePoint site URLs for the documents you want to 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
hasUrls()
method.- Returns:
- The Microsoft SharePoint site URLs for the documents you want to index.
-
secretArn
The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the user name and password required to connect to the SharePoint instance. For more information, see Microsoft SharePoint.
- Returns:
- The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the user name and password required to connect to the SharePoint instance. For more information, see Microsoft SharePoint.
-
crawlAttachments
TRUE
to index document attachments.- Returns:
TRUE
to index document attachments.
-
useChangeLog
TRUE
to use the SharePoint change log to determine which documents require updating in the index. Depending on the change log's size, it may take longer for Amazon Kendra to use the change log than to scan all of your documents in SharePoint.- Returns:
TRUE
to use the SharePoint change log to determine which documents require updating in the index. Depending on the change log's size, it may take longer for Amazon Kendra to use the change log than to scan all of your documents in SharePoint.
-
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 theisEmpty()
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
A list of regular expression patterns to include certain documents in your SharePoint. 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 and exclusion pattern, the exclusion pattern takes precedence and the document isn't included in the index.
The regex applies to the display URL of the SharePoint document.
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 documents in your SharePoint. 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 and exclusion pattern, the exclusion pattern takes
precedence and the document isn't included in the index.
The regex applies to the display URL of the SharePoint document.
-
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 theisEmpty()
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
A list of regular expression patterns to exclude certain documents in your SharePoint. 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 inclusion and exclusion pattern, the exclusion pattern takes precedence and the document isn't included in the index.
The regex applies to the display URL of the SharePoint document.
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 documents in your SharePoint. 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 inclusion and exclusion pattern, the exclusion pattern takes
precedence and the document isn't included in the index.
The regex applies to the display URL of the SharePoint document.
-
vpcConfiguration
Configuration information for an Amazon Virtual Private Cloud to connect to your Microsoft SharePoint. For more information, see Configuring a VPC.
- Returns:
- Configuration information for an Amazon Virtual Private Cloud to connect to your Microsoft SharePoint. For more information, see Configuring a VPC.
-
hasFieldMappings
public final boolean hasFieldMappings()For responses, this returns true if the service returned a value for the FieldMappings property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
fieldMappings
A list of
DataSourceToIndexFieldMapping
objects that map SharePoint data source attributes or field names to Amazon Kendra index field names. To create custom fields, use theUpdateIndex
API before you map to SharePoint fields. For more information, see Mapping data source fields. The SharePoint data source field names must exist in your SharePoint 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
hasFieldMappings()
method.- Returns:
- A list of
DataSourceToIndexFieldMapping
objects that map SharePoint data source attributes or field names to Amazon Kendra index field names. To create custom fields, use theUpdateIndex
API before you map to SharePoint fields. For more information, see Mapping data source fields. The SharePoint data source field names must exist in your SharePoint custom metadata.
-
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.
-
disableLocalGroups
TRUE
to disable local groups information.- Returns:
TRUE
to disable local groups information.
-
sslCertificateS3Path
The path to the SSL certificate stored in an Amazon S3 bucket. You use this to connect to SharePoint Server if you require a secure SSL connection.
You can 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 SharePoint
Server if you require a secure SSL connection.
You can 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.
-
authenticationType
Whether you want to connect to SharePoint Online using basic authentication of user name and password, or OAuth authentication of user name, password, client ID, and client secret, or AD App-only authentication of client secret.
If the service returns an enum value that is not available in the current SDK version,
authenticationType
will returnSharePointOnlineAuthenticationType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromauthenticationTypeAsString()
.- Returns:
- Whether you want to connect to SharePoint Online using basic authentication of user name and password, or OAuth authentication of user name, password, client ID, and client secret, or AD App-only authentication of client secret.
- See Also:
-
authenticationTypeAsString
Whether you want to connect to SharePoint Online using basic authentication of user name and password, or OAuth authentication of user name, password, client ID, and client secret, or AD App-only authentication of client secret.
If the service returns an enum value that is not available in the current SDK version,
authenticationType
will returnSharePointOnlineAuthenticationType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromauthenticationTypeAsString()
.- Returns:
- Whether you want to connect to SharePoint Online using basic authentication of user name and password, or OAuth authentication of user name, password, client ID, and client secret, or AD App-only authentication of client secret.
- See Also:
-
proxyConfiguration
Configuration information to connect to your Microsoft SharePoint site URLs via instance via a web proxy. You can use this option for SharePoint 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 Microsoft SharePoint site URLs via instance via a web proxy.
You can use this option for SharePoint 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.
-
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 interfaceToCopyableBuilder<SharePointConfiguration.Builder,
SharePointConfiguration> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields