Google Cloud Native v0.32.0, Nov 29 23

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi

google-native.bigquery/v2.getDataset

Explore with Pulumi AI

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi

Using getDataset

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

TypeScript
Python
Go
C#
Java
YAML

function getDataset(args: GetDatasetArgs, opts?: InvokeOptions): Promise<GetDatasetResult>
function getDatasetOutput(args: GetDatasetOutputArgs, opts?: InvokeOptions): Output<GetDatasetResult>

def get_dataset(dataset_id: Optional[str] = None,
                dataset_view: Optional[str] = None,
                project: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetDatasetResult
def get_dataset_output(dataset_id: Optional[pulumi.Input[str]] = None,
                dataset_view: Optional[pulumi.Input[str]] = None,
                project: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetDatasetResult]

func LookupDataset(ctx *Context, args *LookupDatasetArgs, opts ...InvokeOption) (*LookupDatasetResult, error)
func LookupDatasetOutput(ctx *Context, args *LookupDatasetOutputArgs, opts ...InvokeOption) LookupDatasetResultOutput

> Note: This function is named LookupDataset in the Go SDK.

public static class GetDataset 
{
    public static Task<GetDatasetResult> InvokeAsync(GetDatasetArgs args, InvokeOptions? opts = null)
    public static Output<GetDatasetResult> Invoke(GetDatasetInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetDatasetResult> getDataset(GetDatasetArgs args, InvokeOptions options)
public static Output<GetDatasetResult> getDataset(GetDatasetArgs args, InvokeOptions options)

fn::invoke:
  function: google-native:bigquery/v2:getDataset
  arguments:
    # arguments dictionary

The following arguments are supported:

DatasetId string
DatasetView string
Project string

DatasetId string
DatasetView string
Project string

datasetId String
datasetView String
project String

datasetId string
datasetView string
project string

dataset_id str
dataset_view str
project str

datasetId String
datasetView String
project String

getDataset Result

The following output properties are available:

Access List<Pulumi.GoogleNative.BigQuery.V2.Outputs.DatasetAccessItemResponse>: [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;
CreationTime string: The time when this dataset was created, in milliseconds since the epoch.
DatasetReference Pulumi.GoogleNative.BigQuery.V2.Outputs.DatasetReferenceResponse: [Required] A reference that identifies the dataset.
DefaultCollation string: The default collation of the dataset.
DefaultEncryptionConfiguration Pulumi.GoogleNative.BigQuery.V2.Outputs.EncryptionConfigurationResponse
DefaultPartitionExpirationMs 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.
DefaultRoundingMode string: The default rounding mode of the dataset.
DefaultTableExpirationMs 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.
Description string: [Optional] A user-friendly description of the dataset.
Etag string: A hash of the resource.
ExternalDatasetReference Pulumi.GoogleNative.BigQuery.V2.Outputs.ExternalDatasetReferenceResponse: [Optional] Information about the external metadata storage where the dataset is defined. Filled out when the dataset type is EXTERNAL.
FriendlyName string: [Optional] A descriptive name for the dataset.
IsCaseInsensitive bool: [Optional] Indicates if table names are case insensitive in the dataset.
Kind string: The resource type.
Labels Dictionary<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.
LastModifiedTime string: The date when this dataset or any of its tables was last modified, in milliseconds since the epoch.
Location string: The geographic location where the dataset should reside. The default value is US. See details at https://cloud.google.com/bigquery/docs/locations.
MaxTimeTravelHours string: [Optional] Number of hours for the max time travel for all tables in the dataset.
SatisfiesPzs bool: Reserved for future use.
SelfLink 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.
StorageBillingModel string: [Optional] Storage billing model to be used for all tables in the dataset. Can be set to PHYSICAL. Default is LOGICAL.
Tags List<Pulumi.GoogleNative.BigQuery.V2.Outputs.DatasetTagsItemResponse>: [Optional]The tags associated with this dataset. Tag keys are globally unique.

Access []DatasetAccessItemResponse: [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;
CreationTime string: The time when this dataset was created, in milliseconds since the epoch.
DatasetReference DatasetReferenceResponse: [Required] A reference that identifies the dataset.
DefaultCollation string: The default collation of the dataset.
DefaultEncryptionConfiguration EncryptionConfigurationResponse
DefaultPartitionExpirationMs 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.
DefaultRoundingMode string: The default rounding mode of the dataset.
DefaultTableExpirationMs 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.
Description string: [Optional] A user-friendly description of the dataset.
Etag string: A hash of the resource.
ExternalDatasetReference ExternalDatasetReferenceResponse: [Optional] Information about the external metadata storage where the dataset is defined. Filled out when the dataset type is EXTERNAL.
FriendlyName string: [Optional] A descriptive name for the dataset.
IsCaseInsensitive bool: [Optional] Indicates if table names are case insensitive in the dataset.
Kind string: The resource type.
Labels 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.
LastModifiedTime string: The date when this dataset or any of its tables was last modified, in milliseconds since the epoch.
Location string: The geographic location where the dataset should reside. The default value is US. See details at https://cloud.google.com/bigquery/docs/locations.
MaxTimeTravelHours string: [Optional] Number of hours for the max time travel for all tables in the dataset.
SatisfiesPzs bool: Reserved for future use.
SelfLink 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.
StorageBillingModel string: [Optional] Storage billing model to be used for all tables in the dataset. Can be set to PHYSICAL. Default is LOGICAL.
Tags []DatasetTagsItemResponse: [Optional]The tags associated with this dataset. Tag keys are globally unique.

access List<DatasetAccessItemResponse>: [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;
creationTime String: The time when this dataset was created, in milliseconds since the epoch.
datasetReference DatasetReferenceResponse: [Required] A reference that identifies the dataset.
defaultCollation String: The default collation of the dataset.
defaultEncryptionConfiguration EncryptionConfigurationResponse
defaultPartitionExpirationMs 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.
defaultRoundingMode String: The default rounding mode of the dataset.
defaultTableExpirationMs 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.
description String: [Optional] A user-friendly description of the dataset.
etag String: A hash of the resource.
externalDatasetReference ExternalDatasetReferenceResponse: [Optional] Information about the external metadata storage where the dataset is defined. Filled out when the dataset type is EXTERNAL.
friendlyName String: [Optional] A descriptive name for the dataset.
isCaseInsensitive Boolean: [Optional] Indicates if table names are case insensitive in the dataset.
kind String: The resource type.
labels 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.
lastModifiedTime String: The date when this dataset or any of its tables was last modified, in milliseconds since the epoch.
location String: The geographic location where the dataset should reside. The default value is US. See details at https://cloud.google.com/bigquery/docs/locations.
maxTimeTravelHours String: [Optional] Number of hours for the max time travel for all tables in the dataset.
satisfiesPzs Boolean: Reserved for future use.
selfLink 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.
storageBillingModel String: [Optional] Storage billing model to be used for all tables in the dataset. Can be set to PHYSICAL. Default is LOGICAL.
tags List<DatasetTagsItemResponse>: [Optional]The tags associated with this dataset. Tag keys are globally unique.

access DatasetAccessItemResponse[]: [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;
creationTime string: The time when this dataset was created, in milliseconds since the epoch.
datasetReference DatasetReferenceResponse: [Required] A reference that identifies the dataset.
defaultCollation string: The default collation of the dataset.
defaultEncryptionConfiguration EncryptionConfigurationResponse
defaultPartitionExpirationMs 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.
defaultRoundingMode string: The default rounding mode of the dataset.
defaultTableExpirationMs 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.
description string: [Optional] A user-friendly description of the dataset.
etag string: A hash of the resource.
externalDatasetReference ExternalDatasetReferenceResponse: [Optional] Information about the external metadata storage where the dataset is defined. Filled out when the dataset type is EXTERNAL.
friendlyName string: [Optional] A descriptive name for the dataset.
isCaseInsensitive boolean: [Optional] Indicates if table names are case insensitive in the dataset.
kind string: The resource type.
labels {[key: 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.
lastModifiedTime string: The date when this dataset or any of its tables was last modified, in milliseconds since the epoch.
location string: The geographic location where the dataset should reside. The default value is US. See details at https://cloud.google.com/bigquery/docs/locations.
maxTimeTravelHours string: [Optional] Number of hours for the max time travel for all tables in the dataset.
satisfiesPzs boolean: Reserved for future use.
selfLink 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.
storageBillingModel string: [Optional] Storage billing model to be used for all tables in the dataset. Can be set to PHYSICAL. Default is LOGICAL.
tags DatasetTagsItemResponse[]: [Optional]The tags associated with this dataset. Tag keys are globally unique.

access Sequence[DatasetAccessItemResponse]: [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;
creation_time str: The time when this dataset was created, in milliseconds since the epoch.
dataset_reference DatasetReferenceResponse: [Required] A reference that identifies the dataset.
default_collation str: The default collation of the dataset.
default_encryption_configuration EncryptionConfigurationResponse
default_partition_expiration_ms str: [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.
default_rounding_mode str: The default rounding mode of the dataset.
default_table_expiration_ms str: [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.
description str: [Optional] A user-friendly description of the dataset.
etag str: A hash of the resource.
external_dataset_reference ExternalDatasetReferenceResponse: [Optional] Information about the external metadata storage where the dataset is defined. Filled out when the dataset type is EXTERNAL.
friendly_name str: [Optional] A descriptive name for the dataset.
is_case_insensitive bool: [Optional] Indicates if table names are case insensitive in the dataset.
kind str: The resource type.
labels Mapping[str, str]: 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.
last_modified_time str: The date when this dataset or any of its tables was last modified, in milliseconds since the epoch.
location str: The geographic location where the dataset should reside. The default value is US. See details at https://cloud.google.com/bigquery/docs/locations.
max_time_travel_hours str: [Optional] Number of hours for the max time travel for all tables in the dataset.
satisfies_pzs bool: Reserved for future use.
self_link str: A URL that can be used to access the resource again. You can use this URL in Get or Update requests to the resource.
storage_billing_model str: [Optional] Storage billing model to be used for all tables in the dataset. Can be set to PHYSICAL. Default is LOGICAL.
tags Sequence[DatasetTagsItemResponse]: [Optional]The tags associated with this dataset. Tag keys are globally unique.

access List<Property Map>: [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;
creationTime String: The time when this dataset was created, in milliseconds since the epoch.
datasetReference Property Map: [Required] A reference that identifies the dataset.
defaultCollation String: The default collation of the dataset.
defaultEncryptionConfiguration Property Map
defaultPartitionExpirationMs 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.
defaultRoundingMode String: The default rounding mode of the dataset.
defaultTableExpirationMs 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.
description String: [Optional] A user-friendly description of the dataset.
etag String: A hash of the resource.
externalDatasetReference Property Map: [Optional] Information about the external metadata storage where the dataset is defined. Filled out when the dataset type is EXTERNAL.
friendlyName String: [Optional] A descriptive name for the dataset.
isCaseInsensitive Boolean: [Optional] Indicates if table names are case insensitive in the dataset.
kind String: The resource type.
labels Map<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.
lastModifiedTime String: The date when this dataset or any of its tables was last modified, in milliseconds since the epoch.
location String: The geographic location where the dataset should reside. The default value is US. See details at https://cloud.google.com/bigquery/docs/locations.
maxTimeTravelHours String: [Optional] Number of hours for the max time travel for all tables in the dataset.
satisfiesPzs Boolean: Reserved for future use.
selfLink 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.
storageBillingModel String: [Optional] Storage billing model to be used for all tables in the dataset. Can be set to PHYSICAL. Default is LOGICAL.
tags List<Property Map>: [Optional]The tags associated with this dataset. Tag keys are globally unique.

Supporting Types

DatasetAccessEntryResponse

Dataset Pulumi.GoogleNative.BigQuery.V2.Inputs.DatasetReferenceResponse: [Required] The dataset this entry applies to.
TargetTypes List<string>

Dataset DatasetReferenceResponse: [Required] The dataset this entry applies to.
TargetTypes []string

dataset DatasetReferenceResponse: [Required] The dataset this entry applies to.
targetTypes List<String>

dataset DatasetReferenceResponse: [Required] The dataset this entry applies to.
targetTypes string[]

dataset DatasetReferenceResponse: [Required] The dataset this entry applies to.
target_types Sequence[str]

dataset Property Map: [Required] The dataset this entry applies to.
targetTypes List<String>

DatasetAccessItemResponse

Dataset Pulumi.GoogleNative.BigQuery.V2.Inputs.DatasetAccessEntryResponse: [Pick one] A grant authorizing all resources of a particular type in a particular dataset access to this dataset. Only views are supported for now. The role field is not required when this field is set. If that dataset is deleted and re-created, its access needs to be granted again via an update operation.
Domain string: [Pick one] A domain to grant access to. Any users signed in with the domain specified will be granted the specified access. Example: "example.com". Maps to IAM policy member "domain:DOMAIN".
GroupByEmail string: [Pick one] An email address of a Google Group to grant access to. Maps to IAM policy member "group:GROUP".
IamMember string: [Pick one] Some other type of member that appears in the IAM Policy but isn't a user, group, domain, or special group.
Role string: [Required] An IAM role ID that should be granted to the user, group, or domain specified in this access entry. The following legacy mappings will be applied: OWNER roles/bigquery.dataOwner WRITER roles/bigquery.dataEditor READER roles/bigquery.dataViewer This field will accept any of the above formats, but will return only the legacy format. For example, if you set this field to "roles/bigquery.dataOwner", it will be returned back as "OWNER".
Routine Pulumi.GoogleNative.BigQuery.V2.Inputs.RoutineReferenceResponse: [Pick one] A routine from a different dataset to grant access to. Queries executed against that routine will have read access to views/tables/routines in this dataset. Only UDF is supported for now. The role field is not required when this field is set. If that routine is updated by any user, access to the routine needs to be granted again via an update operation.
SpecialGroup string: [Pick one] A special group to grant access to. Possible values include: projectOwners: Owners of the enclosing project. projectReaders: Readers of the enclosing project. projectWriters: Writers of the enclosing project. allAuthenticatedUsers: All authenticated BigQuery users. Maps to similarly-named IAM members.
UserByEmail string: [Pick one] An email address of a user to grant access to. For example: fred@example.com. Maps to IAM policy member "user:EMAIL" or "serviceAccount:EMAIL".
View Pulumi.GoogleNative.BigQuery.V2.Inputs.TableReferenceResponse: [Pick one] A view from a different dataset to grant access to. Queries executed against that view will have read access to tables in this dataset. The role field is not required when this field is set. If that view is updated by any user, access to the view needs to be granted again via an update operation.

Dataset DatasetAccessEntryResponse: [Pick one] A grant authorizing all resources of a particular type in a particular dataset access to this dataset. Only views are supported for now. The role field is not required when this field is set. If that dataset is deleted and re-created, its access needs to be granted again via an update operation.
Domain string: [Pick one] A domain to grant access to. Any users signed in with the domain specified will be granted the specified access. Example: "example.com". Maps to IAM policy member "domain:DOMAIN".
GroupByEmail string: [Pick one] An email address of a Google Group to grant access to. Maps to IAM policy member "group:GROUP".
IamMember string: [Pick one] Some other type of member that appears in the IAM Policy but isn't a user, group, domain, or special group.
Role string: [Required] An IAM role ID that should be granted to the user, group, or domain specified in this access entry. The following legacy mappings will be applied: OWNER roles/bigquery.dataOwner WRITER roles/bigquery.dataEditor READER roles/bigquery.dataViewer This field will accept any of the above formats, but will return only the legacy format. For example, if you set this field to "roles/bigquery.dataOwner", it will be returned back as "OWNER".
Routine RoutineReferenceResponse: [Pick one] A routine from a different dataset to grant access to. Queries executed against that routine will have read access to views/tables/routines in this dataset. Only UDF is supported for now. The role field is not required when this field is set. If that routine is updated by any user, access to the routine needs to be granted again via an update operation.
SpecialGroup string: [Pick one] A special group to grant access to. Possible values include: projectOwners: Owners of the enclosing project. projectReaders: Readers of the enclosing project. projectWriters: Writers of the enclosing project. allAuthenticatedUsers: All authenticated BigQuery users. Maps to similarly-named IAM members.
UserByEmail string: [Pick one] An email address of a user to grant access to. For example: fred@example.com. Maps to IAM policy member "user:EMAIL" or "serviceAccount:EMAIL".
View TableReferenceResponse: [Pick one] A view from a different dataset to grant access to. Queries executed against that view will have read access to tables in this dataset. The role field is not required when this field is set. If that view is updated by any user, access to the view needs to be granted again via an update operation.

dataset DatasetAccessEntryResponse: [Pick one] A grant authorizing all resources of a particular type in a particular dataset access to this dataset. Only views are supported for now. The role field is not required when this field is set. If that dataset is deleted and re-created, its access needs to be granted again via an update operation.
domain String: [Pick one] A domain to grant access to. Any users signed in with the domain specified will be granted the specified access. Example: "example.com". Maps to IAM policy member "domain:DOMAIN".
groupByEmail String: [Pick one] An email address of a Google Group to grant access to. Maps to IAM policy member "group:GROUP".
iamMember String: [Pick one] Some other type of member that appears in the IAM Policy but isn't a user, group, domain, or special group.
role String: [Required] An IAM role ID that should be granted to the user, group, or domain specified in this access entry. The following legacy mappings will be applied: OWNER roles/bigquery.dataOwner WRITER roles/bigquery.dataEditor READER roles/bigquery.dataViewer This field will accept any of the above formats, but will return only the legacy format. For example, if you set this field to "roles/bigquery.dataOwner", it will be returned back as "OWNER".
routine RoutineReferenceResponse: [Pick one] A routine from a different dataset to grant access to. Queries executed against that routine will have read access to views/tables/routines in this dataset. Only UDF is supported for now. The role field is not required when this field is set. If that routine is updated by any user, access to the routine needs to be granted again via an update operation.
specialGroup String: [Pick one] A special group to grant access to. Possible values include: projectOwners: Owners of the enclosing project. projectReaders: Readers of the enclosing project. projectWriters: Writers of the enclosing project. allAuthenticatedUsers: All authenticated BigQuery users. Maps to similarly-named IAM members.
userByEmail String: [Pick one] An email address of a user to grant access to. For example: fred@example.com. Maps to IAM policy member "user:EMAIL" or "serviceAccount:EMAIL".
view TableReferenceResponse: [Pick one] A view from a different dataset to grant access to. Queries executed against that view will have read access to tables in this dataset. The role field is not required when this field is set. If that view is updated by any user, access to the view needs to be granted again via an update operation.

dataset DatasetAccessEntryResponse: [Pick one] A grant authorizing all resources of a particular type in a particular dataset access to this dataset. Only views are supported for now. The role field is not required when this field is set. If that dataset is deleted and re-created, its access needs to be granted again via an update operation.
domain string: [Pick one] A domain to grant access to. Any users signed in with the domain specified will be granted the specified access. Example: "example.com". Maps to IAM policy member "domain:DOMAIN".
groupByEmail string: [Pick one] An email address of a Google Group to grant access to. Maps to IAM policy member "group:GROUP".
iamMember string: [Pick one] Some other type of member that appears in the IAM Policy but isn't a user, group, domain, or special group.
role string: [Required] An IAM role ID that should be granted to the user, group, or domain specified in this access entry. The following legacy mappings will be applied: OWNER roles/bigquery.dataOwner WRITER roles/bigquery.dataEditor READER roles/bigquery.dataViewer This field will accept any of the above formats, but will return only the legacy format. For example, if you set this field to "roles/bigquery.dataOwner", it will be returned back as "OWNER".
routine RoutineReferenceResponse: [Pick one] A routine from a different dataset to grant access to. Queries executed against that routine will have read access to views/tables/routines in this dataset. Only UDF is supported for now. The role field is not required when this field is set. If that routine is updated by any user, access to the routine needs to be granted again via an update operation.
specialGroup string: [Pick one] A special group to grant access to. Possible values include: projectOwners: Owners of the enclosing project. projectReaders: Readers of the enclosing project. projectWriters: Writers of the enclosing project. allAuthenticatedUsers: All authenticated BigQuery users. Maps to similarly-named IAM members.
userByEmail string: [Pick one] An email address of a user to grant access to. For example: fred@example.com. Maps to IAM policy member "user:EMAIL" or "serviceAccount:EMAIL".
view TableReferenceResponse: [Pick one] A view from a different dataset to grant access to. Queries executed against that view will have read access to tables in this dataset. The role field is not required when this field is set. If that view is updated by any user, access to the view needs to be granted again via an update operation.

dataset DatasetAccessEntryResponse: [Pick one] A grant authorizing all resources of a particular type in a particular dataset access to this dataset. Only views are supported for now. The role field is not required when this field is set. If that dataset is deleted and re-created, its access needs to be granted again via an update operation.
domain str: [Pick one] A domain to grant access to. Any users signed in with the domain specified will be granted the specified access. Example: "example.com". Maps to IAM policy member "domain:DOMAIN".
group_by_email str: [Pick one] An email address of a Google Group to grant access to. Maps to IAM policy member "group:GROUP".
iam_member str: [Pick one] Some other type of member that appears in the IAM Policy but isn't a user, group, domain, or special group.
role str: [Required] An IAM role ID that should be granted to the user, group, or domain specified in this access entry. The following legacy mappings will be applied: OWNER roles/bigquery.dataOwner WRITER roles/bigquery.dataEditor READER roles/bigquery.dataViewer This field will accept any of the above formats, but will return only the legacy format. For example, if you set this field to "roles/bigquery.dataOwner", it will be returned back as "OWNER".
routine RoutineReferenceResponse: [Pick one] A routine from a different dataset to grant access to. Queries executed against that routine will have read access to views/tables/routines in this dataset. Only UDF is supported for now. The role field is not required when this field is set. If that routine is updated by any user, access to the routine needs to be granted again via an update operation.
special_group str: [Pick one] A special group to grant access to. Possible values include: projectOwners: Owners of the enclosing project. projectReaders: Readers of the enclosing project. projectWriters: Writers of the enclosing project. allAuthenticatedUsers: All authenticated BigQuery users. Maps to similarly-named IAM members.
user_by_email str: [Pick one] An email address of a user to grant access to. For example: fred@example.com. Maps to IAM policy member "user:EMAIL" or "serviceAccount:EMAIL".
view TableReferenceResponse: [Pick one] A view from a different dataset to grant access to. Queries executed against that view will have read access to tables in this dataset. The role field is not required when this field is set. If that view is updated by any user, access to the view needs to be granted again via an update operation.

dataset Property Map: [Pick one] A grant authorizing all resources of a particular type in a particular dataset access to this dataset. Only views are supported for now. The role field is not required when this field is set. If that dataset is deleted and re-created, its access needs to be granted again via an update operation.
domain String: [Pick one] A domain to grant access to. Any users signed in with the domain specified will be granted the specified access. Example: "example.com". Maps to IAM policy member "domain:DOMAIN".
groupByEmail String: [Pick one] An email address of a Google Group to grant access to. Maps to IAM policy member "group:GROUP".
iamMember String: [Pick one] Some other type of member that appears in the IAM Policy but isn't a user, group, domain, or special group.
role String: [Required] An IAM role ID that should be granted to the user, group, or domain specified in this access entry. The following legacy mappings will be applied: OWNER roles/bigquery.dataOwner WRITER roles/bigquery.dataEditor READER roles/bigquery.dataViewer This field will accept any of the above formats, but will return only the legacy format. For example, if you set this field to "roles/bigquery.dataOwner", it will be returned back as "OWNER".
routine Property Map: [Pick one] A routine from a different dataset to grant access to. Queries executed against that routine will have read access to views/tables/routines in this dataset. Only UDF is supported for now. The role field is not required when this field is set. If that routine is updated by any user, access to the routine needs to be granted again via an update operation.
specialGroup String: [Pick one] A special group to grant access to. Possible values include: projectOwners: Owners of the enclosing project. projectReaders: Readers of the enclosing project. projectWriters: Writers of the enclosing project. allAuthenticatedUsers: All authenticated BigQuery users. Maps to similarly-named IAM members.
userByEmail String: [Pick one] An email address of a user to grant access to. For example: fred@example.com. Maps to IAM policy member "user:EMAIL" or "serviceAccount:EMAIL".
view Property Map: [Pick one] A view from a different dataset to grant access to. Queries executed against that view will have read access to tables in this dataset. The role field is not required when this field is set. If that view is updated by any user, access to the view needs to be granted again via an update operation.

DatasetReferenceResponse

DatasetId string: [Required] A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
Project string: [Optional] The ID of the project containing this dataset.

DatasetId string: [Required] A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
Project string: [Optional] The ID of the project containing this dataset.

datasetId String: [Required] A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
project String: [Optional] The ID of the project containing this dataset.

datasetId string: [Required] A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
project string: [Optional] The ID of the project containing this dataset.

dataset_id str: [Required] A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
project str: [Optional] The ID of the project containing this dataset.

datasetId String: [Required] A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
project String: [Optional] The ID of the project containing this dataset.

DatasetTagsItemResponse

TagKey string: [Required] The namespaced friendly name of the tag key, e.g. "12345/environment" where 12345 is org id.
TagValue string: [Required] Friendly short name of the tag value, e.g. "production".

TagKey string: [Required] The namespaced friendly name of the tag key, e.g. "12345/environment" where 12345 is org id.
TagValue string: [Required] Friendly short name of the tag value, e.g. "production".

tagKey String: [Required] The namespaced friendly name of the tag key, e.g. "12345/environment" where 12345 is org id.
tagValue String: [Required] Friendly short name of the tag value, e.g. "production".

tagKey string: [Required] The namespaced friendly name of the tag key, e.g. "12345/environment" where 12345 is org id.
tagValue string: [Required] Friendly short name of the tag value, e.g. "production".

tag_key str: [Required] The namespaced friendly name of the tag key, e.g. "12345/environment" where 12345 is org id.
tag_value str: [Required] Friendly short name of the tag value, e.g. "production".

tagKey String: [Required] The namespaced friendly name of the tag key, e.g. "12345/environment" where 12345 is org id.
tagValue String: [Required] Friendly short name of the tag value, e.g. "production".

EncryptionConfigurationResponse

KmsKeyName string: Optional. Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key.

KmsKeyName string: Optional. Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key.

kmsKeyName String: Optional. Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key.

kmsKeyName string: Optional. Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key.

kms_key_name str: Optional. Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key.

kmsKeyName String: Optional. Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key.

ExternalDatasetReferenceResponse

Connection string: [Required] The connection id that is used to access the external_source. Format: projects/{project_id}/locations/{location_id}/connections/{connection_id}
ExternalSource string: [Required] External source that backs this dataset.

Connection string: [Required] The connection id that is used to access the external_source. Format: projects/{project_id}/locations/{location_id}/connections/{connection_id}
ExternalSource string: [Required] External source that backs this dataset.

connection String: [Required] The connection id that is used to access the external_source. Format: projects/{project_id}/locations/{location_id}/connections/{connection_id}
externalSource String: [Required] External source that backs this dataset.

connection string: [Required] The connection id that is used to access the external_source. Format: projects/{project_id}/locations/{location_id}/connections/{connection_id}
externalSource string: [Required] External source that backs this dataset.

connection str: [Required] The connection id that is used to access the external_source. Format: projects/{project_id}/locations/{location_id}/connections/{connection_id}
external_source str: [Required] External source that backs this dataset.

connection String: [Required] The connection id that is used to access the external_source. Format: projects/{project_id}/locations/{location_id}/connections/{connection_id}
externalSource String: [Required] External source that backs this dataset.

RoutineReferenceResponse

DatasetId string: The ID of the dataset containing this routine.
Project string: The ID of the project containing this routine.
RoutineId string: The ID of the routine. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters.

DatasetId string: The ID of the dataset containing this routine.
Project string: The ID of the project containing this routine.
RoutineId string: The ID of the routine. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters.

datasetId String: The ID of the dataset containing this routine.
project String: The ID of the project containing this routine.
routineId String: The ID of the routine. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters.

datasetId string: The ID of the dataset containing this routine.
project string: The ID of the project containing this routine.
routineId string: The ID of the routine. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters.

dataset_id str: The ID of the dataset containing this routine.
project str: The ID of the project containing this routine.
routine_id str: The ID of the routine. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters.

datasetId String: The ID of the dataset containing this routine.
project String: The ID of the project containing this routine.
routineId String: The ID of the routine. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters.

TableReferenceResponse

DatasetId string: [Required] The ID of the dataset containing this table.
Project string: [Required] The ID of the project containing this table.
TableId string: [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.

DatasetId string: [Required] The ID of the dataset containing this table.
Project string: [Required] The ID of the project containing this table.
TableId string: [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.

datasetId String: [Required] The ID of the dataset containing this table.
project String: [Required] The ID of the project containing this table.
tableId String: [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.

datasetId string: [Required] The ID of the dataset containing this table.
project string: [Required] The ID of the project containing this table.
tableId string: [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.

dataset_id str: [Required] The ID of the dataset containing this table.
project str: [Required] The ID of the project containing this table.
table_id str: [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.

datasetId String: [Required] The ID of the dataset containing this table.
project String: [Required] The ID of the project containing this table.
tableId String: [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.

Package Details

Repository: Google Cloud Native pulumi/pulumi-google-native
License: Apache-2.0

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi

pulumi/pulumi-google-native

google-native.bigquery/v2.getDataset

On this page

On this page

Using getDataset

getDataset Result

Supporting Types

DatasetAccessEntryResponse

DatasetAccessItemResponse

DatasetReferenceResponse

DatasetTagsItemResponse

EncryptionConfigurationResponse

ExternalDatasetReferenceResponse

RoutineReferenceResponse

TableReferenceResponse

Package Details

On this page

On this page