@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class QuipConfiguration extends Object implements Serializable, Cloneable, StructuredPojo
Provides the configuration information to connect to Quip as your data source.
Constructor and Description |
---|
QuipConfiguration() |
Modifier and Type | Method and Description |
---|---|
QuipConfiguration |
clone() |
boolean |
equals(Object obj) |
List<DataSourceToIndexFieldMapping> |
getAttachmentFieldMappings()
A list of field mappings to apply when indexing Quip attachments.
|
Boolean |
getCrawlAttachments()
Specify whether to crawl attachments in your Quip data source.
|
Boolean |
getCrawlChatRooms()
Specify whether to crawl chat rooms in your Quip data source.
|
Boolean |
getCrawlFileComments()
Specify whether to crawl file comments in your Quip data source.
|
String |
getDomain()
The configuration information to connect to your Quip data source domain.
|
List<String> |
getExclusionPatterns()
A list of regular expression patterns to exclude certain files in your Quip file system.
|
List<String> |
getFolderIds()
The identifier of the Quip folder IDs to index.
|
List<String> |
getInclusionPatterns()
A list of regular expression patterns to include certain files in your Quip file system.
|
List<DataSourceToIndexFieldMapping> |
getMessageFieldMappings()
A list of field mappings to apply when indexing Quip messages.
|
String |
getSecretArn()
The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the key-value pairs that are required
to connect to your Quip file system.
|
List<DataSourceToIndexFieldMapping> |
getThreadFieldMappings()
A list of field mappings to apply when indexing Quip threads.
|
DataSourceVpcConfiguration |
getVpcConfiguration()
Configuration information for connecting to an Amazon Virtual Private Cloud (VPC) for your Quip.
|
int |
hashCode() |
Boolean |
isCrawlAttachments()
Specify whether to crawl attachments in your Quip data source.
|
Boolean |
isCrawlChatRooms()
Specify whether to crawl chat rooms in your Quip data source.
|
Boolean |
isCrawlFileComments()
Specify whether to crawl file comments in your Quip data source.
|
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setAttachmentFieldMappings(Collection<DataSourceToIndexFieldMapping> attachmentFieldMappings)
A list of field mappings to apply when indexing Quip attachments.
|
void |
setCrawlAttachments(Boolean crawlAttachments)
Specify whether to crawl attachments in your Quip data source.
|
void |
setCrawlChatRooms(Boolean crawlChatRooms)
Specify whether to crawl chat rooms in your Quip data source.
|
void |
setCrawlFileComments(Boolean crawlFileComments)
Specify whether to crawl file comments in your Quip data source.
|
void |
setDomain(String domain)
The configuration information to connect to your Quip data source domain.
|
void |
setExclusionPatterns(Collection<String> exclusionPatterns)
A list of regular expression patterns to exclude certain files in your Quip file system.
|
void |
setFolderIds(Collection<String> folderIds)
The identifier of the Quip folder IDs to index.
|
void |
setInclusionPatterns(Collection<String> inclusionPatterns)
A list of regular expression patterns to include certain files in your Quip file system.
|
void |
setMessageFieldMappings(Collection<DataSourceToIndexFieldMapping> messageFieldMappings)
A list of field mappings to apply when indexing Quip messages.
|
void |
setSecretArn(String secretArn)
The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the key-value pairs that are required
to connect to your Quip file system.
|
void |
setThreadFieldMappings(Collection<DataSourceToIndexFieldMapping> threadFieldMappings)
A list of field mappings to apply when indexing Quip threads.
|
void |
setVpcConfiguration(DataSourceVpcConfiguration vpcConfiguration)
Configuration information for connecting to an Amazon Virtual Private Cloud (VPC) for your Quip.
|
String |
toString()
Returns a string representation of this object.
|
QuipConfiguration |
withAttachmentFieldMappings(Collection<DataSourceToIndexFieldMapping> attachmentFieldMappings)
A list of field mappings to apply when indexing Quip attachments.
|
QuipConfiguration |
withAttachmentFieldMappings(DataSourceToIndexFieldMapping... attachmentFieldMappings)
A list of field mappings to apply when indexing Quip attachments.
|
QuipConfiguration |
withCrawlAttachments(Boolean crawlAttachments)
Specify whether to crawl attachments in your Quip data source.
|
QuipConfiguration |
withCrawlChatRooms(Boolean crawlChatRooms)
Specify whether to crawl chat rooms in your Quip data source.
|
QuipConfiguration |
withCrawlFileComments(Boolean crawlFileComments)
Specify whether to crawl file comments in your Quip data source.
|
QuipConfiguration |
withDomain(String domain)
The configuration information to connect to your Quip data source domain.
|
QuipConfiguration |
withExclusionPatterns(Collection<String> exclusionPatterns)
A list of regular expression patterns to exclude certain files in your Quip file system.
|
QuipConfiguration |
withExclusionPatterns(String... exclusionPatterns)
A list of regular expression patterns to exclude certain files in your Quip file system.
|
QuipConfiguration |
withFolderIds(Collection<String> folderIds)
The identifier of the Quip folder IDs to index.
|
QuipConfiguration |
withFolderIds(String... folderIds)
The identifier of the Quip folder IDs to index.
|
QuipConfiguration |
withInclusionPatterns(Collection<String> inclusionPatterns)
A list of regular expression patterns to include certain files in your Quip file system.
|
QuipConfiguration |
withInclusionPatterns(String... inclusionPatterns)
A list of regular expression patterns to include certain files in your Quip file system.
|
QuipConfiguration |
withMessageFieldMappings(Collection<DataSourceToIndexFieldMapping> messageFieldMappings)
A list of field mappings to apply when indexing Quip messages.
|
QuipConfiguration |
withMessageFieldMappings(DataSourceToIndexFieldMapping... messageFieldMappings)
A list of field mappings to apply when indexing Quip messages.
|
QuipConfiguration |
withSecretArn(String secretArn)
The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the key-value pairs that are required
to connect to your Quip file system.
|
QuipConfiguration |
withThreadFieldMappings(Collection<DataSourceToIndexFieldMapping> threadFieldMappings)
A list of field mappings to apply when indexing Quip threads.
|
QuipConfiguration |
withThreadFieldMappings(DataSourceToIndexFieldMapping... threadFieldMappings)
A list of field mappings to apply when indexing Quip threads.
|
QuipConfiguration |
withVpcConfiguration(DataSourceVpcConfiguration vpcConfiguration)
Configuration information for connecting to an Amazon Virtual Private Cloud (VPC) for your Quip.
|
public void setDomain(String domain)
The configuration information to connect to your Quip data source domain.
domain
- The configuration information to connect to your Quip data source domain.public String getDomain()
The configuration information to connect to your Quip data source domain.
public QuipConfiguration withDomain(String domain)
The configuration information to connect to your Quip data source domain.
domain
- The configuration information to connect to your Quip data source domain.public void setSecretArn(String secretArn)
The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the key-value pairs that are required to connect to your Quip file system. Windows is currently the only supported type. The secret must contain a JSON structure with the following keys:
username—The Active Directory user name, along with the Domain Name System (DNS) domain name. For example, [email protected]. The Active Directory user account must have read and mounting access to the Quip file system for Windows.
password—The password of the Active Directory user account with read and mounting access to the Quip Windows file system.
secretArn
- The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the key-value pairs that are
required to connect to your Quip file system. Windows is currently the only supported type. The secret
must contain a JSON structure with the following keys:
username—The Active Directory user name, along with the Domain Name System (DNS) domain name. For example, [email protected]. The Active Directory user account must have read and mounting access to the Quip file system for Windows.
password—The password of the Active Directory user account with read and mounting access to the Quip Windows file system.
public String getSecretArn()
The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the key-value pairs that are required to connect to your Quip file system. Windows is currently the only supported type. The secret must contain a JSON structure with the following keys:
username—The Active Directory user name, along with the Domain Name System (DNS) domain name. For example, [email protected]. The Active Directory user account must have read and mounting access to the Quip file system for Windows.
password—The password of the Active Directory user account with read and mounting access to the Quip Windows file system.
username—The Active Directory user name, along with the Domain Name System (DNS) domain name. For example, [email protected]. The Active Directory user account must have read and mounting access to the Quip file system for Windows.
password—The password of the Active Directory user account with read and mounting access to the Quip Windows file system.
public QuipConfiguration withSecretArn(String secretArn)
The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the key-value pairs that are required to connect to your Quip file system. Windows is currently the only supported type. The secret must contain a JSON structure with the following keys:
username—The Active Directory user name, along with the Domain Name System (DNS) domain name. For example, [email protected]. The Active Directory user account must have read and mounting access to the Quip file system for Windows.
password—The password of the Active Directory user account with read and mounting access to the Quip Windows file system.
secretArn
- The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the key-value pairs that are
required to connect to your Quip file system. Windows is currently the only supported type. The secret
must contain a JSON structure with the following keys:
username—The Active Directory user name, along with the Domain Name System (DNS) domain name. For example, [email protected]. The Active Directory user account must have read and mounting access to the Quip file system for Windows.
password—The password of the Active Directory user account with read and mounting access to the Quip Windows file system.
public void setCrawlFileComments(Boolean crawlFileComments)
Specify whether to crawl file comments in your Quip data source. You can specify one or more of these options.
crawlFileComments
- Specify whether to crawl file comments in your Quip data source. You can specify one or more of these
options.public Boolean getCrawlFileComments()
Specify whether to crawl file comments in your Quip data source. You can specify one or more of these options.
public QuipConfiguration withCrawlFileComments(Boolean crawlFileComments)
Specify whether to crawl file comments in your Quip data source. You can specify one or more of these options.
crawlFileComments
- Specify whether to crawl file comments in your Quip data source. You can specify one or more of these
options.public Boolean isCrawlFileComments()
Specify whether to crawl file comments in your Quip data source. You can specify one or more of these options.
public void setCrawlChatRooms(Boolean crawlChatRooms)
Specify whether to crawl chat rooms in your Quip data source. You can specify one or more of these options.
crawlChatRooms
- Specify whether to crawl chat rooms in your Quip data source. You can specify one or more of these
options.public Boolean getCrawlChatRooms()
Specify whether to crawl chat rooms in your Quip data source. You can specify one or more of these options.
public QuipConfiguration withCrawlChatRooms(Boolean crawlChatRooms)
Specify whether to crawl chat rooms in your Quip data source. You can specify one or more of these options.
crawlChatRooms
- Specify whether to crawl chat rooms in your Quip data source. You can specify one or more of these
options.public Boolean isCrawlChatRooms()
Specify whether to crawl chat rooms in your Quip data source. You can specify one or more of these options.
public void setCrawlAttachments(Boolean crawlAttachments)
Specify whether to crawl attachments in your Quip data source. You can specify one or more of these options.
crawlAttachments
- Specify whether to crawl attachments in your Quip data source. You can specify one or more of these
options.public Boolean getCrawlAttachments()
Specify whether to crawl attachments in your Quip data source. You can specify one or more of these options.
public QuipConfiguration withCrawlAttachments(Boolean crawlAttachments)
Specify whether to crawl attachments in your Quip data source. You can specify one or more of these options.
crawlAttachments
- Specify whether to crawl attachments in your Quip data source. You can specify one or more of these
options.public Boolean isCrawlAttachments()
Specify whether to crawl attachments in your Quip data source. You can specify one or more of these options.
public List<String> getFolderIds()
The identifier of the Quip folder IDs to index.
public void setFolderIds(Collection<String> folderIds)
The identifier of the Quip folder IDs to index.
folderIds
- The identifier of the Quip folder IDs to index.public QuipConfiguration withFolderIds(String... folderIds)
The identifier of the Quip folder IDs to index.
NOTE: This method appends the values to the existing list (if any). Use
setFolderIds(java.util.Collection)
or withFolderIds(java.util.Collection)
if you want to
override the existing values.
folderIds
- The identifier of the Quip folder IDs to index.public QuipConfiguration withFolderIds(Collection<String> folderIds)
The identifier of the Quip folder IDs to index.
folderIds
- The identifier of the Quip folder IDs to index.public List<DataSourceToIndexFieldMapping> getThreadFieldMappings()
A list of field mappings to apply when indexing Quip threads.
public void setThreadFieldMappings(Collection<DataSourceToIndexFieldMapping> threadFieldMappings)
A list of field mappings to apply when indexing Quip threads.
threadFieldMappings
- A list of field mappings to apply when indexing Quip threads.public QuipConfiguration withThreadFieldMappings(DataSourceToIndexFieldMapping... threadFieldMappings)
A list of field mappings to apply when indexing Quip threads.
NOTE: This method appends the values to the existing list (if any). Use
setThreadFieldMappings(java.util.Collection)
or withThreadFieldMappings(java.util.Collection)
if you want to override the existing values.
threadFieldMappings
- A list of field mappings to apply when indexing Quip threads.public QuipConfiguration withThreadFieldMappings(Collection<DataSourceToIndexFieldMapping> threadFieldMappings)
A list of field mappings to apply when indexing Quip threads.
threadFieldMappings
- A list of field mappings to apply when indexing Quip threads.public List<DataSourceToIndexFieldMapping> getMessageFieldMappings()
A list of field mappings to apply when indexing Quip messages.
public void setMessageFieldMappings(Collection<DataSourceToIndexFieldMapping> messageFieldMappings)
A list of field mappings to apply when indexing Quip messages.
messageFieldMappings
- A list of field mappings to apply when indexing Quip messages.public QuipConfiguration withMessageFieldMappings(DataSourceToIndexFieldMapping... messageFieldMappings)
A list of field mappings to apply when indexing Quip messages.
NOTE: This method appends the values to the existing list (if any). Use
setMessageFieldMappings(java.util.Collection)
or withMessageFieldMappings(java.util.Collection)
if you want to override the existing values.
messageFieldMappings
- A list of field mappings to apply when indexing Quip messages.public QuipConfiguration withMessageFieldMappings(Collection<DataSourceToIndexFieldMapping> messageFieldMappings)
A list of field mappings to apply when indexing Quip messages.
messageFieldMappings
- A list of field mappings to apply when indexing Quip messages.public List<DataSourceToIndexFieldMapping> getAttachmentFieldMappings()
A list of field mappings to apply when indexing Quip attachments.
public void setAttachmentFieldMappings(Collection<DataSourceToIndexFieldMapping> attachmentFieldMappings)
A list of field mappings to apply when indexing Quip attachments.
attachmentFieldMappings
- A list of field mappings to apply when indexing Quip attachments.public QuipConfiguration withAttachmentFieldMappings(DataSourceToIndexFieldMapping... attachmentFieldMappings)
A list of field mappings to apply when indexing Quip attachments.
NOTE: This method appends the values to the existing list (if any). Use
setAttachmentFieldMappings(java.util.Collection)
or
withAttachmentFieldMappings(java.util.Collection)
if you want to override the existing values.
attachmentFieldMappings
- A list of field mappings to apply when indexing Quip attachments.public QuipConfiguration withAttachmentFieldMappings(Collection<DataSourceToIndexFieldMapping> attachmentFieldMappings)
A list of field mappings to apply when indexing Quip attachments.
attachmentFieldMappings
- A list of field mappings to apply when indexing Quip attachments.public List<String> getInclusionPatterns()
A list of regular expression patterns to include certain files in your Quip file system. 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.
public void setInclusionPatterns(Collection<String> inclusionPatterns)
A list of regular expression patterns to include certain files in your Quip file system. 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.
inclusionPatterns
- A list of regular expression patterns to include certain files in your Quip file system. 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.public QuipConfiguration withInclusionPatterns(String... inclusionPatterns)
A list of regular expression patterns to include certain files in your Quip file system. 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.
NOTE: This method appends the values to the existing list (if any). Use
setInclusionPatterns(java.util.Collection)
or withInclusionPatterns(java.util.Collection)
if
you want to override the existing values.
inclusionPatterns
- A list of regular expression patterns to include certain files in your Quip file system. 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.public QuipConfiguration withInclusionPatterns(Collection<String> inclusionPatterns)
A list of regular expression patterns to include certain files in your Quip file system. 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.
inclusionPatterns
- A list of regular expression patterns to include certain files in your Quip file system. 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.public List<String> getExclusionPatterns()
A list of regular expression patterns to exclude certain files in your Quip file system. 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.
public void setExclusionPatterns(Collection<String> exclusionPatterns)
A list of regular expression patterns to exclude certain files in your Quip file system. 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.
exclusionPatterns
- A list of regular expression patterns to exclude certain files in your Quip file system. 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.public QuipConfiguration withExclusionPatterns(String... exclusionPatterns)
A list of regular expression patterns to exclude certain files in your Quip file system. 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.
NOTE: This method appends the values to the existing list (if any). Use
setExclusionPatterns(java.util.Collection)
or withExclusionPatterns(java.util.Collection)
if
you want to override the existing values.
exclusionPatterns
- A list of regular expression patterns to exclude certain files in your Quip file system. 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.public QuipConfiguration withExclusionPatterns(Collection<String> exclusionPatterns)
A list of regular expression patterns to exclude certain files in your Quip file system. 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.
exclusionPatterns
- A list of regular expression patterns to exclude certain files in your Quip file system. 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.public void setVpcConfiguration(DataSourceVpcConfiguration vpcConfiguration)
Configuration information for connecting to an Amazon Virtual Private Cloud (VPC) for your Quip. Your Quip instance must reside inside your VPC.
vpcConfiguration
- Configuration information for connecting to an Amazon Virtual Private Cloud (VPC) for your Quip. Your Quip
instance must reside inside your VPC.public DataSourceVpcConfiguration getVpcConfiguration()
Configuration information for connecting to an Amazon Virtual Private Cloud (VPC) for your Quip. Your Quip instance must reside inside your VPC.
public QuipConfiguration withVpcConfiguration(DataSourceVpcConfiguration vpcConfiguration)
Configuration information for connecting to an Amazon Virtual Private Cloud (VPC) for your Quip. Your Quip instance must reside inside your VPC.
vpcConfiguration
- Configuration information for connecting to an Amazon Virtual Private Cloud (VPC) for your Quip. Your Quip
instance must reside inside your VPC.public String toString()
toString
in class Object
Object.toString()
public QuipConfiguration clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.