Class CitationMetadata.Builder (1.14.0)

public static final class CitationMetadata.Builder extends GeneratedMessageV3.Builder<CitationMetadata.Builder> implements CitationMetadataOrBuilder

A collection of source attributions for a piece of content.

Protobuf type google.cloud.vertexai.v1.CitationMetadata

Static Methods

getDescriptor()

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

Methods

addAllCitations(Iterable<? extends Citation> values)

public CitationMetadata.Builder addAllCitations(Iterable<? extends Citation> values)

Output only. List of citations.

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

Parameter
Name Description
values Iterable<? extends com.google.cloud.vertexai.api.Citation>
Returns
Type Description
CitationMetadata.Builder

addCitations(Citation value)

public CitationMetadata.Builder addCitations(Citation value)

Output only. List of citations.

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

Parameter
Name Description
value Citation
Returns
Type Description
CitationMetadata.Builder

addCitations(Citation.Builder builderForValue)

public CitationMetadata.Builder addCitations(Citation.Builder builderForValue)

Output only. List of citations.

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

Parameter
Name Description
builderForValue Citation.Builder
Returns
Type Description
CitationMetadata.Builder

addCitations(int index, Citation value)

public CitationMetadata.Builder addCitations(int index, Citation value)

Output only. List of citations.

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

Parameters
Name Description
index int
value Citation
Returns
Type Description
CitationMetadata.Builder

addCitations(int index, Citation.Builder builderForValue)

public CitationMetadata.Builder addCitations(int index, Citation.Builder builderForValue)

Output only. List of citations.

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

Parameters
Name Description
index int
builderForValue Citation.Builder
Returns
Type Description
CitationMetadata.Builder

addCitationsBuilder()

public Citation.Builder addCitationsBuilder()

Output only. List of citations.

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

Returns
Type Description
Citation.Builder

addCitationsBuilder(int index)

public Citation.Builder addCitationsBuilder(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.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public CitationMetadata.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
CitationMetadata.Builder
Overrides

build()

public CitationMetadata build()
Returns
Type Description
CitationMetadata

buildPartial()

public CitationMetadata buildPartial()
Returns
Type Description
CitationMetadata

clear()

public CitationMetadata.Builder clear()
Returns
Type Description
CitationMetadata.Builder
Overrides

clearCitations()

public CitationMetadata.Builder clearCitations()

Output only. List of citations.

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

Returns
Type Description
CitationMetadata.Builder

clearField(Descriptors.FieldDescriptor field)

public CitationMetadata.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
CitationMetadata.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public CitationMetadata.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
CitationMetadata.Builder
Overrides

clone()

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

getCitationsBuilder(int index)

public Citation.Builder getCitationsBuilder(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.Builder

getCitationsBuilderList()

public List<Citation.Builder> getCitationsBuilderList()

Output only. List of citations.

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

Returns
Type Description
List<Builder>

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(CitationMetadata other)

public CitationMetadata.Builder mergeFrom(CitationMetadata other)
Parameter
Name Description
other CitationMetadata
Returns
Type Description
CitationMetadata.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public CitationMetadata.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CitationMetadata.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public CitationMetadata.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
CitationMetadata.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final CitationMetadata.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
CitationMetadata.Builder
Overrides

removeCitations(int index)

public CitationMetadata.Builder removeCitations(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
CitationMetadata.Builder

setCitations(int index, Citation value)

public CitationMetadata.Builder setCitations(int index, Citation value)

Output only. List of citations.

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

Parameters
Name Description
index int
value Citation
Returns
Type Description
CitationMetadata.Builder

setCitations(int index, Citation.Builder builderForValue)

public CitationMetadata.Builder setCitations(int index, Citation.Builder builderForValue)

Output only. List of citations.

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

Parameters
Name Description
index int
builderForValue Citation.Builder
Returns
Type Description
CitationMetadata.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public CitationMetadata.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
CitationMetadata.Builder
Overrides

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public CitationMetadata.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
CitationMetadata.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final CitationMetadata.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
CitationMetadata.Builder
Overrides