com.amazonaws.services.kendra.model.S3DataSourceConfiguration Maven / Gradle / Ivy
Show all versions of aws-java-sdk-kendra Show documentation
/*
* Copyright 2019-2024 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 an Amazon S3 bucket.
*
*
*
* Amazon Kendra now supports an upgraded Amazon S3 connector.
*
*
* You must now use the TemplateConfiguration
* object instead of the S3DataSourceConfiguration object to configure your connector.
*
*
* Connectors configured using the older console and API architecture will continue to function as configured. However,
* you won't be able to edit or update them. If you want to edit or update your connector configuration, you must create
* a new connector.
*
*
* We recommended migrating your connector workflow to the upgraded version. Support for connectors configured using the
* older architecture is scheduled to end by June 2024.
*
*
*
* @see AWS
* API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class S3DataSourceConfiguration implements Serializable, Cloneable, StructuredPojo {
/**
*
* The name of the bucket that contains the documents.
*
*/
private String bucketName;
/**
*
* A list of S3 prefixes for the documents that should be included in the index.
*
*/
private java.util.List inclusionPrefixes;
/**
*
* A list of glob patterns (patterns that can expand a wildcard pattern into a list of path names that match the
* given pattern) for certain file names and file types to include in your index. If a document matches both an
* inclusion and exclusion prefix or pattern, the exclusion prefix takes precendence and the document is not
* indexed. Examples of glob patterns include:
*
*
* -
*
* /myapp/config/*—All files inside config directory.
*
*
* -
*
* **/*.png—All .png files in all directories.
*
*
* -
*
* **/*.{png, ico, md}—All .png, .ico or .md files in all directories.
*
*
* -
*
* /myapp/src/**/*.ts—All .ts files inside src directory (and all its subdirectories).
*
*
* -
*
* **/!(*.module).ts—All .ts files but not .module.ts
*
*
* -
*
* *.png , *.jpg—All PNG and JPEG image files in a directory (files with the extensions .png and .jpg).
*
*
* -
*
* *internal*—All files in a directory that contain 'internal' in the file name, such as 'internal',
* 'internal_only', 'company_internal'.
*
*
* -
*
* **/*internal*—All internal-related files in a directory and its subdirectories.
*
*
*
*
* For more examples, see Use of Exclude and
* Include Filters in the Amazon Web Services CLI Command Reference.
*
*/
private java.util.List inclusionPatterns;
/**
*
* A list of glob patterns (patterns that can expand a wildcard pattern into a list of path names that match the
* given pattern) for certain file names and file types to exclude from your index. If a document matches both an
* inclusion and exclusion prefix or pattern, the exclusion prefix takes precendence and the document is not
* indexed. Examples of glob patterns include:
*
*
* -
*
* /myapp/config/*—All files inside config directory.
*
*
* -
*
* **/*.png—All .png files in all directories.
*
*
* -
*
* **/*.{png, ico, md}—All .png, .ico or .md files in all directories.
*
*
* -
*
* /myapp/src/**/*.ts—All .ts files inside src directory (and all its subdirectories).
*
*
* -
*
* **/!(*.module).ts—All .ts files but not .module.ts
*
*
* -
*
* *.png , *.jpg—All PNG and JPEG image files in a directory (files with the extensions .png and .jpg).
*
*
* -
*
* *internal*—All files in a directory that contain 'internal' in the file name, such as 'internal',
* 'internal_only', 'company_internal'.
*
*
* -
*
* **/*internal*—All internal-related files in a directory and its subdirectories.
*
*
*
*
* For more examples, see Use of Exclude and
* Include Filters in the Amazon Web Services CLI Command Reference.
*
*/
private java.util.List exclusionPatterns;
private DocumentsMetadataConfiguration documentsMetadataConfiguration;
/**
*
* Provides the path to the S3 bucket that contains the user context filtering files for the data source. For the
* format of the file, see Access control for S3
* data sources.
*
*/
private AccessControlListConfiguration accessControlListConfiguration;
/**
*
* The name of the bucket that contains the documents.
*
*
* @param bucketName
* The name of the bucket that contains the documents.
*/
public void setBucketName(String bucketName) {
this.bucketName = bucketName;
}
/**
*
* The name of the bucket that contains the documents.
*
*
* @return The name of the bucket that contains the documents.
*/
public String getBucketName() {
return this.bucketName;
}
/**
*
* The name of the bucket that contains the documents.
*
*
* @param bucketName
* The name of the bucket that contains the documents.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public S3DataSourceConfiguration withBucketName(String bucketName) {
setBucketName(bucketName);
return this;
}
/**
*
* A list of S3 prefixes for the documents that should be included in the index.
*
*
* @return A list of S3 prefixes for the documents that should be included in the index.
*/
public java.util.List getInclusionPrefixes() {
return inclusionPrefixes;
}
/**
*
* A list of S3 prefixes for the documents that should be included in the index.
*
*
* @param inclusionPrefixes
* A list of S3 prefixes for the documents that should be included in the index.
*/
public void setInclusionPrefixes(java.util.Collection inclusionPrefixes) {
if (inclusionPrefixes == null) {
this.inclusionPrefixes = null;
return;
}
this.inclusionPrefixes = new java.util.ArrayList(inclusionPrefixes);
}
/**
*
* A list of S3 prefixes for the documents that should be included in the index.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setInclusionPrefixes(java.util.Collection)} or {@link #withInclusionPrefixes(java.util.Collection)} if
* you want to override the existing values.
*
*
* @param inclusionPrefixes
* A list of S3 prefixes for the documents that should be included in the index.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public S3DataSourceConfiguration withInclusionPrefixes(String... inclusionPrefixes) {
if (this.inclusionPrefixes == null) {
setInclusionPrefixes(new java.util.ArrayList(inclusionPrefixes.length));
}
for (String ele : inclusionPrefixes) {
this.inclusionPrefixes.add(ele);
}
return this;
}
/**
*
* A list of S3 prefixes for the documents that should be included in the index.
*
*
* @param inclusionPrefixes
* A list of S3 prefixes for the documents that should be included in the index.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public S3DataSourceConfiguration withInclusionPrefixes(java.util.Collection inclusionPrefixes) {
setInclusionPrefixes(inclusionPrefixes);
return this;
}
/**
*
* A list of glob patterns (patterns that can expand a wildcard pattern into a list of path names that match the
* given pattern) for certain file names and file types to include in your index. If a document matches both an
* inclusion and exclusion prefix or pattern, the exclusion prefix takes precendence and the document is not
* indexed. Examples of glob patterns include:
*
*
* -
*
* /myapp/config/*—All files inside config directory.
*
*
* -
*
* **/*.png—All .png files in all directories.
*
*
* -
*
* **/*.{png, ico, md}—All .png, .ico or .md files in all directories.
*
*
* -
*
* /myapp/src/**/*.ts—All .ts files inside src directory (and all its subdirectories).
*
*
* -
*
* **/!(*.module).ts—All .ts files but not .module.ts
*
*
* -
*
* *.png , *.jpg—All PNG and JPEG image files in a directory (files with the extensions .png and .jpg).
*
*
* -
*
* *internal*—All files in a directory that contain 'internal' in the file name, such as 'internal',
* 'internal_only', 'company_internal'.
*
*
* -
*
* **/*internal*—All internal-related files in a directory and its subdirectories.
*
*
*
*
* For more examples, see Use of Exclude and
* Include Filters in the Amazon Web Services CLI Command Reference.
*
*
* @return A list of glob patterns (patterns that can expand a wildcard pattern into a list of path names that match
* the given pattern) for certain file names and file types to include in your index. If a document matches
* both an inclusion and exclusion prefix or pattern, the exclusion prefix takes precendence and the
* document is not indexed. Examples of glob patterns include:
*
* -
*
* /myapp/config/*—All files inside config directory.
*
*
* -
*
* **/*.png—All .png files in all directories.
*
*
* -
*
* **/*.{png, ico, md}—All .png, .ico or .md files in all directories.
*
*
* -
*
* /myapp/src/**/*.ts—All .ts files inside src directory (and all its subdirectories).
*
*
* -
*
* **/!(*.module).ts—All .ts files but not .module.ts
*
*
* -
*
* *.png , *.jpg—All PNG and JPEG image files in a directory (files with the extensions .png and
* .jpg).
*
*
* -
*
* *internal*—All files in a directory that contain 'internal' in the file name, such as 'internal',
* 'internal_only', 'company_internal'.
*
*
* -
*
* **/*internal*—All internal-related files in a directory and its subdirectories.
*
*
*
*
* For more examples, see Use of
* Exclude and Include Filters in the Amazon Web Services CLI Command Reference.
*/
public java.util.List getInclusionPatterns() {
return inclusionPatterns;
}
/**
*
* A list of glob patterns (patterns that can expand a wildcard pattern into a list of path names that match the
* given pattern) for certain file names and file types to include in your index. If a document matches both an
* inclusion and exclusion prefix or pattern, the exclusion prefix takes precendence and the document is not
* indexed. Examples of glob patterns include:
*
*
* -
*
* /myapp/config/*—All files inside config directory.
*
*
* -
*
* **/*.png—All .png files in all directories.
*
*
* -
*
* **/*.{png, ico, md}—All .png, .ico or .md files in all directories.
*
*
* -
*
* /myapp/src/**/*.ts—All .ts files inside src directory (and all its subdirectories).
*
*
* -
*
* **/!(*.module).ts—All .ts files but not .module.ts
*
*
* -
*
* *.png , *.jpg—All PNG and JPEG image files in a directory (files with the extensions .png and .jpg).
*
*
* -
*
* *internal*—All files in a directory that contain 'internal' in the file name, such as 'internal',
* 'internal_only', 'company_internal'.
*
*
* -
*
* **/*internal*—All internal-related files in a directory and its subdirectories.
*
*
*
*
* For more examples, see Use of Exclude and
* Include Filters in the Amazon Web Services CLI Command Reference.
*
*
* @param inclusionPatterns
* A list of glob patterns (patterns that can expand a wildcard pattern into a list of path names that match
* the given pattern) for certain file names and file types to include in your index. If a document matches
* both an inclusion and exclusion prefix or pattern, the exclusion prefix takes precendence and the document
* is not indexed. Examples of glob patterns include:
*
* -
*
* /myapp/config/*—All files inside config directory.
*
*
* -
*
* **/*.png—All .png files in all directories.
*
*
* -
*
* **/*.{png, ico, md}—All .png, .ico or .md files in all directories.
*
*
* -
*
* /myapp/src/**/*.ts—All .ts files inside src directory (and all its subdirectories).
*
*
* -
*
* **/!(*.module).ts—All .ts files but not .module.ts
*
*
* -
*
* *.png , *.jpg—All PNG and JPEG image files in a directory (files with the extensions .png and
* .jpg).
*
*
* -
*
* *internal*—All files in a directory that contain 'internal' in the file name, such as 'internal',
* 'internal_only', 'company_internal'.
*
*
* -
*
* **/*internal*—All internal-related files in a directory and its subdirectories.
*
*
*
*
* For more examples, see Use of
* Exclude and Include Filters in the Amazon Web Services CLI Command Reference.
*/
public void setInclusionPatterns(java.util.Collection inclusionPatterns) {
if (inclusionPatterns == null) {
this.inclusionPatterns = null;
return;
}
this.inclusionPatterns = new java.util.ArrayList(inclusionPatterns);
}
/**
*
* A list of glob patterns (patterns that can expand a wildcard pattern into a list of path names that match the
* given pattern) for certain file names and file types to include in your index. If a document matches both an
* inclusion and exclusion prefix or pattern, the exclusion prefix takes precendence and the document is not
* indexed. Examples of glob patterns include:
*
*
* -
*
* /myapp/config/*—All files inside config directory.
*
*
* -
*
* **/*.png—All .png files in all directories.
*
*
* -
*
* **/*.{png, ico, md}—All .png, .ico or .md files in all directories.
*
*
* -
*
* /myapp/src/**/*.ts—All .ts files inside src directory (and all its subdirectories).
*
*
* -
*
* **/!(*.module).ts—All .ts files but not .module.ts
*
*
* -
*
* *.png , *.jpg—All PNG and JPEG image files in a directory (files with the extensions .png and .jpg).
*
*
* -
*
* *internal*—All files in a directory that contain 'internal' in the file name, such as 'internal',
* 'internal_only', 'company_internal'.
*
*
* -
*
* **/*internal*—All internal-related files in a directory and its subdirectories.
*
*
*
*
* For more examples, see Use of Exclude and
* Include Filters in the Amazon Web Services CLI Command Reference.
*
*
* 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 glob patterns (patterns that can expand a wildcard pattern into a list of path names that match
* the given pattern) for certain file names and file types to include in your index. If a document matches
* both an inclusion and exclusion prefix or pattern, the exclusion prefix takes precendence and the document
* is not indexed. Examples of glob patterns include:
*
* -
*
* /myapp/config/*—All files inside config directory.
*
*
* -
*
* **/*.png—All .png files in all directories.
*
*
* -
*
* **/*.{png, ico, md}—All .png, .ico or .md files in all directories.
*
*
* -
*
* /myapp/src/**/*.ts—All .ts files inside src directory (and all its subdirectories).
*
*
* -
*
* **/!(*.module).ts—All .ts files but not .module.ts
*
*
* -
*
* *.png , *.jpg—All PNG and JPEG image files in a directory (files with the extensions .png and
* .jpg).
*
*
* -
*
* *internal*—All files in a directory that contain 'internal' in the file name, such as 'internal',
* 'internal_only', 'company_internal'.
*
*
* -
*
* **/*internal*—All internal-related files in a directory and its subdirectories.
*
*
*
*
* For more examples, see Use of
* Exclude and Include Filters in the Amazon Web Services CLI Command Reference.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public S3DataSourceConfiguration withInclusionPatterns(String... inclusionPatterns) {
if (this.inclusionPatterns == null) {
setInclusionPatterns(new java.util.ArrayList(inclusionPatterns.length));
}
for (String ele : inclusionPatterns) {
this.inclusionPatterns.add(ele);
}
return this;
}
/**
*
* A list of glob patterns (patterns that can expand a wildcard pattern into a list of path names that match the
* given pattern) for certain file names and file types to include in your index. If a document matches both an
* inclusion and exclusion prefix or pattern, the exclusion prefix takes precendence and the document is not
* indexed. Examples of glob patterns include:
*
*
* -
*
* /myapp/config/*—All files inside config directory.
*
*
* -
*
* **/*.png—All .png files in all directories.
*
*
* -
*
* **/*.{png, ico, md}—All .png, .ico or .md files in all directories.
*
*
* -
*
* /myapp/src/**/*.ts—All .ts files inside src directory (and all its subdirectories).
*
*
* -
*
* **/!(*.module).ts—All .ts files but not .module.ts
*
*
* -
*
* *.png , *.jpg—All PNG and JPEG image files in a directory (files with the extensions .png and .jpg).
*
*
* -
*
* *internal*—All files in a directory that contain 'internal' in the file name, such as 'internal',
* 'internal_only', 'company_internal'.
*
*
* -
*
* **/*internal*—All internal-related files in a directory and its subdirectories.
*
*
*
*
* For more examples, see Use of Exclude and
* Include Filters in the Amazon Web Services CLI Command Reference.
*
*
* @param inclusionPatterns
* A list of glob patterns (patterns that can expand a wildcard pattern into a list of path names that match
* the given pattern) for certain file names and file types to include in your index. If a document matches
* both an inclusion and exclusion prefix or pattern, the exclusion prefix takes precendence and the document
* is not indexed. Examples of glob patterns include:
*
* -
*
* /myapp/config/*—All files inside config directory.
*
*
* -
*
* **/*.png—All .png files in all directories.
*
*
* -
*
* **/*.{png, ico, md}—All .png, .ico or .md files in all directories.
*
*
* -
*
* /myapp/src/**/*.ts—All .ts files inside src directory (and all its subdirectories).
*
*
* -
*
* **/!(*.module).ts—All .ts files but not .module.ts
*
*
* -
*
* *.png , *.jpg—All PNG and JPEG image files in a directory (files with the extensions .png and
* .jpg).
*
*
* -
*
* *internal*—All files in a directory that contain 'internal' in the file name, such as 'internal',
* 'internal_only', 'company_internal'.
*
*
* -
*
* **/*internal*—All internal-related files in a directory and its subdirectories.
*
*
*
*
* For more examples, see Use of
* Exclude and Include Filters in the Amazon Web Services CLI Command Reference.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public S3DataSourceConfiguration withInclusionPatterns(java.util.Collection inclusionPatterns) {
setInclusionPatterns(inclusionPatterns);
return this;
}
/**
*
* A list of glob patterns (patterns that can expand a wildcard pattern into a list of path names that match the
* given pattern) for certain file names and file types to exclude from your index. If a document matches both an
* inclusion and exclusion prefix or pattern, the exclusion prefix takes precendence and the document is not
* indexed. Examples of glob patterns include:
*
*
* -
*
* /myapp/config/*—All files inside config directory.
*
*
* -
*
* **/*.png—All .png files in all directories.
*
*
* -
*
* **/*.{png, ico, md}—All .png, .ico or .md files in all directories.
*
*
* -
*
* /myapp/src/**/*.ts—All .ts files inside src directory (and all its subdirectories).
*
*
* -
*
* **/!(*.module).ts—All .ts files but not .module.ts
*
*
* -
*
* *.png , *.jpg—All PNG and JPEG image files in a directory (files with the extensions .png and .jpg).
*
*
* -
*
* *internal*—All files in a directory that contain 'internal' in the file name, such as 'internal',
* 'internal_only', 'company_internal'.
*
*
* -
*
* **/*internal*—All internal-related files in a directory and its subdirectories.
*
*
*
*
* For more examples, see Use of Exclude and
* Include Filters in the Amazon Web Services CLI Command Reference.
*
*
* @return A list of glob patterns (patterns that can expand a wildcard pattern into a list of path names that match
* the given pattern) for certain file names and file types to exclude from your index. If a document
* matches both an inclusion and exclusion prefix or pattern, the exclusion prefix takes precendence and the
* document is not indexed. Examples of glob patterns include:
*
* -
*
* /myapp/config/*—All files inside config directory.
*
*
* -
*
* **/*.png—All .png files in all directories.
*
*
* -
*
* **/*.{png, ico, md}—All .png, .ico or .md files in all directories.
*
*
* -
*
* /myapp/src/**/*.ts—All .ts files inside src directory (and all its subdirectories).
*
*
* -
*
* **/!(*.module).ts—All .ts files but not .module.ts
*
*
* -
*
* *.png , *.jpg—All PNG and JPEG image files in a directory (files with the extensions .png and
* .jpg).
*
*
* -
*
* *internal*—All files in a directory that contain 'internal' in the file name, such as 'internal',
* 'internal_only', 'company_internal'.
*
*
* -
*
* **/*internal*—All internal-related files in a directory and its subdirectories.
*
*
*
*
* For more examples, see Use of
* Exclude and Include Filters in the Amazon Web Services CLI Command Reference.
*/
public java.util.List getExclusionPatterns() {
return exclusionPatterns;
}
/**
*
* A list of glob patterns (patterns that can expand a wildcard pattern into a list of path names that match the
* given pattern) for certain file names and file types to exclude from your index. If a document matches both an
* inclusion and exclusion prefix or pattern, the exclusion prefix takes precendence and the document is not
* indexed. Examples of glob patterns include:
*
*
* -
*
* /myapp/config/*—All files inside config directory.
*
*
* -
*
* **/*.png—All .png files in all directories.
*
*
* -
*
* **/*.{png, ico, md}—All .png, .ico or .md files in all directories.
*
*
* -
*
* /myapp/src/**/*.ts—All .ts files inside src directory (and all its subdirectories).
*
*
* -
*
* **/!(*.module).ts—All .ts files but not .module.ts
*
*
* -
*
* *.png , *.jpg—All PNG and JPEG image files in a directory (files with the extensions .png and .jpg).
*
*
* -
*
* *internal*—All files in a directory that contain 'internal' in the file name, such as 'internal',
* 'internal_only', 'company_internal'.
*
*
* -
*
* **/*internal*—All internal-related files in a directory and its subdirectories.
*
*
*
*
* For more examples, see Use of Exclude and
* Include Filters in the Amazon Web Services CLI Command Reference.
*
*
* @param exclusionPatterns
* A list of glob patterns (patterns that can expand a wildcard pattern into a list of path names that match
* the given pattern) for certain file names and file types to exclude from your index. If a document matches
* both an inclusion and exclusion prefix or pattern, the exclusion prefix takes precendence and the document
* is not indexed. Examples of glob patterns include:
*
* -
*
* /myapp/config/*—All files inside config directory.
*
*
* -
*
* **/*.png—All .png files in all directories.
*
*
* -
*
* **/*.{png, ico, md}—All .png, .ico or .md files in all directories.
*
*
* -
*
* /myapp/src/**/*.ts—All .ts files inside src directory (and all its subdirectories).
*
*
* -
*
* **/!(*.module).ts—All .ts files but not .module.ts
*
*
* -
*
* *.png , *.jpg—All PNG and JPEG image files in a directory (files with the extensions .png and
* .jpg).
*
*
* -
*
* *internal*—All files in a directory that contain 'internal' in the file name, such as 'internal',
* 'internal_only', 'company_internal'.
*
*
* -
*
* **/*internal*—All internal-related files in a directory and its subdirectories.
*
*
*
*
* For more examples, see Use of
* Exclude and Include Filters in the Amazon Web Services CLI Command Reference.
*/
public void setExclusionPatterns(java.util.Collection exclusionPatterns) {
if (exclusionPatterns == null) {
this.exclusionPatterns = null;
return;
}
this.exclusionPatterns = new java.util.ArrayList(exclusionPatterns);
}
/**
*
* A list of glob patterns (patterns that can expand a wildcard pattern into a list of path names that match the
* given pattern) for certain file names and file types to exclude from your index. If a document matches both an
* inclusion and exclusion prefix or pattern, the exclusion prefix takes precendence and the document is not
* indexed. Examples of glob patterns include:
*
*
* -
*
* /myapp/config/*—All files inside config directory.
*
*
* -
*
* **/*.png—All .png files in all directories.
*
*
* -
*
* **/*.{png, ico, md}—All .png, .ico or .md files in all directories.
*
*
* -
*
* /myapp/src/**/*.ts—All .ts files inside src directory (and all its subdirectories).
*
*
* -
*
* **/!(*.module).ts—All .ts files but not .module.ts
*
*
* -
*
* *.png , *.jpg—All PNG and JPEG image files in a directory (files with the extensions .png and .jpg).
*
*
* -
*
* *internal*—All files in a directory that contain 'internal' in the file name, such as 'internal',
* 'internal_only', 'company_internal'.
*
*
* -
*
* **/*internal*—All internal-related files in a directory and its subdirectories.
*
*
*
*
* For more examples, see Use of Exclude and
* Include Filters in the Amazon Web Services CLI Command Reference.
*
*
* 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 glob patterns (patterns that can expand a wildcard pattern into a list of path names that match
* the given pattern) for certain file names and file types to exclude from your index. If a document matches
* both an inclusion and exclusion prefix or pattern, the exclusion prefix takes precendence and the document
* is not indexed. Examples of glob patterns include:
*
* -
*
* /myapp/config/*—All files inside config directory.
*
*
* -
*
* **/*.png—All .png files in all directories.
*
*
* -
*
* **/*.{png, ico, md}—All .png, .ico or .md files in all directories.
*
*
* -
*
* /myapp/src/**/*.ts—All .ts files inside src directory (and all its subdirectories).
*
*
* -
*
* **/!(*.module).ts—All .ts files but not .module.ts
*
*
* -
*
* *.png , *.jpg—All PNG and JPEG image files in a directory (files with the extensions .png and
* .jpg).
*
*
* -
*
* *internal*—All files in a directory that contain 'internal' in the file name, such as 'internal',
* 'internal_only', 'company_internal'.
*
*
* -
*
* **/*internal*—All internal-related files in a directory and its subdirectories.
*
*
*
*
* For more examples, see Use of
* Exclude and Include Filters in the Amazon Web Services CLI Command Reference.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public S3DataSourceConfiguration withExclusionPatterns(String... exclusionPatterns) {
if (this.exclusionPatterns == null) {
setExclusionPatterns(new java.util.ArrayList(exclusionPatterns.length));
}
for (String ele : exclusionPatterns) {
this.exclusionPatterns.add(ele);
}
return this;
}
/**
*
* A list of glob patterns (patterns that can expand a wildcard pattern into a list of path names that match the
* given pattern) for certain file names and file types to exclude from your index. If a document matches both an
* inclusion and exclusion prefix or pattern, the exclusion prefix takes precendence and the document is not
* indexed. Examples of glob patterns include:
*
*
* -
*
* /myapp/config/*—All files inside config directory.
*
*
* -
*
* **/*.png—All .png files in all directories.
*
*
* -
*
* **/*.{png, ico, md}—All .png, .ico or .md files in all directories.
*
*
* -
*
* /myapp/src/**/*.ts—All .ts files inside src directory (and all its subdirectories).
*
*
* -
*
* **/!(*.module).ts—All .ts files but not .module.ts
*
*
* -
*
* *.png , *.jpg—All PNG and JPEG image files in a directory (files with the extensions .png and .jpg).
*
*
* -
*
* *internal*—All files in a directory that contain 'internal' in the file name, such as 'internal',
* 'internal_only', 'company_internal'.
*
*
* -
*
* **/*internal*—All internal-related files in a directory and its subdirectories.
*
*
*
*
* For more examples, see Use of Exclude and
* Include Filters in the Amazon Web Services CLI Command Reference.
*
*
* @param exclusionPatterns
* A list of glob patterns (patterns that can expand a wildcard pattern into a list of path names that match
* the given pattern) for certain file names and file types to exclude from your index. If a document matches
* both an inclusion and exclusion prefix or pattern, the exclusion prefix takes precendence and the document
* is not indexed. Examples of glob patterns include:
*
* -
*
* /myapp/config/*—All files inside config directory.
*
*
* -
*
* **/*.png—All .png files in all directories.
*
*
* -
*
* **/*.{png, ico, md}—All .png, .ico or .md files in all directories.
*
*
* -
*
* /myapp/src/**/*.ts—All .ts files inside src directory (and all its subdirectories).
*
*
* -
*
* **/!(*.module).ts—All .ts files but not .module.ts
*
*
* -
*
* *.png , *.jpg—All PNG and JPEG image files in a directory (files with the extensions .png and
* .jpg).
*
*
* -
*
* *internal*—All files in a directory that contain 'internal' in the file name, such as 'internal',
* 'internal_only', 'company_internal'.
*
*
* -
*
* **/*internal*—All internal-related files in a directory and its subdirectories.
*
*
*
*
* For more examples, see Use of
* Exclude and Include Filters in the Amazon Web Services CLI Command Reference.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public S3DataSourceConfiguration withExclusionPatterns(java.util.Collection exclusionPatterns) {
setExclusionPatterns(exclusionPatterns);
return this;
}
/**
* @param documentsMetadataConfiguration
*/
public void setDocumentsMetadataConfiguration(DocumentsMetadataConfiguration documentsMetadataConfiguration) {
this.documentsMetadataConfiguration = documentsMetadataConfiguration;
}
/**
* @return
*/
public DocumentsMetadataConfiguration getDocumentsMetadataConfiguration() {
return this.documentsMetadataConfiguration;
}
/**
* @param documentsMetadataConfiguration
* @return Returns a reference to this object so that method calls can be chained together.
*/
public S3DataSourceConfiguration withDocumentsMetadataConfiguration(DocumentsMetadataConfiguration documentsMetadataConfiguration) {
setDocumentsMetadataConfiguration(documentsMetadataConfiguration);
return this;
}
/**
*
* Provides the path to the S3 bucket that contains the user context filtering files for the data source. For the
* format of the file, see Access control for S3
* data sources.
*
*
* @param accessControlListConfiguration
* Provides the path to the S3 bucket that contains the user context filtering files for the data source. For
* the format of the file, see Access
* control for S3 data sources.
*/
public void setAccessControlListConfiguration(AccessControlListConfiguration accessControlListConfiguration) {
this.accessControlListConfiguration = accessControlListConfiguration;
}
/**
*
* Provides the path to the S3 bucket that contains the user context filtering files for the data source. For the
* format of the file, see Access control for S3
* data sources.
*
*
* @return Provides the path to the S3 bucket that contains the user context filtering files for the data source.
* For the format of the file, see Access
* control for S3 data sources.
*/
public AccessControlListConfiguration getAccessControlListConfiguration() {
return this.accessControlListConfiguration;
}
/**
*
* Provides the path to the S3 bucket that contains the user context filtering files for the data source. For the
* format of the file, see Access control for S3
* data sources.
*
*
* @param accessControlListConfiguration
* Provides the path to the S3 bucket that contains the user context filtering files for the data source. For
* the format of the file, see Access
* control for S3 data sources.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public S3DataSourceConfiguration withAccessControlListConfiguration(AccessControlListConfiguration accessControlListConfiguration) {
setAccessControlListConfiguration(accessControlListConfiguration);
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getBucketName() != null)
sb.append("BucketName: ").append(getBucketName()).append(",");
if (getInclusionPrefixes() != null)
sb.append("InclusionPrefixes: ").append(getInclusionPrefixes()).append(",");
if (getInclusionPatterns() != null)
sb.append("InclusionPatterns: ").append(getInclusionPatterns()).append(",");
if (getExclusionPatterns() != null)
sb.append("ExclusionPatterns: ").append(getExclusionPatterns()).append(",");
if (getDocumentsMetadataConfiguration() != null)
sb.append("DocumentsMetadataConfiguration: ").append(getDocumentsMetadataConfiguration()).append(",");
if (getAccessControlListConfiguration() != null)
sb.append("AccessControlListConfiguration: ").append(getAccessControlListConfiguration());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof S3DataSourceConfiguration == false)
return false;
S3DataSourceConfiguration other = (S3DataSourceConfiguration) obj;
if (other.getBucketName() == null ^ this.getBucketName() == null)
return false;
if (other.getBucketName() != null && other.getBucketName().equals(this.getBucketName()) == false)
return false;
if (other.getInclusionPrefixes() == null ^ this.getInclusionPrefixes() == null)
return false;
if (other.getInclusionPrefixes() != null && other.getInclusionPrefixes().equals(this.getInclusionPrefixes()) == false)
return false;
if (other.getInclusionPatterns() == null ^ this.getInclusionPatterns() == null)
return false;
if (other.getInclusionPatterns() != null && other.getInclusionPatterns().equals(this.getInclusionPatterns()) == false)
return false;
if (other.getExclusionPatterns() == null ^ this.getExclusionPatterns() == null)
return false;
if (other.getExclusionPatterns() != null && other.getExclusionPatterns().equals(this.getExclusionPatterns()) == false)
return false;
if (other.getDocumentsMetadataConfiguration() == null ^ this.getDocumentsMetadataConfiguration() == null)
return false;
if (other.getDocumentsMetadataConfiguration() != null
&& other.getDocumentsMetadataConfiguration().equals(this.getDocumentsMetadataConfiguration()) == false)
return false;
if (other.getAccessControlListConfiguration() == null ^ this.getAccessControlListConfiguration() == null)
return false;
if (other.getAccessControlListConfiguration() != null
&& other.getAccessControlListConfiguration().equals(this.getAccessControlListConfiguration()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getBucketName() == null) ? 0 : getBucketName().hashCode());
hashCode = prime * hashCode + ((getInclusionPrefixes() == null) ? 0 : getInclusionPrefixes().hashCode());
hashCode = prime * hashCode + ((getInclusionPatterns() == null) ? 0 : getInclusionPatterns().hashCode());
hashCode = prime * hashCode + ((getExclusionPatterns() == null) ? 0 : getExclusionPatterns().hashCode());
hashCode = prime * hashCode + ((getDocumentsMetadataConfiguration() == null) ? 0 : getDocumentsMetadataConfiguration().hashCode());
hashCode = prime * hashCode + ((getAccessControlListConfiguration() == null) ? 0 : getAccessControlListConfiguration().hashCode());
return hashCode;
}
@Override
public S3DataSourceConfiguration clone() {
try {
return (S3DataSourceConfiguration) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
@com.amazonaws.annotation.SdkInternalApi
@Override
public void marshall(ProtocolMarshaller protocolMarshaller) {
com.amazonaws.services.kendra.model.transform.S3DataSourceConfigurationMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}