Class: Google::Apis::WorkflowexecutionsV1::StepEntry

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/workflowexecutions_v1/classes.rb,
lib/google/apis/workflowexecutions_v1/representations.rb,
lib/google/apis/workflowexecutions_v1/representations.rb

Overview

An StepEntry contains debugging information for a step transition in a workflow execution.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ StepEntry

Returns a new instance of StepEntry.



723
724
725
 
# File 'lib/google/apis/workflowexecutions_v1/classes.rb', line 723

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#create_time ⇒ String

Output only. The creation time of the step entry. Corresponds to the JSON property createTime

Returns:

  • (String) 


660
661
662
 
# File 'lib/google/apis/workflowexecutions_v1/classes.rb', line 660

def create_time
  @create_time
end

#entry_id ⇒ Fixnum

Output only. The numeric ID of this step entry, used for navigation. Corresponds to the JSON property entryId

Returns:

  • (Fixnum) 


665
666
667
 
# File 'lib/google/apis/workflowexecutions_v1/classes.rb', line 665

def entry_id
  @entry_id
end

#exception ⇒ Google::Apis::WorkflowexecutionsV1::Exception

Exception describes why the step entry failed. Corresponds to the JSON property exception

Returns:



670
671
672
 
# File 'lib/google/apis/workflowexecutions_v1/classes.rb', line 670

def exception
  @exception
end

#name ⇒ String

Output only. The full resource name of the step entry. Each step entry has a unique entry ID, which is a monotonically increasing counter. Step entry names have the format: projects/project/locations/location/workflows/workflow/ executions/execution/stepEntries/step_entry`. Corresponds to the JSON propertyname`

Returns:

  • (String) 


678
679
680
 
# File 'lib/google/apis/workflowexecutions_v1/classes.rb', line 678

def name
  @name
end

#navigation_info ⇒ Google::Apis::WorkflowexecutionsV1::NavigationInfo

NavigationInfo describes what steps if any come before or after this step, or what steps are parents or children of this step. Corresponds to the JSON property navigationInfo

Returns:



684
685
686
 
# File 'lib/google/apis/workflowexecutions_v1/classes.rb', line 684

def navigation_info
  @navigation_info
end

#routine ⇒ String

Output only. The name of the routine this step entry belongs to. A routine name is the subworkflow name defined in the YAML source code. The top level routine name is main. Corresponds to the JSON property routine

Returns:

  • (String) 


691
692
693
 
# File 'lib/google/apis/workflowexecutions_v1/classes.rb', line 691

def routine
  @routine
end

#state ⇒ String

Output only. The state of the step entry. Corresponds to the JSON property state

Returns:

  • (String) 


696
697
698
 
# File 'lib/google/apis/workflowexecutions_v1/classes.rb', line 696

def state
  @state
end

#step ⇒ String

Output only. The name of the step this step entry belongs to. Corresponds to the JSON property step

Returns:

  • (String) 


701
702
703
 
# File 'lib/google/apis/workflowexecutions_v1/classes.rb', line 701

def step
  @step
end

#step_entry_metadata ⇒ Google::Apis::WorkflowexecutionsV1::StepEntryMetadata

StepEntryMetadata contains metadata information about this step. Corresponds to the JSON property stepEntryMetadata

Returns:



706
707
708
 
# File 'lib/google/apis/workflowexecutions_v1/classes.rb', line 706

def step_entry_metadata
  @step_entry_metadata
end

#step_type ⇒ String

Output only. The type of the step this step entry belongs to. Corresponds to the JSON property stepType

Returns:

  • (String) 


711
712
713
 
# File 'lib/google/apis/workflowexecutions_v1/classes.rb', line 711

def step_type
  @step_type
end

#update_time ⇒ String

Output only. The most recently updated time of the step entry. Corresponds to the JSON property updateTime

Returns:

  • (String) 


716
717
718
 
# File 'lib/google/apis/workflowexecutions_v1/classes.rb', line 716

def update_time
  @update_time
end

#variable_data ⇒ Google::Apis::WorkflowexecutionsV1::VariableData

VariableData contains the variable data for this step. Corresponds to the JSON property variableData

Returns:



721
722
723
 
# File 'lib/google/apis/workflowexecutions_v1/classes.rb', line 721

def variable_data
  @variable_data
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



728
729
730
731
732
733
734
735
736
737
738
739
740
741
 
# File 'lib/google/apis/workflowexecutions_v1/classes.rb', line 728

def update!(**args)
  @create_time = args[:create_time] if args.key?(:create_time)
  @entry_id = args[:entry_id] if args.key?(:entry_id)
  @exception = args[:exception] if args.key?(:exception)
  @name = args[:name] if args.key?(:name)
  @navigation_info = args[:navigation_info] if args.key?(:navigation_info)
  @routine = args[:routine] if args.key?(:routine)
  @state = args[:state] if args.key?(:state)
  @step = args[:step] if args.key?(:step)
  @step_entry_metadata = args[:step_entry_metadata] if args.key?(:step_entry_metadata)
  @step_type = args[:step_type] if args.key?(:step_type)
  @update_time = args[:update_time] if args.key?(:update_time)
  @variable_data = args[:variable_data] if args.key?(:variable_data)
end