Class CitationPageLocation
-
- All Implemented Interfaces:
public final class CitationPageLocation
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classCitationPageLocation.BuilderA builder for CitationPageLocation.
-
Method Summary
Modifier and Type Method Description final CitationPageLocationParamtoParam()final StringcitedText()final LongdocumentIndex()final Optional<String>documentTitle()final LongendPageNumber()final Optional<String>fileId()final LongstartPageNumber()final JsonValue_type()Expected to always return the following:
However, this method can be useful for debugging and logging (e.g.JsonValue.from("page_location")final JsonField<String>_citedText()Returns the raw JSON value of citedText. final JsonField<Long>_documentIndex()Returns the raw JSON value of documentIndex. final JsonField<String>_documentTitle()Returns the raw JSON value of documentTitle. final JsonField<Long>_endPageNumber()Returns the raw JSON value of endPageNumber. final JsonField<String>_fileId()Returns the raw JSON value of fileId. final JsonField<Long>_startPageNumber()Returns the raw JSON value of startPageNumber. final Map<String, JsonValue>_additionalProperties()final CitationPageLocation.BuildertoBuilder()final CitationPageLocationvalidate()Validates that the types of all values in this object match their expected types recursively. final BooleanisValid()Booleanequals(Object other)IntegerhashCode()StringtoString()final static CitationPageLocation.Builderbuilder()Returns a mutable builder for constructing an instance of CitationPageLocation. -
-
Method Detail
-
toParam
final CitationPageLocationParam toParam()
-
documentIndex
final Long documentIndex()
-
documentTitle
final Optional<String> documentTitle()
-
endPageNumber
final Long endPageNumber()
-
startPageNumber
final Long startPageNumber()
-
_type
final JsonValue _type()
Expected to always return the following:
JsonValue.from("page_location")However, this method can be useful for debugging and logging (e.g. if the server responded with an unexpected value).
-
_citedText
final JsonField<String> _citedText()
Returns the raw JSON value of citedText.
Unlike citedText, this method doesn't throw if the JSON field has an unexpected type.
-
_documentIndex
final JsonField<Long> _documentIndex()
Returns the raw JSON value of documentIndex.
Unlike documentIndex, this method doesn't throw if the JSON field has an unexpected type.
-
_documentTitle
final JsonField<String> _documentTitle()
Returns the raw JSON value of documentTitle.
Unlike documentTitle, this method doesn't throw if the JSON field has an unexpected type.
-
_endPageNumber
final JsonField<Long> _endPageNumber()
Returns the raw JSON value of endPageNumber.
Unlike endPageNumber, this method doesn't throw if the JSON field has an unexpected type.
-
_fileId
final JsonField<String> _fileId()
Returns the raw JSON value of fileId.
Unlike fileId, this method doesn't throw if the JSON field has an unexpected type.
-
_startPageNumber
final JsonField<Long> _startPageNumber()
Returns the raw JSON value of startPageNumber.
Unlike startPageNumber, this method doesn't throw if the JSON field has an unexpected type.
-
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
-
toBuilder
final CitationPageLocation.Builder toBuilder()
-
validate
final CitationPageLocation validate()
Validates that the types of all values in this object match their expected types recursively.
This method is not forwards compatible with new types from the API for existing fields.
-
builder
final static CitationPageLocation.Builder builder()
Returns a mutable builder for constructing an instance of CitationPageLocation.
The following fields are required:
.citedText() .documentIndex() .documentTitle() .endPageNumber() .fileId() .startPageNumber()
-
-
-
-