com.pulumi.gcp.biglake.kotlin.CatalogArgs.kt Maven / Gradle / Ivy
@file:Suppress("NAME_SHADOWING", "DEPRECATION")
package com.pulumi.gcp.biglake.kotlin
import com.pulumi.core.Output
import com.pulumi.core.Output.of
import com.pulumi.gcp.biglake.CatalogArgs.builder
import com.pulumi.kotlin.ConvertibleToJava
import com.pulumi.kotlin.PulumiTagMarker
import kotlin.String
import kotlin.Suppress
import kotlin.jvm.JvmName
/**
* Catalogs are top-level containers for Databases and Tables.
* To get more information about Catalog, see:
* * [API documentation](https://cloud.google.com/bigquery/docs/reference/biglake/rest/v1/projects.locations.catalogs)
* * How-to Guides
* * [Manage open source metadata with BigLake Metastore](https://cloud.google.com/bigquery/docs/manage-open-source-metadata#create_catalogs)
* ## Example Usage
* ### Bigquery Biglake Catalog
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
* const _default = new gcp.biglake.Catalog("default", {
* name: "my_catalog",
* location: "US",
* });
* ```
* ```python
* import pulumi
* import pulumi_gcp as gcp
* default = gcp.biglake.Catalog("default",
* name="my_catalog",
* location="US")
* ```
* ```csharp
* using System.Collections.Generic;
* using System.Linq;
* using Pulumi;
* using Gcp = Pulumi.Gcp;
* return await Deployment.RunAsync(() =>
* {
* var @default = new Gcp.BigLake.Catalog("default", new()
* {
* Name = "my_catalog",
* Location = "US",
* });
* });
* ```
* ```go
* package main
* import (
* "github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/biglake"
* "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
* )
* func main() {
* pulumi.Run(func(ctx *pulumi.Context) error {
* _, err := biglake.NewCatalog(ctx, "default", &biglake.CatalogArgs{
* Name: pulumi.String("my_catalog"),
* Location: pulumi.String("US"),
* })
* if err != nil {
* return err
* }
* return nil
* })
* }
* ```
* ```java
* package generated_program;
* import com.pulumi.Context;
* import com.pulumi.Pulumi;
* import com.pulumi.core.Output;
* import com.pulumi.gcp.biglake.Catalog;
* import com.pulumi.gcp.biglake.CatalogArgs;
* import java.util.List;
* import java.util.ArrayList;
* import java.util.Map;
* import java.io.File;
* import java.nio.file.Files;
* import java.nio.file.Paths;
* public class App {
* public static void main(String[] args) {
* Pulumi.run(App::stack);
* }
* public static void stack(Context ctx) {
* var default_ = new Catalog("default", CatalogArgs.builder()
* .name("my_catalog")
* .location("US")
* .build());
* }
* }
* ```
* ```yaml
* resources:
* default:
* type: gcp:biglake:Catalog
* properties:
* name: my_catalog
* location: US
* ```
*
* ## Import
* Catalog can be imported using any of these accepted formats:
* * `projects/{{project}}/locations/{{location}}/catalogs/{{name}}`
* * `{{project}}/{{location}}/{{name}}`
* * `{{location}}/{{name}}`
* When using the `pulumi import` command, Catalog can be imported using one of the formats above. For example:
* ```sh
* $ pulumi import gcp:biglake/catalog:Catalog default projects/{{project}}/locations/{{location}}/catalogs/{{name}}
* ```
* ```sh
* $ pulumi import gcp:biglake/catalog:Catalog default {{project}}/{{location}}/{{name}}
* ```
* ```sh
* $ pulumi import gcp:biglake/catalog:Catalog default {{location}}/{{name}}
* ```
* @property location The geographic location where the Catalog should reside.
* @property name The name of the Catalog. Format:
* projects/{project_id_or_number}/locations/{locationId}/catalogs/{catalogId}
* - - -
* @property project The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
public data class CatalogArgs(
public val location: Output? = null,
public val name: Output? = null,
public val project: Output? = null,
) : ConvertibleToJava {
override fun toJava(): com.pulumi.gcp.biglake.CatalogArgs =
com.pulumi.gcp.biglake.CatalogArgs.builder()
.location(location?.applyValue({ args0 -> args0 }))
.name(name?.applyValue({ args0 -> args0 }))
.project(project?.applyValue({ args0 -> args0 })).build()
}
/**
* Builder for [CatalogArgs].
*/
@PulumiTagMarker
public class CatalogArgsBuilder internal constructor() {
private var location: Output? = null
private var name: Output? = null
private var project: Output? = null
/**
* @param value The geographic location where the Catalog should reside.
*/
@JvmName("drkoxsdrwwalfobc")
public suspend fun location(`value`: Output) {
this.location = value
}
/**
* @param value The name of the Catalog. Format:
* projects/{project_id_or_number}/locations/{locationId}/catalogs/{catalogId}
* - - -
*/
@JvmName("gnqbfjmfgtqpecuj")
public suspend fun name(`value`: Output) {
this.name = value
}
/**
* @param value The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
@JvmName("gbysnfberrllpmby")
public suspend fun project(`value`: Output) {
this.project = value
}
/**
* @param value The geographic location where the Catalog should reside.
*/
@JvmName("whlbuepcxeioxqgk")
public suspend fun location(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.location = mapped
}
/**
* @param value The name of the Catalog. Format:
* projects/{project_id_or_number}/locations/{locationId}/catalogs/{catalogId}
* - - -
*/
@JvmName("rjjtghpldrfqoeim")
public suspend fun name(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.name = mapped
}
/**
* @param value The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
@JvmName("eadafsbdwxgspdqk")
public suspend fun project(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.project = mapped
}
internal fun build(): CatalogArgs = CatalogArgs(
location = location,
name = name,
project = project,
)
}