Class: Google::Apis::WorkflowexecutionsV1::Execution

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

A running instance of a Workflow.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Execution

Returns a new instance of Execution.



113
114
115
 
# File 'lib/google/apis/workflowexecutions_v1/classes.rb', line 113

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

Instance Attribute Details

#argument ⇒ String

Input parameters of the execution represented as a JSON string. The size limit is 32KB. Note: If you are using the REST API directly to run your workflow, you must escape any JSON string value of argument. Example: '"argument":"\ "firstName\":\"FIRST\",\"lastName\":\"LAST\""' Corresponds to the JSON property argument

Returns:

  • (String) 


74
75
76
 
# File 'lib/google/apis/workflowexecutions_v1/classes.rb', line 74

def argument
  @argument
end

#end_time ⇒ String

Output only. Marks the end of execution, successful or not. Corresponds to the JSON property endTime

Returns:

  • (String) 


79
80
81
 
# File 'lib/google/apis/workflowexecutions_v1/classes.rb', line 79

def end_time
  @end_time
end

#error ⇒ Google::Apis::WorkflowexecutionsV1::Error

Error describes why the execution was abnormally terminated. Corresponds to the JSON property error

Returns:



84
85
86
 
# File 'lib/google/apis/workflowexecutions_v1/classes.rb', line 84

def error
  @error
end

#name ⇒ String

Output only. The resource name of the execution. Format: projects/project/ locations/location/workflows/workflow/executions/execution Corresponds to the JSON property name

Returns:

  • (String) 


90
91
92
 
# File 'lib/google/apis/workflowexecutions_v1/classes.rb', line 90

def name
  @name
end

#result ⇒ String

Output only. Output of the execution represented as a JSON string. The value can only be present if the execution's state is SUCCEEDED. Corresponds to the JSON property result

Returns:

  • (String) 


96
97
98
 
# File 'lib/google/apis/workflowexecutions_v1/classes.rb', line 96

def result
  @result
end

#start_time ⇒ String

Output only. Marks the beginning of execution. Corresponds to the JSON property startTime

Returns:

  • (String) 


101
102
103
 
# File 'lib/google/apis/workflowexecutions_v1/classes.rb', line 101

def start_time
  @start_time
end

#state ⇒ String

Output only. Current state of the execution. Corresponds to the JSON property state

Returns:

  • (String) 


106
107
108
 
# File 'lib/google/apis/workflowexecutions_v1/classes.rb', line 106

def state
  @state
end

#workflow_revision_id ⇒ String

Output only. Revision of the workflow this execution is using. Corresponds to the JSON property workflowRevisionId

Returns:

  • (String) 


111
112
113
 
# File 'lib/google/apis/workflowexecutions_v1/classes.rb', line 111

def workflow_revision_id
  @workflow_revision_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



118
119
120
121
122
123
124
125
126
127
 
# File 'lib/google/apis/workflowexecutions_v1/classes.rb', line 118

def update!(**args)
  @argument = args[:argument] if args.key?(:argument)
  @end_time = args[:end_time] if args.key?(:end_time)
  @error = args[:error] if args.key?(:error)
  @name = args[:name] if args.key?(:name)
  @result = args[:result] if args.key?(:result)
  @start_time = args[:start_time] if args.key?(:start_time)
  @state = args[:state] if args.key?(:state)
  @workflow_revision_id = args[:workflow_revision_id] if args.key?(:workflow_revision_id)
end