Engine class

Creates a Engine.

Constructors

Engine(String name, {EngineArgs? args, CustomResourceOptions? options})
Creates a new Engine. name The Pulumi resource name. args Arguments used to configure this Engine. The set of arguments for Engine. options Resource options controlling this resource's behavior.

Properties

chatEngineConfig ↔ Output<GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigResponse>
Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
latefinal
chatEngineMetadata ↔ Output<GoogleCloudDiscoveryengineV1alphaEngineChatEngineMetadataResponse>
Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
latefinal
childResources → Set<Resource>
finalinherited
collectionId ↔ Output<String>
latefinal
commonConfig ↔ Output<GoogleCloudDiscoveryengineV1alphaEngineCommonConfigResponse>
Common config spec that specifies the metadata of the engine.
latefinal
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
createTime ↔ Output<String>
Timestamp the Recommendation Engine was created at.
latefinal
dataStoreIds ↔ Output<List<String>>
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 intializations.
latefinal
displayName ↔ Output<String>
The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.
latefinal
engineId ↔ Output<String>
Required. The ID to use for the Engine, which will become the final component of the Engine's resource name. This field must conform to RFC-1034 standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.
latefinal
hashCode → int
The hash code for this object.
no setterinherited
id ↔ Output<String>
getter/setter pairinherited
industryVertical ↔ Output<String>
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.
latefinal
isCustom → bool
Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool
Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool
Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool
Whether this instance represents a resource value returned over RPC.
finalinherited
location ↔ Output<String>
latefinal
mediaRecommendationEngineConfig ↔ Output<GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigResponse>
Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical.
latefinal
name ↔ Output<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_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.
latefinal
project ↔ Output<String>
latefinal
recommendationMetadata ↔ Output<GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadataResponse>
Additional information of a recommendation engine. Only applicable if solution_type is SOLUTION_TYPE_RECOMMENDATION.
latefinal
resourceTransforms → List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
searchEngineConfig ↔ Output<GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfigResponse>
Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH.
latefinal
similarDocumentsConfig ↔ Output<Map<String, dynamic>>
Additional config specs for a similar-items engine.
latefinal
solutionType ↔ Output<String>
The solutions of the engine.
latefinal
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
updateTime ↔ Output<String>
Timestamp the Recommendation Engine was last updated.
latefinal
urn ↔ Output<String>
latefinalinherited

Methods

failId(Object error) → void
Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void
Completes all output properties with error.
inherited
failUrn(Object error) → void
Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?
Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String
Returns this resource's logical name.
inherited
getResourceType() → String
Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>
Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void
Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void
Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void
Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>
Serializes resource properties for RPC transmission.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited