Try SpotterCreates a GCP Dataset
Authors: Google Inc. (@googlecloudplatform)
preview | supported by community
Install with ansible-galaxy collection install delowan.googlecloud:==1.0.2
collections:
- name: delowan.googlecloud
version: 1.0.2Datasets allow you to organize and control access to your tables.
- name: create a dataset
google.cloud.gcp_bigquery_dataset:
name: my_example_dataset
dataset_reference:
dataset_id: my_example_dataset
project: test_project
auth_kind: serviceaccount
service_account_file: "/tmp/auth.pem"
state: present
name:
description:
- Dataset name.
required: false
type: str
state:
choices:
- present
- absent
default: present
description:
- Whether the given object should exist in GCP
type: str
access:
description:
- An array of objects that define dataset access for one or more entities.
elements: dict
required: false
suboptions:
domain:
description:
- A domain to grant access to. Any users signed in with the domain specified will
be granted the specified access .
required: false
type: str
group_by_email:
description:
- An email address of a Google Group to grant access to.
required: false
type: str
role:
description:
- Describes the rights granted to the user specified by the other member of the
access object. Basic, predefined, and custom roles are supported. Predefined
roles that have equivalent basic roles are swapped by the API to their basic
counterparts. See [official docs](U(https://cloud.google.com/bigquery/docs/access-control)).
required: false
type: str
special_group:
description:
- '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.'
required: false
type: str
user_by_email:
description:
- 'An email address of a user to grant access to. For example: fred@example.com
.'
required: false
type: str
view:
description:
- 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.
required: false
suboptions:
dataset_id:
description:
- The ID of the dataset containing this table.
required: true
type: str
project_id:
description:
- The ID of the project containing this table.
required: true
type: str
table_id:
description:
- 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.
required: true
type: str
type: dict
type: list
labels:
description:
- The labels associated with this dataset. You can use these to organize and group
your datasets .
required: false
type: dict
scopes:
description:
- Array of scopes to be used
elements: str
type: list
project:
description:
- The Google Cloud Platform project to use.
type: str
env_type:
description:
- Specifies which Ansible environment you're running this module within.
- This should not be set unless you know what you're doing.
- This only alters the User Agent string for any API requests.
type: str
location:
default: US
description:
- The geographic location where the dataset should reside.
- See [official docs](U(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.
- The default value is multi-regional location `US`.
- Changing this forces a new resource to be created.
required: false
type: str
auth_kind:
choices:
- application
- machineaccount
- serviceaccount
description:
- The type of credential used.
required: true
type: str
description:
description:
- A user-friendly description of the dataset.
required: false
type: str
friendly_name:
description:
- A descriptive name for the dataset.
required: false
type: str
dataset_reference:
description:
- A reference that identifies the dataset.
required: true
suboptions:
dataset_id:
description:
- 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.
required: true
type: str
project_id:
description:
- The ID of the project containing this dataset.
required: false
type: str
type: dict
service_account_file:
description:
- The path of a Service Account JSON file if serviceaccount is selected as type.
type: path
service_account_email:
description:
- An optional service account email address if machineaccount is selected and the
user does not wish to use the default email.
type: str
service_account_contents:
description:
- The contents of a Service Account JSON file, either in a dictionary or as a JSON
string that represents it.
type: jsonarg
default_table_expiration_ms:
description:
- 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.
required: false
type: int
default_partition_expiration_ms:
description:
- 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.'
required: false
type: int
default_encryption_configuration:
description:
- 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.
required: false
suboptions:
kms_key_name:
description:
- 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.
required: true
type: str
type: dict
access:
contains:
domain:
description:
- A domain to grant access to. Any users signed in with the domain specified
will be granted the specified access .
returned: success
type: str
groupByEmail:
description:
- An email address of a Google Group to grant access to.
returned: success
type: str
role:
description:
- Describes the rights granted to the user specified by the other member of
the access object. Basic, predefined, and custom roles are supported. Predefined
roles that have equivalent basic roles are swapped by the API to their basic
counterparts. See [official docs](U(https://cloud.google.com/bigquery/docs/access-control)).
returned: success
type: str
specialGroup:
description:
- '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.'
returned: success
type: str
userByEmail:
description:
- 'An email address of a user to grant access to. For example: fred@example.com
.'
returned: success
type: str
view:
contains:
datasetId:
description:
- The ID of the dataset containing this table.
returned: success
type: str
projectId:
description:
- The ID of the project containing this table.
returned: success
type: str
tableId:
description:
- 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.
returned: success
type: str
description:
- 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.
returned: success
type: complex
description:
- An array of objects that define dataset access for one or more entities.
returned: success
type: complex
creationTime:
description:
- The time when this dataset was created, in milliseconds since the epoch.
returned: success
type: int
datasetReference:
contains:
datasetId:
description:
- 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.
returned: success
type: str
projectId:
description:
- The ID of the project containing this dataset.
returned: success
type: str
description:
- A reference that identifies the dataset.
returned: success
type: complex
defaultEncryptionConfiguration:
contains:
kmsKeyName:
description:
- 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.
returned: success
type: str
description:
- 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.
returned: success
type: complex
defaultPartitionExpirationMs:
description:
- 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.'
returned: success
type: int
defaultTableExpirationMs:
description:
- 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.
returned: success
type: int
description:
description:
- A user-friendly description of the dataset.
returned: success
type: str
etag:
description:
- A hash of the resource.
returned: success
type: str
friendlyName:
description:
- A descriptive name for the dataset.
returned: success
type: str
id:
description:
- 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 .
returned: success
type: str
labels:
description:
- The labels associated with this dataset. You can use these to organize and group
your datasets .
returned: success
type: dict
lastModifiedTime:
description:
- The date when this dataset or any of its tables was last modified, in milliseconds
since the epoch.
returned: success
type: int
location:
description:
- The geographic location where the dataset should reside.
- See [official docs](U(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.
- The default value is multi-regional location `US`.
- Changing this forces a new resource to be created.
returned: success
type: str
name:
description:
- Dataset name.
returned: success
type: str