CreateFaqRequest (AWS Java SDK :: Services

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

Nested Classes
Modifier and Type	Class and Description
`static interface`	`CreateFaqRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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 for the FAQ.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`FaqFileFormat`	`fileFormat()` The format of the FAQ input file.
`String`	`fileFormatAsString()` The format of the FAQ input file.
`<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 FAQ.
`String`	`languageCode()` The code for a language.
`String`	`name()` A name for the FAQ.
`String`	`roleArn()` The Amazon Resource Name (ARN) of an IAM role with permission to access the S3 bucket that contains the FAQs.
`S3Path`	`s3Path()` The path to the FAQ file in S3.
`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 final String indexId()
```
    The identifier of the index for the FAQ.
    
    Returns:
    
    The identifier of the index for the FAQ.
  - name
```
public final String name()
```
    A name for the FAQ.
    
    Returns:
    
    A name for the FAQ.
  - description
```
public final String description()
```
    A description for the FAQ.
    
    Returns:
    
    A description for the FAQ.
  - s3Path
```
public final S3Path s3Path()
```
    The path to the FAQ file in S3.
    
    Returns:
    
    The path to the FAQ file in S3.
  - roleArn
```
public final String roleArn()
```
    The Amazon Resource Name (ARN) of an IAM role with permission to access the S3 bucket that contains the FAQs. For more information, see IAM access roles for Amazon Kendra.
    
    Returns:
    
    The Amazon Resource Name (ARN) of an IAM role with permission to access the S3 bucket that contains the FAQs. 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 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.
    
    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 the FAQ. You can use the tags to identify and organize your resources and to control access to resources.
  - fileFormat
```
public final FaqFileFormat fileFormat()
```
    The format of the FAQ 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 default format is CSV.
    
    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 FAQ 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 default format is CSV.
    
    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 final String fileFormatAsString()
```
    The format of the FAQ 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 default format is CSV.
    
    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 FAQ 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 default format is CSV.
    
    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 final String clientToken()
```
    A token that you provide to identify the request to create a FAQ. Multiple calls to the CreateFaqRequest API 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 API with the same client token will create only one FAQ.
  - languageCode
```
public final String languageCode()
```
    The code for a language. This allows you to support a language for the FAQ document. 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 the FAQ document. English is supported by default. For more information on supported languages, including their codes, see Adding documents in languages other than English.
  - 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 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

Class CreateFaqRequest

Nested Class Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

Method Detail

indexId

name

description

s3Path

roleArn

hasTags

tags

fileFormat

fileFormatAsString

clientToken

languageCode

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields