com.amazonaws.services.kendra.model.SharePointConfiguration Maven / Gradle / Ivy
Show all versions of aws-java-sdk-kendra Show documentation
/*
* Copyright 2015-2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.kendra.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* Provides configuration information for connecting to a Microsoft SharePoint data source.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class SharePointConfiguration implements Serializable, Cloneable, StructuredPojo {
/**
*
* The version of Microsoft SharePoint that you are using as a data source.
*
*/
private String sharePointVersion;
/**
*
* The URLs of the Microsoft SharePoint site that contains the documents that should be indexed.
*
*/
private java.util.List urls;
/**
*
* 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.
*
*/
private String secretArn;
/**
*
* TRUE to include attachments to documents stored in your Microsoft SharePoint site in the index;
* otherwise, FALSE.
*
*/
private Boolean crawlAttachments;
private DataSourceVpcConfiguration vpcConfiguration;
/**
*
* 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.
*
*/
private java.util.List fieldMappings;
/**
*
* The Microsoft SharePoint attribute field that contains the title of the document.
*
*/
private String documentTitleFieldName;
/**
*
* The version of Microsoft SharePoint that you are using as a data source.
*
*
* @param sharePointVersion
* The version of Microsoft SharePoint that you are using as a data source.
* @see SharePointVersion
*/
public void setSharePointVersion(String sharePointVersion) {
this.sharePointVersion = sharePointVersion;
}
/**
*
* The version of Microsoft SharePoint that you are using as a data source.
*
*
* @return The version of Microsoft SharePoint that you are using as a data source.
* @see SharePointVersion
*/
public String getSharePointVersion() {
return this.sharePointVersion;
}
/**
*
* The version of Microsoft SharePoint that you are using as a data source.
*
*
* @param sharePointVersion
* The version of Microsoft SharePoint that you are using as a data source.
* @return Returns a reference to this object so that method calls can be chained together.
* @see SharePointVersion
*/
public SharePointConfiguration withSharePointVersion(String sharePointVersion) {
setSharePointVersion(sharePointVersion);
return this;
}
/**
*
* The version of Microsoft SharePoint that you are using as a data source.
*
*
* @param sharePointVersion
* The version of Microsoft SharePoint that you are using as a data source.
* @return Returns a reference to this object so that method calls can be chained together.
* @see SharePointVersion
*/
public SharePointConfiguration withSharePointVersion(SharePointVersion sharePointVersion) {
this.sharePointVersion = sharePointVersion.toString();
return this;
}
/**
*
* The URLs of the Microsoft SharePoint site that contains the documents that should be indexed.
*
*
* @return The URLs of the Microsoft SharePoint site that contains the documents that should be indexed.
*/
public java.util.List getUrls() {
return urls;
}
/**
*
* The URLs of the Microsoft SharePoint site that contains the documents that should be indexed.
*
*
* @param urls
* The URLs of the Microsoft SharePoint site that contains the documents that should be indexed.
*/
public void setUrls(java.util.Collection urls) {
if (urls == null) {
this.urls = null;
return;
}
this.urls = new java.util.ArrayList(urls);
}
/**
*
* The URLs of the Microsoft SharePoint site that contains the documents that should be indexed.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setUrls(java.util.Collection)} or {@link #withUrls(java.util.Collection)} if you want to override the
* existing values.
*
*
* @param urls
* The URLs of the Microsoft SharePoint site that contains the documents that should be indexed.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SharePointConfiguration withUrls(String... urls) {
if (this.urls == null) {
setUrls(new java.util.ArrayList(urls.length));
}
for (String ele : urls) {
this.urls.add(ele);
}
return this;
}
/**
*
* The URLs of the Microsoft SharePoint site that contains the documents that should be indexed.
*
*
* @param urls
* The URLs of the Microsoft SharePoint site that contains the documents that should be indexed.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SharePointConfiguration withUrls(java.util.Collection urls) {
setUrls(urls);
return this;
}
/**
*
* 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.
*
*
* @param 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 void setSecretArn(String secretArn) {
this.secretArn = 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.
*
*
* @return 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 String getSecretArn() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SharePointConfiguration withSecretArn(String secretArn) {
setSecretArn(secretArn);
return this;
}
/**
*
* TRUE to include attachments to documents stored in your Microsoft SharePoint site in the index;
* otherwise, FALSE.
*
*
* @param crawlAttachments
* TRUE to include attachments to documents stored in your Microsoft SharePoint site in the
* index; otherwise, FALSE.
*/
public void setCrawlAttachments(Boolean crawlAttachments) {
this.crawlAttachments = crawlAttachments;
}
/**
*
* TRUE to include attachments to documents stored in your Microsoft SharePoint site in the index;
* otherwise, FALSE.
*
*
* @return TRUE to include attachments to documents stored in your Microsoft SharePoint site in the
* index; otherwise, FALSE.
*/
public Boolean getCrawlAttachments() {
return this.crawlAttachments;
}
/**
*
* TRUE to include attachments to documents stored in your Microsoft SharePoint site in the index;
* otherwise, FALSE.
*
*
* @param crawlAttachments
* TRUE to include attachments to documents stored in your Microsoft SharePoint site in the
* index; otherwise, FALSE.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SharePointConfiguration withCrawlAttachments(Boolean crawlAttachments) {
setCrawlAttachments(crawlAttachments);
return this;
}
/**
*
* TRUE to include attachments to documents stored in your Microsoft SharePoint site in the index;
* otherwise, FALSE.
*
*
* @return TRUE to include attachments to documents stored in your Microsoft SharePoint site in the
* index; otherwise, FALSE.
*/
public Boolean isCrawlAttachments() {
return this.crawlAttachments;
}
/**
* @param vpcConfiguration
*/
public void setVpcConfiguration(DataSourceVpcConfiguration vpcConfiguration) {
this.vpcConfiguration = vpcConfiguration;
}
/**
* @return
*/
public DataSourceVpcConfiguration getVpcConfiguration() {
return this.vpcConfiguration;
}
/**
* @param vpcConfiguration
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SharePointConfiguration withVpcConfiguration(DataSourceVpcConfiguration vpcConfiguration) {
setVpcConfiguration(vpcConfiguration);
return this;
}
/**
*
* 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.
*
*
* @return 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.
*/
public java.util.List getFieldMappings() {
return 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.
*
*
* @param 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.
*/
public void setFieldMappings(java.util.Collection fieldMappings) {
if (fieldMappings == null) {
this.fieldMappings = null;
return;
}
this.fieldMappings = new java.util.ArrayList(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.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setFieldMappings(java.util.Collection)} or {@link #withFieldMappings(java.util.Collection)} if you want
* to override the existing values.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SharePointConfiguration withFieldMappings(DataSourceToIndexFieldMapping... fieldMappings) {
if (this.fieldMappings == null) {
setFieldMappings(new java.util.ArrayList(fieldMappings.length));
}
for (DataSourceToIndexFieldMapping ele : fieldMappings) {
this.fieldMappings.add(ele);
}
return this;
}
/**
*
* 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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SharePointConfiguration withFieldMappings(java.util.Collection fieldMappings) {
setFieldMappings(fieldMappings);
return this;
}
/**
*
* The Microsoft SharePoint attribute field that contains the title of the document.
*
*
* @param documentTitleFieldName
* The Microsoft SharePoint attribute field that contains the title of the document.
*/
public void setDocumentTitleFieldName(String documentTitleFieldName) {
this.documentTitleFieldName = documentTitleFieldName;
}
/**
*
* The Microsoft SharePoint attribute field that contains the title of the document.
*
*
* @return The Microsoft SharePoint attribute field that contains the title of the document.
*/
public String getDocumentTitleFieldName() {
return this.documentTitleFieldName;
}
/**
*
* The Microsoft SharePoint attribute field that contains the title of the document.
*
*
* @param documentTitleFieldName
* The Microsoft SharePoint attribute field that contains the title of the document.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SharePointConfiguration withDocumentTitleFieldName(String documentTitleFieldName) {
setDocumentTitleFieldName(documentTitleFieldName);
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getSharePointVersion() != null)
sb.append("SharePointVersion: ").append(getSharePointVersion()).append(",");
if (getUrls() != null)
sb.append("Urls: ").append(getUrls()).append(",");
if (getSecretArn() != null)
sb.append("SecretArn: ").append(getSecretArn()).append(",");
if (getCrawlAttachments() != null)
sb.append("CrawlAttachments: ").append(getCrawlAttachments()).append(",");
if (getVpcConfiguration() != null)
sb.append("VpcConfiguration: ").append(getVpcConfiguration()).append(",");
if (getFieldMappings() != null)
sb.append("FieldMappings: ").append(getFieldMappings()).append(",");
if (getDocumentTitleFieldName() != null)
sb.append("DocumentTitleFieldName: ").append(getDocumentTitleFieldName());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof SharePointConfiguration == false)
return false;
SharePointConfiguration other = (SharePointConfiguration) obj;
if (other.getSharePointVersion() == null ^ this.getSharePointVersion() == null)
return false;
if (other.getSharePointVersion() != null && other.getSharePointVersion().equals(this.getSharePointVersion()) == false)
return false;
if (other.getUrls() == null ^ this.getUrls() == null)
return false;
if (other.getUrls() != null && other.getUrls().equals(this.getUrls()) == false)
return false;
if (other.getSecretArn() == null ^ this.getSecretArn() == null)
return false;
if (other.getSecretArn() != null && other.getSecretArn().equals(this.getSecretArn()) == false)
return false;
if (other.getCrawlAttachments() == null ^ this.getCrawlAttachments() == null)
return false;
if (other.getCrawlAttachments() != null && other.getCrawlAttachments().equals(this.getCrawlAttachments()) == false)
return false;
if (other.getVpcConfiguration() == null ^ this.getVpcConfiguration() == null)
return false;
if (other.getVpcConfiguration() != null && other.getVpcConfiguration().equals(this.getVpcConfiguration()) == false)
return false;
if (other.getFieldMappings() == null ^ this.getFieldMappings() == null)
return false;
if (other.getFieldMappings() != null && other.getFieldMappings().equals(this.getFieldMappings()) == false)
return false;
if (other.getDocumentTitleFieldName() == null ^ this.getDocumentTitleFieldName() == null)
return false;
if (other.getDocumentTitleFieldName() != null && other.getDocumentTitleFieldName().equals(this.getDocumentTitleFieldName()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getSharePointVersion() == null) ? 0 : getSharePointVersion().hashCode());
hashCode = prime * hashCode + ((getUrls() == null) ? 0 : getUrls().hashCode());
hashCode = prime * hashCode + ((getSecretArn() == null) ? 0 : getSecretArn().hashCode());
hashCode = prime * hashCode + ((getCrawlAttachments() == null) ? 0 : getCrawlAttachments().hashCode());
hashCode = prime * hashCode + ((getVpcConfiguration() == null) ? 0 : getVpcConfiguration().hashCode());
hashCode = prime * hashCode + ((getFieldMappings() == null) ? 0 : getFieldMappings().hashCode());
hashCode = prime * hashCode + ((getDocumentTitleFieldName() == null) ? 0 : getDocumentTitleFieldName().hashCode());
return hashCode;
}
@Override
public SharePointConfiguration clone() {
try {
return (SharePointConfiguration) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
@com.amazonaws.annotation.SdkInternalApi
@Override
public void marshall(ProtocolMarshaller protocolMarshaller) {
com.amazonaws.services.kendra.model.transform.SharePointConfigurationMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}