QuipConfiguration.Builder (AWS Java SDK :: Services

All Superinterfaces:

Buildable, CopyableBuilder<QuipConfiguration.Builder,QuipConfiguration>, SdkBuilder<QuipConfiguration.Builder,QuipConfiguration>, SdkPojo

Enclosing class:

QuipConfiguration
```
public static interface QuipConfiguration.Builder
extends SdkPojo, CopyableBuilder<QuipConfiguration.Builder,QuipConfiguration>
```

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`QuipConfiguration.Builder`	`attachmentFieldMappings(Collection<DataSourceToIndexFieldMapping> attachmentFieldMappings)` A list of `DataSourceToIndexFieldMapping` objects that map attributes or field names of Quip attachments to Amazon Kendra index field names.
`QuipConfiguration.Builder`	`attachmentFieldMappings(Consumer<DataSourceToIndexFieldMapping.Builder>... attachmentFieldMappings)` A list of `DataSourceToIndexFieldMapping` objects that map attributes or field names of Quip attachments to Amazon Kendra index field names.
`QuipConfiguration.Builder`	`attachmentFieldMappings(DataSourceToIndexFieldMapping... attachmentFieldMappings)` A list of `DataSourceToIndexFieldMapping` objects that map attributes or field names of Quip attachments to Amazon Kendra index field names.
`QuipConfiguration.Builder`	`crawlAttachments(Boolean crawlAttachments)` `TRUE` to index attachments.
`QuipConfiguration.Builder`	`crawlChatRooms(Boolean crawlChatRooms)` `TRUE` to index the contents of chat rooms.
`QuipConfiguration.Builder`	`crawlFileComments(Boolean crawlFileComments)` `TRUE` to index file comments.
`QuipConfiguration.Builder`	`domain(String domain)` The Quip site domain.
`QuipConfiguration.Builder`	`exclusionPatterns(Collection<String> exclusionPatterns)` A list of regular expression patterns to exclude certain files in your Quip file system.
`QuipConfiguration.Builder`	`exclusionPatterns(String... exclusionPatterns)` A list of regular expression patterns to exclude certain files in your Quip file system.
`QuipConfiguration.Builder`	`folderIds(Collection<String> folderIds)` The identifiers of the Quip folders you want to index.
`QuipConfiguration.Builder`	`folderIds(String... folderIds)` The identifiers of the Quip folders you want to index.
`QuipConfiguration.Builder`	`inclusionPatterns(Collection<String> inclusionPatterns)` A list of regular expression patterns to include certain files in your Quip file system.
`QuipConfiguration.Builder`	`inclusionPatterns(String... inclusionPatterns)` A list of regular expression patterns to include certain files in your Quip file system.
`QuipConfiguration.Builder`	`messageFieldMappings(Collection<DataSourceToIndexFieldMapping> messageFieldMappings)` A list of `DataSourceToIndexFieldMapping` objects that map attributes or field names of Quip messages to Amazon Kendra index field names.
`QuipConfiguration.Builder`	`messageFieldMappings(Consumer<DataSourceToIndexFieldMapping.Builder>... messageFieldMappings)` A list of `DataSourceToIndexFieldMapping` objects that map attributes or field names of Quip messages to Amazon Kendra index field names.
`QuipConfiguration.Builder`	`messageFieldMappings(DataSourceToIndexFieldMapping... messageFieldMappings)` A list of `DataSourceToIndexFieldMapping` objects that map attributes or field names of Quip messages to Amazon Kendra index field names.
`QuipConfiguration.Builder`	`secretArn(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.
`QuipConfiguration.Builder`	`threadFieldMappings(Collection<DataSourceToIndexFieldMapping> threadFieldMappings)` A list of `DataSourceToIndexFieldMapping` objects that map attributes or field names of Quip threads to Amazon Kendra index field names.
`QuipConfiguration.Builder`	`threadFieldMappings(Consumer<DataSourceToIndexFieldMapping.Builder>... threadFieldMappings)` A list of `DataSourceToIndexFieldMapping` objects that map attributes or field names of Quip threads to Amazon Kendra index field names.
`QuipConfiguration.Builder`	`threadFieldMappings(DataSourceToIndexFieldMapping... threadFieldMappings)` A list of `DataSourceToIndexFieldMapping` objects that map attributes or field names of Quip threads to Amazon Kendra index field names.
`default QuipConfiguration.Builder`	`vpcConfiguration(Consumer<DataSourceVpcConfiguration.Builder> vpcConfiguration)` Configuration information for an Amazon Virtual Private Cloud (VPC) to connect to your Quip.
`QuipConfiguration.Builder`	`vpcConfiguration(DataSourceVpcConfiguration vpcConfiguration)` Configuration information for an Amazon Virtual Private Cloud (VPC) to connect to your Quip.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build

- Method Detail
  - domain
```
QuipConfiguration.Builder domain(String domain)
```
    The Quip site domain. For example, https://quip-company.quipdomain.com/browse. The domain in this example is "quipdomain".
    
    Parameters:
    
    domain - The Quip site domain. For example, https://quip-company.quipdomain.com/browse. The domain in this example is "quipdomain".
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - secretArn
```
QuipConfiguration.Builder secretArn(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. The secret must contain a JSON structure with the following keys:
    - accessToken—The token created in Quip. For more information, see Using a Quip data source.
    Parameters:
    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. The secret must contain a JSON structure with the following keys:
    
    accessToken—The token created in Quip. For more information, see Using a Quip data source.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - crawlFileComments
```
QuipConfiguration.Builder crawlFileComments(Boolean crawlFileComments)
```
    TRUE to index file comments.
    
    Parameters:
    
    crawlFileComments - TRUE to index file comments.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - crawlChatRooms
```
QuipConfiguration.Builder crawlChatRooms(Boolean crawlChatRooms)
```
    TRUE to index the contents of chat rooms.
    
    Parameters:
    
    crawlChatRooms - TRUE to index the contents of chat rooms.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - crawlAttachments
```
QuipConfiguration.Builder crawlAttachments(Boolean crawlAttachments)
```
    TRUE to index attachments.
    
    Parameters:
    
    crawlAttachments - TRUE to index attachments.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - folderIds
```
QuipConfiguration.Builder folderIds(Collection<String> folderIds)
```
    The identifiers of the Quip folders you want to index. You can find the folder ID in your browser URL when you access your folder in Quip. For example, https://quip-company.quipdomain.com/zlLuOVNSarTL/folder-name. The folder ID in this example is "zlLuOVNSarTL".
    
    Parameters:
    
    folderIds - The identifiers of the Quip folders you want to index. You can find the folder ID in your browser URL when you access your folder in Quip. For example, https://quip-company.quipdomain.com/zlLuOVNSarTL/folder-name. The folder ID in this example is "zlLuOVNSarTL".
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - folderIds
```
QuipConfiguration.Builder folderIds(String... folderIds)
```
    The identifiers of the Quip folders you want to index. You can find the folder ID in your browser URL when you access your folder in Quip. For example, https://quip-company.quipdomain.com/zlLuOVNSarTL/folder-name. The folder ID in this example is "zlLuOVNSarTL".
    
    Parameters:
    
    folderIds - The identifiers of the Quip folders you want to index. You can find the folder ID in your browser URL when you access your folder in Quip. For example, https://quip-company.quipdomain.com/zlLuOVNSarTL/folder-name. The folder ID in this example is "zlLuOVNSarTL".
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - threadFieldMappings
```
QuipConfiguration.Builder threadFieldMappings(Collection<DataSourceToIndexFieldMapping> threadFieldMappings)
```
    A list of DataSourceToIndexFieldMapping objects that map attributes or field names of Quip threads to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Quip fields. For more information, see Mapping data source fields. The Quip field names must exist in your Quip custom metadata.
    
    Parameters:
    
    threadFieldMappings - A list of DataSourceToIndexFieldMapping objects that map attributes or field names of Quip threads to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Quip fields. For more information, see Mapping data source fields. The Quip field names must exist in your Quip custom metadata.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - threadFieldMappings
```
QuipConfiguration.Builder threadFieldMappings(DataSourceToIndexFieldMapping... threadFieldMappings)
```
    A list of DataSourceToIndexFieldMapping objects that map attributes or field names of Quip threads to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Quip fields. For more information, see Mapping data source fields. The Quip field names must exist in your Quip custom metadata.
    
    Parameters:
    
    threadFieldMappings - A list of DataSourceToIndexFieldMapping objects that map attributes or field names of Quip threads to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Quip fields. For more information, see Mapping data source fields. The Quip field names must exist in your Quip custom metadata.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - threadFieldMappings
```
QuipConfiguration.Builder threadFieldMappings(Consumer<DataSourceToIndexFieldMapping.Builder>... threadFieldMappings)
```
    A list of DataSourceToIndexFieldMapping objects that map attributes or field names of Quip threads to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Quip fields. For more information, see Mapping data source fields. The Quip field names must exist in your Quip custom metadata.
    This is a convenience method that creates an instance of the DataSourceToIndexFieldMapping.Builder avoiding the need to create one manually via DataSourceToIndexFieldMapping.builder().
    When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #threadFieldMappings(List).
    
    Parameters:
    
    threadFieldMappings - a consumer that will call methods on DataSourceToIndexFieldMapping.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    #threadFieldMappings(java.util.Collection)
  - messageFieldMappings
```
QuipConfiguration.Builder messageFieldMappings(Collection<DataSourceToIndexFieldMapping> messageFieldMappings)
```
    A list of DataSourceToIndexFieldMapping objects that map attributes or field names of Quip messages to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Quip fields. For more information, see Mapping data source fields. The Quip field names must exist in your Quip custom metadata.
    
    Parameters:
    
    messageFieldMappings - A list of DataSourceToIndexFieldMapping objects that map attributes or field names of Quip messages to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Quip fields. For more information, see Mapping data source fields. The Quip field names must exist in your Quip custom metadata.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - messageFieldMappings
```
QuipConfiguration.Builder messageFieldMappings(DataSourceToIndexFieldMapping... messageFieldMappings)
```
    A list of DataSourceToIndexFieldMapping objects that map attributes or field names of Quip messages to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Quip fields. For more information, see Mapping data source fields. The Quip field names must exist in your Quip custom metadata.
    
    Parameters:
    
    messageFieldMappings - A list of DataSourceToIndexFieldMapping objects that map attributes or field names of Quip messages to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Quip fields. For more information, see Mapping data source fields. The Quip field names must exist in your Quip custom metadata.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - messageFieldMappings
```
QuipConfiguration.Builder messageFieldMappings(Consumer<DataSourceToIndexFieldMapping.Builder>... messageFieldMappings)
```
    A list of DataSourceToIndexFieldMapping objects that map attributes or field names of Quip messages to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Quip fields. For more information, see Mapping data source fields. The Quip field names must exist in your Quip custom metadata.
    This is a convenience method that creates an instance of the DataSourceToIndexFieldMapping.Builder avoiding the need to create one manually via DataSourceToIndexFieldMapping.builder().
    When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #messageFieldMappings(List).
    
    Parameters:
    
    messageFieldMappings - a consumer that will call methods on DataSourceToIndexFieldMapping.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    #messageFieldMappings(java.util.Collection)
  - attachmentFieldMappings
```
QuipConfiguration.Builder attachmentFieldMappings(Collection<DataSourceToIndexFieldMapping> attachmentFieldMappings)
```
    A list of DataSourceToIndexFieldMapping objects that map attributes or field names of Quip attachments to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Quip fields. For more information, see Mapping data source fields. The Quip field names must exist in your Quip custom metadata.
    
    Parameters:
    
    attachmentFieldMappings - A list of DataSourceToIndexFieldMapping objects that map attributes or field names of Quip attachments to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Quip fields. For more information, see Mapping data source fields. The Quip field names must exist in your Quip custom metadata.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - attachmentFieldMappings
```
QuipConfiguration.Builder attachmentFieldMappings(DataSourceToIndexFieldMapping... attachmentFieldMappings)
```
    A list of DataSourceToIndexFieldMapping objects that map attributes or field names of Quip attachments to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Quip fields. For more information, see Mapping data source fields. The Quip field names must exist in your Quip custom metadata.
    
    Parameters:
    
    attachmentFieldMappings - A list of DataSourceToIndexFieldMapping objects that map attributes or field names of Quip attachments to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Quip fields. For more information, see Mapping data source fields. The Quip field names must exist in your Quip custom metadata.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - attachmentFieldMappings
```
QuipConfiguration.Builder attachmentFieldMappings(Consumer<DataSourceToIndexFieldMapping.Builder>... attachmentFieldMappings)
```
    A list of DataSourceToIndexFieldMapping objects that map attributes or field names of Quip attachments to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Quip fields. For more information, see Mapping data source fields. The Quip field names must exist in your Quip custom metadata.
    This is a convenience method that creates an instance of the DataSourceToIndexFieldMapping.Builder avoiding the need to create one manually via DataSourceToIndexFieldMapping.builder().
    When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #attachmentFieldMappings(List).
    
    Parameters:
    
    attachmentFieldMappings - a consumer that will call methods on DataSourceToIndexFieldMapping.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    #attachmentFieldMappings(java.util.Collection)
  - inclusionPatterns
```
QuipConfiguration.Builder inclusionPatterns(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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - inclusionPatterns
```
QuipConfiguration.Builder inclusionPatterns(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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - exclusionPatterns
```
QuipConfiguration.Builder exclusionPatterns(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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - exclusionPatterns
```
QuipConfiguration.Builder exclusionPatterns(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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - vpcConfiguration
```
QuipConfiguration.Builder vpcConfiguration(DataSourceVpcConfiguration vpcConfiguration)
```
    Configuration information for an Amazon Virtual Private Cloud (VPC) to connect to your Quip. For more information, see Configuring a VPC.
    
    Parameters:
    
    vpcConfiguration - Configuration information for an Amazon Virtual Private Cloud (VPC) to connect to your Quip. For more information, see Configuring a VPC.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - vpcConfiguration
```
default QuipConfiguration.Builder vpcConfiguration(Consumer<DataSourceVpcConfiguration.Builder> vpcConfiguration)
```
    Configuration information for an Amazon Virtual Private Cloud (VPC) to connect to your Quip. For more information, see Configuring a VPC.
    This is a convenience method that creates an instance of the DataSourceVpcConfiguration.Builder avoiding the need to create one manually via DataSourceVpcConfiguration.builder().
    When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to vpcConfiguration(DataSourceVpcConfiguration).
    
    Parameters:
    
    vpcConfiguration - a consumer that will call methods on DataSourceVpcConfiguration.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    vpcConfiguration(DataSourceVpcConfiguration)

Interface QuipConfiguration.Builder

Method Summary

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

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

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

Method Detail

domain

secretArn

crawlFileComments

crawlChatRooms

crawlAttachments

folderIds

folderIds

threadFieldMappings

threadFieldMappings

threadFieldMappings

messageFieldMappings

messageFieldMappings

messageFieldMappings

attachmentFieldMappings

attachmentFieldMappings

attachmentFieldMappings

inclusionPatterns

inclusionPatterns

exclusionPatterns

exclusionPatterns

vpcConfiguration

vpcConfiguration