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.
DataSourceConfiguration	getConfiguration() The connector configuration information that is required to access the repository.
String	getDescription() A description for the data source.
String	getIndexId() The identifier of the index that should be associated with this data source.
String	getName() A unique name for the data source.
String	getRoleArn() The Amazon Resource Name (ARN) of a role with permission to access the data source.
String	getSchedule() Sets the frequency that Amazon Kendra will check the documents in your repository and update the index.
List<Tag>	getTags() A list of key-value pairs that identify the data source.
String	getType() The type of repository that contains the data source.
int	hashCode()
void	setClientToken(String clientToken) A token that you provide to identify the request to create a data source.
void	setConfiguration(DataSourceConfiguration configuration) The connector configuration information that is required to access the repository.
void	setDescription(String description) A description for the data source.
void	setIndexId(String indexId) The identifier of the index that should be associated with this data source.
void	setName(String name) A unique name for the data source.
void	setRoleArn(String roleArn) The Amazon Resource Name (ARN) of a role with permission to access the data source.
void	setSchedule(String schedule) Sets the frequency that Amazon Kendra will check the documents in your repository and update the index.
void	setTags(Collection<Tag> tags) A list of key-value pairs that identify the data source.
void	setType(String type) The type of repository that contains the 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.
CreateDataSourceRequest	withConfiguration(DataSourceConfiguration configuration) The connector configuration information that is required to access the repository.
CreateDataSourceRequest	withDescription(String description) A description for the data source.
CreateDataSourceRequest	withIndexId(String indexId) The identifier of the index that should be associated with this data source.
CreateDataSourceRequest	withName(String name) A unique name for the data source.
CreateDataSourceRequest	withRoleArn(String roleArn) The Amazon Resource Name (ARN) of a role with permission to access the data source.
CreateDataSourceRequest	withSchedule(String schedule) Sets the frequency that Amazon Kendra will check the documents in your repository and update the index.
CreateDataSourceRequest	withTags(Collection<Tag> tags) A list of key-value pairs that identify the data source.
CreateDataSourceRequest	withTags(Tag... tags) A list of key-value pairs that identify the data source.
CreateDataSourceRequest	withType(DataSourceType type) The type of repository that contains the data source.
CreateDataSourceRequest	withType(String type) The type of repository that contains the 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 unique name for the data source. A data source name can't be changed without deleting and recreating the data source.

Parameters:

name - A unique name for the data source. A data source name can't be changed without deleting and recreating the data source.

getName

public String getName()

A unique name for the data source. A data source name can't be changed without deleting and recreating the data source.

Returns:

A unique name for the data source. A data source name can't be changed without deleting and recreating the data source.

withName

public CreateDataSourceRequest withName(String name)

A unique name for the data source. A data source name can't be changed without deleting and recreating the data source.

Parameters:

name - A unique name for the data source. A data source name can't be changed without deleting and recreating the data source.

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 that should be associated with this data source.

Parameters:

indexId - The identifier of the index that should be associated with this data source.

getIndexId

public String getIndexId()

The identifier of the index that should be associated with this data source.

Returns:

The identifier of the index that should be associated with this data source.

withIndexId

public CreateDataSourceRequest withIndexId(String indexId)

The identifier of the index that should be associated with this data source.

Parameters:

indexId - The identifier of the index that should be associated with this data source.

Returns:

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

setType

public void setType(String type)

The type of repository that contains the data source.

Parameters:

type - The type of repository that contains the data source.

See Also:

DataSourceType

getType

public String getType()

The type of repository that contains the data source.

Returns:

The type of repository that contains the data source.

See Also:

DataSourceType

withType

public CreateDataSourceRequest withType(String type)

The type of repository that contains the data source.

Parameters:

type - The type of repository that contains the data source.

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 repository that contains the data source.

Parameters:

type - The type of repository that contains the data source.

Returns:

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

See Also:

DataSourceType

setConfiguration

public void setConfiguration(DataSourceConfiguration configuration)

The connector configuration information that is required to access the 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 - The connector configuration information that is required to access the 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()

The connector configuration information that is required to access the 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:

The connector configuration information that is required to access the 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)

The connector configuration information that is required to access the 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 - The connector configuration information that is required to access the 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.

setDescription

public void setDescription(String description)

A description for the data source.

Parameters:

description - A description for the data source.

getDescription

public String getDescription()

A description for the data source.

Returns:

A description for the data source.

withDescription

public CreateDataSourceRequest withDescription(String description)

A description for the data source.

Parameters:

description - A description for the data source.

Returns:

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

setSchedule

public void setSchedule(String schedule)

Sets the frequency that Amazon Kendra will check the documents in your 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 operation to update the index.

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 that Amazon Kendra will check the documents in your 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 operation to update the index.

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 that Amazon Kendra will check the documents in your 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 operation to update the index.

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 that Amazon Kendra will check the documents in your 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 operation to update the index.

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 that Amazon Kendra will check the documents in your 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 operation to update the index.

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 that Amazon Kendra will check the documents in your 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 operation to update the index.

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 a role with permission to access the data source. For more information, see IAM 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 a role with permission to access the data source. For more information, see IAM 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 a role with permission to access the data source. For more information, see IAM 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 a role with permission to access the data source. For more information, see IAM 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 a role with permission to access the data source. For more information, see IAM 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 a role with permission to access the data source. For more information, see IAM 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 the data source. You can use the tags to identify and organize your resources and to control access to resources.

Returns:

A list of key-value pairs that identify the data source. You can use the tags to identify and organize your resources and to control access to resources.

setTags

public void setTags(Collection<Tag> tags)

A list of key-value pairs that identify the data source. You can use the tags to identify and organize your resources and to control access to resources.

Parameters:

tags - A list of key-value pairs that identify the data source. You can use the tags to identify and organize your resources and to control access to resources.

withTags

public CreateDataSourceRequest withTags(Tag... tags)

A list of key-value pairs that identify the data source. You can use the tags to identify and organize your resources and to control access to resources.

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 the data source. You can use the tags to identify and organize your resources and to control access to resources.

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 the data source. You can use the tags to identify and organize your resources and to control access to resources.

Parameters:

tags - A list of key-value pairs that identify the data source. You can use the tags to identify and organize your resources and to control access to resources.

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. Multiple calls to the CreateDataSource operation with the same client token will create only one data source.

Parameters:

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

getClientToken

public String getClientToken()

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

Returns:

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

withClientToken

public CreateDataSourceRequest withClientToken(String clientToken)

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

Parameters:

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

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