Class CreateDataSourceRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CreateDataSourceRequest.Builder,
CreateDataSourceRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final String
A token that you provide to identify the request to create a data source connector.final DataSourceConfiguration
Configuration information to connect to your data source repository.Configuration information for altering document metadata and content during the document ingestion process.final String
A description for the data source connector.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final String
indexId()
The identifier of the index you want to use with the data source connector.final String
The code for a language.final String
name()
A name for the data source connector.final String
roleArn()
The Amazon Resource Name (ARN) of an IAM role with permission to access the data source and required resources.final String
schedule()
Sets the frequency for Amazon Kendra to check the documents in your data source repository and update the index.static Class
<? extends CreateDataSourceRequest.Builder> tags()
A list of key-value pairs that identify or categorize the data source connector.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final DataSourceType
type()
The type of data source repository.final String
The type of data source repository.Configuration information for an Amazon Virtual Private Cloud to connect to your data source.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
name
A name for the data source connector.
- Returns:
- A name for the data source connector.
-
indexId
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.
-
type
The type of data source repository. For example,
SHAREPOINT
.If the service returns an enum value that is not available in the current SDK version,
type
will returnDataSourceType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- The type of data source repository. For example,
SHAREPOINT
. - See Also:
-
typeAsString
The type of data source repository. For example,
SHAREPOINT
.If the service returns an enum value that is not available in the current SDK version,
type
will returnDataSourceType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- The type of data source repository. For example,
SHAREPOINT
. - See Also:
-
configuration
Configuration information to connect to your data source repository.
You can't specify the
Configuration
parameter when theType
parameter is set toCUSTOM
. If you do, you receive aValidationException
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 theType
parameter is set toCUSTOM
. If you do, you receive aValidationException
exception.The
Configuration
parameter is required for all other data sources.
-
vpcConfiguration
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.
-
description
A description for the data source connector.
- Returns:
- A description for the data source connector.
-
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 theType
parameter is set toCUSTOM
. If you do, you receive aValidationException
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 theType
parameter is set toCUSTOM
. If you do, you receive aValidationException
exception.
-
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 theType
parameter is set toCUSTOM
. If you do, you receive aValidationException
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 theType
parameter is set toCUSTOM
. If you do, you receive aValidationException
exception.The
RoleArn
parameter is required for all other data sources.
-
hasTags
public final boolean hasTags()For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
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: _ . : / = + - @.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasTags()
method.- 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: _ . : / = + - @.
-
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:
- 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.
-
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:
- 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.
-
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:
- 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.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<CreateDataSourceRequest.Builder,
CreateDataSourceRequest> - Specified by:
toBuilder
in classKendraRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-