Class BatchSearchDataObjectsRequest.BatchSearchMetadataOptions (0.21.0)

0.21.0 (latest) 0.17.0 0.16.0 0.15.0 0.12.0 0.9.0 0.8.0 0.6.0 0.4.0 0.3.0 0.1.0

public static final class BatchSearchDataObjectsRequest.BatchSearchMetadataOptions extends GeneratedMessage implements BatchSearchDataObjectsRequest.BatchSearchMetadataOptionsOrBuilder

Options controlling which metadata is included in the search results.

Protobuf type google.cloud.vectorsearch.v1beta.BatchSearchDataObjectsRequest.BatchSearchMetadataOptions

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessage > BatchSearchDataObjectsRequest.BatchSearchMetadataOptions

Implements

BatchSearchDataObjectsRequest.BatchSearchMetadataOptionsOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashCode()

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.newBuilderForType(AbstractMessage.BuilderParent)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessage.<ContainingT,T>newFileScopedGeneratedExtension(java.lang.Class<?>,com.google.protobuf.Message)

com.google.protobuf.GeneratedMessage.<ContainingT,T>newMessageScopedGeneratedExtension(com.google.protobuf.Message,int,java.lang.Class<?>,com.google.protobuf.Message)

com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT,int)

GeneratedMessage.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessage.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessage.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessage.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessage.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessage.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessage.<T>emptyList(java.lang.Class<T>)

com.google.protobuf.GeneratedMessage.<V>serializeBooleanMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Boolean,V>,com.google.protobuf.MapEntry<java.lang.Boolean,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeIntegerMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Integer,V>,com.google.protobuf.MapEntry<java.lang.Integer,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeLongMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Long,V>,com.google.protobuf.MapEntry<java.lang.Long,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeStringMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.String,V>,com.google.protobuf.MapEntry<java.lang.String,V>,int)

com.google.protobuf.GeneratedMessage.canUseUnsafe()

GeneratedMessage.computeStringSize(int,Object)

GeneratedMessage.computeStringSizeNoTag(Object)

com.google.protobuf.GeneratedMessage.emptyBooleanList()

com.google.protobuf.GeneratedMessage.emptyDoubleList()

com.google.protobuf.GeneratedMessage.emptyFloatList()

com.google.protobuf.GeneratedMessage.emptyIntList()

com.google.protobuf.GeneratedMessage.emptyLongList()

GeneratedMessage.getAllFields()

GeneratedMessage.getDescriptorForType()

GeneratedMessage.getField(Descriptors.FieldDescriptor)

GeneratedMessage.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessage.getParserForType()

GeneratedMessage.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessage.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessage.getSerializedSize()

GeneratedMessage.getUnknownFields()

GeneratedMessage.hasField(Descriptors.FieldDescriptor)

GeneratedMessage.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessage.internalGetFieldAccessorTable()

GeneratedMessage.internalGetMapField(int)

com.google.protobuf.GeneratedMessage.internalGetMapFieldReflection(int)

GeneratedMessage.isInitialized()

com.google.protobuf.GeneratedMessage.isStringEmpty(java.lang.Object)

GeneratedMessage.makeExtensionsImmutable()

com.google.protobuf.GeneratedMessage.mergeFromAndMakeImmutableInternal(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite)

com.google.protobuf.GeneratedMessage.newInstance(com.google.protobuf.GeneratedMessage.UnusedPrivateParameter)

GeneratedMessage.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

com.google.protobuf.GeneratedMessage.parseUnknownFieldProto3(com.google.protobuf.CodedInputStream,com.google.protobuf.UnknownFieldSet.Builder,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessage.writeReplace()

GeneratedMessage.writeString(CodedOutputStream,int,Object)

GeneratedMessage.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessage.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

SEARCH_SIGNALS_ENABLED_FIELD_NUMBER

public static final int SEARCH_SIGNALS_ENABLED_FIELD_NUMBER

Field Value
Type	Description
int

Static Methods

getDefaultInstance()

public static BatchSearchDataObjectsRequest.BatchSearchMetadataOptions getDefaultInstance()

Returns
Type	Description
BatchSearchDataObjectsRequest.BatchSearchMetadataOptions

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

newBuilder()

public static BatchSearchDataObjectsRequest.BatchSearchMetadataOptions.Builder newBuilder()

Returns
Type	Description
BatchSearchDataObjectsRequest.BatchSearchMetadataOptions.Builder

newBuilder(BatchSearchDataObjectsRequest.BatchSearchMetadataOptions prototype)

public static BatchSearchDataObjectsRequest.BatchSearchMetadataOptions.Builder newBuilder(BatchSearchDataObjectsRequest.BatchSearchMetadataOptions prototype)

Parameter
Name	Description
prototype	BatchSearchDataObjectsRequest.BatchSearchMetadataOptions

Returns
Type	Description
BatchSearchDataObjectsRequest.BatchSearchMetadataOptions.Builder

parseDelimitedFrom(InputStream input)

public static BatchSearchDataObjectsRequest.BatchSearchMetadataOptions parseDelimitedFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
BatchSearchDataObjectsRequest.BatchSearchMetadataOptions

Exceptions
Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static BatchSearchDataObjectsRequest.BatchSearchMetadataOptions parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
BatchSearchDataObjectsRequest.BatchSearchMetadataOptions

Exceptions
Type	Description
IOException

parseFrom(byte[] data)

public static BatchSearchDataObjectsRequest.BatchSearchMetadataOptions parseFrom(byte[] data)

Parameter
Name	Description
data	byte[]

Returns
Type	Description
BatchSearchDataObjectsRequest.BatchSearchMetadataOptions

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static BatchSearchDataObjectsRequest.BatchSearchMetadataOptions parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
BatchSearchDataObjectsRequest.BatchSearchMetadataOptions

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static BatchSearchDataObjectsRequest.BatchSearchMetadataOptions parseFrom(ByteString data)

Parameter
Name	Description
data	ByteString

Returns
Type	Description
BatchSearchDataObjectsRequest.BatchSearchMetadataOptions

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static BatchSearchDataObjectsRequest.BatchSearchMetadataOptions parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
BatchSearchDataObjectsRequest.BatchSearchMetadataOptions

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static BatchSearchDataObjectsRequest.BatchSearchMetadataOptions parseFrom(CodedInputStream input)

Parameter
Name	Description
input	CodedInputStream

Returns
Type	Description
BatchSearchDataObjectsRequest.BatchSearchMetadataOptions

Exceptions
Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static BatchSearchDataObjectsRequest.BatchSearchMetadataOptions parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
BatchSearchDataObjectsRequest.BatchSearchMetadataOptions

Exceptions
Type	Description
IOException

parseFrom(InputStream input)

public static BatchSearchDataObjectsRequest.BatchSearchMetadataOptions parseFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
BatchSearchDataObjectsRequest.BatchSearchMetadataOptions

Exceptions
Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static BatchSearchDataObjectsRequest.BatchSearchMetadataOptions parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
BatchSearchDataObjectsRequest.BatchSearchMetadataOptions

Exceptions
Type	Description
IOException

parseFrom(ByteBuffer data)

public static BatchSearchDataObjectsRequest.BatchSearchMetadataOptions parseFrom(ByteBuffer data)

Parameter
Name	Description
data	ByteBuffer

Returns
Type	Description
BatchSearchDataObjectsRequest.BatchSearchMetadataOptions

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static BatchSearchDataObjectsRequest.BatchSearchMetadataOptions parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
BatchSearchDataObjectsRequest.BatchSearchMetadataOptions

Exceptions
Type	Description
InvalidProtocolBufferException

parser()

public static Parser<BatchSearchDataObjectsRequest.BatchSearchMetadataOptions> parser()

Returns
Type	Description
Parser<BatchSearchMetadataOptions>

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
obj	Object

Returns
Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

getDefaultInstanceForType()

public BatchSearchDataObjectsRequest.BatchSearchMetadataOptions getDefaultInstanceForType()

Returns
Type	Description
BatchSearchDataObjectsRequest.BatchSearchMetadataOptions

getParserForType()

public Parser<BatchSearchDataObjectsRequest.BatchSearchMetadataOptions> getParserForType()

Returns
Type	Description
Parser<BatchSearchMetadataOptions>

Overrides

GeneratedMessage.getParserForType()

getSearchSignalsEnabled()

public boolean getSearchSignalsEnabled()

Optional. If true, per-result quality signals are returned in SearchResult.search_result_metadata.

bool search_signals_enabled = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	The searchSignalsEnabled.

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

GeneratedMessage.getSerializedSize()

hashCode()

public int hashCode()

Returns
Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessage.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessage.isInitialized()

newBuilderForType()

public BatchSearchDataObjectsRequest.BatchSearchMetadataOptions.Builder newBuilderForType()

Returns
Type	Description
BatchSearchDataObjectsRequest.BatchSearchMetadataOptions.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected BatchSearchDataObjectsRequest.BatchSearchMetadataOptions.Builder newBuilderForType(AbstractMessage.BuilderParent parent)

Parameter
Name	Description
parent	BuilderParent

Returns
Type	Description
BatchSearchDataObjectsRequest.BatchSearchMetadataOptions.Builder

Overrides

AbstractMessage.newBuilderForType(AbstractMessage.BuilderParent parent)

toBuilder()

public BatchSearchDataObjectsRequest.BatchSearchMetadataOptions.Builder toBuilder()

Returns
Type	Description
BatchSearchDataObjectsRequest.BatchSearchMetadataOptions.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessage.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException