Package com.google.cloud.discoveryengine.v1beta

Class SearchResponse.SearchResult.RankSignals.CustomSignal.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderT>

com.google.protobuf.GeneratedMessage.Builder<SearchResponse.SearchResult.RankSignals.CustomSignal.Builder>

com.google.cloud.discoveryengine.v1beta.SearchResponse.SearchResult.RankSignals.CustomSignal.Builder

All Implemented Interfaces:

SearchResponse.SearchResult.RankSignals.CustomSignalOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:

SearchResponse.SearchResult.RankSignals.CustomSignal

public static final class SearchResponse.SearchResult.RankSignals.CustomSignal.Builder
extends com.google.protobuf.GeneratedMessage.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

Method Summary

Modifier and Type	Method	Description
SearchResponse.SearchResult.RankSignals.CustomSignal	build()
SearchResponse.SearchResult.RankSignals.CustomSignal	buildPartial()
SearchResponse.SearchResult.RankSignals.CustomSignal.Builder	clear()
SearchResponse.SearchResult.RankSignals.CustomSignal.Builder	clearName()	Name of the signal.
SearchResponse.SearchResult.RankSignals.CustomSignal.Builder	clearValue()	Float value representing the ranking signal (e.g. 1.25 for BM25).
SearchResponse.SearchResult.RankSignals.CustomSignal	getDefaultInstanceForType()
static final com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
String	getName()	Name of the signal.
com.google.protobuf.ByteString	getNameBytes()	Name of the signal.
float	getValue()	Float value representing the ranking signal (e.g. 1.25 for BM25).
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable	internalGetFieldAccessorTable()
final boolean	isInitialized()
SearchResponse.SearchResult.RankSignals.CustomSignal.Builder	mergeFrom(SearchResponse.SearchResult.RankSignals.CustomSignal other)
SearchResponse.SearchResult.RankSignals.CustomSignal.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
SearchResponse.SearchResult.RankSignals.CustomSignal.Builder	mergeFrom(com.google.protobuf.Message other)
SearchResponse.SearchResult.RankSignals.CustomSignal.Builder	setName(String value)	Name of the signal.
SearchResponse.SearchResult.RankSignals.CustomSignal.Builder	setNameBytes(com.google.protobuf.ByteString value)	Name of the signal.
SearchResponse.SearchResult.RankSignals.CustomSignal.Builder	setValue(float value)	Float value representing the ranking signal (e.g. 1.25 for BM25).

Methods inherited from class com.google.protobuf.GeneratedMessage.Builder

addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.Message.Builder

mergeDelimitedFrom, mergeDelimitedFrom

Methods inherited from interface com.google.protobuf.MessageLite.Builder

mergeFrom

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Method Details

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<SearchResponse.SearchResult.RankSignals.CustomSignal.Builder>

clear

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

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessage.Builder<SearchResponse.SearchResult.RankSignals.CustomSignal.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<SearchResponse.SearchResult.RankSignals.CustomSignal.Builder>

getDefaultInstanceForType

public SearchResponse.SearchResult.RankSignals.CustomSignal getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public SearchResponse.SearchResult.RankSignals.CustomSignal build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public SearchResponse.SearchResult.RankSignals.CustomSignal buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

mergeFrom

public SearchResponse.SearchResult.RankSignals.CustomSignal.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<SearchResponse.SearchResult.RankSignals.CustomSignal.Builder>

mergeFrom

public SearchResponse.SearchResult.RankSignals.CustomSignal.Builder mergeFrom(SearchResponse.SearchResult.RankSignals.CustomSignal other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessage.Builder<SearchResponse.SearchResult.RankSignals.CustomSignal.Builder>

mergeFrom

public SearchResponse.SearchResult.RankSignals.CustomSignal.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                                       throws IOException

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<SearchResponse.SearchResult.RankSignals.CustomSignal.Builder>

Throws:

IOException

getName

public String getName()

 Name of the signal.
 

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

Specified by:

getName in interface SearchResponse.SearchResult.RankSignals.CustomSignalOrBuilder

Returns:

The name.

getNameBytes

public com.google.protobuf.ByteString getNameBytes()

 Name of the signal.
 

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

Specified by:

getNameBytes in interface SearchResponse.SearchResult.RankSignals.CustomSignalOrBuilder

Returns:

The bytes for name.

setName

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

 Name of the signal.
 

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

Parameters:

value - The name to set.

Returns:

This builder for chaining.

clearName

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

 Name of the signal.
 

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

Returns:

This builder for chaining.

setNameBytes

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

 Name of the signal.
 

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

Parameters:

value - The bytes for name to set.

Returns:

This builder for chaining.

getValue

public float getValue()

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

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

Specified by:

getValue in interface SearchResponse.SearchResult.RankSignals.CustomSignalOrBuilder

Returns:

The value.

setValue

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];

Parameters:

value - The value to set.

Returns:

This builder for chaining.

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:

This builder for chaining.