Class Dataset

Inheritance

object

Dataset

Implements

IDirectResponseSchema

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Google.Apis.Bigquery.v2.Data

Assembly: Google.Apis.Bigquery.v2.dll

Syntax

public class Dataset : IDirectResponseSchema

Properties

Access

Optional. An array of objects that define dataset access for one or more entities. You can set this property when inserting or updating a dataset in order to control who is allowed to access the data. If unspecified at dataset creation time, BigQuery adds default dataset access for the following entities: access.specialGroup: projectReaders; access.role: READER; access.specialGroup: projectWriters; access.role: WRITER; access.specialGroup: projectOwners; access.role: OWNER; access.userByEmail: [dataset creator email]; access.role: OWNER;

Declaration

[JsonProperty("access")]
public virtual IList<Dataset.AccessData> Access { get; set; }

Property Value

Type	Description
IList<Dataset.AccessData>

CreationTime

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

Declaration

[JsonProperty("creationTime")]
public virtual long? CreationTime { get; set; }

Property Value

Type	Description
long?

DatasetReference

Required. A reference that identifies the dataset.

Declaration

[JsonProperty("datasetReference")]
public virtual DatasetReference DatasetReference { get; set; }

Property Value

Type	Description
DatasetReference

DefaultCollation

Optional. Defines the default collation specification of future tables created in the dataset. If a table is created in this dataset without table-level default collation, then the table inherits the dataset default collation, which is applied to the string fields that do not have explicit collation specified. A change to this field affects only tables created afterwards, and does not alter the existing tables. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior.

Declaration

[JsonProperty("defaultCollation")]
public virtual string DefaultCollation { get; set; }

Property Value

Type	Description
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.

Declaration

[JsonProperty("defaultEncryptionConfiguration")]
public virtual EncryptionConfiguration DefaultEncryptionConfiguration { get; set; }

Property Value

Type	Description
EncryptionConfiguration

DefaultPartitionExpirationMs

This default partition expiration, expressed in milliseconds. When new time-partitioned tables are created in a dataset where this property is set, the table will inherit this value, propagated as the TimePartitioning.expirationMs property on the new table. If you set TimePartitioning.expirationMs explicitly when creating a table, the defaultPartitionExpirationMs of the containing dataset is ignored. When creating a partitioned table, if defaultPartitionExpirationMs is set, the defaultTableExpirationMs value is ignored and the table will not be inherit a table expiration deadline.

Declaration

[JsonProperty("defaultPartitionExpirationMs")]
public virtual long? DefaultPartitionExpirationMs { get; set; }

Property Value

Type	Description
long?

DefaultRoundingMode

Optional. Defines the default rounding mode specification of new tables created within this dataset. During table creation, if this field is specified, the table within this dataset will inherit the default rounding mode of the dataset. Setting the default rounding mode on a table overrides this option. Existing tables in the dataset are unaffected. If columns are defined during that table creation, they will immediately inherit the table's default rounding mode, unless otherwise specified.

Declaration

[JsonProperty("defaultRoundingMode")]
public virtual string DefaultRoundingMode { get; set; }

Property Value

Type	Description
string

DefaultTableExpirationMs

Optional. The default lifetime of all tables in the dataset, in milliseconds. The minimum lifetime value is 3600000 milliseconds (one hour). To clear an existing default expiration with a PATCH request, set to 0. Once this property is set, all newly-created tables in the dataset will have an expirationTime property set to the creation time plus the value in this property, and changing the value will only affect new tables, not existing ones. When the expirationTime for a given table is reached, that table will be deleted automatically. If a table's expirationTime is modified or removed before the table expires, or if you provide an explicit expirationTime when creating a table, that value takes precedence over the default expiration time indicated by this property.

Declaration

[JsonProperty("defaultTableExpirationMs")]
public virtual long? DefaultTableExpirationMs { get; set; }

Property Value

Type	Description
long?

Description

Optional. A user-friendly description of the dataset.

Declaration

[JsonProperty("description")]
public virtual string Description { get; set; }

Property Value

Type	Description
string

ETag

Output only. A hash of the resource.

Declaration

[JsonProperty("etag")]
public virtual string ETag { get; set; }

Property Value

Type	Description
string

ExternalDatasetReference

Optional. Reference to a read-only external dataset defined in data catalogs outside of BigQuery. Filled out when the dataset type is EXTERNAL.

Declaration

[JsonProperty("externalDatasetReference")]
public virtual ExternalDatasetReference ExternalDatasetReference { get; set; }

Property Value

Type	Description
ExternalDatasetReference

FriendlyName

Optional. A descriptive name for the dataset.

Declaration

[JsonProperty("friendlyName")]
public virtual string FriendlyName { get; set; }

Property Value

Type	Description
string

Id

Output only. The fully-qualified unique name of the dataset in the format projectId:datasetId. The dataset name without the project name is given in the datasetId field. When creating a new dataset, leave this field blank, and instead specify the datasetId field.

Declaration

[JsonProperty("id")]
public virtual string Id { get; set; }

Property Value

Type	Description
string

IsCaseInsensitive

Optional. TRUE if the dataset and its table names are case-insensitive, otherwise FALSE. By default, this is FALSE, which means the dataset and its table names are case-sensitive. This field does not affect routine references.

Declaration

[JsonProperty("isCaseInsensitive")]
public virtual bool? IsCaseInsensitive { get; set; }

Property Value

Type	Description
bool?

Kind

Output only. The resource type.

Declaration

[JsonProperty("kind")]
public virtual string Kind { get; set; }

Property Value

Type	Description
string

Labels

The labels associated with this dataset. You can use these to organize and group your datasets. You can set this property when inserting or updating a dataset. See Creating and Updating Dataset Labels for more information.

Declaration

[JsonProperty("labels")]
public virtual IDictionary<string, string> Labels { get; set; }

Property Value

Type	Description
IDictionary<string, string>

LastModifiedTime

Output only. The date when this dataset was last modified, in milliseconds since the epoch.

Declaration

[JsonProperty("lastModifiedTime")]
public virtual long? LastModifiedTime { get; set; }

Property Value

Type	Description
long?

LinkedDatasetSource

Optional. The source dataset reference when the dataset is of type LINKED. For all other dataset types it is not set. This field cannot be updated once it is set. Any attempt to update this field using Update and Patch API Operations will be ignored.

Declaration

[JsonProperty("linkedDatasetSource")]
public virtual LinkedDatasetSource LinkedDatasetSource { get; set; }

Property Value

Type	Description
LinkedDatasetSource

Location

The geographic location where the dataset should reside. See https://cloud.google.com/bigquery/docs/locations for supported locations.

Declaration

[JsonProperty("location")]
public virtual string Location { get; set; }

Property Value

Type	Description
string

MaxTimeTravelHours

Optional. Defines the time travel window in hours. The value can be from 48 to 168 hours (2 to 7 days). The default value is 168 hours if this is not set.

Declaration

[JsonProperty("maxTimeTravelHours")]
public virtual long? MaxTimeTravelHours { get; set; }

Property Value

Type	Description
long?

SatisfiesPzi

Output only. Reserved for future use.

Declaration

[JsonProperty("satisfiesPzi")]
public virtual bool? SatisfiesPzi { get; set; }

Property Value

Type	Description
bool?

SatisfiesPzs

Output only. Reserved for future use.

Declaration

[JsonProperty("satisfiesPzs")]
public virtual bool? SatisfiesPzs { get; set; }

Property Value

Type	Description
bool?

SelfLink

Output only. A URL that can be used to access the resource again. You can use this URL in Get or Update requests to the resource.

Declaration

[JsonProperty("selfLink")]
public virtual string SelfLink { get; set; }

Property Value

Type	Description
string

StorageBillingModel

Optional. Updates storage_billing_model for the dataset.

Declaration

[JsonProperty("storageBillingModel")]
public virtual string StorageBillingModel { get; set; }

Property Value

Type	Description
string

Type	Description
IList<Dataset.TagsData>

Type

Output only. Same as type in ListFormatDataset. The type of the dataset, one of: * DEFAULT - only accessible by owner and authorized accounts, * PUBLIC - accessible by everyone, * LINKED - linked dataset, * EXTERNAL - dataset with definition in external metadata catalog. -- *BIGLAKE_METASTORE - dataset that references a database created in BigLakeMetastore service. --

Declaration

[JsonProperty("type")]
public virtual string Type { get; set; }

Property Value

Type	Description
string

Implements

IDirectResponseSchema