Class Table

Creates a table resource in a dataset for Google BigQuery. For more information see the official documentation and API.

Inheritance

System.Object

Resource

CustomResource

Table

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 Table : CustomResource

Constructors

View Source

Table(String, TableArgs, CustomResourceOptions)

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

Declaration

public Table(string name, TableArgs args, CustomResourceOptions options = null)

Parameters

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

Properties

View Source

Clusterings

Specifies column names to use for data clustering. Up to four top-level columns are allowed, and should be specified in descending priority order.

Declaration

public Output<ImmutableArray<string>> Clusterings { get; }

Property Value

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

View Source

CreationTime

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

Declaration

public Output<int> CreationTime { get; }

Property Value

Type	Description
Output<System.Int32>

View Source

DatasetId

The dataset ID to create the table in. Changing this forces a new resource to be created.

Declaration

public Output<string> DatasetId { get; }

Property Value

Type	Description
Output<System.String>

View Source

Description

The field description.

Declaration

public Output<string> Description { get; }

Property Value

Type	Description
Output<System.String>

View Source

EncryptionConfiguration

Specifies how the table should be encrypted. If left blank, the table will be encrypted with a Google-managed key; that process is transparent to the user. Structure is documented below.

Declaration

public Output<TableEncryptionConfiguration> EncryptionConfiguration { get; }

Property Value

Type	Description
Output<TableEncryptionConfiguration>

View Source

Etag

A hash of the resource.

Declaration

public Output<string> Etag { get; }

Property Value

Type	Description
Output<System.String>

View Source

ExpirationTime

The time when this table expires, in milliseconds since the epoch. If not present, the table will persist indefinitely. Expired tables will be deleted and their storage reclaimed.

Declaration

public Output<int> ExpirationTime { get; }

Property Value

Type	Description
Output<System.Int32>

View Source

ExternalDataConfiguration

Describes the data format, location, and other properties of a table stored outside of BigQuery. By defining these properties, the data source can then be queried as if it were a standard BigQuery table. Structure is documented below.

Declaration

public Output<TableExternalDataConfiguration> ExternalDataConfiguration { get; }

Property Value

Type	Description
Output<TableExternalDataConfiguration>

View Source

FriendlyName

A descriptive name for the table.

Declaration

public Output<string> FriendlyName { get; }

Property Value

Type	Description
Output<System.String>

View Source

Labels

A mapping of labels to assign to the resource.

Declaration

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

Property Value

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

View Source

LastModifiedTime

The time when this table was last modified, in milliseconds since the epoch.

Declaration

public Output<int> LastModifiedTime { get; }

Property Value

Type	Description
Output<System.Int32>

View Source

Location

The geographic location where the table resides. This value is inherited from the dataset.

Declaration

public Output<string> Location { get; }

Property Value

Type	Description
Output<System.String>

View Source

NumBytes

The size of this table in bytes, excluding any data in the streaming buffer.

Declaration

public Output<int> NumBytes { get; }

Property Value

Type	Description
Output<System.Int32>

View Source

NumLongTermBytes

The number of bytes in the table that are considered "long-term storage".

Declaration

public Output<int> NumLongTermBytes { get; }

Property Value

Type	Description
Output<System.Int32>

View Source

NumRows

The number of rows of data in this table, excluding any data in the streaming buffer.

Declaration

public Output<int> NumRows { get; }

Property Value

Type	Description
Output<System.Int32>

View Source

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>

View Source

RangePartitioning

If specified, configures range-based partitioning for this table. Structure is documented below.

Declaration

public Output<TableRangePartitioning> RangePartitioning { get; }

Property Value

Type	Description
Output<TableRangePartitioning>

View Source

Schema

A JSON schema for the table. Schema is required for CSV and JSON formats and is disallowed for Google Cloud Bigtable, Cloud Datastore backups, and Avro formats when using external tables. For more information see the BigQuery API documentation. ~>NOTE: Because this field expects a JSON string, any changes to the string will create a diff, even if the JSON itself hasn't changed. If the API returns a different value for the same schema, e.g. it switched the order of values or replaced STRUCT field type with RECORD field type, we currently cannot suppress the recurring diff this causes. As a workaround, we recommend using the schema as returned by the API.

Declaration

public Output<string> Schema { get; }

Property Value

Type	Description
Output<System.String>

View Source

SelfLink

The URI of the created resource.

Declaration

public Output<string> SelfLink { get; }

Property Value

Type	Description
Output<System.String>

View Source

TableId

A unique ID for the resource. Changing this forces a new resource to be created.

Declaration

public Output<string> TableId { get; }

Property Value

Type	Description
Output<System.String>

View Source

TimePartitioning

If specified, configures time-based partitioning for this table. Structure is documented below.

Declaration

public Output<TableTimePartitioning> TimePartitioning { get; }

Property Value

Type	Description
Output<TableTimePartitioning>

View Source

Type

The only type supported is DAY, which will generate one partition per day based on data loading time.

Declaration

public Output<string> Type { get; }

Property Value

Type	Description
Output<System.String>

View Source

View

If specified, configures this table as a view. Structure is documented below.

Declaration

public Output<TableView> View { get; }

Property Value

Type	Description
Output<TableView>

Methods

View Source

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

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

Declaration

public static Table Get(string name, Input<string> id, TableState 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.
TableState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
Table