import * as pulumi from "@pulumi/pulumi"; import * as inputs from "../types/input"; import * as outputs from "../types/output"; /** * IcebergTables are the primary objects in an IcebergCatalog. * * ## Example Usage * * ### Biglake Iceberg Table Basic * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const bucket = new gcp.storage.Bucket("bucket", { * name: "my-bucket", * location: "us-central1", * forceDestroy: true, * uniformBucketLevelAccess: true, * }); * const catalog = new gcp.biglake.IcebergCatalog("catalog", { * name: bucket.name, * catalogType: "CATALOG_TYPE_GCS_BUCKET", * }); * const namespace = new gcp.biglake.IcebergNamespace("namespace", { * catalog: catalog.name, * namespaceId: "my_namespace", * }); * const myIcebergTable = new gcp.biglake.IcebergTable("my_iceberg_table", { * catalog: catalog.name, * namespace: namespace.namespaceId, * name: "my_table", * location: pulumi.interpolate`gs://${bucket.name}/${namespace.namespaceId}/my_table`, * schema: { * type: "struct", * fields: [ * { * id: 1, * name: "id", * type: "long", * required: true, * doc: "The ID of the record", * }, * { * id: 2, * name: "name", * type: "string", * required: false, * }, * ], * identifierFieldIds: [1], * }, * partitionSpec: { * fields: [{ * name: "id_partition", * sourceId: 1, * transform: "identity", * }], * }, * }); * ``` * ### Biglake Iceberg Table Update * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const bucket = new gcp.storage.Bucket("bucket", { * name: "my-bucket", * location: "us-central1", * forceDestroy: true, * uniformBucketLevelAccess: true, * }); * const catalog = new gcp.biglake.IcebergCatalog("catalog", { * name: bucket.name, * catalogType: "CATALOG_TYPE_GCS_BUCKET", * }); * const namespace = new gcp.biglake.IcebergNamespace("namespace", { * catalog: catalog.name, * namespaceId: "my_namespace", * }); * const myIcebergTable = new gcp.biglake.IcebergTable("my_iceberg_table", { * catalog: catalog.name, * namespace: namespace.namespaceId, * name: "my_table", * schema: { * type: "struct", * fields: [{ * id: 1, * name: "id", * type: "long", * required: true, * }], * }, * properties: { * key: "value", * }, * }); * ``` * * ## Import * * IcebergTable can be imported using any of these accepted formats: * * * `projects/{{project}}/catalogs/{{catalog}}/namespaces/{{namespace}}/tables/{{name}}` * * `{{project}}/{{catalog}}/{{namespace}}/{{name}}` * * `{{catalog}}/{{namespace}}/{{name}}` * * When using the `pulumi import` command, IcebergTable can be imported using one of the formats above. For example: * * ```sh * $ pulumi import gcp:biglake/icebergTable:IcebergTable default projects/{{project}}/catalogs/{{catalog}}/namespaces/{{namespace}}/tables/{{name}} * $ pulumi import gcp:biglake/icebergTable:IcebergTable default {{project}}/{{catalog}}/{{namespace}}/{{name}} * $ pulumi import gcp:biglake/icebergTable:IcebergTable default {{catalog}}/{{namespace}}/{{name}} * ``` */ export declare class IcebergTable extends pulumi.CustomResource { /** * Get an existing IcebergTable 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 state Any extra arguments used during the lookup. * @param opts Optional settings to control the behavior of the CustomResource. */ static get(name: string, id: pulumi.Input, state?: IcebergTableState, opts?: pulumi.CustomResourceOptions): IcebergTable; /** * Returns true if the given object is an instance of IcebergTable. 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 IcebergTable; /** * The name of the IcebergCatalog. */ readonly catalog: pulumi.Output; /** * Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. * When a 'terraform destroy' or 'pulumi up' would delete the resource, * the command will fail if this field is set to "PREVENT" in Terraform state. * When set to "ABANDON", the command will remove the resource from Terraform * management without updating or deleting the resource in the API. * When set to "DELETE", deleting the resource is allowed. */ readonly deletionPolicy: pulumi.Output; /** * The location of the table. */ readonly location: pulumi.Output; /** * The name of the table. */ readonly name: pulumi.Output; /** * The parent namespace of the table. */ readonly namespace: pulumi.Output; /** * The partition spec of the table. * Structure is documented below. */ readonly partitionSpec: pulumi.Output; /** * The ID of the project in which the resource belongs. * If it is not provided, the provider project is used. */ readonly project: pulumi.Output; /** * User-defined properties for the table. */ readonly properties: pulumi.Output<{ [key: string]: string; }>; /** * The schema of the table. * Structure is documented below. */ readonly schema: pulumi.Output; /** * Create a IcebergTable 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: IcebergTableArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering IcebergTable resources. */ export interface IcebergTableState { /** * The name of the IcebergCatalog. */ catalog?: pulumi.Input; /** * Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. * When a 'terraform destroy' or 'pulumi up' would delete the resource, * the command will fail if this field is set to "PREVENT" in Terraform state. * When set to "ABANDON", the command will remove the resource from Terraform * management without updating or deleting the resource in the API. * When set to "DELETE", deleting the resource is allowed. */ deletionPolicy?: pulumi.Input; /** * The location of the table. */ location?: pulumi.Input; /** * The name of the table. */ name?: pulumi.Input; /** * The parent namespace of the table. */ namespace?: pulumi.Input; /** * The partition spec of the table. * Structure is documented below. */ partitionSpec?: pulumi.Input; /** * The ID of the project in which the resource belongs. * If it is not provided, the provider project is used. */ project?: pulumi.Input; /** * User-defined properties for the table. */ properties?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * The schema of the table. * Structure is documented below. */ schema?: pulumi.Input; } /** * The set of arguments for constructing a IcebergTable resource. */ export interface IcebergTableArgs { /** * The name of the IcebergCatalog. */ catalog: pulumi.Input; /** * Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. * When a 'terraform destroy' or 'pulumi up' would delete the resource, * the command will fail if this field is set to "PREVENT" in Terraform state. * When set to "ABANDON", the command will remove the resource from Terraform * management without updating or deleting the resource in the API. * When set to "DELETE", deleting the resource is allowed. */ deletionPolicy?: pulumi.Input; /** * The location of the table. */ location?: pulumi.Input; /** * The name of the table. */ name?: pulumi.Input; /** * The parent namespace of the table. */ namespace: pulumi.Input; /** * The partition spec of the table. * Structure is documented below. */ partitionSpec?: pulumi.Input; /** * The ID of the project in which the resource belongs. * If it is not provided, the provider project is used. */ project?: pulumi.Input; /** * User-defined properties for the table. */ properties?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * The schema of the table. * Structure is documented below. */ schema: pulumi.Input; } //# sourceMappingURL=icebergTable.d.ts.map