com.google.cloud.discoveryengine.v1

Class SearchResponse.SearchResult.RankSignals.CustomSignal

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessage

com.google.cloud.discoveryengine.v1.SearchResponse.SearchResult.RankSignals.CustomSignal

All Implemented Interfaces:

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

Enclosing class:

SearchResponse.SearchResult.RankSignals

public static final class SearchResponse.SearchResult.RankSignals.CustomSignal
extends com.google.protobuf.GeneratedMessage
implements SearchResponse.SearchResult.RankSignals.CustomSignalOrBuilder

 Custom clearbox signal represented by name and value pair.
 

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SearchResponse.SearchResult.RankSignals.CustomSignal.Builder Custom clearbox signal represented by name and value pair.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

com.google.protobuf.AbstractMessage.BuilderParent

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	NAME_FIELD_NUMBER
static int	VALUE_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessage

alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
static SearchResponse.SearchResult.RankSignals.CustomSignal	getDefaultInstance()
SearchResponse.SearchResult.RankSignals.CustomSignal	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
String	getName() Optional.
com.google.protobuf.ByteString	getNameBytes() Optional.
com.google.protobuf.Parser<SearchResponse.SearchResult.RankSignals.CustomSignal>	getParserForType()
int	getSerializedSize()
float	getValue() Optional.
int	hashCode()
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static SearchResponse.SearchResult.RankSignals.CustomSignal.Builder	newBuilder()
static SearchResponse.SearchResult.RankSignals.CustomSignal.Builder	newBuilder(SearchResponse.SearchResult.RankSignals.CustomSignal prototype)
SearchResponse.SearchResult.RankSignals.CustomSignal.Builder	newBuilderForType()
protected SearchResponse.SearchResult.RankSignals.CustomSignal.Builder	newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
static SearchResponse.SearchResult.RankSignals.CustomSignal	parseDelimitedFrom(InputStream input)
static SearchResponse.SearchResult.RankSignals.CustomSignal	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SearchResponse.SearchResult.RankSignals.CustomSignal	parseFrom(byte[] data)
static SearchResponse.SearchResult.RankSignals.CustomSignal	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SearchResponse.SearchResult.RankSignals.CustomSignal	parseFrom(ByteBuffer data)
static SearchResponse.SearchResult.RankSignals.CustomSignal	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SearchResponse.SearchResult.RankSignals.CustomSignal	parseFrom(com.google.protobuf.ByteString data)
static SearchResponse.SearchResult.RankSignals.CustomSignal	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SearchResponse.SearchResult.RankSignals.CustomSignal	parseFrom(com.google.protobuf.CodedInputStream input)
static SearchResponse.SearchResult.RankSignals.CustomSignal	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SearchResponse.SearchResult.RankSignals.CustomSignal	parseFrom(InputStream input)
static SearchResponse.SearchResult.RankSignals.CustomSignal	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<SearchResponse.SearchResult.RankSignals.CustomSignal>	parser()
SearchResponse.SearchResult.RankSignals.CustomSignal.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessage

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashFields, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

See Also:

Constant Field Values

VALUE_FIELD_NUMBER

public static final int VALUE_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

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

getName

public String getName()

 Optional. 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()

 Optional. 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.

getValue

public float getValue()

 Optional. 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.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessage

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessage

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessage

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static SearchResponse.SearchResult.RankSignals.CustomSignal parseFrom(ByteBuffer data)
                                                                      throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SearchResponse.SearchResult.RankSignals.CustomSignal parseFrom(ByteBuffer data,
                                                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                                      throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SearchResponse.SearchResult.RankSignals.CustomSignal parseFrom(com.google.protobuf.ByteString data)
                                                                      throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SearchResponse.SearchResult.RankSignals.CustomSignal parseFrom(com.google.protobuf.ByteString data,
                                                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                                      throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SearchResponse.SearchResult.RankSignals.CustomSignal parseFrom(byte[] data)
                                                                      throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SearchResponse.SearchResult.RankSignals.CustomSignal parseFrom(byte[] data,
                                                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                                      throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SearchResponse.SearchResult.RankSignals.CustomSignal parseFrom(InputStream input)
                                                                      throws IOException

Throws:

IOException

parseFrom

public static SearchResponse.SearchResult.RankSignals.CustomSignal parseFrom(InputStream input,
                                                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                                      throws IOException

Throws:

IOException

parseDelimitedFrom

public static SearchResponse.SearchResult.RankSignals.CustomSignal parseDelimitedFrom(InputStream input)
                                                                               throws IOException

Throws:

IOException

parseDelimitedFrom

public static SearchResponse.SearchResult.RankSignals.CustomSignal parseDelimitedFrom(InputStream input,
                                                                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                                               throws IOException

Throws:

IOException

parseFrom

public static SearchResponse.SearchResult.RankSignals.CustomSignal parseFrom(com.google.protobuf.CodedInputStream input)
                                                                      throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

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

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static SearchResponse.SearchResult.RankSignals.CustomSignal.Builder newBuilder()

newBuilder

public static SearchResponse.SearchResult.RankSignals.CustomSignal.Builder newBuilder(SearchResponse.SearchResult.RankSignals.CustomSignal prototype)

toBuilder

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

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected SearchResponse.SearchResult.RankSignals.CustomSignal.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)

Overrides:

newBuilderForType in class com.google.protobuf.AbstractMessage

getDefaultInstance

public static SearchResponse.SearchResult.RankSignals.CustomSignal getDefaultInstance()

parser

public static com.google.protobuf.Parser<SearchResponse.SearchResult.RankSignals.CustomSignal> parser()

getParserForType

public com.google.protobuf.Parser<SearchResponse.SearchResult.RankSignals.CustomSignal> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessage

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