FileCitation 0.35.1 API

All Implemented Interfaces:


public final class ResponseOutputText.Annotation.FileCitation

A citation to a file.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public final class`	`ResponseOutputText.Annotation.FileCitation.Builder`	A builder for FileCitation.

Field Summary

Fields
Modifier and Type	Field	Description

Constructor Summary

Constructors
Constructor	Description

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final String`	`fileId()`	The ID of the file.
`final Long`	`index()`	The index of the file in the list of files.
`final JsonValue`	`_type()`	The type of the file citation.
`final JsonField<String>`	`_fileId()`	Returns the raw JSON value of fileId.
`final JsonField<Long>`	`_index()`	Returns the raw JSON value of index.
`final Map<String, JsonValue>`	`_additionalProperties()`
`final ResponseOutputText.Annotation.FileCitation`	`validate()`
`final ResponseOutputText.Annotation.FileCitation.Builder`	`toBuilder()`
`Boolean`	`equals(Object other)`
`Integer`	`hashCode()`
`String`	`toString()`
`final static ResponseOutputText.Annotation.FileCitation.Builder`	`builder()`	Returns a mutable builder for constructing an instance of FileCitation.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
- Method Detail
  - fileId
```
 final String fileId()
```
    The ID of the file.
  - index
```
 final Long index()
```
    The index of the file in the list of files.
  - _type
```
 final JsonValue _type()
```
    The type of the file citation. Always file_citation.
    Expected to always return the following:
    JsonValue.from("file_citation")
    However, this method can be useful for debugging and logging (e.g. if the server responded with an unexpected value).
  - _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.
  - _index
```
 final JsonField<Long> _index()
```
    Returns the raw JSON value of index.
    Unlike index, this method doesn't throw if the JSON field has an unexpected type.
  - _additionalProperties
```
 final Map<String, JsonValue> _additionalProperties()
```
  - validate
```
 final ResponseOutputText.Annotation.FileCitation validate()
```
  - toBuilder
```
 final ResponseOutputText.Annotation.FileCitation.Builder toBuilder()
```
  - equals
```
 Boolean equals(Object other)
```
  - hashCode
```
 Integer hashCode()
```
  - toString
```
 String toString()
```
  - builder
```
 final static ResponseOutputText.Annotation.FileCitation.Builder builder()
```
    Returns a mutable builder for constructing an instance of FileCitation.
    The following fields are required:
    .fileId() .index()