get-deployment-configuration-metadata¶

Description¶

Retrieves the deployment configuration metadata.

Synopsis¶

  get-deployment-configuration-metadata
--environment-crn <value>
--deployment-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.

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

deploymentConfigurationMetadata -> (object)

Provides details about the deployment 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

service -> (object)

The meta information about a DataFlow service.

crn -> (string)

The CRN of the DataFlow service

name -> (string)

The name of the DataFlow service

cloudPlatform -> (string)

The cloudPlatform flag of the DataFlow service

region -> (object)

A cloud region

name -> (string)

Name of the cloud region

displayName -> (string)

Display-friendly name of the cloud region

environmentCrn -> (string)

Crn of associated CDP environment

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, DIRECTORY

assetReferences -> (array)

The list of referenced assets.

( … recursive … )

valueSet -> (boolean)

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

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

clusterSizingOptions -> (array)

The options that are available for determining the size of the deployed cluster

item -> (object)

Cluster scaling parameters.

name -> (string)

The name of this Cluster Size.

coresPerNode -> (double)

The number of CPU Cores per node (will be truncated to the nearest integer).

memoryLimit -> (double)

The memory limit (will be truncated to the nearest integer).

text -> (string)

The text (i.e., the human readable name) for this Cluster Size.

heapSize -> (double)

The heap size.

enabled -> (boolean)

Flag to signal whether this ClusterSize is enabled.

customClusterSizeLimits -> (object)

Limits for the custom cluster size type.

maximumCpuCoresPerNode -> (double)

The maximum number of CPU Cores per node, that fit on the node type.

minimumCpuCoresPerNode -> (double)

The minimum number of CPU Cores per node, that fit on the node type.

maximumMemoryLimit -> (double)

The upper memory limit that is available on the node type.

minimumMemoryLimit -> (double)

The lower memory limit that is available on the node type.

nodeStorageProfileMetadata -> (array)

The list of node storage profiles

item -> (object)

Provides details about the node storage options.

contentRepoSize -> (integer)

Content repository size

provenanceRepoSize -> (integer)

Provenance repository size

flowfileRepoSize -> (integer)

FlowFile repository size

iops -> (string)

IOPS

throughput -> (string)

Throughput

storageVolumeType -> (string)

Storage volume type

name -> (string)

The name of this Storage Profile

text -> (string)

The text (i.e., the human readable name) for this Storage Profile

Form Factors¶

public