com.amazonaws.services.kendra.model

Class CreateDataSourceRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.kendra.model.CreateDataSourceRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateDataSourceRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateDataSourceRequest()

Method Summary

Modifier and Type	Method and Description
CreateDataSourceRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getClientToken() A token that you provide to identify the request to create a data source connector.
DataSourceConfiguration	getConfiguration() Configuration information to connect to your data source repository.
CustomDocumentEnrichmentConfiguration	getCustomDocumentEnrichmentConfiguration() Configuration information for altering document metadata and content during the document ingestion process.
String	getDescription() A description for the data source connector.
String	getIndexId() The identifier of the index you want to use with the data source connector.
String	getLanguageCode() The code for a language.
String	getName() A name for the data source connector.
String	getRoleArn() The Amazon Resource Name (ARN) of an IAM role with permission to access the data source and required resources.
String	getSchedule() Sets the frequency for Amazon Kendra to check the documents in your data source repository and update the index.
List<Tag>	getTags() A list of key-value pairs that identify or categorize the data source connector.
String	getType() The type of data source repository.
DataSourceVpcConfiguration	getVpcConfiguration() Configuration information for an Amazon Virtual Private Cloud to connect to your data source.
int	hashCode()
void	setClientToken(String clientToken) A token that you provide to identify the request to create a data source connector.
void	setConfiguration(DataSourceConfiguration configuration) Configuration information to connect to your data source repository.
void	setCustomDocumentEnrichmentConfiguration(CustomDocumentEnrichmentConfiguration customDocumentEnrichmentConfiguration) Configuration information for altering document metadata and content during the document ingestion process.
void	setDescription(String description) A description for the data source connector.
void	setIndexId(String indexId) The identifier of the index you want to use with the data source connector.
void	setLanguageCode(String languageCode) The code for a language.
void	setName(String name) A name for the data source connector.
void	setRoleArn(String roleArn) The Amazon Resource Name (ARN) of an IAM role with permission to access the data source and required resources.
void	setSchedule(String schedule) Sets the frequency for Amazon Kendra to check the documents in your data source repository and update the index.
void	setTags(Collection<Tag> tags) A list of key-value pairs that identify or categorize the data source connector.
void	setType(String type) The type of data source repository.
void	setVpcConfiguration(DataSourceVpcConfiguration vpcConfiguration) Configuration information for an Amazon Virtual Private Cloud to connect to your data source.
String	toString() Returns a string representation of this object.
CreateDataSourceRequest	withClientToken(String clientToken) A token that you provide to identify the request to create a data source connector.
CreateDataSourceRequest	withConfiguration(DataSourceConfiguration configuration) Configuration information to connect to your data source repository.
CreateDataSourceRequest	withCustomDocumentEnrichmentConfiguration(CustomDocumentEnrichmentConfiguration customDocumentEnrichmentConfiguration) Configuration information for altering document metadata and content during the document ingestion process.
CreateDataSourceRequest	withDescription(String description) A description for the data source connector.
CreateDataSourceRequest	withIndexId(String indexId) The identifier of the index you want to use with the data source connector.
CreateDataSourceRequest	withLanguageCode(String languageCode) The code for a language.
CreateDataSourceRequest	withName(String name) A name for the data source connector.
CreateDataSourceRequest	withRoleArn(String roleArn) The Amazon Resource Name (ARN) of an IAM role with permission to access the data source and required resources.
CreateDataSourceRequest	withSchedule(String schedule) Sets the frequency for Amazon Kendra to check the documents in your data source repository and update the index.
CreateDataSourceRequest	withTags(Collection<Tag> tags) A list of key-value pairs that identify or categorize the data source connector.
CreateDataSourceRequest	withTags(Tag... tags) A list of key-value pairs that identify or categorize the data source connector.
CreateDataSourceRequest	withType(DataSourceType type) The type of data source repository.
CreateDataSourceRequest	withType(String type) The type of data source repository.
CreateDataSourceRequest	withVpcConfiguration(DataSourceVpcConfiguration vpcConfiguration) Configuration information for an Amazon Virtual Private Cloud to connect to your data source.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateDataSourceRequest

public CreateDataSourceRequest()

Method Detail

setName

public void setName(String name)

A name for the data source connector.

Parameters:

name - A name for the data source connector.

getName

public String getName()

A name for the data source connector.

Returns:

A name for the data source connector.

withName

public CreateDataSourceRequest withName(String name)

A name for the data source connector.

Parameters:

name - A name for the data source connector.

Returns:

Returns a reference to this object so that method calls can be chained together.

setIndexId

public void setIndexId(String indexId)

The identifier of the index you want to use with the data source connector.

Parameters:

indexId - The identifier of the index you want to use with the data source connector.

getIndexId

public String getIndexId()

The identifier of the index you want to use with the data source connector.

Returns:

The identifier of the index you want to use with the data source connector.

withIndexId

public CreateDataSourceRequest withIndexId(String indexId)

The identifier of the index you want to use with the data source connector.

Parameters:

indexId - The identifier of the index you want to use with the data source connector.

Returns:

Returns a reference to this object so that method calls can be chained together.

setType

public void setType(String type)

The type of data source repository. For example, SHAREPOINT.

Parameters:

type - The type of data source repository. For example, SHAREPOINT.

See Also:

DataSourceType

getType

public String getType()

The type of data source repository. For example, SHAREPOINT.

Returns:

The type of data source repository. For example, SHAREPOINT.

See Also:

DataSourceType

withType

public CreateDataSourceRequest withType(String type)

The type of data source repository. For example, SHAREPOINT.

Parameters:

type - The type of data source repository. For example, SHAREPOINT.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

DataSourceType

withType

public CreateDataSourceRequest withType(DataSourceType type)

The type of data source repository. For example, SHAREPOINT.

Parameters:

type - The type of data source repository. For example, SHAREPOINT.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

DataSourceType

setConfiguration

public void setConfiguration(DataSourceConfiguration configuration)

Configuration information to connect to your data source repository.

You can't specify the Configuration parameter when the Type parameter is set to CUSTOM. If you do, you receive a ValidationException exception.

The Configuration parameter is required for all other data sources.

Parameters:

configuration - Configuration information to connect to your data source repository.

You can't specify the Configuration parameter when the Type parameter is set to CUSTOM. If you do, you receive a ValidationException exception.

The Configuration parameter is required for all other data sources.

getConfiguration

public DataSourceConfiguration getConfiguration()

Configuration information to connect to your data source repository.

You can't specify the Configuration parameter when the Type parameter is set to CUSTOM. If you do, you receive a ValidationException exception.

The Configuration parameter is required for all other data sources.

Returns:

Configuration information to connect to your data source repository.

You can't specify the Configuration parameter when the Type parameter is set to CUSTOM. If you do, you receive a ValidationException exception.

The Configuration parameter is required for all other data sources.

withConfiguration

public CreateDataSourceRequest withConfiguration(DataSourceConfiguration configuration)

Configuration information to connect to your data source repository.

You can't specify the Configuration parameter when the Type parameter is set to CUSTOM. If you do, you receive a ValidationException exception.

The Configuration parameter is required for all other data sources.

Parameters:

configuration - Configuration information to connect to your data source repository.

You can't specify the Configuration parameter when the Type parameter is set to CUSTOM. If you do, you receive a ValidationException exception.

The Configuration parameter is required for all other data sources.

Returns:

Returns a reference to this object so that method calls can be chained together.

setVpcConfiguration

public void setVpcConfiguration(DataSourceVpcConfiguration vpcConfiguration)

Configuration information for an Amazon Virtual Private Cloud to connect to your data source. For more information, see Configuring a VPC.

Parameters:

vpcConfiguration - Configuration information for an Amazon Virtual Private Cloud to connect to your data source. For more information, see Configuring a VPC.

getVpcConfiguration

public DataSourceVpcConfiguration getVpcConfiguration()

Configuration information for an Amazon Virtual Private Cloud to connect to your data source. For more information, see Configuring a VPC.

Returns:

Configuration information for an Amazon Virtual Private Cloud to connect to your data source. For more information, see Configuring a VPC.

withVpcConfiguration

public CreateDataSourceRequest withVpcConfiguration(DataSourceVpcConfiguration vpcConfiguration)

Configuration information for an Amazon Virtual Private Cloud to connect to your data source. For more information, see Configuring a VPC.

Parameters:

vpcConfiguration - Configuration information for an Amazon Virtual Private Cloud to connect to your data source. For more information, see Configuring a VPC.

Returns:

Returns a reference to this object so that method calls can be chained together.

setDescription

public void setDescription(String description)

A description for the data source connector.

Parameters:

description - A description for the data source connector.

getDescription

public String getDescription()

A description for the data source connector.

Returns:

A description for the data source connector.

withDescription

public CreateDataSourceRequest withDescription(String description)

A description for the data source connector.

Parameters:

description - A description for the data source connector.

Returns:

Returns a reference to this object so that method calls can be chained together.

setSchedule

public void setSchedule(String schedule)

Sets the frequency for Amazon Kendra to check the documents in your data source repository and update the index. If you don't set a schedule Amazon Kendra will not periodically update the index. You can call the StartDataSourceSyncJob API to update the index.

Specify a cron- format schedule string or an empty string to indicate that the index is updated on demand.

You can't specify the Schedule parameter when the Type parameter is set to CUSTOM. If you do, you receive a ValidationException exception.

Parameters:

schedule - Sets the frequency for Amazon Kendra to check the documents in your data source repository and update the index. If you don't set a schedule Amazon Kendra will not periodically update the index. You can call the StartDataSourceSyncJob API to update the index.

Specify a cron- format schedule string or an empty string to indicate that the index is updated on demand.

You can't specify the Schedule parameter when the Type parameter is set to CUSTOM. If you do, you receive a ValidationException exception.

getSchedule

public String getSchedule()

Sets the frequency for Amazon Kendra to check the documents in your data source repository and update the index. If you don't set a schedule Amazon Kendra will not periodically update the index. You can call the StartDataSourceSyncJob API to update the index.

Specify a cron- format schedule string or an empty string to indicate that the index is updated on demand.

You can't specify the Schedule parameter when the Type parameter is set to CUSTOM. If you do, you receive a ValidationException exception.

Returns:

Sets the frequency for Amazon Kendra to check the documents in your data source repository and update the index. If you don't set a schedule Amazon Kendra will not periodically update the index. You can call the StartDataSourceSyncJob API to update the index.

Specify a cron- format schedule string or an empty string to indicate that the index is updated on demand.

You can't specify the Schedule parameter when the Type parameter is set to CUSTOM. If you do, you receive a ValidationException exception.

withSchedule

public CreateDataSourceRequest withSchedule(String schedule)

Sets the frequency for Amazon Kendra to check the documents in your data source repository and update the index. If you don't set a schedule Amazon Kendra will not periodically update the index. You can call the StartDataSourceSyncJob API to update the index.

Specify a cron- format schedule string or an empty string to indicate that the index is updated on demand.

You can't specify the Schedule parameter when the Type parameter is set to CUSTOM. If you do, you receive a ValidationException exception.

Parameters:

schedule - Sets the frequency for Amazon Kendra to check the documents in your data source repository and update the index. If you don't set a schedule Amazon Kendra will not periodically update the index. You can call the StartDataSourceSyncJob API to update the index.

Specify a cron- format schedule string or an empty string to indicate that the index is updated on demand.

You can't specify the Schedule parameter when the Type parameter is set to CUSTOM. If you do, you receive a ValidationException exception.

Returns:

Returns a reference to this object so that method calls can be chained together.

setRoleArn

public void setRoleArn(String roleArn)

The Amazon Resource Name (ARN) of an IAM role with permission to access the data source and required resources. For more information, see IAM access roles for Amazon Kendra..

You can't specify the RoleArn parameter when the Type parameter is set to CUSTOM. If you do, you receive a ValidationException exception.

The RoleArn parameter is required for all other data sources.

Parameters:

roleArn - The Amazon Resource Name (ARN) of an IAM role with permission to access the data source and required resources. For more information, see IAM access roles for Amazon Kendra..

You can't specify the RoleArn parameter when the Type parameter is set to CUSTOM. If you do, you receive a ValidationException exception.

The RoleArn parameter is required for all other data sources.

getRoleArn

public String getRoleArn()

The Amazon Resource Name (ARN) of an IAM role with permission to access the data source and required resources. For more information, see IAM access roles for Amazon Kendra..

You can't specify the RoleArn parameter when the Type parameter is set to CUSTOM. If you do, you receive a ValidationException exception.

The RoleArn parameter is required for all other data sources.

Returns:

The Amazon Resource Name (ARN) of an IAM role with permission to access the data source and required resources. For more information, see IAM access roles for Amazon Kendra..

You can't specify the RoleArn parameter when the Type parameter is set to CUSTOM. If you do, you receive a ValidationException exception.

The RoleArn parameter is required for all other data sources.

withRoleArn

public CreateDataSourceRequest withRoleArn(String roleArn)

The Amazon Resource Name (ARN) of an IAM role with permission to access the data source and required resources. For more information, see IAM access roles for Amazon Kendra..

You can't specify the RoleArn parameter when the Type parameter is set to CUSTOM. If you do, you receive a ValidationException exception.

The RoleArn parameter is required for all other data sources.

Parameters:

roleArn - The Amazon Resource Name (ARN) of an IAM role with permission to access the data source and required resources. For more information, see IAM access roles for Amazon Kendra..

You can't specify the RoleArn parameter when the Type parameter is set to CUSTOM. If you do, you receive a ValidationException exception.

The RoleArn parameter is required for all other data sources.

Returns:

Returns a reference to this object so that method calls can be chained together.

getTags

public List<Tag> getTags()

A list of key-value pairs that identify or categorize the data source connector. You can also use tags to help control access to the data source connector. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.

Returns:

A list of key-value pairs that identify or categorize the data source connector. You can also use tags to help control access to the data source connector. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.

setTags

public void setTags(Collection<Tag> tags)

A list of key-value pairs that identify or categorize the data source connector. You can also use tags to help control access to the data source connector. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.

Parameters:

tags - A list of key-value pairs that identify or categorize the data source connector. You can also use tags to help control access to the data source connector. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.

withTags

public CreateDataSourceRequest withTags(Tag... tags)

A list of key-value pairs that identify or categorize the data source connector. You can also use tags to help control access to the data source connector. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.

NOTE: This method appends the values to the existing list (if any). Use setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the existing values.

Parameters:

tags - A list of key-value pairs that identify or categorize the data source connector. You can also use tags to help control access to the data source connector. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.

Returns:

Returns a reference to this object so that method calls can be chained together.

withTags

public CreateDataSourceRequest withTags(Collection<Tag> tags)

A list of key-value pairs that identify or categorize the data source connector. You can also use tags to help control access to the data source connector. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.

Parameters:

tags - A list of key-value pairs that identify or categorize the data source connector. You can also use tags to help control access to the data source connector. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.

Returns:

Returns a reference to this object so that method calls can be chained together.

setClientToken

public void setClientToken(String clientToken)

A token that you provide to identify the request to create a data source connector. Multiple calls to the CreateDataSource API with the same client token will create only one data source connector.

Parameters:

clientToken - A token that you provide to identify the request to create a data source connector. Multiple calls to the CreateDataSource API with the same client token will create only one data source connector.

getClientToken

public String getClientToken()

A token that you provide to identify the request to create a data source connector. Multiple calls to the CreateDataSource API with the same client token will create only one data source connector.

Returns:

A token that you provide to identify the request to create a data source connector. Multiple calls to the CreateDataSource API with the same client token will create only one data source connector.

withClientToken

public CreateDataSourceRequest withClientToken(String clientToken)

A token that you provide to identify the request to create a data source connector. Multiple calls to the CreateDataSource API with the same client token will create only one data source connector.

Parameters:

clientToken - A token that you provide to identify the request to create a data source connector. Multiple calls to the CreateDataSource API with the same client token will create only one data source connector.

Returns:

Returns a reference to this object so that method calls can be chained together.

setLanguageCode

public void setLanguageCode(String languageCode)

The code for a language. This allows you to support a language for all documents when creating the data source connector. English is supported by default. For more information on supported languages, including their codes, see Adding documents in languages other than English.

Parameters:

languageCode - The code for a language. This allows you to support a language for all documents when creating the data source connector. English is supported by default. For more information on supported languages, including their codes, see Adding documents in languages other than English.

getLanguageCode

public String getLanguageCode()

The code for a language. This allows you to support a language for all documents when creating the data source connector. English is supported by default. For more information on supported languages, including their codes, see Adding documents in languages other than English.

Returns:

The code for a language. This allows you to support a language for all documents when creating the data source connector. English is supported by default. For more information on supported languages, including their codes, see Adding documents in languages other than English.

withLanguageCode

public CreateDataSourceRequest withLanguageCode(String languageCode)

The code for a language. This allows you to support a language for all documents when creating the data source connector. English is supported by default. For more information on supported languages, including their codes, see Adding documents in languages other than English.

Parameters:

languageCode - The code for a language. This allows you to support a language for all documents when creating the data source connector. English is supported by default. For more information on supported languages, including their codes, see Adding documents in languages other than English.

Returns:

Returns a reference to this object so that method calls can be chained together.

setCustomDocumentEnrichmentConfiguration

public void setCustomDocumentEnrichmentConfiguration(CustomDocumentEnrichmentConfiguration customDocumentEnrichmentConfiguration)

Configuration information for altering document metadata and content during the document ingestion process.

For more information on how to create, modify and delete document metadata, or make other content alterations when you ingest documents into Amazon Kendra, see Customizing document metadata during the ingestion process.

Parameters:

customDocumentEnrichmentConfiguration - Configuration information for altering document metadata and content during the document ingestion process.

For more information on how to create, modify and delete document metadata, or make other content alterations when you ingest documents into Amazon Kendra, see Customizing document metadata during the ingestion process.

getCustomDocumentEnrichmentConfiguration

public CustomDocumentEnrichmentConfiguration getCustomDocumentEnrichmentConfiguration()

Configuration information for altering document metadata and content during the document ingestion process.

For more information on how to create, modify and delete document metadata, or make other content alterations when you ingest documents into Amazon Kendra, see Customizing document metadata during the ingestion process.

Returns:

Configuration information for altering document metadata and content during the document ingestion process.

For more information on how to create, modify and delete document metadata, or make other content alterations when you ingest documents into Amazon Kendra, see Customizing document metadata during the ingestion process.

withCustomDocumentEnrichmentConfiguration

public CreateDataSourceRequest withCustomDocumentEnrichmentConfiguration(CustomDocumentEnrichmentConfiguration customDocumentEnrichmentConfiguration)

Configuration information for altering document metadata and content during the document ingestion process.

For more information on how to create, modify and delete document metadata, or make other content alterations when you ingest documents into Amazon Kendra, see Customizing document metadata during the ingestion process.

Parameters:

customDocumentEnrichmentConfiguration - Configuration information for altering document metadata and content during the document ingestion process.

For more information on how to create, modify and delete document metadata, or make other content alterations when you ingest documents into Amazon Kendra, see Customizing document metadata during the ingestion process.

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public CreateDataSourceRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()