cloudera.cloud.df_readyflow_info module – Gather information about CDP DataFlow ReadyFlow 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_readyflow_info.

Synopsis

  • Gather information about CDP DataFlow ReadyFlow 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 ReadyFlow Definition is returned

Choices:

  • false

  • true ← (default)

name

string

If a name is provided, that DataFlow ReadyFlow 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

  • This 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 ReadyFlow Definitions
- cloudera.cloud.df_readyflow_info:

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

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 ReadyFlow Definitions in the DataFlow Catalog in this CDP Tenant

Returned: always

addedReadyflowCrn

string

The CRN of this readyflow when it is imported to the CDP Tenant

Use this readyflowCrn to address this object when doing deployments

Returned: when readyflow imported is True

readyflow

dictionary

The details of the ReadyFlow object

Returned: always

author

string

Author of the most recent version.

Returned: always

description

string

The ready flow description (long).

Returned: always

destination

string

The ready flow data destination.

Returned: always

destinationDataFormat

string

The ready flow data destination format.

Returned: always

string

A link to the ready flow documentation.

Returned: always

imported

boolean

Whether the ready flow has been imported into the current account.

Returned: always

modifiedTimestamp

integer

The timestamp the entry was last modified.

Returned: always

name

string

The DataFlow Flow Definition’s name.

Returned: always

notes

string

Optional notes about the ready flow.

Returned: always

readyflowCrn

string

The CRN of this readyflow in the Control Plane

Different to the addedReadyflowCrn of the imported readyflow within the CDP Tenant

Use this readyflowCrn when importing the object to your CDP Tenant

Returned: always

source

string

The ready flow data source.

Returned: always

sourceDataFormat

string

The ready flow data source format.

Returned: always

summary

string

The ready flow summary (short).

Returned: always

versions

list / elements=string

The list of artifactDetail versions.

Returned: When imported is True

author

string

The author of the artifact.

Returned: always

bucketIdentifier

string

The bucketIdentifier of the flow.

Returned: always

comments

string

Comments about the version.

Returned: always

crn

string

The artifact version CRN.

Returned: always

deploymentCount

integer

The number of deployments of the artifact.

Returned: always

timestamp

integer

The timestamp of the artifact.

Returned: always

version

integer

The version of the artifact.

Returned: always

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)