Dataset class

Creates a new empty dataset. Auto-naming is currently not supported for this resource.

Constructors

Dataset(String name, {DatasetArgs? args, CustomResourceOptions? options})

Creates a new Dataset. name The Pulumi resource name. args Arguments used to configure this Dataset. The set of arguments for Dataset. options Resource options controlling this resource's behavior.

Properties

access ↔ Output<List<Map<String, dynamic>>>

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;

late, final

childResources → Set<Resource>

final, inherited

completionSources ↔ Map<String, IOutputCompletionSource>

late, final, inherited

creationTime ↔ Output<String>

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

late, final

datasetReference ↔ Output<DatasetReferenceResponse>

Required A reference that identifies the dataset.

late, final

defaultCollation ↔ Output<String>

The default collation of the dataset.

late, final

defaultEncryptionConfiguration ↔ Output<EncryptionConfigurationResponse>

late, final

defaultPartitionExpirationMs ↔ Output<String>

Optional The default partition expiration for all partitioned tables in the dataset, in milliseconds. Once this property is set, all newly-created partitioned tables in the dataset will have an expirationMs property in the timePartitioning settings set to this value, and changing the value will only affect new tables, not existing ones. The storage in a partition will have an expiration time of its partition time plus this value. Setting this property overrides the use of defaultTableExpirationMs for partitioned tables: only one of defaultTableExpirationMs and defaultPartitionExpirationMs will be used for any new partitioned table. If you provide an explicit timePartitioning.expirationMs when creating or updating a partitioned table, that value takes precedence over the default partition expiration time indicated by this property.

late, final

defaultRoundingMode ↔ Output<String>

The default rounding mode of the dataset.

late, final

defaultTableExpirationMs ↔ Output<String>

Optional The default lifetime of all tables in the dataset, in milliseconds. The minimum value is 3600000 milliseconds (one hour). 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.

late, final

description ↔ Output<String>

Optional A user-friendly description of the dataset.

late, final

etag ↔ Output<String>

A hash of the resource.

late, final

externalDatasetReference ↔ Output<ExternalDatasetReferenceResponse>

Optional Information about the external metadata storage where the dataset is defined. Filled out when the dataset type is EXTERNAL.

late, final

friendlyName ↔ Output<String>

Optional A descriptive name for the dataset.

late, final

hashCode → int

The hash code for this object.

no setter, inherited

id ↔ Output<String>

getter/setter pair, inherited

isCaseInsensitive ↔ Output<bool>

Optional Indicates if table names are case insensitive in the dataset.

late, final

isCustom → bool

Returns whether this resource is provider-managed.

no setter, inherited

isProtected → bool

Returns whether this resource is protected from deletion.

no setter, inherited

isRemote → bool

Whether this resource is registered as remote.

no setter, inherited

isResourceReference → bool

Whether this instance represents a resource value returned over RPC.

final, inherited

kind ↔ Output<String>

The resource type.

late, final

labels ↔ Output<Map<String, String>>

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.

late, final

lastModifiedTime ↔ Output<String>

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

late, final

location ↔ Output<String>

The geographic location where the dataset should reside. The default value is US. See details at https://cloud.google.com/bigquery/docs/locations.

late, final

maxTimeTravelHours ↔ Output<String>

Optional Number of hours for the max time travel for all tables in the dataset.

late, final

project ↔ Output<String>

late, final

resourceTransforms → List<ResourceTransform>

Inherited/explicit async transforms.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

satisfiesPzs ↔ Output<bool>

Reserved for future use.

late, final

selfLink ↔ Output<String>

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

late, final

storageBillingModel ↔ Output<String>

Optional Storage billing model to be used for all tables in the dataset. Can be set to PHYSICAL. Default is LOGICAL.

late, final

tags ↔ Output<List<Map<String, dynamic>>>

OptionalThe tags associated with this dataset. Tag keys are globally unique.

late, final

transformations → List<ResourceTransformation>

Inherited/explicit legacy transformations.

no setter, inherited

urn ↔ Output<String>

late, final, inherited

Methods

failId(Object error) → void

Completes this resource ID with an error when registration fails.

inherited

failOutputs(Object error) → void

Completes all output properties with error.

inherited

failUrn(Object error) → void

Completes this resource URN with an error when registration fails.

inherited

getProvider(String moduleMember) → ProviderResource?

Returns provider for moduleMember's package, if configured.

inherited

getResourceName() → String

Returns this resource's logical name.

inherited

getResourceType() → String

Returns this resource's Pulumi type token.

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>

Registers a dynamic output property for this resource.

inherited

resolveId(String? value, {required bool isKnown}) → void

Resolves the provider-assigned ID for this resource.

inherited

resolveOutputs(Struct outputs) → void

Resolves all output properties from a monitor response payload.

inherited

resolveUrn(String value) → void

Resolves this resource's URN once assigned by the engine.

inherited

serializeProperties(Map<String, dynamic> properties) → Future<Struct>

Serializes resource properties for RPC transmission.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited