ServingConfig class

Represents a serving config which is a singleton resource under engine. A default serving config is automatically provisioned and deleted with its parent engine.

To get more information about ServingConfig, see:

• API documentation

Import

ServingConfig can be imported using any of these accepted formats:

• projects/{{project}}/locations/{{location}}/collections/{{collection_id}}/engines/{{engine_id}}/servingConfigs/{{serving_config_id}}
• {{project}}/{{location}}/{{collection_id}}/{{engine_id}}/{{serving_config_id}}
• {{location}}/{{collection_id}}/{{engine_id}}/{{serving_config_id}}

When using the pulumi import command, ServingConfig can be imported using one of the formats above. For example:

$ pulumi import gcp:discoveryengine/servingConfig:ServingConfig default projects/{{project}}/locations/{{location}}/collections/{{collection_id}}/engines/{{engine_id}}/servingConfigs/{{serving_config_id}}
$ pulumi import gcp:discoveryengine/servingConfig:ServingConfig default {{project}}/{{location}}/{{collection_id}}/{{engine_id}}/{{serving_config_id}}
$ pulumi import gcp:discoveryengine/servingConfig:ServingConfig default {{location}}/{{collection_id}}/{{engine_id}}/{{serving_config_id}}

Constructors

ServingConfig(String name, {ServingConfigArgs? args, CustomResourceOptions? options})

Creates a new ServingConfig. name The Pulumi resource name. args Arguments used to configure this ServingConfig. The set of arguments for ServingConfig. options Resource options controlling this resource's behavior.

ServingConfig.reference(String urn)

Creates a typed reference to an existing ServingConfig resource.

Properties

boostControlIds ↔ Output<List<String>?>

The resource IDs of the boost controls to be applied.

late, final

childResources → Set<Resource>

final, inherited

collectionId ↔ Output<String?>

The collection ID. Currently only accepts "defaultCollection".

late, final

completionSources ↔ Map<String, IOutputCompletionSource>

late, final, inherited

engineId ↔ Output<String>

The ID of the engine associated with the serving config.

late, final

filterControlIds ↔ Output<List<String>?>

The resource IDs of the filter controls to be applied.

late, final

hashCode → int

The hash code for this object.

no setter, inherited

id ↔ Output<String>

getter/setter pair, inherited

isCustom → bool

Returns whether this resource is provider-managed.

no setter, inherited

isProtected → bool

Returns whether this resource is protected from deletion.

no setter, inherited

isRemote → bool

Whether this resource is registered as remote.

no setter, inherited

isResourceReference → bool

Whether this instance represents a resource value returned over RPC.

final, inherited

location ↔ Output<String>

The geographic location where the data store should reside. The value can only be one of "global", "us" and "eu".

late, final

name ↔ Output<String>

The unique full resource name of the serving config. Values are of the format projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}.

late, final

project ↔ Output<String>

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

late, final

promoteControlIds ↔ Output<List<String>?>

The resource IDs of the promote controls to be applied.

late, final

redirectControlIds ↔ Output<List<String>?>

The resource IDs of the redirect controls to be applied.

late, final

resourceTransforms → List<ResourceTransform>

Inherited/explicit async transforms.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

servingConfigId ↔ Output<String?>

'The unique ID of the serving config. Currently only accepts "defaultSearch".'

late, final

synonymsControlIds ↔ Output<List<String>?>

The resource IDs of the synonyms controls to be applied.

late, final

transformations → List<ResourceTransformation>

Inherited/explicit legacy transformations.

no setter, inherited

urn ↔ Output<String>

late, final, inherited

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

Static Methods

get(String name, Input<String> id, {ServingConfigState? state, CustomResourceOptions? options}) → ServingConfig

Gets an existing ServingConfig resource's state with the given name and id.