gcp_bigquery_dataset_facts – Gather facts for GCP Dataset — Ansible Documentation

- AnsibleFest
- Products
- Community
- Webinars & Training
- Blog

Documentation

# gcp_bigquery_dataset_facts – Gather facts for GCP Dataset

New in version 2.8.

- Synopsis
- Requirements
- Parameters
- Notes
- Examples
- Return Values
- Status

## Synopsis

- Gather facts for GCP Dataset

## Requirements

The below requirements are needed on the host that executes this module.

- python >= 2.6
- requests >= 2.18.4
- google-auth >= 1.3.0

## Parameters

Parameter | Choices/Defaults | Comments
--- | --- | ---
auth_kind string / required | Choices: application machineaccount serviceaccount | The type of credential used.
project string |  | The Google Cloud Platform project to use.
scopes list |  | Array of scopes to be used.
service_account_contents string |  | A string representing the contents of a Service Account JSON file. This should not be passed in as a dictionary, but a string that has the exact contents of a service account json file (valid JSON)
service_account_email string |  | An optional service account email address if machineaccount is selected and the user does not wish to use the default email.
service_account_file path |  | The path of a Service Account JSON file if serviceaccount is selected as type.

## Notes

Note

- For authentication, you can set service_account_file using the `GCP_SERVICE_ACCOUNT_FILE` env variable.
- For authentication, you can set service_account_email using the `GCP_SERVICE_ACCOUNT_EMAIL` env variable.
- For authentication, you can set service_account_contents using the `GCP_SERVICE_ACCOUNT_CONTENTS` env variable.
- For authentication, you can set auth_kind using the `GCP_AUTH_KIND` env variable.
- For authentication, you can set scopes using the `GCP_SCOPES` env variable.
- Environment variables values will only be used if the playbook values are not set.
- The service_account_email and service_account_file options are mutually exclusive.

## Examples

    - name: " a dataset facts"
      gcp_bigquery_dataset_facts:
        project: test_project
        auth_kind: serviceaccount
        service_account_file: "/tmp/auth.pem"
        state: facts

## Return Values

Common return values are documented here, the following are the fields unique to this module:

Key | Returned | Description
--- | --- | ---
items complex | always | List of items
| access complex | success | Access controls on the bucket.
|  | domain string | success | A domain to grant access to. Any users signed in with the domain specified will be granted the specified access .
|  | groupByEmail string | success | An email address of a Google Group to grant access to.
|  | role string | success | Describes the rights granted to the user specified by the other member of the access object .
|  | specialGroup string | success | A special group to grant access to.
|  | userByEmail string | success | An email address of a user to grant access to. For example: fred@example.com .
|  | view complex | success | 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.
|  |  | datasetId string | success | The ID of the dataset containing this table.
|  |  | projectId string | success | The ID of the project containing this table.
|  |  | tableId string | success | 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.
| creationTime integer | success | The time when this dataset was created, in milliseconds since the epoch.
| datasetReference complex | success | A reference that identifies the dataset.
|  | datasetId string | success | 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.
|  | projectId string | success | The ID of the project containing this dataset.
| defaultTableExpirationMs integer | success | The default lifetime of all tables in the dataset, in milliseconds .
| description string | success | A user-friendly description of the dataset.
| friendlyName string | success | A descriptive name for the dataset.
| id string | success | 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 .
| labels dictionary | success | The labels associated with this dataset. You can use these to organize and group your datasets .
| lastModifiedTime integer | success | The date when this dataset or any of its tables was last modified, in milliseconds since the epoch.
| location string | success | The geographic location where the dataset should reside. Possible values include EU and US. The default value is US.
| name string | success | Dataset name.

## Status

- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]

### Authors

- Google Inc. (@googlecloudplatform)

Hint

If you notice any issues in this documentation you can edit this document to improve it.