public static final class SearchResponse.Summary.SummaryWithMetadata.Builder extends GeneratedMessage.Builder<SearchResponse.Summary.SummaryWithMetadata.Builder> implements SearchResponse.Summary.SummaryWithMetadataOrBuilderSummary with metadata information.
Protobuf type
google.cloud.discoveryengine.v1.SearchResponse.Summary.SummaryWithMetadata
Inheritance
java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > SearchResponse.Summary.SummaryWithMetadata.BuilderStatic 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.v1.SearchResponse.Summary.Reference references = 3;
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<? extends com.google.cloud.discoveryengine.v1.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.v1.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.v1.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.v1.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.v1.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.v1.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.v1.SearchResponse.Summary.Reference references = 3;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.Summary.Reference.Builder |
|
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 |
|
clearCitationMetadata()
public SearchResponse.Summary.SummaryWithMetadata.Builder clearCitationMetadata()Citation metadata for given summary.
.google.cloud.discoveryengine.v1.SearchResponse.Summary.CitationMetadata citation_metadata = 2;
| Returns | |
|---|---|
| Type | Description |
SearchResponse.Summary.SummaryWithMetadata.Builder |
|
clearReferences()
public SearchResponse.Summary.SummaryWithMetadata.Builder clearReferences()Document References.
repeated .google.cloud.discoveryengine.v1.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. |
getCitationMetadata()
public SearchResponse.Summary.CitationMetadata getCitationMetadata()Citation metadata for given summary.
.google.cloud.discoveryengine.v1.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.v1.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.v1.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 |
|
getReferences(int index)
public SearchResponse.Summary.Reference getReferences(int index)Document References.
repeated .google.cloud.discoveryengine.v1.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.v1.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.v1.SearchResponse.Summary.Reference references = 3;
| Returns | |
|---|---|
| Type | Description |
List<Builder> |
|
getReferencesCount()
public int getReferencesCount()Document References.
repeated .google.cloud.discoveryengine.v1.SearchResponse.Summary.Reference references = 3;
| Returns | |
|---|---|
| Type | Description |
int |
|
getReferencesList()
public List<SearchResponse.Summary.Reference> getReferencesList()Document References.
repeated .google.cloud.discoveryengine.v1.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.v1.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.v1.SearchResponse.Summary.Reference references = 3;
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.cloud.discoveryengine.v1.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.v1.SearchResponse.Summary.CitationMetadata citation_metadata = 2;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the citationMetadata field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeCitationMetadata(SearchResponse.Summary.CitationMetadata value)
public SearchResponse.Summary.SummaryWithMetadata.Builder mergeCitationMetadata(SearchResponse.Summary.CitationMetadata value)Citation metadata for given summary.
.google.cloud.discoveryengine.v1.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 |
|
| 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 |
|
removeReferences(int index)
public SearchResponse.Summary.SummaryWithMetadata.Builder removeReferences(int index)Document References.
repeated .google.cloud.discoveryengine.v1.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.v1.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.v1.SearchResponse.Summary.CitationMetadata citation_metadata = 2;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
SearchResponse.Summary.CitationMetadata.Builder |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.Summary.SummaryWithMetadata.Builder |
|
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.v1.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.v1.SearchResponse.Summary.Reference references = 3;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
SearchResponse.Summary.Reference.Builder |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.Summary.SummaryWithMetadata.Builder |
|
setSummary(String value)
public SearchResponse.Summary.SummaryWithMetadata.Builder setSummary(String value)Summary text with no citation information.
string summary = 1;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe 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 |
ByteStringThe bytes for summary to set. |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.Summary.SummaryWithMetadata.Builder |
This builder for chaining. |