Class CompleteQueryResponse.QuerySuggestion.Builder (0.49.0)

public static final class CompleteQueryResponse.QuerySuggestion.Builder extends GeneratedMessageV3.Builder<CompleteQueryResponse.QuerySuggestion.Builder> implements CompleteQueryResponse.QuerySuggestionOrBuilder

Suggestions as search queries.

Protobuf type google.cloud.discoveryengine.v1alpha.CompleteQueryResponse.QuerySuggestion

Static Methods

getDescriptor()

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

Methods

addAllCompletableFieldPaths(Iterable<String> values)

public CompleteQueryResponse.QuerySuggestion.Builder addAllCompletableFieldPaths(Iterable<String> values)

The unique document field paths that serve as the source of this suggestion if it was generated from completable fields.

This field is only populated for the document-completable model.

repeated string completable_field_paths = 2;

Parameter
Name Description
values Iterable<String>

The completableFieldPaths to add.

Returns
Type Description
CompleteQueryResponse.QuerySuggestion.Builder

This builder for chaining.

addCompletableFieldPaths(String value)

public CompleteQueryResponse.QuerySuggestion.Builder addCompletableFieldPaths(String value)

The unique document field paths that serve as the source of this suggestion if it was generated from completable fields.

This field is only populated for the document-completable model.

repeated string completable_field_paths = 2;

Parameter
Name Description
value String

The completableFieldPaths to add.

Returns
Type Description
CompleteQueryResponse.QuerySuggestion.Builder

This builder for chaining.

addCompletableFieldPathsBytes(ByteString value)

public CompleteQueryResponse.QuerySuggestion.Builder addCompletableFieldPathsBytes(ByteString value)

The unique document field paths that serve as the source of this suggestion if it was generated from completable fields.

This field is only populated for the document-completable model.

repeated string completable_field_paths = 2;

Parameter
Name Description
value ByteString

The bytes of the completableFieldPaths to add.

Returns
Type Description
CompleteQueryResponse.QuerySuggestion.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public CompleteQueryResponse.QuerySuggestion.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
CompleteQueryResponse.QuerySuggestion.Builder
Overrides

build()

public CompleteQueryResponse.QuerySuggestion build()
Returns
Type Description
CompleteQueryResponse.QuerySuggestion

buildPartial()

public CompleteQueryResponse.QuerySuggestion buildPartial()
Returns
Type Description
CompleteQueryResponse.QuerySuggestion

clear()

public CompleteQueryResponse.QuerySuggestion.Builder clear()
Returns
Type Description
CompleteQueryResponse.QuerySuggestion.Builder
Overrides

clearCompletableFieldPaths()

public CompleteQueryResponse.QuerySuggestion.Builder clearCompletableFieldPaths()

The unique document field paths that serve as the source of this suggestion if it was generated from completable fields.

This field is only populated for the document-completable model.

repeated string completable_field_paths = 2;

Returns
Type Description
CompleteQueryResponse.QuerySuggestion.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public CompleteQueryResponse.QuerySuggestion.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
CompleteQueryResponse.QuerySuggestion.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public CompleteQueryResponse.QuerySuggestion.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
CompleteQueryResponse.QuerySuggestion.Builder
Overrides

clearSuggestion()

public CompleteQueryResponse.QuerySuggestion.Builder clearSuggestion()

The suggestion for the query.

string suggestion = 1;

Returns
Type Description
CompleteQueryResponse.QuerySuggestion.Builder

This builder for chaining.

clone()

public CompleteQueryResponse.QuerySuggestion.Builder clone()
Returns
Type Description
CompleteQueryResponse.QuerySuggestion.Builder
Overrides

getCompletableFieldPaths(int index)

public String getCompletableFieldPaths(int index)

The unique document field paths that serve as the source of this suggestion if it was generated from completable fields.

This field is only populated for the document-completable model.

repeated string completable_field_paths = 2;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The completableFieldPaths at the given index.

getCompletableFieldPathsBytes(int index)

public ByteString getCompletableFieldPathsBytes(int index)

The unique document field paths that serve as the source of this suggestion if it was generated from completable fields.

This field is only populated for the document-completable model.

repeated string completable_field_paths = 2;

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the completableFieldPaths at the given index.

getCompletableFieldPathsCount()

public int getCompletableFieldPathsCount()

The unique document field paths that serve as the source of this suggestion if it was generated from completable fields.

This field is only populated for the document-completable model.

repeated string completable_field_paths = 2;

Returns
Type Description
int

The count of completableFieldPaths.

getCompletableFieldPathsList()

public ProtocolStringList getCompletableFieldPathsList()

The unique document field paths that serve as the source of this suggestion if it was generated from completable fields.

This field is only populated for the document-completable model.

repeated string completable_field_paths = 2;

Returns
Type Description
ProtocolStringList

A list containing the completableFieldPaths.

getDefaultInstanceForType()

public CompleteQueryResponse.QuerySuggestion getDefaultInstanceForType()
Returns
Type Description
CompleteQueryResponse.QuerySuggestion

getDescriptorForType()

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

getSuggestion()

public String getSuggestion()

The suggestion for the query.

string suggestion = 1;

Returns
Type Description
String

The suggestion.

getSuggestionBytes()

public ByteString getSuggestionBytes()

The suggestion for the query.

string suggestion = 1;

Returns
Type Description
ByteString

The bytes for suggestion.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(CompleteQueryResponse.QuerySuggestion other)

public CompleteQueryResponse.QuerySuggestion.Builder mergeFrom(CompleteQueryResponse.QuerySuggestion other)
Parameter
Name Description
other CompleteQueryResponse.QuerySuggestion
Returns
Type Description
CompleteQueryResponse.QuerySuggestion.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

public CompleteQueryResponse.QuerySuggestion.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
CompleteQueryResponse.QuerySuggestion.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final CompleteQueryResponse.QuerySuggestion.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
CompleteQueryResponse.QuerySuggestion.Builder
Overrides

setCompletableFieldPaths(int index, String value)

public CompleteQueryResponse.QuerySuggestion.Builder setCompletableFieldPaths(int index, String value)

The unique document field paths that serve as the source of this suggestion if it was generated from completable fields.

This field is only populated for the document-completable model.

repeated string completable_field_paths = 2;

Parameters
Name Description
index int

The index to set the value at.

value String

The completableFieldPaths to set.

Returns
Type Description
CompleteQueryResponse.QuerySuggestion.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public CompleteQueryResponse.QuerySuggestion.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
CompleteQueryResponse.QuerySuggestion.Builder
Overrides

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

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

setSuggestion(String value)

public CompleteQueryResponse.QuerySuggestion.Builder setSuggestion(String value)

The suggestion for the query.

string suggestion = 1;

Parameter
Name Description
value String

The suggestion to set.

Returns
Type Description
CompleteQueryResponse.QuerySuggestion.Builder

This builder for chaining.

setSuggestionBytes(ByteString value)

public CompleteQueryResponse.QuerySuggestion.Builder setSuggestionBytes(ByteString value)

The suggestion for the query.

string suggestion = 1;

Parameter
Name Description
value ByteString

The bytes for suggestion to set.

Returns
Type Description
CompleteQueryResponse.QuerySuggestion.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final CompleteQueryResponse.QuerySuggestion.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
CompleteQueryResponse.QuerySuggestion.Builder
Overrides