Class CompleteQueryResponse.QuerySuggestion.Builder (0.31.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
TypeDescription
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
NameDescription
valuesIterable<String>

The completableFieldPaths to add.

Returns
TypeDescription
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
NameDescription
valueString

The completableFieldPaths to add.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes of the completableFieldPaths to add.

Returns
TypeDescription
CompleteQueryResponse.QuerySuggestion.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public CompleteQueryResponse.QuerySuggestion.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
CompleteQueryResponse.QuerySuggestion.Builder
Overrides

build()

public CompleteQueryResponse.QuerySuggestion build()
Returns
TypeDescription
CompleteQueryResponse.QuerySuggestion

buildPartial()

public CompleteQueryResponse.QuerySuggestion buildPartial()
Returns
TypeDescription
CompleteQueryResponse.QuerySuggestion

clear()

public CompleteQueryResponse.QuerySuggestion.Builder clear()
Returns
TypeDescription
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
TypeDescription
CompleteQueryResponse.QuerySuggestion.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public CompleteQueryResponse.QuerySuggestion.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
CompleteQueryResponse.QuerySuggestion.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public CompleteQueryResponse.QuerySuggestion.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
CompleteQueryResponse.QuerySuggestion.Builder
Overrides

clearSuggestion()

public CompleteQueryResponse.QuerySuggestion.Builder clearSuggestion()

The suggestion for the query.

string suggestion = 1;

Returns
TypeDescription
CompleteQueryResponse.QuerySuggestion.Builder

This builder for chaining.

clone()

public CompleteQueryResponse.QuerySuggestion.Builder clone()
Returns
TypeDescription
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
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
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
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ProtocolStringList

A list containing the completableFieldPaths.

getDefaultInstanceForType()

public CompleteQueryResponse.QuerySuggestion getDefaultInstanceForType()
Returns
TypeDescription
CompleteQueryResponse.QuerySuggestion

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getSuggestion()

public String getSuggestion()

The suggestion for the query.

string suggestion = 1;

Returns
TypeDescription
String

The suggestion.

getSuggestionBytes()

public ByteString getSuggestionBytes()

The suggestion for the query.

string suggestion = 1;

Returns
TypeDescription
ByteString

The bytes for suggestion.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(CompleteQueryResponse.QuerySuggestion other)

public CompleteQueryResponse.QuerySuggestion.Builder mergeFrom(CompleteQueryResponse.QuerySuggestion other)
Parameter
NameDescription
otherCompleteQueryResponse.QuerySuggestion
Returns
TypeDescription
CompleteQueryResponse.QuerySuggestion.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public CompleteQueryResponse.QuerySuggestion.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CompleteQueryResponse.QuerySuggestion.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public CompleteQueryResponse.QuerySuggestion.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
CompleteQueryResponse.QuerySuggestion.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final CompleteQueryResponse.QuerySuggestion.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
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
NameDescription
indexint

The index to set the value at.

valueString

The completableFieldPaths to set.

Returns
TypeDescription
CompleteQueryResponse.QuerySuggestion.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public CompleteQueryResponse.QuerySuggestion.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
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
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
CompleteQueryResponse.QuerySuggestion.Builder
Overrides

setSuggestion(String value)

public CompleteQueryResponse.QuerySuggestion.Builder setSuggestion(String value)

The suggestion for the query.

string suggestion = 1;

Parameter
NameDescription
valueString

The suggestion to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for suggestion to set.

Returns
TypeDescription
CompleteQueryResponse.QuerySuggestion.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final CompleteQueryResponse.QuerySuggestion.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
CompleteQueryResponse.QuerySuggestion.Builder
Overrides