Class SearchResponse.Summary.Reference.Builder (0.41.0)

public static final class SearchResponse.Summary.Reference.Builder extends GeneratedMessageV3.Builder<SearchResponse.Summary.Reference.Builder> implements SearchResponse.Summary.ReferenceOrBuilder

Document reference.

Protobuf type google.cloud.discoveryengine.v1.SearchResponse.Summary.Reference

Static Methods

getDescriptor()

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

Methods

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

public SearchResponse.Summary.Reference.Builder addAllChunkContents(Iterable<? extends SearchResponse.Summary.Reference.ChunkContent> values)

List of cited chunk contents derived from document content.

repeated .google.cloud.discoveryengine.v1.SearchResponse.Summary.Reference.ChunkContent chunk_contents = 4;

Parameter
Name Description
values Iterable<? extends com.google.cloud.discoveryengine.v1.SearchResponse.Summary.Reference.ChunkContent>
Returns
Type Description
SearchResponse.Summary.Reference.Builder

addChunkContents(SearchResponse.Summary.Reference.ChunkContent value)

public SearchResponse.Summary.Reference.Builder addChunkContents(SearchResponse.Summary.Reference.ChunkContent value)

List of cited chunk contents derived from document content.

repeated .google.cloud.discoveryengine.v1.SearchResponse.Summary.Reference.ChunkContent chunk_contents = 4;

Parameter
Name Description
value SearchResponse.Summary.Reference.ChunkContent
Returns
Type Description
SearchResponse.Summary.Reference.Builder

addChunkContents(SearchResponse.Summary.Reference.ChunkContent.Builder builderForValue)

public SearchResponse.Summary.Reference.Builder addChunkContents(SearchResponse.Summary.Reference.ChunkContent.Builder builderForValue)

List of cited chunk contents derived from document content.

repeated .google.cloud.discoveryengine.v1.SearchResponse.Summary.Reference.ChunkContent chunk_contents = 4;

Parameter
Name Description
builderForValue SearchResponse.Summary.Reference.ChunkContent.Builder
Returns
Type Description
SearchResponse.Summary.Reference.Builder

addChunkContents(int index, SearchResponse.Summary.Reference.ChunkContent value)

public SearchResponse.Summary.Reference.Builder addChunkContents(int index, SearchResponse.Summary.Reference.ChunkContent value)

List of cited chunk contents derived from document content.

repeated .google.cloud.discoveryengine.v1.SearchResponse.Summary.Reference.ChunkContent chunk_contents = 4;

Parameters
Name Description
index int
value SearchResponse.Summary.Reference.ChunkContent
Returns
Type Description
SearchResponse.Summary.Reference.Builder

addChunkContents(int index, SearchResponse.Summary.Reference.ChunkContent.Builder builderForValue)

public SearchResponse.Summary.Reference.Builder addChunkContents(int index, SearchResponse.Summary.Reference.ChunkContent.Builder builderForValue)

List of cited chunk contents derived from document content.

repeated .google.cloud.discoveryengine.v1.SearchResponse.Summary.Reference.ChunkContent chunk_contents = 4;

Parameters
Name Description
index int
builderForValue SearchResponse.Summary.Reference.ChunkContent.Builder
Returns
Type Description
SearchResponse.Summary.Reference.Builder

addChunkContentsBuilder()

public SearchResponse.Summary.Reference.ChunkContent.Builder addChunkContentsBuilder()

List of cited chunk contents derived from document content.

repeated .google.cloud.discoveryengine.v1.SearchResponse.Summary.Reference.ChunkContent chunk_contents = 4;

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

addChunkContentsBuilder(int index)

public SearchResponse.Summary.Reference.ChunkContent.Builder addChunkContentsBuilder(int index)

List of cited chunk contents derived from document content.

repeated .google.cloud.discoveryengine.v1.SearchResponse.Summary.Reference.ChunkContent chunk_contents = 4;

Parameter
Name Description
index int
Returns
Type Description
SearchResponse.Summary.Reference.ChunkContent.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public SearchResponse.Summary.Reference build()
Returns
Type Description
SearchResponse.Summary.Reference

buildPartial()

public SearchResponse.Summary.Reference buildPartial()
Returns
Type Description
SearchResponse.Summary.Reference

clear()

public SearchResponse.Summary.Reference.Builder clear()
Returns
Type Description
SearchResponse.Summary.Reference.Builder
Overrides

clearChunkContents()

public SearchResponse.Summary.Reference.Builder clearChunkContents()

List of cited chunk contents derived from document content.

repeated .google.cloud.discoveryengine.v1.SearchResponse.Summary.Reference.ChunkContent chunk_contents = 4;

Returns
Type Description
SearchResponse.Summary.Reference.Builder

clearDocument()

public SearchResponse.Summary.Reference.Builder clearDocument()

Required. Document.name of the document. Full resource name of the referenced document, in the format projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*.

string document = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
SearchResponse.Summary.Reference.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public SearchResponse.Summary.Reference.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
SearchResponse.Summary.Reference.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public SearchResponse.Summary.Reference.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
SearchResponse.Summary.Reference.Builder
Overrides

clearTitle()

public SearchResponse.Summary.Reference.Builder clearTitle()

Title of the document.

string title = 1;

Returns
Type Description
SearchResponse.Summary.Reference.Builder

This builder for chaining.

clearUri()

public SearchResponse.Summary.Reference.Builder clearUri()

Cloud Storage or HTTP uri for the document.

string uri = 3;

Returns
Type Description
SearchResponse.Summary.Reference.Builder

This builder for chaining.

clone()

public SearchResponse.Summary.Reference.Builder clone()
Returns
Type Description
SearchResponse.Summary.Reference.Builder
Overrides

getChunkContents(int index)

public SearchResponse.Summary.Reference.ChunkContent getChunkContents(int index)

List of cited chunk contents derived from document content.

repeated .google.cloud.discoveryengine.v1.SearchResponse.Summary.Reference.ChunkContent chunk_contents = 4;

Parameter
Name Description
index int
Returns
Type Description
SearchResponse.Summary.Reference.ChunkContent

getChunkContentsBuilder(int index)

public SearchResponse.Summary.Reference.ChunkContent.Builder getChunkContentsBuilder(int index)

List of cited chunk contents derived from document content.

repeated .google.cloud.discoveryengine.v1.SearchResponse.Summary.Reference.ChunkContent chunk_contents = 4;

Parameter
Name Description
index int
Returns
Type Description
SearchResponse.Summary.Reference.ChunkContent.Builder

getChunkContentsBuilderList()

public List<SearchResponse.Summary.Reference.ChunkContent.Builder> getChunkContentsBuilderList()

List of cited chunk contents derived from document content.

repeated .google.cloud.discoveryengine.v1.SearchResponse.Summary.Reference.ChunkContent chunk_contents = 4;

Returns
Type Description
List<Builder>

getChunkContentsCount()

public int getChunkContentsCount()

List of cited chunk contents derived from document content.

repeated .google.cloud.discoveryengine.v1.SearchResponse.Summary.Reference.ChunkContent chunk_contents = 4;

Returns
Type Description
int

getChunkContentsList()

public List<SearchResponse.Summary.Reference.ChunkContent> getChunkContentsList()

List of cited chunk contents derived from document content.

repeated .google.cloud.discoveryengine.v1.SearchResponse.Summary.Reference.ChunkContent chunk_contents = 4;

Returns
Type Description
List<ChunkContent>

getChunkContentsOrBuilder(int index)

public SearchResponse.Summary.Reference.ChunkContentOrBuilder getChunkContentsOrBuilder(int index)

List of cited chunk contents derived from document content.

repeated .google.cloud.discoveryengine.v1.SearchResponse.Summary.Reference.ChunkContent chunk_contents = 4;

Parameter
Name Description
index int
Returns
Type Description
SearchResponse.Summary.Reference.ChunkContentOrBuilder

getChunkContentsOrBuilderList()

public List<? extends SearchResponse.Summary.Reference.ChunkContentOrBuilder> getChunkContentsOrBuilderList()

List of cited chunk contents derived from document content.

repeated .google.cloud.discoveryengine.v1.SearchResponse.Summary.Reference.ChunkContent chunk_contents = 4;

Returns
Type Description
List<? extends com.google.cloud.discoveryengine.v1.SearchResponse.Summary.Reference.ChunkContentOrBuilder>

getDefaultInstanceForType()

public SearchResponse.Summary.Reference getDefaultInstanceForType()
Returns
Type Description
SearchResponse.Summary.Reference

getDescriptorForType()

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

getDocument()

public String getDocument()

Required. Document.name of the document. Full resource name of the referenced document, in the format projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*.

string document = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The document.

getDocumentBytes()

public ByteString getDocumentBytes()

Required. Document.name of the document. Full resource name of the referenced document, in the format projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*.

string document = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for document.

getTitle()

public String getTitle()

Title of the document.

string title = 1;

Returns
Type Description
String

The title.

getTitleBytes()

public ByteString getTitleBytes()

Title of the document.

string title = 1;

Returns
Type Description
ByteString

The bytes for title.

getUri()

public String getUri()

Cloud Storage or HTTP uri for the document.

string uri = 3;

Returns
Type Description
String

The uri.

getUriBytes()

public ByteString getUriBytes()

Cloud Storage or HTTP uri for the document.

string uri = 3;

Returns
Type Description
ByteString

The bytes for uri.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(SearchResponse.Summary.Reference other)

public SearchResponse.Summary.Reference.Builder mergeFrom(SearchResponse.Summary.Reference other)
Parameter
Name Description
other SearchResponse.Summary.Reference
Returns
Type Description
SearchResponse.Summary.Reference.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

public SearchResponse.Summary.Reference.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
SearchResponse.Summary.Reference.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final SearchResponse.Summary.Reference.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
SearchResponse.Summary.Reference.Builder
Overrides

removeChunkContents(int index)

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

List of cited chunk contents derived from document content.

repeated .google.cloud.discoveryengine.v1.SearchResponse.Summary.Reference.ChunkContent chunk_contents = 4;

Parameter
Name Description
index int
Returns
Type Description
SearchResponse.Summary.Reference.Builder

setChunkContents(int index, SearchResponse.Summary.Reference.ChunkContent value)

public SearchResponse.Summary.Reference.Builder setChunkContents(int index, SearchResponse.Summary.Reference.ChunkContent value)

List of cited chunk contents derived from document content.

repeated .google.cloud.discoveryengine.v1.SearchResponse.Summary.Reference.ChunkContent chunk_contents = 4;

Parameters
Name Description
index int
value SearchResponse.Summary.Reference.ChunkContent
Returns
Type Description
SearchResponse.Summary.Reference.Builder

setChunkContents(int index, SearchResponse.Summary.Reference.ChunkContent.Builder builderForValue)

public SearchResponse.Summary.Reference.Builder setChunkContents(int index, SearchResponse.Summary.Reference.ChunkContent.Builder builderForValue)

List of cited chunk contents derived from document content.

repeated .google.cloud.discoveryengine.v1.SearchResponse.Summary.Reference.ChunkContent chunk_contents = 4;

Parameters
Name Description
index int
builderForValue SearchResponse.Summary.Reference.ChunkContent.Builder
Returns
Type Description
SearchResponse.Summary.Reference.Builder

setDocument(String value)

public SearchResponse.Summary.Reference.Builder setDocument(String value)

Required. Document.name of the document. Full resource name of the referenced document, in the format projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*.

string document = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The document to set.

Returns
Type Description
SearchResponse.Summary.Reference.Builder

This builder for chaining.

setDocumentBytes(ByteString value)

public SearchResponse.Summary.Reference.Builder setDocumentBytes(ByteString value)

Required. Document.name of the document. Full resource name of the referenced document, in the format projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*.

string document = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

The bytes for document to set.

Returns
Type Description
SearchResponse.Summary.Reference.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

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

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

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

setTitle(String value)

public SearchResponse.Summary.Reference.Builder setTitle(String value)

Title of the document.

string title = 1;

Parameter
Name Description
value String

The title to set.

Returns
Type Description
SearchResponse.Summary.Reference.Builder

This builder for chaining.

setTitleBytes(ByteString value)

public SearchResponse.Summary.Reference.Builder setTitleBytes(ByteString value)

Title of the document.

string title = 1;

Parameter
Name Description
value ByteString

The bytes for title to set.

Returns
Type Description
SearchResponse.Summary.Reference.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final SearchResponse.Summary.Reference.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
SearchResponse.Summary.Reference.Builder
Overrides

setUri(String value)

public SearchResponse.Summary.Reference.Builder setUri(String value)

Cloud Storage or HTTP uri for the document.

string uri = 3;

Parameter
Name Description
value String

The uri to set.

Returns
Type Description
SearchResponse.Summary.Reference.Builder

This builder for chaining.

setUriBytes(ByteString value)

public SearchResponse.Summary.Reference.Builder setUriBytes(ByteString value)

Cloud Storage or HTTP uri for the document.

string uri = 3;

Parameter
Name Description
value ByteString

The bytes for uri to set.

Returns
Type Description
SearchResponse.Summary.Reference.Builder

This builder for chaining.