Google Cloud Discovery Engine V1 Client - Class Engine (1.2.0)

Reference documentation and code samples for the Google Cloud Discovery Engine V1 Client class Engine.

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

Generated from protobuf message google.cloud.discoveryengine.v1.Engine

Namespace

Google \ Cloud \ DiscoveryEngine \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ chat_engine_config Google\Cloud\DiscoveryEngine\V1\Engine\ChatEngineConfig

Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
↳ search_engine_config Google\Cloud\DiscoveryEngine\V1\Engine\SearchEngineConfig

Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH.
↳ chat_engine_metadata Google\Cloud\DiscoveryEngine\V1\Engine\ChatEngineMetadata

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

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}/locations/{location}/collections/{collection}/engines/{engine} engine should be 1-63 characters, and valid characters are /[a-z0-9][a-z0-9-_]*/. Otherwise, an INVALID_ARGUMENT error is returned.
↳ display_name string

Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.
↳ create_time Google\Protobuf\Timestamp

Output only. Timestamp the Recommendation Engine was created at.
↳ update_time Google\Protobuf\Timestamp

Output only. Timestamp the Recommendation Engine was last updated.
↳ data_store_ids array

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.
↳ solution_type int

Required. The solutions of the engine.
↳ industry_vertical int

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 linked to the engine.
↳ common_config Google\Cloud\DiscoveryEngine\V1\Engine\CommonConfig

Common config spec that specifies the metadata of the engine.
↳ disable_analytics bool

Optional. Whether to disable analytics for searches performed on this engine.

getChatEngineConfig

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

Returns
Type Description
Google\Cloud\DiscoveryEngine\V1\Engine\ChatEngineConfig|null

hasChatEngineConfig

setChatEngineConfig

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

Parameter
Name Description
var Google\Cloud\DiscoveryEngine\V1\Engine\ChatEngineConfig
Returns
Type Description
$this

getSearchEngineConfig

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

Returns
Type Description
Google\Cloud\DiscoveryEngine\V1\Engine\SearchEngineConfig|null

hasSearchEngineConfig

setSearchEngineConfig

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

Parameter
Name Description
var Google\Cloud\DiscoveryEngine\V1\Engine\SearchEngineConfig
Returns
Type Description
$this

getChatEngineMetadata

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

Returns
Type Description
Google\Cloud\DiscoveryEngine\V1\Engine\ChatEngineMetadata|null

hasChatEngineMetadata

setChatEngineMetadata

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

Parameter
Name Description
var Google\Cloud\DiscoveryEngine\V1\Engine\ChatEngineMetadata
Returns
Type Description
$this

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}/locations/{location}/collections/{collection}/engines/{engine} engine should be 1-63 characters, and valid characters are /[a-z0-9][a-z0-9-_]*/. Otherwise, an INVALID_ARGUMENT error is returned.

Returns
Type Description
string

setName

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}/locations/{location}/collections/{collection}/engines/{engine} engine should be 1-63 characters, and valid characters are /[a-z0-9][a-z0-9-_]*/. Otherwise, an INVALID_ARGUMENT error is returned.

Parameter
Name Description
var string
Returns
Type Description
$this

getDisplayName

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

Returns
Type Description
string

setDisplayName

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

Parameter
Name Description
var string
Returns
Type Description
$this

getCreateTime

Output only. Timestamp the Recommendation Engine was created at.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. Timestamp the Recommendation Engine was created at.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getUpdateTime

Output only. Timestamp the Recommendation Engine was last updated.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. Timestamp the Recommendation Engine was last updated.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getDataStoreIds

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.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setDataStoreIds

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.

Parameter
Name Description
var string[]
Returns
Type Description
$this

getSolutionType

Required. The solutions of the engine.

Returns
Type Description
int

setSolutionType

Required. The solutions of the engine.

Parameter
Name Description
var int
Returns
Type Description
$this

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 linked to the engine.

Returns
Type Description
int

setIndustryVertical

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 linked to the engine.

Parameter
Name Description
var int
Returns
Type Description
$this

getCommonConfig

Common config spec that specifies the metadata of the engine.

Returns
Type Description
Google\Cloud\DiscoveryEngine\V1\Engine\CommonConfig|null

hasCommonConfig

clearCommonConfig

setCommonConfig

Common config spec that specifies the metadata of the engine.

Parameter
Name Description
var Google\Cloud\DiscoveryEngine\V1\Engine\CommonConfig
Returns
Type Description
$this

getDisableAnalytics

Optional. Whether to disable analytics for searches performed on this engine.

Returns
Type Description
bool

setDisableAnalytics

Optional. Whether to disable analytics for searches performed on this engine.

Parameter
Name Description
var bool
Returns
Type Description
$this

getEngineConfig

Returns
Type Description
string

getEngineMetadata

Returns
Type Description
string