Class: AWSCDK::StepFunctions::FieldUtils

Inherits:
Jsii::Object
  • Object
show all
Defined in:
step_functions/field_utils.rb

Overview

Helper functions to work with structures containing fields.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(*args) ⇒ FieldUtils

Returns a new instance of FieldUtils.

Raises:

  • (NoMethodError) 


8
9
10
 
# File 'step_functions/field_utils.rb', line 8

def initialize(*args)
  raise NoMethodError, "aws-cdk-lib.aws_stepfunctions.FieldUtils does not have a visible constructor; use the provided factory methods"
end

Class Method Details

.contains_task_token(obj = nil) ⇒ 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.

Parameters:

  • obj (Hash{String => Object}, nil) (defaults to: nil)

Returns:

  • (Boolean) 


24
25
26
27
 
# File 'step_functions/field_utils.rb', line 24

def self.contains_task_token(obj = nil)
  Jsii::Type.check_type(obj, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6ImFueSJ9LCJraW5kIjoibWFwIn19")), "obj") unless obj.nil?
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_stepfunctions.FieldUtils", "containsTaskToken", [obj])
end

.find_referenced_paths(obj = nil) ⇒ Array<String>

Return all JSON paths used in the given structure.

Parameters:

  • obj (Hash{String => Object}, nil) (defaults to: nil)

Returns:

  • (Array<String>) 


33
34
35
36
 
# File 'step_functions/field_utils.rb', line 33

def self.find_referenced_paths(obj = nil)
  Jsii::Type.check_type(obj, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6ImFueSJ9LCJraW5kIjoibWFwIn19")), "obj") unless obj.nil?
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_stepfunctions.FieldUtils", "findReferencedPaths", [obj])
end

.jsii_overridable_methods ⇒ Object 



12
13
14
15
 
# File 'step_functions/field_utils.rb', line 12

def self.jsii_overridable_methods
  {
  }
end

.render_object(obj = nil) ⇒ Hash{String => Object}?

Render a JSON structure containing fields to the right StepFunctions structure.

Parameters:

  • obj (Hash{String => Object}, nil) (defaults to: nil)

Returns:

  • (Hash{String => Object}, nil) 


42
43
44
45
 
# File 'step_functions/field_utils.rb', line 42

def self.render_object(obj = nil)
  Jsii::Type.check_type(obj, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6ImFueSJ9LCJraW5kIjoibWFwIn19")), "obj") unless obj.nil?
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_stepfunctions.FieldUtils", "renderObject", [obj])
end