Class protos.google.cloud.discoveryengine.v1beta.Engine (3.3.1)

Represents an Engine.

Implements

protos.google.cloud.discoveryengine.v1beta.IEngine

Package

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.discoveryengine.v1beta.IEngine);

Constructs a new Engine.

Parameter
Name	Description
`properties`	`IEngine` Properties to set

Properties

agentGatewaySetting

public agentGatewaySetting?: (google.cloud.discoveryengine.v1beta.IAgentGatewaySetting|null);

Engine agentGatewaySetting.

appType

public appType: (google.cloud.discoveryengine.v1beta.Engine.AppType|keyof typeof google.cloud.discoveryengine.v1beta.Engine.AppType);

Engine appType.

chatEngineConfig

public chatEngineConfig?: (google.cloud.discoveryengine.v1beta.Engine.IChatEngineConfig|null);

Engine chatEngineConfig.

chatEngineMetadata

public chatEngineMetadata?: (google.cloud.discoveryengine.v1beta.Engine.IChatEngineMetadata|null);

Engine chatEngineMetadata.

cmekConfig

public cmekConfig?: (google.cloud.discoveryengine.v1beta.ICmekConfig|null);

Engine cmekConfig.

commonConfig

public commonConfig?: (google.cloud.discoveryengine.v1beta.Engine.ICommonConfig|null);

Engine commonConfig.

configurableBillingApproach

public configurableBillingApproach: (google.cloud.discoveryengine.v1beta.Engine.ConfigurableBillingApproach|keyof typeof google.cloud.discoveryengine.v1beta.Engine.ConfigurableBillingApproach);

Engine configurableBillingApproach.

connectorTenantInfo

public connectorTenantInfo: { [k: string]: string };

Engine connectorTenantInfo.

createTime

public createTime?: (google.protobuf.ITimestamp|null);

Engine createTime.

dataStoreIds

public dataStoreIds: string[];

Engine dataStoreIds.

disableAnalytics

public disableAnalytics: boolean;

Engine disableAnalytics.

displayName

public displayName: string;

Engine displayName.

engineConfig

public engineConfig?: ("chatEngineConfig"|"searchEngineConfig"|"mediaRecommendationEngineConfig");

Engine engineConfig.

engineMetadata

public engineMetadata?: "chatEngineMetadata";

Engine engineMetadata.

features

public features: { [k: string]: google.cloud.discoveryengine.v1beta.Engine.FeatureState };

Engine features.

industryVertical

public industryVertical: (google.cloud.discoveryengine.v1beta.IndustryVertical|keyof typeof google.cloud.discoveryengine.v1beta.IndustryVertical);

Engine industryVertical.

knowledgeGraphConfig

public knowledgeGraphConfig?: (google.cloud.discoveryengine.v1beta.Engine.IKnowledgeGraphConfig|null);

Engine knowledgeGraphConfig.

marketplaceAgentVisibility

public marketplaceAgentVisibility: (google.cloud.discoveryengine.v1beta.Engine.MarketplaceAgentVisibility|keyof typeof google.cloud.discoveryengine.v1beta.Engine.MarketplaceAgentVisibility);

Engine marketplaceAgentVisibility.

mediaRecommendationEngineConfig

public mediaRecommendationEngineConfig?: (google.cloud.discoveryengine.v1beta.Engine.IMediaRecommendationEngineConfig|null);

Engine mediaRecommendationEngineConfig.

modelConfigs

public modelConfigs: { [k: string]: google.cloud.discoveryengine.v1beta.Engine.ModelState };

Engine modelConfigs.

name

public name: string;

Engine name.

observabilityConfig

public observabilityConfig?: (google.cloud.discoveryengine.v1beta.IObservabilityConfig|null);

Engine observabilityConfig.

procurementContactEmails

public procurementContactEmails: string[];

Engine procurementContactEmails.

searchEngineConfig

public searchEngineConfig?: (google.cloud.discoveryengine.v1beta.Engine.ISearchEngineConfig|null);

Engine searchEngineConfig.

solutionType

public solutionType: (google.cloud.discoveryengine.v1beta.SolutionType|keyof typeof google.cloud.discoveryengine.v1beta.SolutionType);

Engine solutionType.

updateTime

public updateTime?: (google.protobuf.ITimestamp|null);

Engine updateTime.

Methods

create(properties)

public static create(properties?: google.cloud.discoveryengine.v1beta.IEngine): google.cloud.discoveryengine.v1beta.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.v1beta.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.v1beta.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.v1beta.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.v1beta.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.v1beta.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.v1beta.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)`	`null` if valid, otherwise the reason why it is not

Class protos.google.cloud.discoveryengine.v1beta.Engine (3.3.1) Stay organized with collections Save and categorize content based on your preferences.