Class Engine.SearchEngineConfig (0.41.0)

public static final class Engine.SearchEngineConfig extends GeneratedMessageV3 implements Engine.SearchEngineConfigOrBuilder

Configurations for a Search Engine.

Protobuf type google.cloud.discoveryengine.v1.Engine.SearchEngineConfig

Static Fields

SEARCH_ADD_ONS_FIELD_NUMBER

public static final int SEARCH_ADD_ONS_FIELD_NUMBER
Field Value
Type Description
int

SEARCH_TIER_FIELD_NUMBER

public static final int SEARCH_TIER_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Engine.SearchEngineConfig getDefaultInstance()
Returns
Type Description
Engine.SearchEngineConfig

getDescriptor()

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

newBuilder()

public static Engine.SearchEngineConfig.Builder newBuilder()
Returns
Type Description
Engine.SearchEngineConfig.Builder

newBuilder(Engine.SearchEngineConfig prototype)

public static Engine.SearchEngineConfig.Builder newBuilder(Engine.SearchEngineConfig prototype)
Parameter
Name Description
prototype Engine.SearchEngineConfig
Returns
Type Description
Engine.SearchEngineConfig.Builder

parseDelimitedFrom(InputStream input)

public static Engine.SearchEngineConfig parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Engine.SearchEngineConfig
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Engine.SearchEngineConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Engine.SearchEngineConfig
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Engine.SearchEngineConfig parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Engine.SearchEngineConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Engine.SearchEngineConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Engine.SearchEngineConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Engine.SearchEngineConfig parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Engine.SearchEngineConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Engine.SearchEngineConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Engine.SearchEngineConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Engine.SearchEngineConfig parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Engine.SearchEngineConfig
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Engine.SearchEngineConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Engine.SearchEngineConfig
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Engine.SearchEngineConfig parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Engine.SearchEngineConfig
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Engine.SearchEngineConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Engine.SearchEngineConfig
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Engine.SearchEngineConfig parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Engine.SearchEngineConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Engine.SearchEngineConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Engine.SearchEngineConfig
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Engine.SearchEngineConfig> parser()
Returns
Type Description
Parser<SearchEngineConfig>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public Engine.SearchEngineConfig getDefaultInstanceForType()
Returns
Type Description
Engine.SearchEngineConfig

getParserForType()

public Parser<Engine.SearchEngineConfig> getParserForType()
Returns
Type Description
Parser<SearchEngineConfig>
Overrides

getSearchAddOns(int index)

public SearchAddOn getSearchAddOns(int index)

The add-on that this search engine enables.

repeated .google.cloud.discoveryengine.v1.SearchAddOn search_add_ons = 2;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
SearchAddOn

The searchAddOns at the given index.

getSearchAddOnsCount()

public int getSearchAddOnsCount()

The add-on that this search engine enables.

repeated .google.cloud.discoveryengine.v1.SearchAddOn search_add_ons = 2;

Returns
Type Description
int

The count of searchAddOns.

getSearchAddOnsList()

public List<SearchAddOn> getSearchAddOnsList()

The add-on that this search engine enables.

repeated .google.cloud.discoveryengine.v1.SearchAddOn search_add_ons = 2;

Returns
Type Description
List<SearchAddOn>

A list containing the searchAddOns.

getSearchAddOnsValue(int index)

public int getSearchAddOnsValue(int index)

The add-on that this search engine enables.

repeated .google.cloud.discoveryengine.v1.SearchAddOn search_add_ons = 2;

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
int

The enum numeric value on the wire of searchAddOns at the given index.

getSearchAddOnsValueList()

public List<Integer> getSearchAddOnsValueList()

The add-on that this search engine enables.

repeated .google.cloud.discoveryengine.v1.SearchAddOn search_add_ons = 2;

Returns
Type Description
List<Integer>

A list containing the enum numeric values on the wire for searchAddOns.

getSearchTier()

public SearchTier getSearchTier()

The search feature tier of this engine.

Different tiers might have different pricing. To learn more, check the pricing documentation.

Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified.

.google.cloud.discoveryengine.v1.SearchTier search_tier = 1;

Returns
Type Description
SearchTier

The searchTier.

getSearchTierValue()

public int getSearchTierValue()

The search feature tier of this engine.

Different tiers might have different pricing. To learn more, check the pricing documentation.

Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified.

.google.cloud.discoveryengine.v1.SearchTier search_tier = 1;

Returns
Type Description
int

The enum numeric value on the wire for searchTier.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Engine.SearchEngineConfig.Builder newBuilderForType()
Returns
Type Description
Engine.SearchEngineConfig.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Engine.SearchEngineConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Engine.SearchEngineConfig.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public Engine.SearchEngineConfig.Builder toBuilder()
Returns
Type Description
Engine.SearchEngineConfig.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException