cloudera.services.atlas_typedef_info module – Retrieve type definitions from Apache Atlas

Note

This module is part of the cloudera.services collection (version 1.0.0).

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 git+https://github.com/cloudera-labs/cloudera.services.git.

To use it in a playbook, specify: cloudera.services.atlas_typedef_info.

New in cloudera.services 1.1.0

Synopsis

  • Retrieve a type definition by name, or list the headers of all type definitions.

  • Without name, only the headers (guid, name, category, service type) are returned.

  • With name, the full type definition is returned.

  • The module supports check_mode.

Parameters

Parameter

Comments

category

string

Only list type definitions of this category.

Choices:

  • "enum"

  • "struct"

  • "classification"

  • "entity"

  • "relationship"

  • "business_metadata"

client_cert

path

The path to a client certificate for authenticating to the API endpoint.

client_key

path

The path to a client key for authenticating to the API endpoint.

debug

aliases: debug_endpoints

boolean

A flag to enable debug logging of the module’s execution.

Choices:

  • false ← (default)

  • true

force

boolean

A flag to force a refresh of the API request, ignoring any cached results.

Choices:

  • false ← (default)

  • true

force_basic_auth

boolean

A flag to force basic authentication for API requests.

Choices:

  • false ← (default)

  • true

http_agent

aliases: user_agent

string

The User-Agent string to send with API requests.

Default: "cloudera-services-module"

name

string

Name of the type definition to retrieve.

When set, category is ignored.

page_size

aliases: default_page_size

integer

The number of items to return per page in a paginated API response.

Default: 100

timeout

aliases: timeout_seconds

integer

The timeout in seconds for any API requests.

Default: 60

url

aliases: endpoint, endpoint_url

string / required

The base URL of the API endpoint, including the port if necessary.

url_password

string

The password for authenticating to the API endpoint.

url_username

string

The username for authenticating to the API endpoint.

use_gssapi

boolean

A flag to enable or disable GSSAPI authentication for API requests.

Choices:

  • false ← (default)

  • true

use_proxy

boolean

A flag to enable or disable the use of a proxy for API requests.

Choices:

  • false

  • true ← (default)

validate_certs

boolean

A flag to enable or disable SSL certificate validation for API requests.

Choices:

  • false

  • true ← (default)

Attributes

Attribute

Support

Description

check_mode

Support: full

This module supports check mode.

Examples

# NOTE: Examples do not include connection and authentication fields
- name: List all type definition headers
  cloudera.services.atlas_typedef_info:

- name: List enum type definition headers
  cloudera.services.atlas_typedef_info:
    category: enum

- name: Retrieve a type definition by name
  cloudera.services.atlas_typedef_info:
    name: traffic_light

Return Values

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

Key

Description

typedefs

list / elements=dictionary

Type definitions matching the criteria.

Headers when listing, the full type definition when name is set.

Empty when name does not exist.

Returned: always

category

string

Type category, e.g. ENUM or CLASSIFICATION.

Returned: always

guid

string

Atlas-assigned identifier.

Returned: always

name

string

Name of the type definition.

Returned: always

options

dictionary

Free-form options of the type definition. Keys are returned verbatim.

Returned: when name is set

service_type

string

Name of the service that owns the type definition.

Returned: sometimes

Authors

  • Webster Mudge (@wmudge)