class FieldUtils
This page is available in another version. Click here for the v2 documentation.
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.StepFunctions.FieldUtils |
![]() | software.amazon.awscdk.services.stepfunctions.FieldUtils |
![]() | aws_cdk.aws_stepfunctions.FieldUtils |
![]() | @aws-cdk/aws-stepfunctions » FieldUtils |
Helper functions to work with structures containing fields.
Methods
Name | Description |
---|---|
static contains | Returns whether the given task structure contains the TaskToken field anywhere. |
static find | Return all JSON paths used in the given structure. |
static render | Render a JSON structure containing fields to the right StepFunctions structure. |
static containsTaskToken(obj?)
public static containsTaskToken(obj?: { [string]: any }): boolean
Parameters
- obj
{ [string]: any }
Returns
boolean
Returns whether the given task structure contains the TaskToken field anywhere.
The field is considered included if the field itself or one of its containing fields occurs anywhere in the payload.
static findReferencedPaths(obj?)
public static findReferencedPaths(obj?: { [string]: any }): string[]
Parameters
- obj
{ [string]: any }
Returns
string[]
Return all JSON paths used in the given structure.
static renderObject(obj?)
public static renderObject(obj?: { [string]: any }): { [string]: any }
Parameters
- obj
{ [string]: any }
Returns
{ [string]: any }
Render a JSON structure containing fields to the right StepFunctions structure.