Class CreateFaqRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CreateFaqRequest.Builder,
CreateFaqRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic CreateFaqRequest.Builder
builder()
final String
A token that you provide to identify the request to create a FAQ.final String
A description for the FAQ.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final FaqFileFormat
The format of the FAQ input file.final String
The format of the FAQ input file.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final String
indexId()
The identifier of the index for the FAQ.final String
The code for a language.final String
name()
A name for the FAQ.final String
roleArn()
The Amazon Resource Name (ARN) of an IAM role with permission to access the S3 bucket that contains the FAQs.final S3Path
s3Path()
The path to the FAQ file in S3.static Class
<? extends CreateFaqRequest.Builder> tags()
A list of key-value pairs that identify the FAQ.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
indexId
The identifier of the index for the FAQ.
- Returns:
- The identifier of the index for the FAQ.
-
name
A name for the FAQ.
- Returns:
- A name for the FAQ.
-
description
A description for the FAQ.
- Returns:
- A description for the FAQ.
-
s3Path
The path to the FAQ file in S3.
- Returns:
- The path to the FAQ file in S3.
-
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 theisEmpty()
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
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
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 returnFaqFileFormat.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromfileFormatAsString()
.- 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:
-
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 returnFaqFileFormat.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromfileFormatAsString()
.- 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:
-
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
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
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<CreateFaqRequest.Builder,
CreateFaqRequest> - Specified by:
toBuilder
in classKendraRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-