Class Engine (0.37.0)

public final class Engine extends GeneratedMessageV3 implements EngineOrBuilder

Metadata that describes the training and serving parameters of an Engine.

Protobuf type google.cloud.discoveryengine.v1alpha.Engine

Implements

EngineOrBuilder

Static Fields

CHAT_ENGINE_CONFIG_FIELD_NUMBER

public static final int CHAT_ENGINE_CONFIG_FIELD_NUMBER
Field Value
TypeDescription
int

CHAT_ENGINE_METADATA_FIELD_NUMBER

public static final int CHAT_ENGINE_METADATA_FIELD_NUMBER
Field Value
TypeDescription
int

COMMON_CONFIG_FIELD_NUMBER

public static final int COMMON_CONFIG_FIELD_NUMBER
Field Value
TypeDescription
int

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

DATA_STORE_IDS_FIELD_NUMBER

public static final int DATA_STORE_IDS_FIELD_NUMBER
Field Value
TypeDescription
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
TypeDescription
int

INDUSTRY_VERTICAL_FIELD_NUMBER

public static final int INDUSTRY_VERTICAL_FIELD_NUMBER
Field Value
TypeDescription
int

MEDIA_RECOMMENDATION_ENGINE_CONFIG_FIELD_NUMBER

public static final int MEDIA_RECOMMENDATION_ENGINE_CONFIG_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

RECOMMENDATION_METADATA_FIELD_NUMBER

public static final int RECOMMENDATION_METADATA_FIELD_NUMBER
Field Value
TypeDescription
int

SEARCH_ENGINE_CONFIG_FIELD_NUMBER

public static final int SEARCH_ENGINE_CONFIG_FIELD_NUMBER
Field Value
TypeDescription
int

SIMILAR_DOCUMENTS_CONFIG_FIELD_NUMBER

public static final int SIMILAR_DOCUMENTS_CONFIG_FIELD_NUMBER
Field Value
TypeDescription
int

SOLUTION_TYPE_FIELD_NUMBER

public static final int SOLUTION_TYPE_FIELD_NUMBER
Field Value
TypeDescription
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static Engine getDefaultInstance()
Returns
TypeDescription
Engine

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static Engine.Builder newBuilder()
Returns
TypeDescription
Engine.Builder

newBuilder(Engine prototype)

public static Engine.Builder newBuilder(Engine prototype)
Parameter
NameDescription
prototypeEngine
Returns
TypeDescription
Engine.Builder

parseDelimitedFrom(InputStream input)

public static Engine parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Engine
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Engine parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Engine
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static Engine parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
Engine
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Engine parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Engine
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Engine parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
Engine
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Engine parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Engine
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Engine parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
Engine
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Engine parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Engine
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static Engine parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Engine
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Engine parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Engine
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static Engine parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
Engine
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Engine parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Engine
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<Engine> parser()
Returns
TypeDescription
Parser<Engine>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getChatEngineConfig()

public Engine.ChatEngineConfig getChatEngineConfig()

Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.

.google.cloud.discoveryengine.v1alpha.Engine.ChatEngineConfig chat_engine_config = 11;

Returns
TypeDescription
Engine.ChatEngineConfig

The chatEngineConfig.

getChatEngineConfigOrBuilder()

public Engine.ChatEngineConfigOrBuilder getChatEngineConfigOrBuilder()

Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.

.google.cloud.discoveryengine.v1alpha.Engine.ChatEngineConfig chat_engine_config = 11;

Returns
TypeDescription
Engine.ChatEngineConfigOrBuilder

getChatEngineMetadata()

public Engine.ChatEngineMetadata getChatEngineMetadata()

Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.

.google.cloud.discoveryengine.v1alpha.Engine.ChatEngineMetadata chat_engine_metadata = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Engine.ChatEngineMetadata

The chatEngineMetadata.

getChatEngineMetadataOrBuilder()

public Engine.ChatEngineMetadataOrBuilder getChatEngineMetadataOrBuilder()

Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.

.google.cloud.discoveryengine.v1alpha.Engine.ChatEngineMetadata chat_engine_metadata = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Engine.ChatEngineMetadataOrBuilder

getCommonConfig()

public Engine.CommonConfig getCommonConfig()

Common config spec that specifies the metadata of the engine.

.google.cloud.discoveryengine.v1alpha.Engine.CommonConfig common_config = 15;

Returns
TypeDescription
Engine.CommonConfig

The commonConfig.

getCommonConfigOrBuilder()

public Engine.CommonConfigOrBuilder getCommonConfigOrBuilder()

Common config spec that specifies the metadata of the engine.

.google.cloud.discoveryengine.v1alpha.Engine.CommonConfig common_config = 15;

Returns
TypeDescription
Engine.CommonConfigOrBuilder

getCreateTime()

public Timestamp getCreateTime()

Output only. Timestamp the Recommendation Engine was created at.

.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Timestamp the Recommendation Engine was created at.

.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
TimestampOrBuilder

getDataStoreIds(int index)

public String getDataStoreIds(int index)

The data stores associated with this engine.

For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store.

If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here.

Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations.

repeated string data_store_ids = 5;

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The dataStoreIds at the given index.

getDataStoreIdsBytes(int index)

public ByteString getDataStoreIdsBytes(int index)

The data stores associated with this engine.

For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store.

If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here.

Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations.

repeated string data_store_ids = 5;

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the dataStoreIds at the given index.

getDataStoreIdsCount()

public int getDataStoreIdsCount()

The data stores associated with this engine.

For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store.

If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here.

Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations.

repeated string data_store_ids = 5;

Returns
TypeDescription
int

The count of dataStoreIds.

getDataStoreIdsList()

public ProtocolStringList getDataStoreIdsList()

The data stores associated with this engine.

For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store.

If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here.

Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations.

repeated string data_store_ids = 5;

Returns
TypeDescription
ProtocolStringList

A list containing the dataStoreIds.

getDefaultInstanceForType()

public Engine getDefaultInstanceForType()
Returns
TypeDescription
Engine

getDisplayName()

public String getDisplayName()

Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.

string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.

string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
ByteString

The bytes for displayName.

getEngineConfigCase()

public Engine.EngineConfigCase getEngineConfigCase()
Returns
TypeDescription
Engine.EngineConfigCase

getEngineMetadataCase()

public Engine.EngineMetadataCase getEngineMetadataCase()
Returns
TypeDescription
Engine.EngineMetadataCase

getIndustryVertical()

public IndustryVertical getIndustryVertical()

The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: If unspecified, default to GENERIC. Vertical on Engine has to match vertical of the DataStore liniked to the engine.

.google.cloud.discoveryengine.v1alpha.IndustryVertical industry_vertical = 16;

Returns
TypeDescription
IndustryVertical

The industryVertical.

getIndustryVerticalValue()

public int getIndustryVerticalValue()

The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: If unspecified, default to GENERIC. Vertical on Engine has to match vertical of the DataStore liniked to the engine.

.google.cloud.discoveryengine.v1alpha.IndustryVertical industry_vertical = 16;

Returns
TypeDescription
int

The enum numeric value on the wire for industryVertical.

getMediaRecommendationEngineConfig()

public Engine.MediaRecommendationEngineConfig getMediaRecommendationEngineConfig()

Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical.

.google.cloud.discoveryengine.v1alpha.Engine.MediaRecommendationEngineConfig media_recommendation_engine_config = 14;

Returns
TypeDescription
Engine.MediaRecommendationEngineConfig

The mediaRecommendationEngineConfig.

getMediaRecommendationEngineConfigOrBuilder()

public Engine.MediaRecommendationEngineConfigOrBuilder getMediaRecommendationEngineConfigOrBuilder()

Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical.

.google.cloud.discoveryengine.v1alpha.Engine.MediaRecommendationEngineConfig media_recommendation_engine_config = 14;

Returns
TypeDescription
Engine.MediaRecommendationEngineConfigOrBuilder

getName()

public String getName()

Immutable. The fully qualified resource name of the engine.

This field must be a UTF-8 encoded string with a length limit of 1024 characters.

Format: projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine} engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned.

string name = 1 [(.google.api.field_behavior) = IMMUTABLE];

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

Immutable. The fully qualified resource name of the engine.

This field must be a UTF-8 encoded string with a length limit of 1024 characters.

Format: projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine} engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned.

string name = 1 [(.google.api.field_behavior) = IMMUTABLE];

Returns
TypeDescription
ByteString

The bytes for name.

getParserForType()

public Parser<Engine> getParserForType()
Returns
TypeDescription
Parser<Engine>
Overrides

getRecommendationMetadata()

public Engine.RecommendationMetadata getRecommendationMetadata()

Output only. Additional information of a recommendation engine. Only applicable if solution_type is SOLUTION_TYPE_RECOMMENDATION.

.google.cloud.discoveryengine.v1alpha.Engine.RecommendationMetadata recommendation_metadata = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Engine.RecommendationMetadata

The recommendationMetadata.

getRecommendationMetadataOrBuilder()

public Engine.RecommendationMetadataOrBuilder getRecommendationMetadataOrBuilder()

Output only. Additional information of a recommendation engine. Only applicable if solution_type is SOLUTION_TYPE_RECOMMENDATION.

.google.cloud.discoveryengine.v1alpha.Engine.RecommendationMetadata recommendation_metadata = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Engine.RecommendationMetadataOrBuilder

getSearchEngineConfig()

public Engine.SearchEngineConfig getSearchEngineConfig()

Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH.

.google.cloud.discoveryengine.v1alpha.Engine.SearchEngineConfig search_engine_config = 13;

Returns
TypeDescription
Engine.SearchEngineConfig

The searchEngineConfig.

getSearchEngineConfigOrBuilder()

public Engine.SearchEngineConfigOrBuilder getSearchEngineConfigOrBuilder()

Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH.

.google.cloud.discoveryengine.v1alpha.Engine.SearchEngineConfig search_engine_config = 13;

Returns
TypeDescription
Engine.SearchEngineConfigOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getSimilarDocumentsConfig()

public Engine.SimilarDocumentsEngineConfig getSimilarDocumentsConfig()

Additional config specs for a similar-items engine.

.google.cloud.discoveryengine.v1alpha.Engine.SimilarDocumentsEngineConfig similar_documents_config = 9;

Returns
TypeDescription
Engine.SimilarDocumentsEngineConfig

The similarDocumentsConfig.

getSimilarDocumentsConfigOrBuilder()

public Engine.SimilarDocumentsEngineConfigOrBuilder getSimilarDocumentsConfigOrBuilder()

Additional config specs for a similar-items engine.

.google.cloud.discoveryengine.v1alpha.Engine.SimilarDocumentsEngineConfig similar_documents_config = 9;

Returns
TypeDescription
Engine.SimilarDocumentsEngineConfigOrBuilder

getSolutionType()

public SolutionType getSolutionType()

Required. The solutions of the engine.

.google.cloud.discoveryengine.v1alpha.SolutionType solution_type = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
SolutionType

The solutionType.

getSolutionTypeValue()

public int getSolutionTypeValue()

Required. The solutions of the engine.

.google.cloud.discoveryengine.v1alpha.SolutionType solution_type = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
int

The enum numeric value on the wire for solutionType.

getUpdateTime()

public Timestamp getUpdateTime()

Output only. Timestamp the Recommendation Engine was last updated.

.google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. Timestamp the Recommendation Engine was last updated.

.google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
TimestampOrBuilder

hasChatEngineConfig()

public boolean hasChatEngineConfig()

Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.

.google.cloud.discoveryengine.v1alpha.Engine.ChatEngineConfig chat_engine_config = 11;

Returns
TypeDescription
boolean

Whether the chatEngineConfig field is set.

hasChatEngineMetadata()

public boolean hasChatEngineMetadata()

Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.

.google.cloud.discoveryengine.v1alpha.Engine.ChatEngineMetadata chat_engine_metadata = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
boolean

Whether the chatEngineMetadata field is set.

hasCommonConfig()

public boolean hasCommonConfig()

Common config spec that specifies the metadata of the engine.

.google.cloud.discoveryengine.v1alpha.Engine.CommonConfig common_config = 15;

Returns
TypeDescription
boolean

Whether the commonConfig field is set.

hasCreateTime()

public boolean hasCreateTime()

Output only. Timestamp the Recommendation Engine was created at.

.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
boolean

Whether the createTime field is set.

hasMediaRecommendationEngineConfig()

public boolean hasMediaRecommendationEngineConfig()

Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical.

.google.cloud.discoveryengine.v1alpha.Engine.MediaRecommendationEngineConfig media_recommendation_engine_config = 14;

Returns
TypeDescription
boolean

Whether the mediaRecommendationEngineConfig field is set.

hasRecommendationMetadata()

public boolean hasRecommendationMetadata()

Output only. Additional information of a recommendation engine. Only applicable if solution_type is SOLUTION_TYPE_RECOMMENDATION.

.google.cloud.discoveryengine.v1alpha.Engine.RecommendationMetadata recommendation_metadata = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
boolean

Whether the recommendationMetadata field is set.

hasSearchEngineConfig()

public boolean hasSearchEngineConfig()

Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH.

.google.cloud.discoveryengine.v1alpha.Engine.SearchEngineConfig search_engine_config = 13;

Returns
TypeDescription
boolean

Whether the searchEngineConfig field is set.

hasSimilarDocumentsConfig()

public boolean hasSimilarDocumentsConfig()

Additional config specs for a similar-items engine.

.google.cloud.discoveryengine.v1alpha.Engine.SimilarDocumentsEngineConfig similar_documents_config = 9;

Returns
TypeDescription
boolean

Whether the similarDocumentsConfig field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. Timestamp the Recommendation Engine was last updated.

.google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
boolean

Whether the updateTime field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public Engine.Builder newBuilderForType()
Returns
TypeDescription
Engine.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Engine.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
Engine.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public Engine.Builder toBuilder()
Returns
TypeDescription
Engine.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException