@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
108 lines (107 loc) • 3.41 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
* Get information about a BigQuery dataset. For more information see
* the [official documentation](https://cloud.google.com/bigquery/docs)
* and [API](https://cloud.google.com/bigquery/docs/reference/rest/v2/datasets).
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const dataset = gcp.bigquery.getDataset({
* datasetId: "my-bq-dataset",
* project: "my-project",
* });
* ```
*/
export declare function getDataset(args: GetDatasetArgs, opts?: pulumi.InvokeOptions): Promise<GetDatasetResult>;
/**
* A collection of arguments for invoking getDataset.
*/
export interface GetDatasetArgs {
/**
* The dataset ID.
*/
datasetId: string;
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
project?: string;
}
/**
* A collection of values returned by getDataset.
*/
export interface GetDatasetResult {
readonly accesses: outputs.bigquery.GetDatasetAccess[];
readonly creationTime: number;
readonly datasetId: string;
readonly defaultCollation: string;
readonly defaultEncryptionConfigurations: outputs.bigquery.GetDatasetDefaultEncryptionConfiguration[];
readonly defaultPartitionExpirationMs: number;
readonly defaultTableExpirationMs: number;
readonly deleteContentsOnDestroy: boolean;
readonly description: string;
readonly effectiveLabels: {
[key: string]: string;
};
readonly etag: string;
readonly externalCatalogDatasetOptions: outputs.bigquery.GetDatasetExternalCatalogDatasetOption[];
readonly externalDatasetReferences: outputs.bigquery.GetDatasetExternalDatasetReference[];
readonly friendlyName: string;
/**
* The provider-assigned unique ID for this managed resource.
*/
readonly id: string;
readonly isCaseInsensitive: boolean;
readonly labels: {
[key: string]: string;
};
readonly lastModifiedTime: number;
readonly location: string;
readonly maxTimeTravelHours: string;
readonly project?: string;
readonly pulumiLabels: {
[key: string]: string;
};
readonly resourceTags: {
[key: string]: string;
};
readonly selfLink: string;
readonly storageBillingModel: string;
}
/**
* Get information about a BigQuery dataset. For more information see
* the [official documentation](https://cloud.google.com/bigquery/docs)
* and [API](https://cloud.google.com/bigquery/docs/reference/rest/v2/datasets).
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const dataset = gcp.bigquery.getDataset({
* datasetId: "my-bq-dataset",
* project: "my-project",
* });
* ```
*/
export declare function getDatasetOutput(args: GetDatasetOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetDatasetResult>;
/**
* A collection of arguments for invoking getDataset.
*/
export interface GetDatasetOutputArgs {
/**
* The dataset ID.
*/
datasetId: pulumi.Input<string>;
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
project?: pulumi.Input<string>;
}