QuipConfiguration (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.services.kendra.model.QuipConfiguration

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<QuipConfiguration.Builder,QuipConfiguration>
```
@Generated(value="software.amazon.awssdk:codegen")
public final class QuipConfiguration
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<QuipConfiguration.Builder,QuipConfiguration>
```
Provides the configuration information to connect to Quip as your data source.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface QuipConfiguration.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`QuipConfiguration.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`List<DataSourceToIndexFieldMapping>`	`attachmentFieldMappings()` A list of `DataSourceToIndexFieldMapping` objects that map attributes or field names of Quip attachments to Amazon Kendra index field names.
`static QuipConfiguration.Builder`	`builder()`
`Boolean`	`crawlAttachments()` `TRUE` to index attachments.
`Boolean`	`crawlChatRooms()` `TRUE` to index the contents of chat rooms.
`Boolean`	`crawlFileComments()` `TRUE` to index file comments.
`String`	`domain()` The Quip site domain.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`List<String>`	`exclusionPatterns()` A list of regular expression patterns to exclude certain files in your Quip file system.
`List<String>`	`folderIds()` The identifiers of the Quip folders you want to index.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasAttachmentFieldMappings()` For responses, this returns true if the service returned a value for the AttachmentFieldMappings property.
`boolean`	`hasExclusionPatterns()` For responses, this returns true if the service returned a value for the ExclusionPatterns property.
`boolean`	`hasFolderIds()` For responses, this returns true if the service returned a value for the FolderIds property.
`int`	`hashCode()`
`boolean`	`hasInclusionPatterns()` For responses, this returns true if the service returned a value for the InclusionPatterns property.
`boolean`	`hasMessageFieldMappings()` For responses, this returns true if the service returned a value for the MessageFieldMappings property.
`boolean`	`hasThreadFieldMappings()` For responses, this returns true if the service returned a value for the ThreadFieldMappings property.
`List<String>`	`inclusionPatterns()` A list of regular expression patterns to include certain files in your Quip file system.
`List<DataSourceToIndexFieldMapping>`	`messageFieldMappings()` A list of `DataSourceToIndexFieldMapping` objects that map attributes or field names of Quip messages to Amazon Kendra index field names.
`List<SdkField<?>>`	`sdkFields()`
`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.
`static Class<? extends QuipConfiguration.Builder>`	`serializableBuilderClass()`
`List<DataSourceToIndexFieldMapping>`	`threadFieldMappings()` A list of `DataSourceToIndexFieldMapping` objects that map attributes or field names of Quip threads to Amazon Kendra index field names.
`QuipConfiguration.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`DataSourceVpcConfiguration`	`vpcConfiguration()` Configuration information for an Amazon Virtual Private Cloud (VPC) to connect to your Quip.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

- Method Detail
  - domain
```
public final String domain()
```
    The Quip site domain. For example, https://quip-company.quipdomain.com/browse. The domain in this example is "quipdomain".
    
    Returns:
    
    The Quip site domain. For example, https://quip-company.quipdomain.com/browse. The domain in this example is "quipdomain".
  - secretArn
```
public final 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.
    Returns:
    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.
  - crawlFileComments
```
public final Boolean crawlFileComments()
```
    TRUE to index file comments.
    
    Returns:
    
    TRUE to index file comments.
  - crawlChatRooms
```
public final Boolean crawlChatRooms()
```
    TRUE to index the contents of chat rooms.
    
    Returns:
    
    TRUE to index the contents of chat rooms.
  - crawlAttachments
```
public final Boolean crawlAttachments()
```
    TRUE to index attachments.
    
    Returns:
    
    TRUE to index attachments.
  - hasFolderIds
```
public final boolean hasFolderIds()
```
    For responses, this returns true if the service returned a value for the FolderIds property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() 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.
  - folderIds
```
public final List<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".
    
    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 hasFolderIds() method.
    
    Returns:
    
    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".
  - hasThreadFieldMappings
```
public final boolean hasThreadFieldMappings()
```
    For responses, this returns true if the service returned a value for the ThreadFieldMappings property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() 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.
  - threadFieldMappings
```
public final List<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.
    
    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 hasThreadFieldMappings() method.
    
    Returns:
    
    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.
  - hasMessageFieldMappings
```
public final boolean hasMessageFieldMappings()
```
    For responses, this returns true if the service returned a value for the MessageFieldMappings property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() 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.
  - messageFieldMappings
```
public final List<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.
    
    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 hasMessageFieldMappings() method.
    
    Returns:
    
    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.
  - hasAttachmentFieldMappings
```
public final boolean hasAttachmentFieldMappings()
```
    For responses, this returns true if the service returned a value for the AttachmentFieldMappings property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() 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.
  - attachmentFieldMappings
```
public final List<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.
    
    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 hasAttachmentFieldMappings() method.
    
    Returns:
    
    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.
  - 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 the isEmpty() 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
```
public final List<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.
    
    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 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.
  - 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 the isEmpty() 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
```
public final List<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.
    
    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 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.
  - vpcConfiguration
```
public final DataSourceVpcConfiguration vpcConfiguration()
```
    Configuration information for an Amazon Virtual Private Cloud (VPC) to connect to your Quip. For more information, see Configuring a VPC.
    
    Returns:
    
    Configuration information for an Amazon Virtual Private Cloud (VPC) to connect to your Quip. For more information, see Configuring a VPC.
  - toBuilder
```
public QuipConfiguration.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<QuipConfiguration.Builder,QuipConfiguration>
  - builder
```
public static QuipConfiguration.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends QuipConfiguration.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String 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.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class QuipConfiguration

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

domain

secretArn

crawlFileComments

crawlChatRooms

crawlAttachments

hasFolderIds

folderIds

hasThreadFieldMappings

threadFieldMappings

hasMessageFieldMappings

messageFieldMappings

hasAttachmentFieldMappings

attachmentFieldMappings

hasInclusionPatterns

inclusionPatterns

hasExclusionPatterns

exclusionPatterns

vpcConfiguration

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields