Class SearchResponse.Summary.SummaryWithMetadata.Builder (0.36.0)

public static final class SearchResponse.Summary.SummaryWithMetadata.Builder extends GeneratedMessageV3.Builder<SearchResponse.Summary.SummaryWithMetadata.Builder> implements SearchResponse.Summary.SummaryWithMetadataOrBuilder

Summary with metadata information.

Protobuf type google.cloud.discoveryengine.v1alpha.SearchResponse.Summary.SummaryWithMetadata

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addAllReferences(Iterable<? extends SearchResponse.Summary.Reference> values)

public SearchResponse.Summary.SummaryWithMetadata.Builder addAllReferences(Iterable<? extends SearchResponse.Summary.Reference> values)

Document References.

repeated .google.cloud.discoveryengine.v1alpha.SearchResponse.Summary.Reference references = 3;

Parameter
NameDescription
valuesIterable<? extends com.google.cloud.discoveryengine.v1alpha.SearchResponse.Summary.Reference>
Returns
TypeDescription
SearchResponse.Summary.SummaryWithMetadata.Builder

addReferences(SearchResponse.Summary.Reference value)

public SearchResponse.Summary.SummaryWithMetadata.Builder addReferences(SearchResponse.Summary.Reference value)

Document References.

repeated .google.cloud.discoveryengine.v1alpha.SearchResponse.Summary.Reference references = 3;

Parameter
NameDescription
valueSearchResponse.Summary.Reference
Returns
TypeDescription
SearchResponse.Summary.SummaryWithMetadata.Builder

addReferences(SearchResponse.Summary.Reference.Builder builderForValue)

public SearchResponse.Summary.SummaryWithMetadata.Builder addReferences(SearchResponse.Summary.Reference.Builder builderForValue)

Document References.

repeated .google.cloud.discoveryengine.v1alpha.SearchResponse.Summary.Reference references = 3;

Parameter
NameDescription
builderForValueSearchResponse.Summary.Reference.Builder
Returns
TypeDescription
SearchResponse.Summary.SummaryWithMetadata.Builder

addReferences(int index, SearchResponse.Summary.Reference value)

public SearchResponse.Summary.SummaryWithMetadata.Builder addReferences(int index, SearchResponse.Summary.Reference value)

Document References.

repeated .google.cloud.discoveryengine.v1alpha.SearchResponse.Summary.Reference references = 3;

Parameters
NameDescription
indexint
valueSearchResponse.Summary.Reference
Returns
TypeDescription
SearchResponse.Summary.SummaryWithMetadata.Builder

addReferences(int index, SearchResponse.Summary.Reference.Builder builderForValue)

public SearchResponse.Summary.SummaryWithMetadata.Builder addReferences(int index, SearchResponse.Summary.Reference.Builder builderForValue)

Document References.

repeated .google.cloud.discoveryengine.v1alpha.SearchResponse.Summary.Reference references = 3;

Parameters
NameDescription
indexint
builderForValueSearchResponse.Summary.Reference.Builder
Returns
TypeDescription
SearchResponse.Summary.SummaryWithMetadata.Builder

addReferencesBuilder()

public SearchResponse.Summary.Reference.Builder addReferencesBuilder()

Document References.

repeated .google.cloud.discoveryengine.v1alpha.SearchResponse.Summary.Reference references = 3;

Returns
TypeDescription
SearchResponse.Summary.Reference.Builder

addReferencesBuilder(int index)

public SearchResponse.Summary.Reference.Builder addReferencesBuilder(int index)

Document References.

repeated .google.cloud.discoveryengine.v1alpha.SearchResponse.Summary.Reference references = 3;

Parameter
NameDescription
indexint
Returns
TypeDescription
SearchResponse.Summary.Reference.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public SearchResponse.Summary.SummaryWithMetadata.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
SearchResponse.Summary.SummaryWithMetadata.Builder
Overrides

build()

public SearchResponse.Summary.SummaryWithMetadata build()
Returns
TypeDescription
SearchResponse.Summary.SummaryWithMetadata

buildPartial()

public SearchResponse.Summary.SummaryWithMetadata buildPartial()
Returns
TypeDescription
SearchResponse.Summary.SummaryWithMetadata

clear()

public SearchResponse.Summary.SummaryWithMetadata.Builder clear()
Returns
TypeDescription
SearchResponse.Summary.SummaryWithMetadata.Builder
Overrides

clearCitationMetadata()

public SearchResponse.Summary.SummaryWithMetadata.Builder clearCitationMetadata()

Citation metadata for given summary.

.google.cloud.discoveryengine.v1alpha.SearchResponse.Summary.CitationMetadata citation_metadata = 2;

Returns
TypeDescription
SearchResponse.Summary.SummaryWithMetadata.Builder

clearField(Descriptors.FieldDescriptor field)

public SearchResponse.Summary.SummaryWithMetadata.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
SearchResponse.Summary.SummaryWithMetadata.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public SearchResponse.Summary.SummaryWithMetadata.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
SearchResponse.Summary.SummaryWithMetadata.Builder
Overrides

clearReferences()

public SearchResponse.Summary.SummaryWithMetadata.Builder clearReferences()

Document References.

repeated .google.cloud.discoveryengine.v1alpha.SearchResponse.Summary.Reference references = 3;

Returns
TypeDescription
SearchResponse.Summary.SummaryWithMetadata.Builder

clearSummary()

public SearchResponse.Summary.SummaryWithMetadata.Builder clearSummary()

Summary text with no citation information.

string summary = 1;

Returns
TypeDescription
SearchResponse.Summary.SummaryWithMetadata.Builder

This builder for chaining.

clone()

public SearchResponse.Summary.SummaryWithMetadata.Builder clone()
Returns
TypeDescription
SearchResponse.Summary.SummaryWithMetadata.Builder
Overrides

getCitationMetadata()

public SearchResponse.Summary.CitationMetadata getCitationMetadata()

Citation metadata for given summary.

.google.cloud.discoveryengine.v1alpha.SearchResponse.Summary.CitationMetadata citation_metadata = 2;

Returns
TypeDescription
SearchResponse.Summary.CitationMetadata

The citationMetadata.

getCitationMetadataBuilder()

public SearchResponse.Summary.CitationMetadata.Builder getCitationMetadataBuilder()

Citation metadata for given summary.

.google.cloud.discoveryengine.v1alpha.SearchResponse.Summary.CitationMetadata citation_metadata = 2;

Returns
TypeDescription
SearchResponse.Summary.CitationMetadata.Builder

getCitationMetadataOrBuilder()

public SearchResponse.Summary.CitationMetadataOrBuilder getCitationMetadataOrBuilder()

Citation metadata for given summary.

.google.cloud.discoveryengine.v1alpha.SearchResponse.Summary.CitationMetadata citation_metadata = 2;

Returns
TypeDescription
SearchResponse.Summary.CitationMetadataOrBuilder

getDefaultInstanceForType()

public SearchResponse.Summary.SummaryWithMetadata getDefaultInstanceForType()
Returns
TypeDescription
SearchResponse.Summary.SummaryWithMetadata

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getReferences(int index)

public SearchResponse.Summary.Reference getReferences(int index)

Document References.

repeated .google.cloud.discoveryengine.v1alpha.SearchResponse.Summary.Reference references = 3;

Parameter
NameDescription
indexint
Returns
TypeDescription
SearchResponse.Summary.Reference

getReferencesBuilder(int index)

public SearchResponse.Summary.Reference.Builder getReferencesBuilder(int index)

Document References.

repeated .google.cloud.discoveryengine.v1alpha.SearchResponse.Summary.Reference references = 3;

Parameter
NameDescription
indexint
Returns
TypeDescription
SearchResponse.Summary.Reference.Builder

getReferencesBuilderList()

public List<SearchResponse.Summary.Reference.Builder> getReferencesBuilderList()

Document References.

repeated .google.cloud.discoveryengine.v1alpha.SearchResponse.Summary.Reference references = 3;

Returns
TypeDescription
List<Builder>

getReferencesCount()

public int getReferencesCount()

Document References.

repeated .google.cloud.discoveryengine.v1alpha.SearchResponse.Summary.Reference references = 3;

Returns
TypeDescription
int

getReferencesList()

public List<SearchResponse.Summary.Reference> getReferencesList()

Document References.

repeated .google.cloud.discoveryengine.v1alpha.SearchResponse.Summary.Reference references = 3;

Returns
TypeDescription
List<Reference>

getReferencesOrBuilder(int index)

public SearchResponse.Summary.ReferenceOrBuilder getReferencesOrBuilder(int index)

Document References.

repeated .google.cloud.discoveryengine.v1alpha.SearchResponse.Summary.Reference references = 3;

Parameter
NameDescription
indexint
Returns
TypeDescription
SearchResponse.Summary.ReferenceOrBuilder

getReferencesOrBuilderList()

public List<? extends SearchResponse.Summary.ReferenceOrBuilder> getReferencesOrBuilderList()

Document References.

repeated .google.cloud.discoveryengine.v1alpha.SearchResponse.Summary.Reference references = 3;

Returns
TypeDescription
List<? extends com.google.cloud.discoveryengine.v1alpha.SearchResponse.Summary.ReferenceOrBuilder>

getSummary()

public String getSummary()

Summary text with no citation information.

string summary = 1;

Returns
TypeDescription
String

The summary.

getSummaryBytes()

public ByteString getSummaryBytes()

Summary text with no citation information.

string summary = 1;

Returns
TypeDescription
ByteString

The bytes for summary.

hasCitationMetadata()

public boolean hasCitationMetadata()

Citation metadata for given summary.

.google.cloud.discoveryengine.v1alpha.SearchResponse.Summary.CitationMetadata citation_metadata = 2;

Returns
TypeDescription
boolean

Whether the citationMetadata field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeCitationMetadata(SearchResponse.Summary.CitationMetadata value)

public SearchResponse.Summary.SummaryWithMetadata.Builder mergeCitationMetadata(SearchResponse.Summary.CitationMetadata value)

Citation metadata for given summary.

.google.cloud.discoveryengine.v1alpha.SearchResponse.Summary.CitationMetadata citation_metadata = 2;

Parameter
NameDescription
valueSearchResponse.Summary.CitationMetadata
Returns
TypeDescription
SearchResponse.Summary.SummaryWithMetadata.Builder

mergeFrom(SearchResponse.Summary.SummaryWithMetadata other)

public SearchResponse.Summary.SummaryWithMetadata.Builder mergeFrom(SearchResponse.Summary.SummaryWithMetadata other)
Parameter
NameDescription
otherSearchResponse.Summary.SummaryWithMetadata
Returns
TypeDescription
SearchResponse.Summary.SummaryWithMetadata.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public SearchResponse.Summary.SummaryWithMetadata.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SearchResponse.Summary.SummaryWithMetadata.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public SearchResponse.Summary.SummaryWithMetadata.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
SearchResponse.Summary.SummaryWithMetadata.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final SearchResponse.Summary.SummaryWithMetadata.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
SearchResponse.Summary.SummaryWithMetadata.Builder
Overrides

removeReferences(int index)

public SearchResponse.Summary.SummaryWithMetadata.Builder removeReferences(int index)

Document References.

repeated .google.cloud.discoveryengine.v1alpha.SearchResponse.Summary.Reference references = 3;

Parameter
NameDescription
indexint
Returns
TypeDescription
SearchResponse.Summary.SummaryWithMetadata.Builder

setCitationMetadata(SearchResponse.Summary.CitationMetadata value)

public SearchResponse.Summary.SummaryWithMetadata.Builder setCitationMetadata(SearchResponse.Summary.CitationMetadata value)

Citation metadata for given summary.

.google.cloud.discoveryengine.v1alpha.SearchResponse.Summary.CitationMetadata citation_metadata = 2;

Parameter
NameDescription
valueSearchResponse.Summary.CitationMetadata
Returns
TypeDescription
SearchResponse.Summary.SummaryWithMetadata.Builder

setCitationMetadata(SearchResponse.Summary.CitationMetadata.Builder builderForValue)

public SearchResponse.Summary.SummaryWithMetadata.Builder setCitationMetadata(SearchResponse.Summary.CitationMetadata.Builder builderForValue)

Citation metadata for given summary.

.google.cloud.discoveryengine.v1alpha.SearchResponse.Summary.CitationMetadata citation_metadata = 2;

Parameter
NameDescription
builderForValueSearchResponse.Summary.CitationMetadata.Builder
Returns
TypeDescription
SearchResponse.Summary.SummaryWithMetadata.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public SearchResponse.Summary.SummaryWithMetadata.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
SearchResponse.Summary.SummaryWithMetadata.Builder
Overrides

setReferences(int index, SearchResponse.Summary.Reference value)

public SearchResponse.Summary.SummaryWithMetadata.Builder setReferences(int index, SearchResponse.Summary.Reference value)

Document References.

repeated .google.cloud.discoveryengine.v1alpha.SearchResponse.Summary.Reference references = 3;

Parameters
NameDescription
indexint
valueSearchResponse.Summary.Reference
Returns
TypeDescription
SearchResponse.Summary.SummaryWithMetadata.Builder

setReferences(int index, SearchResponse.Summary.Reference.Builder builderForValue)

public SearchResponse.Summary.SummaryWithMetadata.Builder setReferences(int index, SearchResponse.Summary.Reference.Builder builderForValue)

Document References.

repeated .google.cloud.discoveryengine.v1alpha.SearchResponse.Summary.Reference references = 3;

Parameters
NameDescription
indexint
builderForValueSearchResponse.Summary.Reference.Builder
Returns
TypeDescription
SearchResponse.Summary.SummaryWithMetadata.Builder

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

public SearchResponse.Summary.SummaryWithMetadata.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
SearchResponse.Summary.SummaryWithMetadata.Builder
Overrides

setSummary(String value)

public SearchResponse.Summary.SummaryWithMetadata.Builder setSummary(String value)

Summary text with no citation information.

string summary = 1;

Parameter
NameDescription
valueString

The summary to set.

Returns
TypeDescription
SearchResponse.Summary.SummaryWithMetadata.Builder

This builder for chaining.

setSummaryBytes(ByteString value)

public SearchResponse.Summary.SummaryWithMetadata.Builder setSummaryBytes(ByteString value)

Summary text with no citation information.

string summary = 1;

Parameter
NameDescription
valueByteString

The bytes for summary to set.

Returns
TypeDescription
SearchResponse.Summary.SummaryWithMetadata.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final SearchResponse.Summary.SummaryWithMetadata.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
SearchResponse.Summary.SummaryWithMetadata.Builder
Overrides