diff --git a/website/docs/r/big_query_dataset.html.markdown b/website/docs/r/big_query_dataset.html.markdown deleted file mode 100644 index 1014450ae6b..00000000000 --- a/website/docs/r/big_query_dataset.html.markdown +++ /dev/null @@ -1,255 +0,0 @@ ---- -# ---------------------------------------------------------------------------- -# -# *** AUTO GENERATED CODE *** AUTO GENERATED CODE *** -# -# ---------------------------------------------------------------------------- -# -# This file is automatically generated by Magic Modules and manual -# changes will be clobbered when the file is regenerated. -# -# Please read more about how to change this file in -# .github/CONTRIBUTING.md. -# -# ---------------------------------------------------------------------------- -layout: "google" -page_title: "Google: google_bigquery_dataset" -sidebar_current: "docs-google-bigquery-dataset" -description: |- - Datasets allow you to organize and control access to your tables. ---- - -# google\_bigquery\_dataset - -Datasets allow you to organize and control access to your tables. - - - -
-## Example Usage - Bigquery Dataset Basic - - -```hcl -resource "google_bigquery_dataset" "dataset" { - dataset_id = "example_dataset" - friendly_name = "test" - description = "This is a test description" - location = "EU" - default_table_expiration_ms = 3600000 - - labels = { - env = "default" - } - - access { - role = "OWNER" - user_by_email = "Joe@example.com" - } - access { - role = "READER" - domain = "example.com" - } -} -``` - -## Argument Reference - -The following arguments are supported: - - -* `dataset_id` - - (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. - - -- - - - - -* `access` - - (Optional) - An array of objects that define dataset access for one or more entities. Structure is documented below. - -* `default_table_expiration_ms` - - (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. - -* `default_partition_expiration_ms` - - (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. - -* `description` - - (Optional) - A user-friendly description of the dataset - -* `friendly_name` - - (Optional) - A descriptive name for the dataset - -* `labels` - - (Optional) - The labels associated with this dataset. You can use these to - organize and group your datasets - -* `location` - - (Optional) - The geographic location where the dataset should reside. - See [official docs](https://cloud.google.com/bigquery/docs/dataset-locations). - - There are two types of locations, regional or multi-regional. A regional - location is a specific geographic place, such as Tokyo, and a multi-regional - location is a large geographic area, such as the United States, that - contains at least two geographic places. - - Possible regional values include: `asia-east1`, `asia-northeast1`, - `asia-southeast1`, `australia-southeast1`, `europe-north1`, - `europe-west2` and `us-east4`. - - Possible multi-regional values: `EU` and `US`. - - The default value is multi-regional location `US`. - Changing this forces a new resource to be created. - -* `project` - (Optional) The ID of the project in which the resource belongs. - If it is not provided, the provider project is used. - -* `delete_contents_on_destroy` - (Optional) 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. - -The `access` block supports: - -* `domain` - - (Optional) - A domain to grant access to. Any users signed in with the - domain specified will be granted the specified access - -* `group_by_email` - - (Optional) - An email address of a Google Group to grant access to. - -* `role` - - (Optional) - Describes the rights granted to the user specified by the other - member of the access object. Primitive, Predefined and custom - roles are supported. Predefined roles that have equivalent - primitive roles are swapped by the API to their Primitive - counterparts, and will show a diff post-create. See - [official docs](https://cloud.google.com/bigquery/docs/access-control). - -* `special_group` - - (Optional) - 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. - -* `user_by_email` - - (Optional) - An email address of a user to grant access to. For example: - fred@example.com - -* `view` - - (Optional) - 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. Structure is documented below. - - -The `view` block supports: - -* `dataset_id` - - (Required) - The ID of the dataset containing this table. - -* `project_id` - - (Required) - The ID of the project containing this table. - -* `table_id` - - (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. - -## Attributes Reference - -In addition to the arguments listed above, the following computed attributes are exported: - - -* `creation_time` - - The time when this dataset was created, in milliseconds since the - epoch. - -* `etag` - - A hash of the resource. - -* `last_modified_time` - - The date when this dataset or any of its tables was last modified, in - milliseconds since the epoch. -* `self_link` - The URI of the created resource. - - -## Timeouts - -This resource provides the following -[Timeouts](/docs/configuration/resources.html#timeouts) configuration options: - -- `create` - Default is 4 minutes. -- `update` - Default is 4 minutes. -- `delete` - Default is 4 minutes. - -## Import - -Dataset can be imported using any of these accepted formats: - -``` -$ terraform import google_bigquery_dataset.default {{project}}/{{dataset_id}} -$ terraform import google_bigquery_dataset.default {{project}}:{{dataset_id}} -$ terraform import google_bigquery_dataset.default {{dataset_id}} -``` - --> If you're importing a resource with beta features, make sure to include `-provider=google-beta` -as an argument so that Terraform uses the correct provider to import your resource. - -## User Project Overrides - -This resource supports [User Project Overrides](https://www.terraform.io/docs/providers/google/provider_reference.html#user_project_override). diff --git a/website/docs/r/bigquery_dataset.html.markdown b/website/docs/r/bigquery_dataset.html.markdown index 3c0f4917612..1014450ae6b 100644 --- a/website/docs/r/bigquery_dataset.html.markdown +++ b/website/docs/r/bigquery_dataset.html.markdown @@ -1,23 +1,41 @@ --- +# ---------------------------------------------------------------------------- +# +# *** AUTO GENERATED CODE *** AUTO GENERATED CODE *** +# +# ---------------------------------------------------------------------------- +# +# This file is automatically generated by Magic Modules and manual +# changes will be clobbered when the file is regenerated. +# +# Please read more about how to change this file in +# .github/CONTRIBUTING.md. +# +# ---------------------------------------------------------------------------- layout: "google" page_title: "Google: google_bigquery_dataset" sidebar_current: "docs-google-bigquery-dataset" description: |- - Creates a dataset resource for Google BigQuery. + Datasets allow you to organize and control access to your tables. --- -# google_bigquery_dataset +# google\_bigquery\_dataset -Creates a dataset resource for Google BigQuery. For more information see -[the official documentation](https://cloud.google.com/bigquery/docs/) and -[API](https://cloud.google.com/bigquery/docs/reference/rest/v2/datasets). +Datasets allow you to organize and control access to your tables. -## Example Usage + + +## Example Usage - Bigquery Dataset Basic + ```hcl -resource "google_bigquery_dataset" "default" { - dataset_id = "foo" +resource "google_bigquery_dataset" "dataset" { + dataset_id = "example_dataset" friendly_name = "test" description = "This is a test description" location = "EU" @@ -28,12 +46,12 @@ resource "google_bigquery_dataset" "default" { } access { - role = "READER" - domain = "example.com" + role = "OWNER" + user_by_email = "Joe@example.com" } access { - role = "WRITER" - group_by_email = "writers@example.com" + role = "READER" + domain = "example.com" } } ``` @@ -42,127 +60,196 @@ resource "google_bigquery_dataset" "default" { The following arguments are supported: -* `dataset_id` - (Required) A unique ID for the resource. - Changing this forces a new resource to be created. - -* `project` - (Optional) The ID of the project in which the resource belongs. If it - is not provided, the provider project is used. - -* `friendly_name` - (Optional) A descriptive name for the dataset. - -* `description` - (Optional) A user-friendly description of the dataset. - -* `delete_contents_on_destroy` - (Optional) 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. - -* `location` - (Optional) The geographic location where the dataset should reside. - See [official docs](https://cloud.google.com/bigquery/docs/dataset-locations). - - There are two types of locations, regional or multi-regional. - A regional location is a specific geographic place, such as Tokyo, and a - multi-regional location is a large geographic area, such as the United States, - that contains at least two geographic places - - Possible regional values include: `asia-east1`, `asia-northeast1`, `asia-southeast1` - `australia-southeast1`, `europe-north1`, `europe-west2` and `us-east4`. - - Possible multi-regional values:`EU` and `US`. - - The default value is multi-regional location `US`. - Changing this forces a new resource to be created. - -* `default_partition_expiration_ms` - (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. +* `dataset_id` - + (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. + + +- - - + + +* `access` - + (Optional) + An array of objects that define dataset access for one or more entities. Structure is documented below. + +* `default_table_expiration_ms` - + (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. + +* `default_partition_expiration_ms` - + (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. + +* `description` - + (Optional) + A user-friendly description of the dataset + +* `friendly_name` - + (Optional) + A descriptive name for the dataset + +* `labels` - + (Optional) + The labels associated with this dataset. You can use these to + organize and group your datasets + +* `location` - + (Optional) + The geographic location where the dataset should reside. + See [official docs](https://cloud.google.com/bigquery/docs/dataset-locations). + + There are two types of locations, regional or multi-regional. A regional + location is a specific geographic place, such as Tokyo, and a multi-regional + location is a large geographic area, such as the United States, that + contains at least two geographic places. + + Possible regional values include: `asia-east1`, `asia-northeast1`, + `asia-southeast1`, `australia-southeast1`, `europe-north1`, + `europe-west2` and `us-east4`. + + Possible multi-regional values: `EU` and `US`. + + The default value is multi-regional location `US`. + Changing this forces a new resource to be created. + +* `project` - (Optional) The ID of the project in which the resource belongs. + If it is not provided, the provider project is used. + +* `delete_contents_on_destroy` - (Optional) 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. + +The `access` block supports: + +* `domain` - + (Optional) + A domain to grant access to. Any users signed in with the + domain specified will be granted the specified access + +* `group_by_email` - + (Optional) + An email address of a Google Group to grant access to. + +* `role` - + (Optional) + Describes the rights granted to the user specified by the other + member of the access object. Primitive, Predefined and custom + roles are supported. Predefined roles that have equivalent + primitive roles are swapped by the API to their Primitive + counterparts, and will show a diff post-create. See + [official docs](https://cloud.google.com/bigquery/docs/access-control). + +* `special_group` - + (Optional) + A special group to grant access to. -* `default_table_expiration_ms` - (Optional) The default lifetime of all - tables in the dataset, in milliseconds. The minimum value is 3600000 - milliseconds (one hour). + Possible values include: - 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. + * `projectOwners`: Owners of the enclosing project. -* `labels` - (Optional) A mapping of labels to assign to the resource. + * `projectReaders`: Readers of the enclosing project. -* `access` - (Optional) An array of objects that define dataset access for - one or more entities. Structure is documented below. + * `projectWriters`: Writers of the enclosing project. -The `access` block supports the following fields (exactly one of `domain`, -`group_by_email`, `special_group`, `user_by_email`, or `view` must be set, -even though they are marked optional): + * `allAuthenticatedUsers`: All authenticated BigQuery users. -* `role` - (Required unless `view` is set) Describes the rights granted to - the user specified by the other member of the access object. - Primitive, Predefined and custom roles are supported. - Predefined roles that have equivalent primitive roles are swapped - by the API to their Primitive counterparts, and will show a diff post-create. - See [official docs](https://cloud.google.com/bigquery/docs/access-control). +* `user_by_email` - + (Optional) + An email address of a user to grant access to. For example: + fred@example.com -* `domain` - (Optional) A domain to grant access to. +* `view` - + (Optional) + 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. Structure is documented below. -* `group_by_email` - (Optional) An email address of a Google Group to grant - access to. -* `special_group` - (Optional) 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. +The `view` block supports: -* `user_by_email` - (Optional) An email address of a user to grant access to. +* `dataset_id` - + (Required) + The ID of the dataset containing this table. -* `view` - (Optional) 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. Structure is documented below. +* `project_id` - + (Required) + The ID of the project containing this table. -The `access.view` block supports: +* `table_id` - + (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` - (Required) The ID of the dataset containing this table. +## Attributes Reference -* `project_id` - (Required) The ID of the project containing this table. +In addition to the arguments listed above, the following computed attributes are exported: -* `table_id` - (Required) The ID of the table. -## Attributes Reference +* `creation_time` - + The time when this dataset was created, in milliseconds since the + epoch. -In addition to the arguments listed above, the following computed attributes are -exported: +* `etag` - + A hash of the resource. +* `last_modified_time` - + The date when this dataset or any of its tables was last modified, in + milliseconds since the epoch. * `self_link` - The URI of the created resource. -* `etag` - A hash of the resource. -* `creation_time` - The time when this dataset was created, in milliseconds since the epoch. +## Timeouts -* `last_modified_time` - The date when this dataset or any of its tables was last modified, - in milliseconds since the epoch. +This resource provides the following +[Timeouts](/docs/configuration/resources.html#timeouts) configuration options: + +- `create` - Default is 4 minutes. +- `update` - Default is 4 minutes. +- `delete` - Default is 4 minutes. ## Import -BigQuery datasets can be imported using the `project` and `dataset_id`, e.g. +Dataset can be imported using any of these accepted formats: ``` -$ terraform import google_bigquery_dataset.default gcp-project:foo +$ terraform import google_bigquery_dataset.default {{project}}/{{dataset_id}} +$ terraform import google_bigquery_dataset.default {{project}}:{{dataset_id}} +$ terraform import google_bigquery_dataset.default {{dataset_id}} ``` + +-> If you're importing a resource with beta features, make sure to include `-provider=google-beta` +as an argument so that Terraform uses the correct provider to import your resource. + +## User Project Overrides + +This resource supports [User Project Overrides](https://www.terraform.io/docs/providers/google/provider_reference.html#user_project_override). diff --git a/website/docs/r/cloud_build_trigger.html.markdown b/website/docs/r/cloudbuild_trigger.html.markdown similarity index 100% rename from website/docs/r/cloud_build_trigger.html.markdown rename to website/docs/r/cloudbuild_trigger.html.markdown diff --git a/website/docs/r/security_center_source.html.markdown b/website/docs/r/scc_source.html.markdown similarity index 100% rename from website/docs/r/security_center_source.html.markdown rename to website/docs/r/scc_source.html.markdown diff --git a/website/docs/r/source_repo_repository.html.markdown b/website/docs/r/sourcerepo_repository.html.markdown similarity index 100% rename from website/docs/r/source_repo_repository.html.markdown rename to website/docs/r/sourcerepo_repository.html.markdown diff --git a/website/docs/r/source_repo_repository_iam.html.markdown b/website/docs/r/sourcerepo_repository_iam.html.markdown similarity index 100% rename from website/docs/r/source_repo_repository_iam.html.markdown rename to website/docs/r/sourcerepo_repository_iam.html.markdown diff --git a/website/google.erb b/website/google.erb index ccf5dca9610..a00e47b2b6f 100644 --- a/website/google.erb +++ b/website/google.erb @@ -209,7 +209,7 @@ Google BigQuery Resources -