get-flow-configuration-metadata-in-deployment¶

Description¶

Retrieves the deployed flow configuration metadata in a deployment.

Synopsis¶

  get-flow-configuration-metadata-in-deployment
--environment-crn <value>
--deployment-crn <value>
--deployed-flow-crn <value>
[--cli-input-json <value>]
[--generate-cli-skeleton]

Options¶

--environment-crn (string)

The CRN of an environment to execute the command.

--deployment-crn (string)

The deployment crn.

--deployed-flow-crn (string)

The deployed 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¶

deployedFlowConfigurationMetadata -> (object)

Provides details about the deployed flow and all of the different configuration items that are available.

flowCrn -> (string)

The CRN of the flow to deploy

flowName -> (string)

The name of the flow to deploy

flowVersion -> (integer)

The version of the flow to deploy

flowVersionCrn -> (string)

The CRN for the flow version

requiresEnvironmentSslContextService -> (boolean)

A flag indicating if the flow requires an Environment specific SSLContextService

artifactTypeName -> (string)

The type of the artifact of the flow.

parameterGroups -> (array)

The list of flow parameter groups

item -> (object)

A flow parameter group

name -> (string)

The name of the parameter group

parameters -> (array)

The parameters in the group

item -> (object)

A flow parameter

name -> (string)

The name of the parameter

description -> (string)

The description of the param

value -> (string)

The value of the parameter

sensitive -> (boolean)

Whether or not the parameter value is sensitive

type -> (string)

The type of parameter. Possibly TEXT, FILE, FILES

assetReferences -> (array)

The list of referenced assets.

( … recursive … )

valueSet -> (boolean)

Indicates if the value of this parameter is set (i.e. not null)

sourceParameterGroupId -> (string)

The ID of the shared parameter group where the value should come from.

inheritedParameterGroups -> (array)

The names and versions of the inherited parameter groups

item -> (object)

A reference to a specific version of a shared parameter group

groupId -> (string)

The ID of the parameter group

version -> (integer)

The version of the parameter group. Empty or null means the latest version.

otherName -> (string)

The other name that can be used to reference this group in a flow. This is used when multiple flows with same parameter group are deployed in to same NiFi cluster.

kpiMetaData -> (object)

A template for instantiating KPIs

kpiScopes -> (array)

The KPI scope meta data list, one per MetricComponentType.

item -> (object)

Provides scoping meta data for use during KPI creation

type -> (string)

The type of the scope

metricTypes -> (array)

The available metric types for the chosen scope type

item -> (object)

Provides the legal metric types for an owning scope

id -> (string)

The internal id of the metric type

label -> (string)

The user-visible label of the metric type

unitTypeKey -> (string)

The unit type key for this metric

defaultUnitId -> (string)

The default unitId for this metric

description -> (string)

The user-visible description of the metric type

label -> (string)

The label to use for the chosen scope type

contextGroups -> (array)

The context identifiers for the chosen scope type

item -> (object)

Captures the use of a KPI in the context of a process group

id -> (string)

The id of the containing process group

name -> (string)

The name of the containing process group

scopeComponents -> (array)

The scope components of the group

( … recursive … )

contextLabel -> (string)

The label to use for the context identifier, which depends on scope type.

unitTypes -> (map)

The entire tree of legal unit types for all metrics.

key -> (string)

value -> (array)

item -> (object)

Captures the legal units for a metric, a means to avoid large numbers either before or after a decimal point

id -> (string)

The internal ID of the unit

label -> (string)

The user-visible label of the unit

factor -> (integer)

The conversion factor to use to normalize values with this unit into a common unit

alertFrequencyTolerance -> (object)

The alert frequency tolerance unit choices, including a default

units -> (array)

The legal alert frequency values

item -> (object)

The alert frequency unit to use in KPI tolerances and metrics

id -> (string)

The id of the frequency unit

label -> (string)

The user-friendly label of the frequency unit

abbreviation -> (string)

The abbreviation for frequency unit

defaultUnitId -> (string)

The default alert frequency ID to use as the default chooser value

Form Factors¶

public