import * as pulumi from "@pulumi/pulumi"; import * as outputs from "../types/output"; /** * This data source provides details about a specific Index resource in Oracle Cloud Infrastructure NoSQL Database service. * * Get information about a single index. * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as oci from "@pulumi/oci"; * * const testIndex = oci.nosql.getIndex({ * indexName: testIndexOciNosqlIndex.name, * tableNameOrId: testTableNameOr.id, * compartmentId: compartmentId, * }); * ``` */ export declare function getIndex(args: GetIndexArgs, opts?: pulumi.InvokeOptions): Promise; /** * A collection of arguments for invoking getIndex. */ export interface GetIndexArgs { /** * The ID of a table's compartment. When a table is identified by name, the compartmentId is often needed to provide context for interpreting the name. */ compartmentId: string; /** * The name of a table's index. */ indexName: string; /** * A table name within the compartment, or a table OCID. */ tableNameOrId: string; } /** * A collection of values returned by getIndex. */ export interface GetIndexResult { /** * Compartment Identifier. */ readonly compartmentId: string; readonly id: string; readonly indexName: string; readonly isIfNotExists: boolean; /** * A set of keys for a secondary index. */ readonly keys: outputs.Nosql.GetIndexKey[]; /** * A message describing the current state in more detail. */ readonly lifecycleDetails: string; /** * Index name. */ readonly name: string; /** * The state of an index. */ readonly state: string; /** * the OCID of the table to which this index belongs. */ readonly tableId: string; /** * The name of the table to which this index belongs. */ readonly tableName: string; readonly tableNameOrId: string; } /** * This data source provides details about a specific Index resource in Oracle Cloud Infrastructure NoSQL Database service. * * Get information about a single index. * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as oci from "@pulumi/oci"; * * const testIndex = oci.nosql.getIndex({ * indexName: testIndexOciNosqlIndex.name, * tableNameOrId: testTableNameOr.id, * compartmentId: compartmentId, * }); * ``` */ export declare function getIndexOutput(args: GetIndexOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output; /** * A collection of arguments for invoking getIndex. */ export interface GetIndexOutputArgs { /** * The ID of a table's compartment. When a table is identified by name, the compartmentId is often needed to provide context for interpreting the name. */ compartmentId: pulumi.Input; /** * The name of a table's index. */ indexName: pulumi.Input; /** * A table name within the compartment, or a table OCID. */ tableNameOrId: pulumi.Input; } //# sourceMappingURL=getIndex.d.ts.map