Class BatchSearchDataObjectsRequest.BatchSearchMetadataOptions.Builder (0.21.0)

public static final class BatchSearchDataObjectsRequest.BatchSearchMetadataOptions.Builder extends GeneratedMessage.Builder<BatchSearchDataObjectsRequest.BatchSearchMetadataOptions.Builder> implements BatchSearchDataObjectsRequest.BatchSearchMetadataOptionsOrBuilder

Options controlling which metadata is included in the search results.

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

Inheritance

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

Static Methods

getDescriptor()

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

Methods

build()

public BatchSearchDataObjectsRequest.BatchSearchMetadataOptions build()
Returns
Type Description
BatchSearchDataObjectsRequest.BatchSearchMetadataOptions

buildPartial()

public BatchSearchDataObjectsRequest.BatchSearchMetadataOptions buildPartial()
Returns
Type Description
BatchSearchDataObjectsRequest.BatchSearchMetadataOptions

clear()

public BatchSearchDataObjectsRequest.BatchSearchMetadataOptions.Builder clear()
Returns
Type Description
BatchSearchDataObjectsRequest.BatchSearchMetadataOptions.Builder
Overrides

clearSearchSignalsEnabled()

public BatchSearchDataObjectsRequest.BatchSearchMetadataOptions.Builder clearSearchSignalsEnabled()

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
BatchSearchDataObjectsRequest.BatchSearchMetadataOptions.Builder

This builder for chaining.

getDefaultInstanceForType()

public BatchSearchDataObjectsRequest.BatchSearchMetadataOptions getDefaultInstanceForType()
Returns
Type Description
BatchSearchDataObjectsRequest.BatchSearchMetadataOptions

getDescriptorForType()

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

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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(BatchSearchDataObjectsRequest.BatchSearchMetadataOptions other)

public BatchSearchDataObjectsRequest.BatchSearchMetadataOptions.Builder mergeFrom(BatchSearchDataObjectsRequest.BatchSearchMetadataOptions other)
Parameter
Name Description
other BatchSearchDataObjectsRequest.BatchSearchMetadataOptions
Returns
Type Description
BatchSearchDataObjectsRequest.BatchSearchMetadataOptions.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public BatchSearchDataObjectsRequest.BatchSearchMetadataOptions.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BatchSearchDataObjectsRequest.BatchSearchMetadataOptions.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public BatchSearchDataObjectsRequest.BatchSearchMetadataOptions.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
BatchSearchDataObjectsRequest.BatchSearchMetadataOptions.Builder
Overrides

setSearchSignalsEnabled(boolean value)

public BatchSearchDataObjectsRequest.BatchSearchMetadataOptions.Builder setSearchSignalsEnabled(boolean value)

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

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

Parameter
Name Description
value boolean

The searchSignalsEnabled to set.

Returns
Type Description
BatchSearchDataObjectsRequest.BatchSearchMetadataOptions.Builder

This builder for chaining.