com.pulumi.gcp.bigqueryanalyticshub.kotlin.DataExchangeArgs.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of pulumi-gcp-kotlin Show documentation
Show all versions of pulumi-gcp-kotlin Show documentation
Build cloud applications and infrastructure by combining the safety and reliability of infrastructure as code with the power of the Kotlin programming language.
@file:Suppress("NAME_SHADOWING", "DEPRECATION")
package com.pulumi.gcp.bigqueryanalyticshub.kotlin
import com.pulumi.core.Output
import com.pulumi.core.Output.of
import com.pulumi.gcp.bigqueryanalyticshub.DataExchangeArgs.builder
import com.pulumi.kotlin.ConvertibleToJava
import com.pulumi.kotlin.PulumiTagMarker
import kotlin.String
import kotlin.Suppress
import kotlin.jvm.JvmName
/**
* A Bigquery Analytics Hub data exchange
* To get more information about DataExchange, see:
* * [API documentation](https://cloud.google.com/bigquery/docs/reference/analytics-hub/rest/v1/projects.locations.dataExchanges)
* * How-to Guides
* * [Official Documentation](https://cloud.google.com/bigquery/docs/analytics-hub-introduction)
* ## Example Usage
* ### Bigquery Analyticshub Data Exchange Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
* const dataExchange = new gcp.bigqueryanalyticshub.DataExchange("data_exchange", {
* location: "US",
* dataExchangeId: "my_data_exchange",
* displayName: "my_data_exchange",
* description: "example data exchange",
* });
* ```
* ```python
* import pulumi
* import pulumi_gcp as gcp
* data_exchange = gcp.bigqueryanalyticshub.DataExchange("data_exchange",
* location="US",
* data_exchange_id="my_data_exchange",
* display_name="my_data_exchange",
* description="example data exchange")
* ```
* ```csharp
* using System.Collections.Generic;
* using System.Linq;
* using Pulumi;
* using Gcp = Pulumi.Gcp;
* return await Deployment.RunAsync(() =>
* {
* var dataExchange = new Gcp.BigQueryAnalyticsHub.DataExchange("data_exchange", new()
* {
* Location = "US",
* DataExchangeId = "my_data_exchange",
* DisplayName = "my_data_exchange",
* Description = "example data exchange",
* });
* });
* ```
* ```go
* package main
* import (
* "github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/bigqueryanalyticshub"
* "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
* )
* func main() {
* pulumi.Run(func(ctx *pulumi.Context) error {
* _, err := bigqueryanalyticshub.NewDataExchange(ctx, "data_exchange", &bigqueryanalyticshub.DataExchangeArgs{
* Location: pulumi.String("US"),
* DataExchangeId: pulumi.String("my_data_exchange"),
* DisplayName: pulumi.String("my_data_exchange"),
* Description: pulumi.String("example data exchange"),
* })
* 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.bigqueryanalyticshub.DataExchange;
* import com.pulumi.gcp.bigqueryanalyticshub.DataExchangeArgs;
* 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 dataExchange = new DataExchange("dataExchange", DataExchangeArgs.builder()
* .location("US")
* .dataExchangeId("my_data_exchange")
* .displayName("my_data_exchange")
* .description("example data exchange")
* .build());
* }
* }
* ```
* ```yaml
* resources:
* dataExchange:
* type: gcp:bigqueryanalyticshub:DataExchange
* name: data_exchange
* properties:
* location: US
* dataExchangeId: my_data_exchange
* displayName: my_data_exchange
* description: example data exchange
* ```
*
* ## Import
* DataExchange can be imported using any of these accepted formats:
* * `projects/{{project}}/locations/{{location}}/dataExchanges/{{data_exchange_id}}`
* * `{{project}}/{{location}}/{{data_exchange_id}}`
* * `{{location}}/{{data_exchange_id}}`
* * `{{data_exchange_id}}`
* When using the `pulumi import` command, DataExchange can be imported using one of the formats above. For example:
* ```sh
* $ pulumi import gcp:bigqueryanalyticshub/dataExchange:DataExchange default projects/{{project}}/locations/{{location}}/dataExchanges/{{data_exchange_id}}
* ```
* ```sh
* $ pulumi import gcp:bigqueryanalyticshub/dataExchange:DataExchange default {{project}}/{{location}}/{{data_exchange_id}}
* ```
* ```sh
* $ pulumi import gcp:bigqueryanalyticshub/dataExchange:DataExchange default {{location}}/{{data_exchange_id}}
* ```
* ```sh
* $ pulumi import gcp:bigqueryanalyticshub/dataExchange:DataExchange default {{data_exchange_id}}
* ```
* @property dataExchangeId The ID of the data exchange. Must contain only Unicode letters, numbers (0-9), underscores (_). Should not use characters that require URL-escaping, or characters outside of ASCII, spaces.
* @property description Description of the data exchange.
* @property displayName Human-readable display name of the data exchange. The display name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), and must not start or end with spaces.
* - - -
* @property documentation Documentation describing the data exchange.
* @property icon Base64 encoded image representing the data exchange.
* @property location The name of the location this data exchange.
* @property primaryContact Email or URL of the primary point of contact of the data exchange.
* @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 DataExchangeArgs(
public val dataExchangeId: Output? = null,
public val description: Output? = null,
public val displayName: Output? = null,
public val documentation: Output? = null,
public val icon: Output? = null,
public val location: Output? = null,
public val primaryContact: Output? = null,
public val project: Output? = null,
) : ConvertibleToJava {
override fun toJava(): com.pulumi.gcp.bigqueryanalyticshub.DataExchangeArgs =
com.pulumi.gcp.bigqueryanalyticshub.DataExchangeArgs.builder()
.dataExchangeId(dataExchangeId?.applyValue({ args0 -> args0 }))
.description(description?.applyValue({ args0 -> args0 }))
.displayName(displayName?.applyValue({ args0 -> args0 }))
.documentation(documentation?.applyValue({ args0 -> args0 }))
.icon(icon?.applyValue({ args0 -> args0 }))
.location(location?.applyValue({ args0 -> args0 }))
.primaryContact(primaryContact?.applyValue({ args0 -> args0 }))
.project(project?.applyValue({ args0 -> args0 })).build()
}
/**
* Builder for [DataExchangeArgs].
*/
@PulumiTagMarker
public class DataExchangeArgsBuilder internal constructor() {
private var dataExchangeId: Output? = null
private var description: Output? = null
private var displayName: Output? = null
private var documentation: Output? = null
private var icon: Output? = null
private var location: Output? = null
private var primaryContact: Output? = null
private var project: Output? = null
/**
* @param value The ID of the data exchange. Must contain only Unicode letters, numbers (0-9), underscores (_). Should not use characters that require URL-escaping, or characters outside of ASCII, spaces.
*/
@JvmName("mkbhlbmjnyguxypw")
public suspend fun dataExchangeId(`value`: Output) {
this.dataExchangeId = value
}
/**
* @param value Description of the data exchange.
*/
@JvmName("geqkghvlpseobvnc")
public suspend fun description(`value`: Output) {
this.description = value
}
/**
* @param value Human-readable display name of the data exchange. The display name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), and must not start or end with spaces.
* - - -
*/
@JvmName("cwjytlaidkygryvv")
public suspend fun displayName(`value`: Output) {
this.displayName = value
}
/**
* @param value Documentation describing the data exchange.
*/
@JvmName("oonknltbnvwoimgc")
public suspend fun documentation(`value`: Output) {
this.documentation = value
}
/**
* @param value Base64 encoded image representing the data exchange.
*/
@JvmName("nggduilqojfbcuww")
public suspend fun icon(`value`: Output) {
this.icon = value
}
/**
* @param value The name of the location this data exchange.
*/
@JvmName("gmtebxslmjrlxtac")
public suspend fun location(`value`: Output) {
this.location = value
}
/**
* @param value Email or URL of the primary point of contact of the data exchange.
*/
@JvmName("minmqdrwsubgmxnn")
public suspend fun primaryContact(`value`: Output) {
this.primaryContact = value
}
/**
* @param value The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
@JvmName("sxadrwfqmtgrnqse")
public suspend fun project(`value`: Output) {
this.project = value
}
/**
* @param value The ID of the data exchange. Must contain only Unicode letters, numbers (0-9), underscores (_). Should not use characters that require URL-escaping, or characters outside of ASCII, spaces.
*/
@JvmName("fqflttvlqcgbxbqj")
public suspend fun dataExchangeId(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.dataExchangeId = mapped
}
/**
* @param value Description of the data exchange.
*/
@JvmName("bydqgugjschgyriv")
public suspend fun description(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.description = mapped
}
/**
* @param value Human-readable display name of the data exchange. The display name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), and must not start or end with spaces.
* - - -
*/
@JvmName("jvwpamhwmybfexgy")
public suspend fun displayName(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.displayName = mapped
}
/**
* @param value Documentation describing the data exchange.
*/
@JvmName("jbfqxxhbqokcbjxp")
public suspend fun documentation(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.documentation = mapped
}
/**
* @param value Base64 encoded image representing the data exchange.
*/
@JvmName("ngglpdsteauhrsml")
public suspend fun icon(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.icon = mapped
}
/**
* @param value The name of the location this data exchange.
*/
@JvmName("rxafcbnstwficlkg")
public suspend fun location(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.location = mapped
}
/**
* @param value Email or URL of the primary point of contact of the data exchange.
*/
@JvmName("tuphpbreiwcmswic")
public suspend fun primaryContact(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.primaryContact = mapped
}
/**
* @param value The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
@JvmName("pdehcdonjvokxuvk")
public suspend fun project(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.project = mapped
}
internal fun build(): DataExchangeArgs = DataExchangeArgs(
dataExchangeId = dataExchangeId,
description = description,
displayName = displayName,
documentation = documentation,
icon = icon,
location = location,
primaryContact = primaryContact,
project = project,
)
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy