Class SearchResponse.SessionInfo.Builder (0.79.0)

public static final class SearchResponse.SessionInfo.Builder extends GeneratedMessage.Builder<SearchResponse.SessionInfo.Builder> implements SearchResponse.SessionInfoOrBuilder

Information about the session.

Protobuf type google.cloud.discoveryengine.v1.SearchResponse.SessionInfo

Static Methods

getDescriptor()

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

Methods

build()

public SearchResponse.SessionInfo build()
Returns
Type Description
SearchResponse.SessionInfo

buildPartial()

public SearchResponse.SessionInfo buildPartial()
Returns
Type Description
SearchResponse.SessionInfo

clear()

public SearchResponse.SessionInfo.Builder clear()
Returns
Type Description
SearchResponse.SessionInfo.Builder
Overrides

clearName()

public SearchResponse.SessionInfo.Builder clearName()

Name of the session. If the auto-session mode is used (when SearchRequest.session ends with "-"), this field holds the newly generated session name.

string name = 1;

Returns
Type Description
SearchResponse.SessionInfo.Builder

This builder for chaining.

clearQueryId()

public SearchResponse.SessionInfo.Builder clearQueryId()

Query ID that corresponds to this search API call. One session can have multiple turns, each with a unique query ID.

By specifying the session name and this query ID in the Answer API call, the answer generation happens in the context of the search results from this search call.

string query_id = 2;

Returns
Type Description
SearchResponse.SessionInfo.Builder

This builder for chaining.

getDefaultInstanceForType()

public SearchResponse.SessionInfo getDefaultInstanceForType()
Returns
Type Description
SearchResponse.SessionInfo

getDescriptorForType()

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

getName()

public String getName()

Name of the session. If the auto-session mode is used (when SearchRequest.session ends with "-"), this field holds the newly generated session name.

string name = 1;

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Name of the session. If the auto-session mode is used (when SearchRequest.session ends with "-"), this field holds the newly generated session name.

string name = 1;

Returns
Type Description
ByteString

The bytes for name.

getQueryId()

public String getQueryId()

Query ID that corresponds to this search API call. One session can have multiple turns, each with a unique query ID.

By specifying the session name and this query ID in the Answer API call, the answer generation happens in the context of the search results from this search call.

string query_id = 2;

Returns
Type Description
String

The queryId.

getQueryIdBytes()

public ByteString getQueryIdBytes()

Query ID that corresponds to this search API call. One session can have multiple turns, each with a unique query ID.

By specifying the session name and this query ID in the Answer API call, the answer generation happens in the context of the search results from this search call.

string query_id = 2;

Returns
Type Description
ByteString

The bytes for queryId.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(SearchResponse.SessionInfo other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

setName(String value)

public SearchResponse.SessionInfo.Builder setName(String value)

Name of the session. If the auto-session mode is used (when SearchRequest.session ends with "-"), this field holds the newly generated session name.

string name = 1;

Parameter
Name Description
value String

The name to set.

Returns
Type Description
SearchResponse.SessionInfo.Builder

This builder for chaining.

setNameBytes(ByteString value)

public SearchResponse.SessionInfo.Builder setNameBytes(ByteString value)

Name of the session. If the auto-session mode is used (when SearchRequest.session ends with "-"), this field holds the newly generated session name.

string name = 1;

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
SearchResponse.SessionInfo.Builder

This builder for chaining.

setQueryId(String value)

public SearchResponse.SessionInfo.Builder setQueryId(String value)

Query ID that corresponds to this search API call. One session can have multiple turns, each with a unique query ID.

By specifying the session name and this query ID in the Answer API call, the answer generation happens in the context of the search results from this search call.

string query_id = 2;

Parameter
Name Description
value String

The queryId to set.

Returns
Type Description
SearchResponse.SessionInfo.Builder

This builder for chaining.

setQueryIdBytes(ByteString value)

public SearchResponse.SessionInfo.Builder setQueryIdBytes(ByteString value)

Query ID that corresponds to this search API call. One session can have multiple turns, each with a unique query ID.

By specifying the session name and this query ID in the Answer API call, the answer generation happens in the context of the search results from this search call.

string query_id = 2;

Parameter
Name Description
value ByteString

The bytes for queryId to set.

Returns
Type Description
SearchResponse.SessionInfo.Builder

This builder for chaining.