Class Dataset

Datasets allow you to organize and control access to your tables.

To get more information about Dataset, see:

• API documentation
• How-to Guides
• Datasets Intro

Inheritance

System.Object

Resource

CustomResource

Dataset

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Gcp.BigQuery

Assembly: Pulumi.Gcp.dll

Syntax

public class Dataset : CustomResource

Constructors

Dataset(String, DatasetArgs, CustomResourceOptions)

Create a Dataset resource with the given unique name, arguments, and options.

Declaration

public Dataset(string name, DatasetArgs args, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
DatasetArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

Accesses

An array of objects that define dataset access for one or more entities. Structure is documented below.

Declaration

public Output<ImmutableArray<DatasetAccess>> Accesses { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<DatasetAccess>>

CreationTime

The time when this dataset was created, in milliseconds since the epoch.

Declaration

public Output<int> CreationTime { get; }

Property Value

Type	Description
Output<System.Int32>

DatasetId

The ID of the dataset containing this table.

Declaration

public Output<string> DatasetId { get; }

Property Value

Type	Description
Output<System.String>

DefaultEncryptionConfiguration

The default encryption key for all tables in the dataset. Once this property is set, all newly-created partitioned tables in the dataset will have encryption key set to this value, unless table creation request (or query) overrides the key. Structure is documented below.

Declaration

public Output<DatasetDefaultEncryptionConfiguration> DefaultEncryptionConfiguration { get; }

Property Value

Type	Description
Output<DatasetDefaultEncryptionConfiguration>

DefaultPartitionExpirationMs

The default partition expiration for all partitioned tables in the dataset, in milliseconds.

Declaration

public Output<int?> DefaultPartitionExpirationMs { get; }

Property Value

Type	Description
Output<System.Nullable<System.Int32>>

DefaultTableExpirationMs

The default lifetime of all tables in the dataset, in milliseconds. The minimum value is 3600000 milliseconds (one hour).

Declaration

public Output<int?> DefaultTableExpirationMs { get; }

Property Value

Type	Description
Output<System.Nullable<System.Int32>>

DeleteContentsOnDestroy

If set to true, delete all the tables in the dataset when destroying the resource; otherwise, destroying the resource will fail if tables are present.

Declaration

public Output<bool?> DeleteContentsOnDestroy { get; }

Property Value

Type	Description
Output<System.Nullable<System.Boolean>>

Description

A user-friendly description of the dataset

Declaration

public Output<string> Description { get; }

Property Value

Type	Description
Output<System.String>

Etag

A hash of the resource.

Declaration

public Output<string> Etag { get; }

Property Value

Type	Description
Output<System.String>

FriendlyName

A descriptive name for the dataset

Declaration

public Output<string> FriendlyName { get; }

Property Value

Type	Description
Output<System.String>

Labels

The labels associated with this dataset. You can use these to organize and group your datasets

Declaration

public Output<ImmutableDictionary<string, string>> Labels { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableDictionary<System.String, System.String>>

LastModifiedTime

The date when this dataset or any of its tables was last modified, in milliseconds since the epoch.

Declaration

public Output<int> LastModifiedTime { get; }

Property Value

Type	Description
Output<System.Int32>

Location

The geographic location where the dataset should reside. See official docs.

Declaration

public Output<string> Location { get; }

Property Value

Type	Description
Output<System.String>

Project

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

Declaration

public Output<string> Project { get; }

Property Value

Type	Description
Output<System.String>

SelfLink

The URI of the created resource.

Declaration

public Output<string> SelfLink { get; }

Property Value

Type	Description
Output<System.String>

Methods

Get(String, Input<String>, DatasetState, CustomResourceOptions)

Get an existing Dataset resource's state with the given name, ID, and optional extra properties used to qualify the lookup.

Declaration

public static Dataset Get(string name, Input<string> id, DatasetState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
DatasetState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
Dataset