describe-readyflow¶

Description¶

Gets the details for the specified ready flow.

Synopsis¶

  describe-readyflow
--readyflow-crn <value>
[--cli-input-json <value>]
[--generate-cli-skeleton]

Options¶

--readyflow-crn (string)

The ready flow CRN

--cli-input-json (string)

Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values.

--generate-cli-skeleton (boolean)

Prints a sample input JSON to standard output. Note the specified operation is not run if this argument is specified. The sample input can be used as an argument for --cli-input-json.

Output¶

readyflowDetail -> (object)

A detailed representation of a ready flow.

readyflowCrn -> (string)

The ready flow CRN

name -> (string)

The ready flow name

author -> (string)

The author of the most recent version

summary -> (string)

The ready flow summary (short)

description -> (string)

The ready flow description (long)

documentationLink -> (string)

A link to the ready flow documentation

notes -> (string)

Optional notes about the ready flow

source -> (string)

The ready flow data source

sourceDataFormat -> (string)

The ready flow data source format

destination -> (string)

The ready flow data destination

destinationDataFormat -> (string)

The ready flow data destination format

imported -> (boolean)

Whether the ready flow has been imported into the current account

modifiedTimestamp -> (integer)

The modified timestamp.

Form Factors¶

public