Class GetDocumentContentRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<GetDocumentContentRequest.Builder,
GetDocumentContentRequest>
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionfinal String
The unique identifier of the Amazon Q Business application containing the document.builder()
final String
The identifier of the data source from which the document was ingested.final String
The unique identifier of the document that is indexed via BatchPutDocument API or file-upload or connector sync.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.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 String
indexId()
The identifier of the index where documents are indexed.final OutputFormat
Raw document outputFormat.final String
Raw document outputFormat.static Class
<? extends GetDocumentContentRequest.Builder> 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
-
applicationId
The unique identifier of the Amazon Q Business application containing the document. This ensures the request is scoped to the correct application environment and its associated security policies.
- Returns:
- The unique identifier of the Amazon Q Business application containing the document. This ensures the request is scoped to the correct application environment and its associated security policies.
-
indexId
The identifier of the index where documents are indexed.
- Returns:
- The identifier of the index where documents are indexed.
-
dataSourceId
The identifier of the data source from which the document was ingested. This field is not present if the document is ingested by directly calling the BatchPutDocument API. If the document is from a file-upload data source, the datasource will be "uploaded-docs-file-stat-datasourceid".
- Returns:
- The identifier of the data source from which the document was ingested. This field is not present if the document is ingested by directly calling the BatchPutDocument API. If the document is from a file-upload data source, the datasource will be "uploaded-docs-file-stat-datasourceid".
-
documentId
The unique identifier of the document that is indexed via BatchPutDocument API or file-upload or connector sync. It is also found in chat or chatSync response.
- Returns:
- The unique identifier of the document that is indexed via BatchPutDocument API or file-upload or connector sync. It is also found in chat or chatSync response.
-
outputFormat
Raw document outputFormat.
If the service returns an enum value that is not available in the current SDK version,
outputFormat
will returnOutputFormat.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromoutputFormatAsString()
.- Returns:
- Raw document outputFormat.
- See Also:
-
outputFormatAsString
Raw document outputFormat.
If the service returns an enum value that is not available in the current SDK version,
outputFormat
will returnOutputFormat.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromoutputFormatAsString()
.- Returns:
- Raw document outputFormat.
- See Also:
-
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<GetDocumentContentRequest.Builder,
GetDocumentContentRequest> - Specified by:
toBuilder
in classQBusinessRequest
- 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
-
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
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToField
in interfaceSdkPojo
- Returns:
- The mapping between the field name and its corresponding field.
-