Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace CreatePipelineDetails

Properties used in pipeline create operations

Properties

Optional description

description: undefined | string

Detailed description for the object.

Optional flowConfigValues

flowConfigValues: model.ConfigValues

identifier

identifier: string

Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified.

Optional key

key: undefined | string

Generated key that can be used in API calls to identify pipeline. On scenarios where reference to the pipeline is needed, a value can be passed in create.

Optional modelType

modelType: undefined | string

The type of the object.

Optional modelVersion

modelVersion: undefined | string

This is a version number that is used by the service to upgrade objects if needed through releases of the service.

name

name: string

Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters.

Optional nodes

nodes: Array<FlowNode>

A list of nodes attached to the pipeline

Optional objectStatus

objectStatus: undefined | number

The status of an object that can be set to value 1 for shallow references across objects, other values reserved. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional objectVersion

objectVersion: undefined | number

This is used by the service for optimistic locking of the object, to prevent multiple users from simultaneously updating the object. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional parameters

parameters: Array<Parameter>

A list of additional parameters required in pipeline.

Optional parentRef

parentRef: model.ParentReference

registryMetadata

registryMetadata: RegistryMetadata

Optional variables

variables: Array<Variable>

The list of variables required in pipeline.

Functions

getDeserializedJsonObj

getJsonObj