software.amazon.awssdk.services.kendra.model

Class CreateDataSourceRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.kendra.model.KendraRequest

software.amazon.awssdk.services.kendra.model.CreateDataSourceRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateDataSourceRequest.Builder,CreateDataSourceRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateDataSourceRequest
extends KendraRequest
implements ToCopyableBuilder<CreateDataSourceRequest.Builder,CreateDataSourceRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateDataSourceRequest.Builder

Method Summary

Modifier and Type	Method and Description
static CreateDataSourceRequest.Builder	builder()
DataSourceConfiguration	configuration() The connector configuration information that is required to access the repository.
String	description() A description for the data source.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags() Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
String	indexId() The identifier of the index that should be associated with this data source.
String	name() A unique name for the data source.
String	roleArn() The Amazon Resource Name (ARN) of a role with permission to access the data source.
String	schedule() Sets the frequency that Amazon Kendra will check the documents in your repository and update the index.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateDataSourceRequest.Builder>	serializableBuilderClass()
List<Tag>	tags() A list of key-value pairs that identify the data source.
CreateDataSourceRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
DataSourceType	type() The type of repository that contains the data source.
String	typeAsString() The type of repository that contains the data source.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

name

public String name()

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.

indexId

public String indexId()

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.

type

public DataSourceType type()

The type of repository that contains the data source.

If the service returns an enum value that is not available in the current SDK version, type will return DataSourceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

Returns:

The type of repository that contains the data source.

See Also:

DataSourceType

typeAsString

public String typeAsString()

The type of repository that contains the data source.

If the service returns an enum value that is not available in the current SDK version, type will return DataSourceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

Returns:

The type of repository that contains the data source.

See Also:

DataSourceType

configuration

public DataSourceConfiguration configuration()

The connector configuration information that is required to access the repository.

Returns:

The connector configuration information that is required to access the repository.

description

public String description()

A description for the data source.

Returns:

A description for the data source.

schedule

public 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.

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.

roleArn

public 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.

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.

hasTags

public boolean hasTags()

Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

tags

public List<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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasTags() to see if a value was sent in this field.

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.

toBuilder

public CreateDataSourceRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateDataSourceRequest.Builder,CreateDataSourceRequest>

Specified by:

toBuilder in class KendraRequest

builder

public static CreateDataSourceRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateDataSourceRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo