Class SearchResponse.SearchResult.RankSignals.CustomSignal.Builder (0.70.0)

public static final class SearchResponse.SearchResult.RankSignals.CustomSignal.Builder extends GeneratedMessageV3.Builder<SearchResponse.SearchResult.RankSignals.CustomSignal.Builder> implements SearchResponse.SearchResult.RankSignals.CustomSignalOrBuilder

Custom clearbox signal represented by name and value pair.

Protobuf type google.cloud.discoveryengine.v1beta.SearchResponse.SearchResult.RankSignals.CustomSignal

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > SearchResponse.SearchResult.RankSignals.CustomSignal.Builder

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public SearchResponse.SearchResult.RankSignals.CustomSignal.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
SearchResponse.SearchResult.RankSignals.CustomSignal.Builder
Overrides

build()

public SearchResponse.SearchResult.RankSignals.CustomSignal build()
Returns
Type Description
SearchResponse.SearchResult.RankSignals.CustomSignal

buildPartial()

public SearchResponse.SearchResult.RankSignals.CustomSignal buildPartial()
Returns
Type Description
SearchResponse.SearchResult.RankSignals.CustomSignal

clear()

public SearchResponse.SearchResult.RankSignals.CustomSignal.Builder clear()
Returns
Type Description
SearchResponse.SearchResult.RankSignals.CustomSignal.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public SearchResponse.SearchResult.RankSignals.CustomSignal.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
SearchResponse.SearchResult.RankSignals.CustomSignal.Builder
Overrides

clearName()

public SearchResponse.SearchResult.RankSignals.CustomSignal.Builder clearName()

Name of the signal.

string name = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
SearchResponse.SearchResult.RankSignals.CustomSignal.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public SearchResponse.SearchResult.RankSignals.CustomSignal.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
SearchResponse.SearchResult.RankSignals.CustomSignal.Builder
Overrides

clearValue()

public SearchResponse.SearchResult.RankSignals.CustomSignal.Builder clearValue()

Float value representing the ranking signal (e.g. 1.25 for BM25).

float value = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
SearchResponse.SearchResult.RankSignals.CustomSignal.Builder

This builder for chaining.

clone()

public SearchResponse.SearchResult.RankSignals.CustomSignal.Builder clone()
Returns
Type Description
SearchResponse.SearchResult.RankSignals.CustomSignal.Builder
Overrides

getDefaultInstanceForType()

public SearchResponse.SearchResult.RankSignals.CustomSignal getDefaultInstanceForType()
Returns
Type Description
SearchResponse.SearchResult.RankSignals.CustomSignal

getDescriptorForType()

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

getName()

public String getName()

Name of the signal.

string name = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Name of the signal.

string name = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for name.

getValue()

public float getValue()

Float value representing the ranking signal (e.g. 1.25 for BM25).

float value = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
float

The value.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(SearchResponse.SearchResult.RankSignals.CustomSignal other)

public SearchResponse.SearchResult.RankSignals.CustomSignal.Builder mergeFrom(SearchResponse.SearchResult.RankSignals.CustomSignal other)
Parameter
Name Description
other SearchResponse.SearchResult.RankSignals.CustomSignal
Returns
Type Description
SearchResponse.SearchResult.RankSignals.CustomSignal.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

public SearchResponse.SearchResult.RankSignals.CustomSignal.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
SearchResponse.SearchResult.RankSignals.CustomSignal.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final SearchResponse.SearchResult.RankSignals.CustomSignal.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
SearchResponse.SearchResult.RankSignals.CustomSignal.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public SearchResponse.SearchResult.RankSignals.CustomSignal.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
SearchResponse.SearchResult.RankSignals.CustomSignal.Builder
Overrides

setName(String value)

public SearchResponse.SearchResult.RankSignals.CustomSignal.Builder setName(String value)

Name of the signal.

string name = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The name to set.

Returns
Type Description
SearchResponse.SearchResult.RankSignals.CustomSignal.Builder

This builder for chaining.

setNameBytes(ByteString value)

public SearchResponse.SearchResult.RankSignals.CustomSignal.Builder setNameBytes(ByteString value)

Name of the signal.

string name = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
SearchResponse.SearchResult.RankSignals.CustomSignal.Builder

This builder for chaining.

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

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

setUnknownFields(UnknownFieldSet unknownFields)

public final SearchResponse.SearchResult.RankSignals.CustomSignal.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
SearchResponse.SearchResult.RankSignals.CustomSignal.Builder
Overrides

setValue(float value)

public SearchResponse.SearchResult.RankSignals.CustomSignal.Builder setValue(float value)

Float value representing the ranking signal (e.g. 1.25 for BM25).

float value = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value float

The value to set.

Returns
Type Description
SearchResponse.SearchResult.RankSignals.CustomSignal.Builder

This builder for chaining.