Class Citation (1.11.0)

public final class Citation extends GeneratedMessageV3 implements CitationOrBuilder

Source attributions for content.

Protobuf type google.cloud.vertexai.v1.Citation

Implements

CitationOrBuilder

Static Fields

END_INDEX_FIELD_NUMBER

public static final int END_INDEX_FIELD_NUMBER
Field Value
Type Description
int

LICENSE_FIELD_NUMBER

public static final int LICENSE_FIELD_NUMBER
Field Value
Type Description
int

PUBLICATION_DATE_FIELD_NUMBER

public static final int PUBLICATION_DATE_FIELD_NUMBER
Field Value
Type Description
int

START_INDEX_FIELD_NUMBER

public static final int START_INDEX_FIELD_NUMBER
Field Value
Type Description
int

TITLE_FIELD_NUMBER

public static final int TITLE_FIELD_NUMBER
Field Value
Type Description
int

URI_FIELD_NUMBER

public static final int URI_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Citation getDefaultInstance()
Returns
Type Description
Citation

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static Citation.Builder newBuilder()
Returns
Type Description
Citation.Builder

newBuilder(Citation prototype)

public static Citation.Builder newBuilder(Citation prototype)
Parameter
Name Description
prototype Citation
Returns
Type Description
Citation.Builder

parseDelimitedFrom(InputStream input)

public static Citation parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Citation
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Citation parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Citation
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Citation parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Citation
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Citation parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Citation
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Citation parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Citation
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Citation parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Citation
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Citation parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Citation
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Citation parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Citation
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Citation parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Citation
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Citation parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Citation
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Citation parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Citation
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Citation parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Citation
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Citation> parser()
Returns
Type Description
Parser<Citation>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public Citation getDefaultInstanceForType()
Returns
Type Description
Citation

getEndIndex()

public int getEndIndex()

Output only. End index into the content.

int32 end_index = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The endIndex.

getLicense()

public String getLicense()

Output only. License of the attribution.

string license = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The license.

getLicenseBytes()

public ByteString getLicenseBytes()

Output only. License of the attribution.

string license = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for license.

getParserForType()

public Parser<Citation> getParserForType()
Returns
Type Description
Parser<Citation>
Overrides

getPublicationDate()

public Date getPublicationDate()

Output only. Publication date of the attribution.

.google.type.Date publication_date = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
com.google.type.Date

The publicationDate.

getPublicationDateOrBuilder()

public DateOrBuilder getPublicationDateOrBuilder()

Output only. Publication date of the attribution.

.google.type.Date publication_date = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
com.google.type.DateOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getStartIndex()

public int getStartIndex()

Output only. Start index into the content.

int32 start_index = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The startIndex.

getTitle()

public String getTitle()

Output only. Title of the attribution.

string title = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The title.

getTitleBytes()

public ByteString getTitleBytes()

Output only. Title of the attribution.

string title = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for title.

getUri()

public String getUri()

Output only. Url reference of the attribution.

string uri = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The uri.

getUriBytes()

public ByteString getUriBytes()

Output only. Url reference of the attribution.

string uri = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for uri.

hasPublicationDate()

public boolean hasPublicationDate()

Output only. Publication date of the attribution.

.google.type.Date publication_date = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the publicationDate field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Citation.Builder newBuilderForType()
Returns
Type Description
Citation.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Citation.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Citation.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public Citation.Builder toBuilder()
Returns
Type Description
Citation.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException