Class SearchRequest.SearchAsYouTypeSpec.Field.Builder (0.95.0)

public static final class SearchRequest.SearchAsYouTypeSpec.Field.Builder extends GeneratedMessage.Builder<SearchRequest.SearchAsYouTypeSpec.Field.Builder> implements SearchRequest.SearchAsYouTypeSpec.FieldOrBuilder

A schema field to be used for Search As You Type scoring on this request. Overrides any data-store-level Search As You Type field configuration for the duration of the request.

Protobuf type google.cloud.discoveryengine.v1.SearchRequest.SearchAsYouTypeSpec.Field

Static Methods

getDescriptor()

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

Methods

build()

public SearchRequest.SearchAsYouTypeSpec.Field build()
Returns
Type Description
SearchRequest.SearchAsYouTypeSpec.Field

buildPartial()

public SearchRequest.SearchAsYouTypeSpec.Field buildPartial()
Returns
Type Description
SearchRequest.SearchAsYouTypeSpec.Field

clear()

public SearchRequest.SearchAsYouTypeSpec.Field.Builder clear()
Returns
Type Description
SearchRequest.SearchAsYouTypeSpec.Field.Builder
Overrides

clearKey()

public SearchRequest.SearchAsYouTypeSpec.Field.Builder clearKey()

Required. A field key that has been indexed for Search As You Type.

string key = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
SearchRequest.SearchAsYouTypeSpec.Field.Builder

This builder for chaining.

clearWeight()

public SearchRequest.SearchAsYouTypeSpec.Field.Builder clearWeight()

Optional. Weight for scores from this field. Defaults to 1.0 if not specified.

optional double weight = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
SearchRequest.SearchAsYouTypeSpec.Field.Builder

This builder for chaining.

getDefaultInstanceForType()

public SearchRequest.SearchAsYouTypeSpec.Field getDefaultInstanceForType()
Returns
Type Description
SearchRequest.SearchAsYouTypeSpec.Field

getDescriptorForType()

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

getKey()

public String getKey()

Required. A field key that has been indexed for Search As You Type.

string key = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The key.

getKeyBytes()

public ByteString getKeyBytes()

Required. A field key that has been indexed for Search As You Type.

string key = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for key.

getWeight()

public double getWeight()

Optional. Weight for scores from this field. Defaults to 1.0 if not specified.

optional double weight = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
double

The weight.

hasWeight()

public boolean hasWeight()

Optional. Weight for scores from this field. Defaults to 1.0 if not specified.

optional double weight = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the weight field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(SearchRequest.SearchAsYouTypeSpec.Field other)

public SearchRequest.SearchAsYouTypeSpec.Field.Builder mergeFrom(SearchRequest.SearchAsYouTypeSpec.Field other)
Parameter
Name Description
other SearchRequest.SearchAsYouTypeSpec.Field
Returns
Type Description
SearchRequest.SearchAsYouTypeSpec.Field.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public SearchRequest.SearchAsYouTypeSpec.Field.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchRequest.SearchAsYouTypeSpec.Field.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public SearchRequest.SearchAsYouTypeSpec.Field.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
SearchRequest.SearchAsYouTypeSpec.Field.Builder
Overrides

setKey(String value)

public SearchRequest.SearchAsYouTypeSpec.Field.Builder setKey(String value)

Required. A field key that has been indexed for Search As You Type.

string key = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value String

The key to set.

Returns
Type Description
SearchRequest.SearchAsYouTypeSpec.Field.Builder

This builder for chaining.

setKeyBytes(ByteString value)

public SearchRequest.SearchAsYouTypeSpec.Field.Builder setKeyBytes(ByteString value)

Required. A field key that has been indexed for Search As You Type.

string key = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value ByteString

The bytes for key to set.

Returns
Type Description
SearchRequest.SearchAsYouTypeSpec.Field.Builder

This builder for chaining.

setWeight(double value)

public SearchRequest.SearchAsYouTypeSpec.Field.Builder setWeight(double value)

Optional. Weight for scores from this field. Defaults to 1.0 if not specified.

optional double weight = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value double

The weight to set.

Returns
Type Description
SearchRequest.SearchAsYouTypeSpec.Field.Builder

This builder for chaining.