new Flow(id, version, label, description, format, tags, source_id, parents)
Describes a Flow. Immutable value.
Parameters:
| Name | Type | Description |
|---|---|---|
id |
string | Globally unique UUID identifier for the Flow. |
version |
string | String formatted PTP timestamp (<seconds>:<nanoseconds>) indicating precisely when an attribute of the resource last changed. |
label |
string | Freeform string label for the Flow. |
description |
string | Detailed description of the Flow. |
format |
string | Format of the data coming from the Flow as a URN. |
tags |
Object.<string, Array.<string>> | Key value set of freeform string tags to aid in filtering Flows. Can be empty. |
source_id |
string | Globally unique UUID for the source which initially created the Flow. |
parents |
Array.<string> | Array of UUIDs representing the Flow IDs of Grains which came together to generate this Flow. (May change over the lifetime of this Flow). |
- Source:
Extends
Members
(readonly) description :string
Detailed description of the Flow.
Type:
- string
- Source:
(readonly) format :string
Format of the data coming from the Flow as a URN.
Type:
- string
- Source:
(readonly) id :string
Globally unique UUID identifier for the resource.
Type:
- string
- Overrides:
- Source:
(readonly) label :string
Freeform string label for the resource.
Type:
- string
- Overrides:
- Source:
parents
Array of UUIDs representing the Flow IDs of Grains which came together to
generate this Flow. (May change over the lifetime of this Flow.)
- Source:
(readonly) source_id :string
Globally unique UUID identifier for the Flow which initially created the
Flow.
Type:
- string
- Source:
(readonly) tags :Array.<string, Array.<string>>
Key value set of freeform string tags to aid in filtering Flows. Can be
empty.
Type:
- Array.<string, Array.<string>>
- Source:
(readonly) version :string
String formatted PTP timestamp (<seconds>:<nanoseconds>)
indicating precisely when an attribute of the resource last changed.
Type:
- string
- Overrides:
- Source:
Methods
generateID(idopt) → {string}
Generate an identifier when one is not provided,
otherwise pass this one through. No validation takes place.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
id |
string |
<optional> |
Identifier to pass through. |
- Overrides:
- Source:
Returns:
Value passed to the method or a generated pseudo-random
UUID for no arguments, null or undefined.
- Type
- string
generateLabel(labelopt) → {string}
Generate a label when one is not provided, otherwise
pass the given one through. No validation takes place.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
label |
string |
<optional> |
Label to pass through. |
- Overrides:
- Source:
Returns:
Value passed to the method or an empty string for
no arguments, null or undefined.
- Type
- string
generateVersion(versionopt) → {string}
Generate a version number when one is not provided,
otherwise pass the given one through. No validation takes place.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
version |
string |
<optional> |
Version number to pass through. |
- Overrides:
- Source:
Returns:
Value passed to the method or a generated version
number from the current clock with no arguments,
null or undefined.
- Type
- string
valid() → {boolean}
Checks that all the properties of this resource are valid. The is a syntactic
check and does not check semantics such as references to other objects can be
checked. Valid includes:
- Required properties are defined and not null.
- Identifiers a valid UUIDs.
- Enumerations are known values and/or match expected patterns.
- Values are of the expected type.
- Overrides:
- Source:
Returns:
Is the resource valid?
- Type
- boolean