Class DocumentPageLocation
- java.lang.Object
-
- software.amazon.awssdk.services.bedrockruntime.model.DocumentPageLocation
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<DocumentPageLocation.Builder,DocumentPageLocation>
@Generated("software.amazon.awssdk:codegen") public final class DocumentPageLocation extends Object implements SdkPojo, Serializable, ToCopyableBuilder<DocumentPageLocation.Builder,DocumentPageLocation>
Specifies a page-level location within a document, providing positioning information for cited content using page numbers.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceDocumentPageLocation.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static DocumentPageLocation.Builderbuilder()IntegerdocumentIndex()The index of the document within the array of documents provided in the request.Integerend()The ending page number of the cited content within the document.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends DocumentPageLocation.Builder>serializableBuilderClass()Integerstart()The starting page number of the cited content within the document.DocumentPageLocation.BuildertoBuilder()StringtoString()Returns a string representation of this object.-
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
-
documentIndex
public final Integer documentIndex()
The index of the document within the array of documents provided in the request.
- Returns:
- The index of the document within the array of documents provided in the request.
-
start
public final Integer start()
The starting page number of the cited content within the document.
- Returns:
- The starting page number of the cited content within the document.
-
end
public final Integer end()
The ending page number of the cited content within the document.
- Returns:
- The ending page number of the cited content within the document.
-
toBuilder
public DocumentPageLocation.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<DocumentPageLocation.Builder,DocumentPageLocation>
-
builder
public static DocumentPageLocation.Builder builder()
-
serializableBuilderClass
public static Class<? extends DocumentPageLocation.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-