cloudera.services.atlas_entity_def module – Manage entity type definitions in 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_entity_def.

New in cloudera.services 1.1.0

Synopsis

• Create, update, or delete entity type definitions in Apache Atlas.

Parameters

Parameter	Comments
attribute_defs list / elements=dictionary	Attributes of the entity type. Replaces the existing attributes; Atlas may reject removing attributes that are in use. Unset suboptions keep the value Atlas already holds for an attribute of the same name. Atlas rejects adding an attribute to an existing entity type unless attribute_defs[].is_optional=true.
cardinality string	Cardinality of the attribute. Choices: "SINGLE" "LIST" "SET"
constraints list / elements=dictionary	Constraints on the attribute.
params dictionary	Parameters of the constraint. Keys are sent to Atlas verbatim.
type string / required	Type of the constraint, e.g. ownedRef or inverseRef.
default_value string	Default value of the attribute.
description string	Description of the attribute.
display_name string	Display name of the attribute.
include_in_notification boolean	Whether changes to the attribute are included in notifications. Choices: false true
index_type string	Index type of the attribute. Choices: "DEFAULT" "STRING"
is_indexable boolean	Whether the attribute is indexed. Choices: false true
is_optional boolean	Whether a value is optional. Choices: false true
is_unique boolean	Whether values must be unique. Choices: false true
name string / required	Name of the attribute.
options dictionary	Free-form map of string options for the attribute. Keys are sent to Atlas verbatim.
search_weight integer	Search weight of the attribute.
type_name string / required	Name of the attribute type, e.g. string, int, or the name of an enum.
values_max_count integer	Maximum number of values.
values_min_count integer	Minimum number of values.
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
description string	Description of the entity type definition.
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 entity type definition. Required when state=present or state=absent.
options dictionary	Free-form map of string options for the type definition. Keys are sent to Atlas verbatim.
page_size aliases: default_page_size integer	The number of items to return per page in a paginated API response. Default: 100
service_type string	Name of the service that owns the type definition.
state string	Whether the entity type definition should be present or absent. Choices: "present" ← (default) "absent"
super_types list / elements=string	Names of the entity types this entity type inherits from.
timeout aliases: timeout_seconds integer	The timeout in seconds for any API requests. Default: 60
type_version string	Version label of the type definition, e.g. 1.0.
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.
diff_mode	Support: full	This module supports diff mode.

Examples

# NOTE: Examples do not include connection and authentication fields
- name: Create an entity type definition
  cloudera.services.atlas_entity_def:
    name: customer_record
    description: Customer record dataset
    attribute_defs:
      - name: owner
        type_name: string
        is_optional: true

- name: Remove an entity type definition
  cloudera.services.atlas_entity_def:
    name: customer_record
    state: absent

Return Values

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

Key	Description
entity_def dictionary	The entity type definition. Returned: when state=present
attribute_defs list / elements=dictionary	Attributes of the entity type. Returned: success
cardinality string	Cardinality of the attribute. Returned: success
constraints list / elements=dictionary	Constraints on the attribute. Returned: success
params dictionary	Parameters of the constraint. Returned: success
type string	Type of the constraint. Returned: success
default_value string	Default value of the attribute. Returned: success
description string	Description of the attribute. Returned: success
display_name string	Display name of the attribute. Returned: success
include_in_notification boolean	Whether changes are included in notifications. Returned: success
index_type string	Index type of the attribute. Returned: success
is_indexable boolean	Whether the attribute is indexed. Returned: success
is_optional boolean	Whether a value is optional. Returned: success
is_unique boolean	Whether values must be unique. Returned: success
name string	Name of the attribute. Returned: success
options dictionary	Free-form options of the attribute. Returned: success
search_weight integer	Search weight of the attribute. Returned: success
type_name string	Name of the attribute type. Returned: success
values_max_count integer	Maximum number of values. Returned: success
values_min_count integer	Minimum number of values. Returned: success
business_attribute_defs dictionary	Business metadata attributes of the entity type, keyed by business metadata name. Read-only; managed through business metadata type definitions. Returned: success
category string	Type category, always ENTITY. Returned: success
create_time integer	Creation time in epoch milliseconds. Returned: success
created_by string	User that created the type definition. Returned: success
description string	Description of the entity type definition. Returned: success
guid string	Atlas-assigned identifier. Returned: success
name string	Name of the entity type definition. Returned: success
options dictionary	Free-form options of the type definition. Returned: success
relationship_attribute_defs list / elements=dictionary	Relationship attributes of the entity type, derived by Atlas from relationship type definitions. Read-only; has the same fields as attribute_defs plus those below. Returned: success
is_legacy_attribute boolean	Whether the attribute is a legacy attribute. Returned: success
name string	Name of the attribute. Returned: success
relationship_type_name string	Name of the relationship type that defines the attribute. Returned: success
type_name string	Name of the attribute type. Returned: success
service_type string	Name of the service that owns the type definition. Returned: success
sub_types list / elements=string	Names of the entity types that inherit from this entity type. Returned: success
super_types list / elements=string	Names of the entity types this entity type inherits from. Returned: success
type_version string	Version label of the type definition. Returned: success
update_time integer	Last update time in epoch milliseconds. Returned: success
updated_by string	User that last updated the type definition. Returned: success
version integer	Atlas version number of the type definition. Returned: success

Authors

• Webster Mudge (@wmudge)

Collection Links

• Issue Tracker
• Repository (Sources)
• Submit a bug report
• Request a feature