software.amazon.awssdk.services.kendra.model

Class GoogleDriveConfiguration

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 the configuration information to connect to Google Drive as your data source.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GoogleDriveConfiguration.Builder

Method Summary

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 to exclude certain items in your Google Drive, including shared drives and users' My Drives.
List<DataSourceToIndexFieldMapping>	fieldMappings() Maps Google Drive data source attributes or field names to Amazon Kendra index field names.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasExcludeMimeTypes() For responses, this returns true if the service returned a value for the ExcludeMimeTypes property.
boolean	hasExcludeSharedDrives() For responses, this returns true if the service returned a value for the ExcludeSharedDrives property.
boolean	hasExcludeUserAccounts() For responses, this returns true if the service returned a value for the ExcludeUserAccounts property.
boolean	hasExclusionPatterns() For responses, this returns true if the service returned a value for the ExclusionPatterns property.
boolean	hasFieldMappings() For responses, this returns true if the service returned a value for the FieldMappings property.
int	hashCode()
boolean	hasInclusionPatterns() For responses, this returns true if the service returned a value for the InclusionPatterns property.
List<String>	inclusionPatterns() A list of regular expression patterns to include certain items in your Google Drive, including shared drives and users' My Drives.
List<SdkField<?>>	sdkFields()
String	secretArn() The Amazon Resource Name (ARN) of a Secrets Managersecret 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 Secrets Managersecret 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 Secrets Managersecret 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()

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 items in your Google Drive, including shared drives and users' My Drives. Items that match the patterns are included in the index. Items that don't match the patterns are excluded from the index. If an item matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the item 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 items in your Google Drive, including shared drives and users' My Drives. Items that match the patterns are included in the index. Items that don't match the patterns are excluded from the index. If an item matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the item 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 items in your Google Drive, including shared drives and users' My Drives. Items that match the patterns are excluded from the index. Items that don't match the patterns are included in the index. If an item matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the item 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 items in your Google Drive, including shared drives and users' My Drives. Items that match the patterns are excluded from the index. Items that don't match the patterns are included in the index. If an item matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the item isn't included in the index.

hasFieldMappings

public final boolean hasFieldMappings()

For responses, this returns true if the service returned a value for the FieldMappings 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.

fieldMappings

public final List<DataSourceToIndexFieldMapping> fieldMappings()

Maps Google Drive data source attributes or field names to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Google Drive fields. For more information, see Mapping data source fields. The Google Drive data source field names must exist in your Google Drive 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 hasFieldMappings() method.

Returns:

Maps Google Drive data source attributes or field names to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Google Drive fields. For more information, see Mapping data source fields. The Google Drive data source field names must exist in your Google Drive custom metadata.

hasExcludeMimeTypes

public final boolean hasExcludeMimeTypes()

For responses, this returns true if the service returned a value for the ExcludeMimeTypes 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.

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.

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 hasExcludeMimeTypes() method.

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()

For responses, this returns true if the service returned a value for the ExcludeUserAccounts 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.

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.

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 hasExcludeUserAccounts() method.

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()

For responses, this returns true if the service returned a value for the ExcludeSharedDrives 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.

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.

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 hasExcludeSharedDrives() method.

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