Class SearchResponse.Summary.SummaryWithMetadata.Builder (0.45.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.v1beta.SearchResponse.Summary.SummaryWithMetadata

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > SearchResponse.Summary.SummaryWithMetadata.Builder

Implements

SearchResponse.Summary.SummaryWithMetadataOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`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.v1beta.SearchResponse.Summary.Reference references = 3;

Parameter
Name	Description
`values`	`Iterable<? extends com.google.cloud.discoveryengine.v1beta.SearchResponse.Summary.Reference>`

Returns
Type	Description
`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.v1beta.SearchResponse.Summary.Reference references = 3;

Parameter
Name	Description
`value`	`SearchResponse.Summary.Reference`

Returns
Type	Description
`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.v1beta.SearchResponse.Summary.Reference references = 3;

Parameter
Name	Description
`builderForValue`	`SearchResponse.Summary.Reference.Builder`

Returns
Type	Description
`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.v1beta.SearchResponse.Summary.Reference references = 3;

Parameters
Name	Description
`index`	`int`
`value`	`SearchResponse.Summary.Reference`

Returns
Type	Description
`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.v1beta.SearchResponse.Summary.Reference references = 3;

Parameters
Name	Description
`index`	`int`
`builderForValue`	`SearchResponse.Summary.Reference.Builder`

Returns
Type	Description
`SearchResponse.Summary.SummaryWithMetadata.Builder`

addReferencesBuilder()

public SearchResponse.Summary.Reference.Builder addReferencesBuilder()

Document References.

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

Returns
Type	Description
`SearchResponse.Summary.Reference.Builder`

addReferencesBuilder(int index)

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

Document References.

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

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`SearchResponse.Summary.Reference.Builder`

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public SearchResponse.Summary.SummaryWithMetadata.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`SearchResponse.Summary.SummaryWithMetadata.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public SearchResponse.Summary.SummaryWithMetadata build()

Returns
Type	Description
`SearchResponse.Summary.SummaryWithMetadata`

buildPartial()

public SearchResponse.Summary.SummaryWithMetadata buildPartial()

Returns
Type	Description
`SearchResponse.Summary.SummaryWithMetadata`

clear()

public SearchResponse.Summary.SummaryWithMetadata.Builder clear()

Returns
Type	Description
`SearchResponse.Summary.SummaryWithMetadata.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearCitationMetadata()

public SearchResponse.Summary.SummaryWithMetadata.Builder clearCitationMetadata()

Citation metadata for given summary.

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

Returns
Type	Description
`SearchResponse.Summary.SummaryWithMetadata.Builder`

clearField(Descriptors.FieldDescriptor field)

public SearchResponse.Summary.SummaryWithMetadata.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
`field`	`FieldDescriptor`

Returns
Type	Description
`SearchResponse.Summary.SummaryWithMetadata.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearOneof(Descriptors.OneofDescriptor oneof)

public SearchResponse.Summary.SummaryWithMetadata.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
`oneof`	`OneofDescriptor`

Returns
Type	Description
`SearchResponse.Summary.SummaryWithMetadata.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearReferences()

public SearchResponse.Summary.SummaryWithMetadata.Builder clearReferences()

Document References.

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

Returns
Type	Description
`SearchResponse.Summary.SummaryWithMetadata.Builder`

clearSummary()

public SearchResponse.Summary.SummaryWithMetadata.Builder clearSummary()

Summary text with no citation information.

string summary = 1;

Returns
Type	Description
`SearchResponse.Summary.SummaryWithMetadata.Builder`	This builder for chaining.

clone()

public SearchResponse.Summary.SummaryWithMetadata.Builder clone()

Returns
Type	Description
`SearchResponse.Summary.SummaryWithMetadata.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getCitationMetadata()

public SearchResponse.Summary.CitationMetadata getCitationMetadata()

Citation metadata for given summary.

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

Returns
Type	Description
`SearchResponse.Summary.CitationMetadata`	The citationMetadata.

getCitationMetadataBuilder()

public SearchResponse.Summary.CitationMetadata.Builder getCitationMetadataBuilder()

Citation metadata for given summary.

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

Returns
Type	Description
`SearchResponse.Summary.CitationMetadata.Builder`

getCitationMetadataOrBuilder()

public SearchResponse.Summary.CitationMetadataOrBuilder getCitationMetadataOrBuilder()

Citation metadata for given summary.

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

Returns
Type	Description
`SearchResponse.Summary.CitationMetadataOrBuilder`

getDefaultInstanceForType()

public SearchResponse.Summary.SummaryWithMetadata getDefaultInstanceForType()

Returns
Type	Description
`SearchResponse.Summary.SummaryWithMetadata`

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
`Descriptor`

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getReferences(int index)

public SearchResponse.Summary.Reference getReferences(int index)

Document References.

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

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`SearchResponse.Summary.Reference`

getReferencesBuilder(int index)

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

Document References.

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

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`SearchResponse.Summary.Reference.Builder`

getReferencesBuilderList()

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

Document References.

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

Returns
Type	Description
`List<Builder>`

getReferencesCount()

public int getReferencesCount()

Document References.

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

Returns
Type	Description
`int`

getReferencesList()

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

Document References.

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

Returns
Type	Description
`List<Reference>`

getReferencesOrBuilder(int index)

public SearchResponse.Summary.ReferenceOrBuilder getReferencesOrBuilder(int index)

Document References.

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

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`SearchResponse.Summary.ReferenceOrBuilder`

getReferencesOrBuilderList()

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

Document References.

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

Returns
Type	Description
`List<? extends com.google.cloud.discoveryengine.v1beta.SearchResponse.Summary.ReferenceOrBuilder>`

getSummary()

public String getSummary()

Summary text with no citation information.

string summary = 1;

Returns
Type	Description
`String`	The summary.

getSummaryBytes()

public ByteString getSummaryBytes()

Summary text with no citation information.

string summary = 1;

Returns
Type	Description
`ByteString`	The bytes for summary.

hasCitationMetadata()

public boolean hasCitationMetadata()

Citation metadata for given summary.

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

Returns
Type	Description
`boolean`	Whether the citationMetadata field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeCitationMetadata(SearchResponse.Summary.CitationMetadata value)

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

Citation metadata for given summary.

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

Parameter
Name	Description
`value`	`SearchResponse.Summary.CitationMetadata`

Returns
Type	Description
`SearchResponse.Summary.SummaryWithMetadata.Builder`

mergeFrom(SearchResponse.Summary.SummaryWithMetadata other)

public SearchResponse.Summary.SummaryWithMetadata.Builder mergeFrom(SearchResponse.Summary.SummaryWithMetadata other)

Parameter
Name	Description
`other`	`SearchResponse.Summary.SummaryWithMetadata`

Returns
Type	Description
`SearchResponse.Summary.SummaryWithMetadata.Builder`

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public SearchResponse.Summary.SummaryWithMetadata.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`SearchResponse.Summary.SummaryWithMetadata.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
`IOException`

mergeFrom(Message other)

public SearchResponse.Summary.SummaryWithMetadata.Builder mergeFrom(Message other)

Parameter
Name	Description
`other`	`Message`

Returns
Type	Description
`SearchResponse.Summary.SummaryWithMetadata.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeUnknownFields(UnknownFieldSet unknownFields)

public final SearchResponse.Summary.SummaryWithMetadata.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`SearchResponse.Summary.SummaryWithMetadata.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

removeReferences(int index)

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

Document References.

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

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`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.v1beta.SearchResponse.Summary.CitationMetadata citation_metadata = 2;

Parameter
Name	Description
`value`	`SearchResponse.Summary.CitationMetadata`

Returns
Type	Description
`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.v1beta.SearchResponse.Summary.CitationMetadata citation_metadata = 2;

Parameter
Name	Description
`builderForValue`	`SearchResponse.Summary.CitationMetadata.Builder`

Returns
Type	Description
`SearchResponse.Summary.SummaryWithMetadata.Builder`

setField(Descriptors.FieldDescriptor field, Object value)

public SearchResponse.Summary.SummaryWithMetadata.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`SearchResponse.Summary.SummaryWithMetadata.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

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.v1beta.SearchResponse.Summary.Reference references = 3;

Parameters
Name	Description
`index`	`int`
`value`	`SearchResponse.Summary.Reference`

Returns
Type	Description
`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.v1beta.SearchResponse.Summary.Reference references = 3;

Parameters
Name	Description
`index`	`int`
`builderForValue`	`SearchResponse.Summary.Reference.Builder`

Returns
Type	Description
`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
Name	Description
`field`	`FieldDescriptor`
`index`	`int`
`value`	`Object`

Returns
Type	Description
`SearchResponse.Summary.SummaryWithMetadata.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setSummary(String value)

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

Summary text with no citation information.

string summary = 1;

Parameter
Name	Description
`value`	`String` The summary to set.

Returns
Type	Description
`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
Name	Description
`value`	`ByteString` The bytes for summary to set.

Returns
Type	Description
`SearchResponse.Summary.SummaryWithMetadata.Builder`	This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final SearchResponse.Summary.SummaryWithMetadata.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`SearchResponse.Summary.SummaryWithMetadata.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)