/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.kendra.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.protocol.StructuredPojo; import com.amazonaws.protocol.ProtocolMarshaller; /** *
* Provides the configuration information to connect to Google Drive as your data source. *
* * @see AWS * API Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class GoogleDriveConfiguration implements Serializable, Cloneable, StructuredPojo { /** ** 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. *
*/ private String secretArn; /** ** 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. *
*/ private java.util.List* 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. *
*/ private java.util.List
* 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.
*
* 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. *
*/ private java.util.List* 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. *
*/ private java.util.List* A list of identifiers or shared drives to exclude from the index. All files and folders stored on the shared * drive are excluded. *
*/ private java.util.List* 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. *
* * @param 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. */ public void setSecretArn(String secretArn) { this.secretArn = 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. *
* * @return 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. */ public String getSecretArn() { return this.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. *
* * @param 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. * @return Returns a reference to this object so that method calls can be chained together. */ public GoogleDriveConfiguration withSecretArn(String secretArn) { setSecretArn(secretArn); return this; } /** ** 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. *
* * @return 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. */ public java.util.List* 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. *
* * @param 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. */ public void setInclusionPatterns(java.util.Collection* 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. *
** NOTE: This method appends the values to the existing list (if any). Use * {@link #setInclusionPatterns(java.util.Collection)} or {@link #withInclusionPatterns(java.util.Collection)} if * you want to override the existing values. *
* * @param 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. * @return Returns a reference to this object so that method calls can be chained together. */ public GoogleDriveConfiguration withInclusionPatterns(String... inclusionPatterns) { if (this.inclusionPatterns == null) { setInclusionPatterns(new java.util.ArrayList* 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. *
* * @param 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. * @return Returns a reference to this object so that method calls can be chained together. */ public GoogleDriveConfiguration withInclusionPatterns(java.util.Collection* 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. *
* * @return 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. */ public java.util.List* 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. *
* * @param 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. */ public void setExclusionPatterns(java.util.Collection* 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. *
** NOTE: This method appends the values to the existing list (if any). Use * {@link #setExclusionPatterns(java.util.Collection)} or {@link #withExclusionPatterns(java.util.Collection)} if * you want to override the existing values. *
* * @param 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. * @return Returns a reference to this object so that method calls can be chained together. */ public GoogleDriveConfiguration withExclusionPatterns(String... exclusionPatterns) { if (this.exclusionPatterns == null) { setExclusionPatterns(new java.util.ArrayList* 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. *
* * @param 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. * @return Returns a reference to this object so that method calls can be chained together. */ public GoogleDriveConfiguration withExclusionPatterns(java.util.Collection
* 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.
*
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.
*/
public java.util.List
* 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.
*
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.
*/
public void setFieldMappings(java.util.Collection
* 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.
*
* NOTE: This method appends the values to the existing list (if any). Use * {@link #setFieldMappings(java.util.Collection)} or {@link #withFieldMappings(java.util.Collection)} if you want * to override the existing values. *
* * @param fieldMappings * Maps Google Drive data source attributes or field names to Amazon Kendra index field names. To create * custom fields, use theUpdateIndex
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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GoogleDriveConfiguration withFieldMappings(DataSourceToIndexFieldMapping... fieldMappings) {
if (this.fieldMappings == null) {
setFieldMappings(new java.util.ArrayList
* 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.
*
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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GoogleDriveConfiguration withFieldMappings(java.util.Collection* 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. *
* * @return 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.
*/
public java.util.List
* 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.
*
* For a list of MIME types, see Using a Google Workspace
* Drive data source.
*/
public void setExcludeMimeTypes(java.util.Collection
* 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.
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setExcludeMimeTypes(java.util.Collection)} or {@link #withExcludeMimeTypes(java.util.Collection)} if you
* want to override the existing values.
*
* For a list of MIME types, see Using a Google Workspace
* Drive data source.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GoogleDriveConfiguration withExcludeMimeTypes(String... excludeMimeTypes) {
if (this.excludeMimeTypes == null) {
setExcludeMimeTypes(new java.util.ArrayList
* 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.
*
* For a list of MIME types, see Using a Google Workspace
* Drive data source.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GoogleDriveConfiguration withExcludeMimeTypes(java.util.Collection
* 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.
*
* 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.
*
* 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.
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setExcludeUserAccounts(java.util.Collection)} or {@link #withExcludeUserAccounts(java.util.Collection)}
* if you want to override the existing values.
*
* 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.
*
* A list of identifiers or shared drives to exclude from the index. All files and folders stored on the shared
* drive are excluded.
*
* A list of identifiers or shared drives to exclude from the index. All files and folders stored on the shared
* drive are excluded.
*
* A list of identifiers or shared drives to exclude from the index. All files and folders stored on the shared
* drive are excluded.
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setExcludeSharedDrives(java.util.Collection)} or {@link #withExcludeSharedDrives(java.util.Collection)}
* if you want to override the existing values.
*
* A list of identifiers or shared drives to exclude from the index. All files and folders stored on the shared
* drive are excluded.
*