cloudera.cloud.df_customflow_info module – Gather information about CDP DataFlow CustomFlow Definitions

Note

This module is part of the cloudera.cloud collection (version 2.5.1).

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 cloudera.cloud. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: cloudera.cloud.df_customflow_info.

Synopsis

  • Gather information about CDP DataFlow CustomFlow Definitions

Requirements

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

  • cdpy

Parameters

Parameter

Comments

cdp_region

aliases: cdp_endpoint_region, endpoint_region

string

Specify the Cloudera Data Platform endpoint region.

Default: "default"

debug

aliases: debug_endpoints

boolean

Capture the CDP SDK debug log.

Choices:

  • false ← (default)

  • true

include_details

boolean

If set to false, only a summary of each flow is returned

Choices:

  • false

  • true ← (default)

name

string

If a name is provided, that DataFlow Flow Definition will be described

profile

string

If provided, the CDP SDK will use this value as its profile.

verify_endpoint_tls

aliases: endpoint_tls

boolean

Verify the TLS certificates for the CDP endpoint.

Choices:

  • false

  • true ← (default)

Notes

Note

  • The feature this module is for is in Technical Preview

Examples

# Note: These examples do not set authentication details.

# List summary information about all Custom DataFlow Flow Definitions
- cloudera.cloud.df_customflow_info:

# Gather summary information about a specific DataFlow Flow Definition using a name
- cloudera.cloud.df_customflow_info:
    name: my-flow-name
    include_details: False

Return Values

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

Key

Description

flows

list / elements=complex

The listing of CustomFlow Definitions in the DataFlow Catalog in this CDP Tenant

Returned: always

artifactType

string

The type of artifact

Returned: when include_details is False

author

string

Author of the most recent version.

Returned: when include_details is True

createdTimestamp

integer

The created timestamp.

Returned: when include_details is True

crn

string

The DataFlow Flow Definition’s CRN.

Returned: always

description

string

The artifact description.

Returned: when include_details is True

modifiedTimestamp

integer

The timestamp the entry was last modified.

Returned: always

name

string

The DataFlow Flow Definition’s name.

Returned: always

versionCount

string

The number of versions uploaded to the catalog.

Returned: always

versions

list / elements=string

The list of artifactDetail versions.

Returned: when include_details is True

author

string

The author of the flow.

Returned: when include_details is True

bucketIdentifier

string

The bucketIdentifier of the flow.

Returned: when include_details is True

comments

string

Comments about the flow.

Returned: when include_details is True

crn

string

The flow version CRN.

Returned: when include_details is True

deploymentCount

integer

The number of deployments of the flow.

Returned: when include_details is True

timestamp

integer

The timestamp of the flow.

Returned: when include_details is True

version

integer

The version of the flow.

Returned: when include_details is True

sdk_out

string

Returns the captured CDP SDK log.

Returned: when supported

sdk_out_lines

list / elements=string

Returns a list of each line of the captured CDP SDK log.

Returned: when supported

Authors

  • Dan Chaffelson (@chaffelson)