Represents an Engine.
Package
@google-cloud/discoveryengineConstructors
(constructor)(properties)
constructor(properties?: google.cloud.discoveryengine.v1alpha.IEngine);Constructs a new Engine.
| Parameter | |
|---|---|
| Name | Description |
properties |
IEngine
Properties to set |
Properties
chatEngineConfig
public chatEngineConfig?: (google.cloud.discoveryengine.v1alpha.Engine.IChatEngineConfig|null);Engine chatEngineConfig.
chatEngineMetadata
public chatEngineMetadata?: (google.cloud.discoveryengine.v1alpha.Engine.IChatEngineMetadata|null);Engine chatEngineMetadata.
commonConfig
public commonConfig?: (google.cloud.discoveryengine.v1alpha.Engine.ICommonConfig|null);Engine commonConfig.
createTime
public createTime?: (google.protobuf.ITimestamp|null);Engine createTime.
dataStoreIds
public dataStoreIds: string[];Engine dataStoreIds.
displayName
public displayName: string;Engine displayName.
engineConfig
public engineConfig?: ("similarDocumentsConfig"|"chatEngineConfig"|"searchEngineConfig"|"mediaRecommendationEngineConfig");Engine engineConfig.
engineMetadata
public engineMetadata?: ("recommendationMetadata"|"chatEngineMetadata");Engine engineMetadata.
industryVertical
public industryVertical: (google.cloud.discoveryengine.v1alpha.IndustryVertical|keyof typeof google.cloud.discoveryengine.v1alpha.IndustryVertical);Engine industryVertical.
mediaRecommendationEngineConfig
public mediaRecommendationEngineConfig?: (google.cloud.discoveryengine.v1alpha.Engine.IMediaRecommendationEngineConfig|null);Engine mediaRecommendationEngineConfig.
name
public name: string;Engine name.
recommendationMetadata
public recommendationMetadata?: (google.cloud.discoveryengine.v1alpha.Engine.IRecommendationMetadata|null);Engine recommendationMetadata.
searchEngineConfig
public searchEngineConfig?: (google.cloud.discoveryengine.v1alpha.Engine.ISearchEngineConfig|null);Engine searchEngineConfig.
similarDocumentsConfig
public similarDocumentsConfig?: (google.cloud.discoveryengine.v1alpha.Engine.ISimilarDocumentsEngineConfig|null);Engine similarDocumentsConfig.
solutionType
public solutionType: (google.cloud.discoveryengine.v1alpha.SolutionType|keyof typeof google.cloud.discoveryengine.v1alpha.SolutionType);Engine solutionType.
updateTime
public updateTime?: (google.protobuf.ITimestamp|null);Engine updateTime.
Methods
create(properties)
public static create(properties?: google.cloud.discoveryengine.v1alpha.IEngine): google.cloud.discoveryengine.v1alpha.Engine;Creates a new Engine instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IEngine
Properties to set |
| Returns | |
|---|---|
| Type | Description |
Engine | Engine instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.discoveryengine.v1alpha.Engine;Decodes an Engine message from the specified reader or buffer.
| Parameters | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
| Returns | |
|---|---|
| Type | Description |
Engine | Engine |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.discoveryengine.v1alpha.Engine;Decodes an Engine message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
Engine | Engine |
encode(message, writer)
public static encode(message: google.cloud.discoveryengine.v1alpha.IEngine, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified Engine message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IEngine
Engine message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer | Writer |
encodeDelimited(message, writer)
public static encodeDelimited(message: google.cloud.discoveryengine.v1alpha.IEngine, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified Engine message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IEngine
Engine message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer | Writer |
fromObject(object)
public static fromObject(object: { [k: string]: any }): google.cloud.discoveryengine.v1alpha.Engine;Creates an Engine message from a plain object. Also converts values to their respective internal types.
| Parameter | |
|---|---|
| Name | Description |
object |
{ [k: string]: any }
Plain object |
| Returns | |
|---|---|
| Type | Description |
Engine | Engine |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for Engine
| Parameter | |
|---|---|
| Name | Description |
typeUrlPrefix |
string
your custom typeUrlPrefix(default "type.googleapis.com") |
| Returns | |
|---|---|
| Type | Description |
string | The default type url |
toJSON()
public toJSON(): { [k: string]: any };Converts this Engine to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
public static toObject(message: google.cloud.discoveryengine.v1alpha.Engine, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from an Engine message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
Engine
Engine |
options |
$protobuf.IConversionOptions
Conversion options |
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | Plain object |
verify(message)
public static verify(message: { [k: string]: any }): (string|null);Verifies an Engine message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|