import * as pulumi from "@pulumi/pulumi"; import * as inputs from "../../types/input"; import * as outputs from "../../types/output"; import * as enums from "../../types/enums"; /** * Creates an Index. * Auto-naming is currently not supported for this resource. */ export declare class Index extends pulumi.CustomResource { /** * Get an existing Index resource's state with the given name, ID, and optional extra * properties used to qualify the lookup. * * @param name The _unique_ name of the resulting resource. * @param id The _unique_ provider ID of the resource to lookup. * @param opts Optional settings to control the behavior of the CustomResource. */ static get(name: string, id: pulumi.Input, opts?: pulumi.CustomResourceOptions): Index; /** * Returns true if the given object is an instance of Index. This is designed to work even * when multiple copies of the Pulumi SDK have been loaded into the same process. */ static isInstance(obj: any): obj is Index; /** * Timestamp when this Index was created. */ readonly createTime: pulumi.Output; /** * The pointers to DeployedIndexes created from this Index. An Index can be only deleted if all its DeployedIndexes had been undeployed first. */ readonly deployedIndexes: pulumi.Output; /** * The description of the Index. */ readonly description: pulumi.Output; /** * The display name of the Index. The name can be up to 128 characters long and can consist of any UTF-8 characters. */ readonly displayName: pulumi.Output; /** * Immutable. Customer-managed encryption key spec for an Index. If set, this Index and all sub-resources of this Index will be secured by this key. */ readonly encryptionSpec: pulumi.Output; /** * Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. */ readonly etag: pulumi.Output; /** * Stats of the index resource. */ readonly indexStats: pulumi.Output; /** * Immutable. The update method to use with this Index. If not set, BATCH_UPDATE will be used by default. */ readonly indexUpdateMethod: pulumi.Output; /** * The labels with user-defined metadata to organize your Indexes. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels. */ readonly labels: pulumi.Output<{ [key: string]: string; }>; readonly location: pulumi.Output; /** * An additional information about the Index; the schema of the metadata can be found in metadata_schema. */ readonly metadata: pulumi.Output; /** * Immutable. Points to a YAML file stored on Google Cloud Storage describing additional information about the Index, that is specific to it. Unset if the Index does not have any additional information. The schema is defined as an OpenAPI 3.0.2 [Schema Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). Note: The URI given on output will be immutable and probably different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access. */ readonly metadataSchemaUri: pulumi.Output; /** * The resource name of the Index. */ readonly name: pulumi.Output; readonly project: pulumi.Output; /** * Timestamp when this Index was most recently updated. This also includes any update to the contents of the Index. Note that Operations working on this Index may have their Operations.metadata.generic_metadata.update_time a little after the value of this timestamp, yet that does not mean their results are not already reflected in the Index. Result of any successfully completed Operation on the Index is reflected in it. */ readonly updateTime: pulumi.Output; /** * Create a Index resource with the given unique name, arguments, and options. * * @param name The _unique_ name of the resource. * @param args The arguments to use to populate this resource's properties. * @param opts A bag of options that control this resource's behavior. */ constructor(name: string, args: IndexArgs, opts?: pulumi.CustomResourceOptions); } /** * The set of arguments for constructing a Index resource. */ export interface IndexArgs { /** * The description of the Index. */ description?: pulumi.Input; /** * The display name of the Index. The name can be up to 128 characters long and can consist of any UTF-8 characters. */ displayName: pulumi.Input; /** * Immutable. Customer-managed encryption key spec for an Index. If set, this Index and all sub-resources of this Index will be secured by this key. */ encryptionSpec?: pulumi.Input; /** * Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. */ etag?: pulumi.Input; /** * Immutable. The update method to use with this Index. If not set, BATCH_UPDATE will be used by default. */ indexUpdateMethod?: pulumi.Input; /** * The labels with user-defined metadata to organize your Indexes. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels. */ labels?: pulumi.Input<{ [key: string]: pulumi.Input; }>; location?: pulumi.Input; /** * An additional information about the Index; the schema of the metadata can be found in metadata_schema. */ metadata?: any; /** * Immutable. Points to a YAML file stored on Google Cloud Storage describing additional information about the Index, that is specific to it. Unset if the Index does not have any additional information. The schema is defined as an OpenAPI 3.0.2 [Schema Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). Note: The URI given on output will be immutable and probably different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access. */ metadataSchemaUri?: pulumi.Input; project?: pulumi.Input; }