@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
176 lines • 8.37 kB
JavaScript
;
// *** WARNING: this file was generated by pulumi-language-nodejs. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
var desc = Object.getOwnPropertyDescriptor(m, k);
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
desc = { enumerable: true, get: function() { return m[k]; } };
}
Object.defineProperty(o, k2, desc);
}) : (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
o[k2] = m[k];
}));
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
Object.defineProperty(o, "default", { enumerable: true, value: v });
}) : function(o, v) {
o["default"] = v;
});
var __importStar = (this && this.__importStar) || function (mod) {
if (mod && mod.__esModule) return mod;
var result = {};
if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
__setModuleDefault(result, mod);
return result;
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.QueryTemplate = void 0;
const pulumi = __importStar(require("@pulumi/pulumi"));
const utilities = __importStar(require("../utilities"));
/**
* Represents a BigQuery Query Template within a Data Exchange.
* This resource defines a reusable SQL routine (e.g., a TVF) that can be
* shared or executed via the Data Exchange.
*
* > **Warning:** This resource is in beta, and should be used with the terraform-provider-google-beta provider.
* See Provider Versions for more details on beta resources.
*
* To get more information about QueryTemplate, see:
*
* * [API documentation](https://docs.cloud.google.com/bigquery/docs/reference/analytics-hub/rest/v1/projects.locations.dataExchanges.queryTemplates)
* * How-to Guides
* * [Use query templates](https://docs.cloud.google.com/bigquery/docs/query-templates)
*
* ## Example Usage
*
* ### Bigquery Analyticshub Querytemplate Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const me = gcp.organizations.getClientOpenIdUserInfo({});
* const querytemplate = new gcp.bigqueryanalyticshub.DataExchange("querytemplate", {
* displayName: "My Audience Data Exchange",
* dataExchangeId: "my_data_exchange",
* description: "example of query template",
* location: "us",
* sharingEnvironmentConfig: {
* dcrExchangeConfig: {},
* },
* });
* const querytemplateQueryTemplate = new gcp.bigqueryanalyticshub.QueryTemplate("querytemplate", {
* location: "us",
* dataExchangeId: querytemplate.dataExchangeId,
* queryTemplateId: "my_query_template",
* displayName: "my_query_template",
* description: "example of query template",
* primaryContact: me.then(me => me.email),
* documentation: "This TVF takes a table t1 as input and returns all columns. Useful for basic data pass-through.",
* routine: {
* routineType: "TABLE_VALUED_FUNCTION",
* definitionBody: "my_query_template() as (select * from t1)",
* },
* submit: false,
* });
* ```
*
* ## Import
*
* QueryTemplate can be imported using any of these accepted formats:
*
* * `projects/{{project}}/locations/{{location}}/dataExchanges/{{data_exchange_id}}/queryTemplates/{{query_template_id}}`
* * `{{project}}/{{location}}/{{data_exchange_id}}/{{query_template_id}}`
* * `{{location}}/{{data_exchange_id}}/{{query_template_id}}`
*
* When using the `pulumi import` command, QueryTemplate can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:bigqueryanalyticshub/queryTemplate:QueryTemplate default projects/{{project}}/locations/{{location}}/dataExchanges/{{data_exchange_id}}/queryTemplates/{{query_template_id}}
* $ pulumi import gcp:bigqueryanalyticshub/queryTemplate:QueryTemplate default {{project}}/{{location}}/{{data_exchange_id}}/{{query_template_id}}
* $ pulumi import gcp:bigqueryanalyticshub/queryTemplate:QueryTemplate default {{location}}/{{data_exchange_id}}/{{query_template_id}}
* ```
*/
class QueryTemplate extends pulumi.CustomResource {
/**
* Get an existing QueryTemplate 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, id, state, opts) {
return new QueryTemplate(name, state, { ...opts, id: id });
}
/** @internal */
static __pulumiType = 'gcp:bigqueryanalyticshub/queryTemplate:QueryTemplate';
/**
* Returns true if the given object is an instance of QueryTemplate. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj) {
if (obj === undefined || obj === null) {
return false;
}
return obj['__pulumiType'] === QueryTemplate.__pulumiType;
}
constructor(name, argsOrState, opts) {
let resourceInputs = {};
opts = opts || {};
if (opts.id) {
const state = argsOrState;
resourceInputs["createTime"] = state?.createTime;
resourceInputs["dataExchangeId"] = state?.dataExchangeId;
resourceInputs["deletionPolicy"] = state?.deletionPolicy;
resourceInputs["description"] = state?.description;
resourceInputs["displayName"] = state?.displayName;
resourceInputs["documentation"] = state?.documentation;
resourceInputs["location"] = state?.location;
resourceInputs["name"] = state?.name;
resourceInputs["primaryContact"] = state?.primaryContact;
resourceInputs["project"] = state?.project;
resourceInputs["queryTemplateId"] = state?.queryTemplateId;
resourceInputs["routine"] = state?.routine;
resourceInputs["state"] = state?.state;
resourceInputs["submit"] = state?.submit;
resourceInputs["updateTime"] = state?.updateTime;
}
else {
const args = argsOrState;
if (args?.dataExchangeId === undefined && !opts.urn) {
throw new Error("Missing required property 'dataExchangeId'");
}
if (args?.displayName === undefined && !opts.urn) {
throw new Error("Missing required property 'displayName'");
}
if (args?.location === undefined && !opts.urn) {
throw new Error("Missing required property 'location'");
}
if (args?.queryTemplateId === undefined && !opts.urn) {
throw new Error("Missing required property 'queryTemplateId'");
}
resourceInputs["dataExchangeId"] = args?.dataExchangeId;
resourceInputs["deletionPolicy"] = args?.deletionPolicy;
resourceInputs["description"] = args?.description;
resourceInputs["displayName"] = args?.displayName;
resourceInputs["documentation"] = args?.documentation;
resourceInputs["location"] = args?.location;
resourceInputs["primaryContact"] = args?.primaryContact;
resourceInputs["project"] = args?.project;
resourceInputs["queryTemplateId"] = args?.queryTemplateId;
resourceInputs["routine"] = args?.routine;
resourceInputs["submit"] = args?.submit;
resourceInputs["createTime"] = undefined /*out*/;
resourceInputs["name"] = undefined /*out*/;
resourceInputs["state"] = undefined /*out*/;
resourceInputs["updateTime"] = undefined /*out*/;
}
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
super(QueryTemplate.__pulumiType, name, resourceInputs, opts);
}
}
exports.QueryTemplate = QueryTemplate;
//# sourceMappingURL=queryTemplate.js.map