software.amazon.awssdk.services.kendra.model

Class CreateThesaurusRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateThesaurusRequest.Builder,CreateThesaurusRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateThesaurusRequest.Builder

Method Summary

Modifier and Type	Method and Description
static CreateThesaurusRequest.Builder	builder()
String	clientToken() A token that you provide to identify the request to create a thesaurus.
String	description() The description for the new thesaurus.
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 unique identifier of the index for the new thesaurus.
String	name() The name for the new thesaurus.
String	roleArn() An AWS Identity and Access Management (IAM) role that gives Amazon Kendra permissions to access thesaurus file specified in SourceS3Path.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateThesaurusRequest.Builder>	serializableBuilderClass()
S3Path	sourceS3Path() The thesaurus file Amazon S3 source path.
List<Tag>	tags() A list of key-value pairs that identify the thesaurus.
CreateThesaurusRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

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

indexId

public final String indexId()

The unique identifier of the index for the new thesaurus.

Returns:

The unique identifier of the index for the new thesaurus.

name

public final String name()

The name for the new thesaurus.

Returns:

The name for the new thesaurus.

description

public final String description()

The description for the new thesaurus.

Returns:

The description for the new thesaurus.

roleArn

public final String roleArn()

An AWS Identity and Access Management (IAM) role that gives Amazon Kendra permissions to access thesaurus file specified in SourceS3Path.

Returns:

An AWS Identity and Access Management (IAM) role that gives Amazon Kendra permissions to access thesaurus file specified in SourceS3Path.

hasTags

public final 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 final List<Tag> tags()

A list of key-value pairs that identify the thesaurus. 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 thesaurus. You can use the tags to identify and organize your resources and to control access to resources.

sourceS3Path

public final S3Path sourceS3Path()

The thesaurus file Amazon S3 source path.

Returns:

The thesaurus file Amazon S3 source path.

clientToken

public final String clientToken()

A token that you provide to identify the request to create a thesaurus. Multiple calls to the CreateThesaurus operation with the same client token will create only one index.

Returns:

A token that you provide to identify the request to create a thesaurus. Multiple calls to the CreateThesaurus operation with the same client token will create only one index.

toBuilder

public CreateThesaurusRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateThesaurusRequest.Builder,CreateThesaurusRequest>

Specified by:

toBuilder in class KendraRequest

builder

public static CreateThesaurusRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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 final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo