software.amazon.awssdk.services.kendra.model

Class CreateFaqRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateFaqRequest.Builder,CreateFaqRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateFaqRequest.Builder

Method Summary

Modifier and Type	Method and Description
static CreateFaqRequest.Builder	builder()
String	clientToken() A token that you provide to identify the request to create a FAQ.
String	description() A description of the FAQ.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
FaqFileFormat	fileFormat() The format of the input file.
String	fileFormatAsString() The format of the input file.
<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 contains the FAQ.
String	name() The name that should be associated with the FAQ.
String	roleArn() The Amazon Resource Name (ARN) of a role with permission to access the S3 bucket that contains the FAQs.
S3Path	s3Path() The S3 location of the FAQ input data.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateFaqRequest.Builder>	serializableBuilderClass()
List<Tag>	tags() A list of key-value pairs that identify the FAQ.
CreateFaqRequest.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 String indexId()

The identifier of the index that contains the FAQ.

Returns:

The identifier of the index that contains the FAQ.

name

public String name()

The name that should be associated with the FAQ.

Returns:

The name that should be associated with the FAQ.

description

public String description()

A description of the FAQ.

Returns:

A description of the FAQ.

s3Path

public S3Path s3Path()

The S3 location of the FAQ input data.

Returns:

The S3 location of the FAQ input data.

roleArn

public String roleArn()

The Amazon Resource Name (ARN) of a role with permission to access the S3 bucket that contains the FAQs. For more information, see IAM Roles for Amazon Kendra.

Returns:

The Amazon Resource Name (ARN) of a role with permission to access the S3 bucket that contains the FAQs. 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 FAQ. 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 FAQ. You can use the tags to identify and organize your resources and to control access to resources.

fileFormat

public FaqFileFormat fileFormat()

The format of the input file. You can choose between a basic CSV format, a CSV format that includes customs attributes in a header, and a JSON format that includes custom attributes.

The format must match the format of the file stored in the S3 bucket identified in the S3Path parameter.

For more information, see Adding questions and answers.

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

Returns:

The format of the input file. You can choose between a basic CSV format, a CSV format that includes customs attributes in a header, and a JSON format that includes custom attributes.

The format must match the format of the file stored in the S3 bucket identified in the S3Path parameter.

For more information, see Adding questions and answers.

See Also:

FaqFileFormat

fileFormatAsString

public String fileFormatAsString()

The format of the input file. You can choose between a basic CSV format, a CSV format that includes customs attributes in a header, and a JSON format that includes custom attributes.

The format must match the format of the file stored in the S3 bucket identified in the S3Path parameter.

For more information, see Adding questions and answers.

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

Returns:

The format of the input file. You can choose between a basic CSV format, a CSV format that includes customs attributes in a header, and a JSON format that includes custom attributes.

The format must match the format of the file stored in the S3 bucket identified in the S3Path parameter.

For more information, see Adding questions and answers.

See Also:

FaqFileFormat

clientToken

public String clientToken()

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

Returns:

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

toBuilder

public CreateFaqRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateFaqRequest.Builder,CreateFaqRequest>

Specified by:

toBuilder in class KendraRequest

builder

public static CreateFaqRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateFaqRequest.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