UNPKG

@pulumi/gcp

Version:

A Pulumi package for creating and managing Google Cloud Platform resources.

130 lines 4.65 kB
import * as pulumi from "@pulumi/pulumi"; import * as outputs from "../types/output"; /** * Gets an existing Discovery Engine data store by ID or display name. * See [the official documentation](https://cloud.google.com/generative-ai-app-builder/docs/manage-data-stores) * and [API](https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1/projects.locations.collections.dataStores/get). * * ## Example Usage * * ### By ID * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const example = gcp.discoveryengine.getDataStore({ * dataStoreId: "my-data-store", * }); * ``` * * ### By display name * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const example = gcp.discoveryengine.getDataStore({ * displayName: "My Data Store", * }); * ``` */ export declare function getDataStore(args?: GetDataStoreArgs, opts?: pulumi.InvokeOptions): Promise<GetDataStoreResult>; /** * A collection of arguments for invoking getDataStore. */ export interface GetDataStoreArgs { /** * The unique id of the data store. Exactly one of `dataStoreId` or `displayName` must be provided. */ dataStoreId?: string; /** * The display name of the data store. Exactly one of `dataStoreId` or `displayName` must be provided. Returns an error if multiple data stores share the same display name. */ displayName?: string; /** * The geographic location where the data store resides. The value can only be one of "global", "us" and "eu". Defaults to `global`. */ location?: string; /** * The ID of the project in which the resource belongs. If it is not provided, the provider project is used. */ project?: string; } /** * A collection of values returned by getDataStore. */ export interface GetDataStoreResult { readonly advancedSiteSearchConfigs: outputs.discoveryengine.GetDataStoreAdvancedSiteSearchConfig[]; readonly contentConfig: string; readonly createAdvancedSiteSearch: boolean; readonly createTime: string; readonly dataStoreId?: string; readonly defaultSchemaId: string; readonly deletionPolicy: string; readonly displayName?: string; readonly documentProcessingConfigs: outputs.discoveryengine.GetDataStoreDocumentProcessingConfig[]; /** * The provider-assigned unique ID for this managed resource. */ readonly id: string; readonly industryVertical: string; readonly kmsKeyName: string; readonly location?: string; readonly name: string; readonly project?: string; readonly skipDefaultSchemaCreation: boolean; readonly solutionTypes: string[]; } /** * Gets an existing Discovery Engine data store by ID or display name. * See [the official documentation](https://cloud.google.com/generative-ai-app-builder/docs/manage-data-stores) * and [API](https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1/projects.locations.collections.dataStores/get). * * ## Example Usage * * ### By ID * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const example = gcp.discoveryengine.getDataStore({ * dataStoreId: "my-data-store", * }); * ``` * * ### By display name * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const example = gcp.discoveryengine.getDataStore({ * displayName: "My Data Store", * }); * ``` */ export declare function getDataStoreOutput(args?: GetDataStoreOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetDataStoreResult>; /** * A collection of arguments for invoking getDataStore. */ export interface GetDataStoreOutputArgs { /** * The unique id of the data store. Exactly one of `dataStoreId` or `displayName` must be provided. */ dataStoreId?: pulumi.Input<string | undefined>; /** * The display name of the data store. Exactly one of `dataStoreId` or `displayName` must be provided. Returns an error if multiple data stores share the same display name. */ displayName?: pulumi.Input<string | undefined>; /** * The geographic location where the data store resides. The value can only be one of "global", "us" and "eu". Defaults to `global`. */ location?: pulumi.Input<string | undefined>; /** * The ID of the project in which the resource belongs. If it is not provided, the provider project is used. */ project?: pulumi.Input<string | undefined>; } //# sourceMappingURL=getDataStore.d.ts.map