Class CitationMetadata (1.11.0)

public final class CitationMetadata extends GeneratedMessageV3 implements CitationMetadataOrBuilder

A collection of source attributions for a piece of content.

Protobuf type google.cloud.vertexai.v1.CitationMetadata

Static Fields

CITATIONS_FIELD_NUMBER

public static final int CITATIONS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static CitationMetadata getDefaultInstance()
Returns
Type Description
CitationMetadata

getDescriptor()

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

newBuilder()

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

newBuilder(CitationMetadata prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getCitations(int index)

public Citation getCitations(int index)

Output only. List of citations.

repeated .google.cloud.vertexai.v1.Citation citations = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
Citation

getCitationsCount()

public int getCitationsCount()

Output only. List of citations.

repeated .google.cloud.vertexai.v1.Citation citations = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

getCitationsList()

public List<Citation> getCitationsList()

Output only. List of citations.

repeated .google.cloud.vertexai.v1.Citation citations = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<Citation>

getCitationsOrBuilder(int index)

public CitationOrBuilder getCitationsOrBuilder(int index)

Output only. List of citations.

repeated .google.cloud.vertexai.v1.Citation citations = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
CitationOrBuilder

getCitationsOrBuilderList()

public List<? extends CitationOrBuilder> getCitationsOrBuilderList()

Output only. List of citations.

repeated .google.cloud.vertexai.v1.Citation citations = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<? extends com.google.cloud.vertexai.api.CitationOrBuilder>

getDefaultInstanceForType()

public CitationMetadata getDefaultInstanceForType()
Returns
Type Description
CitationMetadata

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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 CitationMetadata.Builder newBuilderForType()
Returns
Type Description
CitationMetadata.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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