Package 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("software.amazon.awssdk:codegen")
public final class CreateThesaurusRequest
extends KendraRequest
implements ToCopyableBuilder<CreateThesaurusRequest.Builder,CreateThesaurusRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateThesaurusRequest.Builder

Method Summary

Modifier and Type	Method	Description
static CreateThesaurusRequest.Builder	builder()
String	clientToken()	A token that you provide to identify the request to create a thesaurus.
String	description()	A description for the thesaurus.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags()	For responses, this returns true if the service returned a value for the Tags property.
String	indexId()	The identifier of the index for the thesaurus.
String	name()	A name for the thesaurus.
String	roleArn()	The Amazon Resource Name (ARN) of an IAM role with permission to access your S3 bucket that contains the thesaurus file.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateThesaurusRequest.Builder>	serializableBuilderClass()
S3Path	sourceS3Path()	The path to the thesaurus file in S3.
List<Tag>	tags()	A list of key-value pairs that identify or categorize 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 identifier of the index for the thesaurus.

Returns:

The identifier of the index for the thesaurus.

name

public final String name()

A name for the thesaurus.

Returns:

A name for the thesaurus.

description

public final String description()

A description for the thesaurus.

Returns:

A description for the thesaurus.

roleArn

public final String roleArn()

The Amazon Resource Name (ARN) of an IAM role with permission to access your S3 bucket that contains the thesaurus file. For more information, see IAM access roles for Amazon Kendra.

Returns:

The Amazon Resource Name (ARN) of an IAM role with permission to access your S3 bucket that contains the thesaurus file. For more information, see IAM access roles for Amazon Kendra.

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

public final List<Tag> tags()

A list of key-value pairs that identify or categorize the thesaurus. You can also use tags to help control access to the thesaurus. 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 thesaurus. You can also use tags to help control access to the thesaurus. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.

sourceS3Path

public final S3Path sourceS3Path()

The path to the thesaurus file in S3.

Returns:

The path to the thesaurus file in S3.

clientToken

public final String clientToken()

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

Returns:

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

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