GoogleDriveConfiguration (AWS Java SDK :: Services

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

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<GoogleDriveConfiguration.Builder,GoogleDriveConfiguration>
```
@Generated(value="software.amazon.awssdk:codegen")
public final class GoogleDriveConfiguration
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<GoogleDriveConfiguration.Builder,GoogleDriveConfiguration>
```
Provides configuration information for data sources that connect to Google Drive.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface GoogleDriveConfiguration.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static GoogleDriveConfiguration.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`List<String>`	`excludeMimeTypes()` A list of MIME types to exclude from the index.
`List<String>`	`excludeSharedDrives()` A list of identifiers or shared drives to exclude from the index.
`List<String>`	`excludeUserAccounts()` A list of email addresses of the users.
`List<String>`	`exclusionPatterns()` A list of regular expression patterns that apply to the path on Google Drive.
`List<DataSourceToIndexFieldMapping>`	`fieldMappings()` Defines mapping between a field in the Google Drive and a Amazon Kendra index field.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasExcludeMimeTypes()` Returns true if the ExcludeMimeTypes property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasExcludeSharedDrives()` Returns true if the ExcludeSharedDrives property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasExcludeUserAccounts()` Returns true if the ExcludeUserAccounts property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasExclusionPatterns()` Returns true if the ExclusionPatterns property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasFieldMappings()` Returns true if the FieldMappings property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`int`	`hashCode()`
`boolean`	`hasInclusionPatterns()` Returns true if the InclusionPatterns property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`List<String>`	`inclusionPatterns()` A list of regular expression patterns that apply to path on Google Drive.
`List<SdkField<?>>`	`sdkFields()`
`String`	`secretArn()` The Amazon Resource Name (ARN) of a AWS Secrets Manager secret that contains the credentials required to connect to Google Drive.
`static Class<? extends GoogleDriveConfiguration.Builder>`	`serializableBuilderClass()`
`GoogleDriveConfiguration.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

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
  - secretArn
```
public final String secretArn()
```
    The Amazon Resource Name (ARN) of a AWS Secrets Manager secret that contains the credentials required to connect to Google Drive. For more information, see Using a Google Workspace Drive data source.
    
    Returns:
    
    The Amazon Resource Name (ARN) of a AWS Secrets Manager secret that contains the credentials required to connect to Google Drive. For more information, see Using a Google Workspace Drive data source.
  - hasInclusionPatterns
```
public final boolean hasInclusionPatterns()
```
    Returns true if the InclusionPatterns property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - inclusionPatterns
```
public final List<String> inclusionPatterns()
```
    A list of regular expression patterns that apply to path on Google Drive. Items that match the pattern are included in the index from both shared drives and users' My Drives. Items that don't match the pattern are excluded from the index. If an item matches both an inclusion pattern and an exclusion pattern, it is excluded from the index.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasInclusionPatterns() to see if a value was sent in this field.
    
    Returns:
    
    A list of regular expression patterns that apply to path on Google Drive. Items that match the pattern are included in the index from both shared drives and users' My Drives. Items that don't match the pattern are excluded from the index. If an item matches both an inclusion pattern and an exclusion pattern, it is excluded from the index.
  - hasExclusionPatterns
```
public final boolean hasExclusionPatterns()
```
    Returns true if the ExclusionPatterns property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - exclusionPatterns
```
public final List<String> exclusionPatterns()
```
    A list of regular expression patterns that apply to the path on Google Drive. Items that match the pattern are excluded from the index from both shared drives and users' My Drives. Items that don't match the pattern are included in the index. If an item matches both an exclusion pattern and an inclusion pattern, it is excluded from the index.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasExclusionPatterns() to see if a value was sent in this field.
    
    Returns:
    
    A list of regular expression patterns that apply to the path on Google Drive. Items that match the pattern are excluded from the index from both shared drives and users' My Drives. Items that don't match the pattern are included in the index. If an item matches both an exclusion pattern and an inclusion pattern, it is excluded from the index.
  - hasFieldMappings
```
public final boolean hasFieldMappings()
```
    Returns true if the FieldMappings property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - fieldMappings
```
public final List<DataSourceToIndexFieldMapping> fieldMappings()
```
    Defines mapping between a field in the Google Drive and a Amazon Kendra index field.
    
    If you are using the console, you can define index fields when creating the mapping. If you are using the API, you must first create the field using the UpdateIndex operation.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasFieldMappings() to see if a value was sent in this field.
    
    Returns:
    
    Defines mapping between a field in the Google Drive and a Amazon Kendra index field.
    
    If you are using the console, you can define index fields when creating the mapping. If you are using the API, you must first create the field using the UpdateIndex operation.
  - hasExcludeMimeTypes
```
public final boolean hasExcludeMimeTypes()
```
    Returns true if the ExcludeMimeTypes property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - excludeMimeTypes
```
public final List<String> excludeMimeTypes()
```
    A list of MIME types to exclude from the index. All documents matching the specified MIME type are excluded.
    
    For a list of MIME types, see Using a Google Workspace Drive data source.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasExcludeMimeTypes() to see if a value was sent in this field.
    
    Returns:
    
    A list of MIME types to exclude from the index. All documents matching the specified MIME type are excluded.
    
    For a list of MIME types, see Using a Google Workspace Drive data source.
  - hasExcludeUserAccounts
```
public final boolean hasExcludeUserAccounts()
```
    Returns true if the ExcludeUserAccounts property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - excludeUserAccounts
```
public final List<String> excludeUserAccounts()
```
    A list of email addresses of the users. Documents owned by these users are excluded from the index. Documents shared with excluded users are indexed unless they are excluded in another way.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasExcludeUserAccounts() to see if a value was sent in this field.
    
    Returns:
    
    A list of email addresses of the users. Documents owned by these users are excluded from the index. Documents shared with excluded users are indexed unless they are excluded in another way.
  - hasExcludeSharedDrives
```
public final boolean hasExcludeSharedDrives()
```
    Returns true if the ExcludeSharedDrives property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - excludeSharedDrives
```
public final List<String> excludeSharedDrives()
```
    A list of identifiers or shared drives to exclude from the index. All files and folders stored on the shared drive are excluded.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasExcludeSharedDrives() to see if a value was sent in this field.
    
    Returns:
    
    A list of identifiers or shared drives to exclude from the index. All files and folders stored on the shared drive are excluded.
  - toBuilder
```
public GoogleDriveConfiguration.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<GoogleDriveConfiguration.Builder,GoogleDriveConfiguration>
  - builder
```
public static GoogleDriveConfiguration.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends GoogleDriveConfiguration.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 GoogleDriveConfiguration

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

secretArn

hasInclusionPatterns

inclusionPatterns

hasExclusionPatterns

exclusionPatterns

hasFieldMappings

fieldMappings

hasExcludeMimeTypes

excludeMimeTypes

hasExcludeUserAccounts

excludeUserAccounts

hasExcludeSharedDrives

excludeSharedDrives

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields