google.cloud.gcp_vertexai_dataset module – Creates a GCP VertexAI.Dataset resource

Note

This module is part of the google.cloud collection (version 1.12.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install google.cloud. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: google.cloud.gcp_vertexai_dataset.

Synopsis

  • A collection of DataItems and Annotations on them.

Requirements

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

  • python >= 3.8

  • requests >= 2.18.4

  • google-auth >= 2.25.1

Parameters

Parameter

Comments

access_token

string

The access token used to authenticate.

auth_kind

string / required

The type of credential used.

Choices:

  • "accesstoken"

  • "application"

  • "machineaccount"

  • "serviceaccount"

display_name

string / required

The user-defined name of the Dataset.

The name can be up to 128 characters long and can be consist of any UTF-8 characters.

encryption_spec

dictionary

Customer-managed encryption key spec for a Dataset.

If set, this Dataset and all sub-resources of this Dataset will be secured by this key.

kms_key_name

string

The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource.

Has the form: projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key.

The key needs to be in the same region as where the resource is created.

env_type

string

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.

labels

dictionary

A set of key/value label pairs to assign to this Workflow.

metadata_schema_uri

string / required

Points to a YAML file stored on Google Cloud Storage describing additional information about the Dataset.

The schema is defined as an OpenAPI 3.0.2 Schema Object.

The schema files that can be used here are found in gs://google-cloud-aiplatform/schema/dataset/metadata/.

project

string

The Google Cloud Platform project to use.

region

string

The region of the dataset.

eg us-central1.

scopes

list / elements=string

Array of scopes to be used.

service_account_contents

jsonarg

The contents of a Service Account JSON file,

either in a dictionary or as a JSON string that represents it.

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.

state

string

Whether the resource should exist in GCP.

Choices:

  • "present" ← (default)

  • "absent"

Notes

Note

Examples

- name: Create dataset
  google.cloud.gcp_vertexai_dataset:
    state: present
    display_name: "{{ resource_name }}"
    metadata_schema_uri: "gs://google-cloud-aiplatform/schema/dataset/metadata/image_1.0.0.yaml"
    region: us-central1
    project: "{{ gcp_project }}"
    auth_kind: "{{ gcp_cred_kind }}"
    service_account_file: "{{ gcp_cred_file }}"
  register: _myds

- name: Run assertions
  ansible.builtin.assert:
    that:
      - _myds.changed == true

- name: Update dataset
  google.cloud.gcp_vertexai_dataset:
    state: present
    display_name: "{{ resource_name }}"
    metadata_schema_uri: "gs://google-cloud-aiplatform/schema/dataset/metadata/image_1.0.0.yaml"
    labels:
      env: test
    region: us-central1
    project: "{{ gcp_project }}"
    auth_kind: "{{ gcp_cred_kind }}"
    service_account_file: "{{ gcp_cred_file }}"
  register: _myds

- name: Run assertions
  ansible.builtin.assert:
    that:
      - _myds.changed == true
      - _myds.labels | length > 0
      - _myds.labels.env == "test"

- name: Destroy dataset
  google.cloud.gcp_vertexai_dataset:
    state: absent
    display_name: "{{ resource_name }}"
    metadata_schema_uri: "gs://google-cloud-aiplatform/schema/dataset/metadata/image_1.0.0.yaml"
    region: us-central1
    project: "{{ gcp_project }}"
    auth_kind: "{{ gcp_cred_kind }}"
    service_account_file: "{{ gcp_cred_file }}"

Return Values

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

Key

Description

changed

boolean

Whether the resource was changed.

Returned: always

createTime

string

The timestamp of when the dataset was created in RFC3339 UTC “Zulu” format, with nanosecond resolution and up to nine fractional digits.

Returned: success

name

string

The resource name of the Dataset.

This value is set by Google.

Returned: success

state

string

The current state of the resource.

Returned: always

updateTime

string

The timestamp of when the dataset was last updated in RFC3339 UTC “Zulu” format, with nanosecond resolution and up to nine fractional digits.

Returned: success

Authors

  • Google Inc. (@googlecloudplatform)