Class: Vellum::ExecuteWorkflowAsyncResponse

Inherits:
Object
  • Object
show all
Defined in:
lib/vellum_ai/types/execute_workflow_async_response.rb

Overview

The response from an async Workflow Deployment execution.

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(execution_id:, additional_properties: nil) ⇒ Vellum::ExecuteWorkflowAsyncResponse

Parameters:

  • execution_id (String) —

    The ID of the workflow execution.

  • additional_properties (OpenStruct) (defaults to: nil) —

    Additional properties unmapped to the current class definition



21
22
23
24
25
 
# File 'lib/vellum_ai/types/execute_workflow_async_response.rb', line 21

def initialize(execution_id:, additional_properties: nil)
  @execution_id = execution_id
  @additional_properties = additional_properties
  @_field_set = { "execution_id": execution_id }
end

Instance Attribute Details

#additional_properties ⇒ OpenStruct (readonly)

Returns Additional properties unmapped to the current class definition.

Returns:

  • (OpenStruct) —

    Additional properties unmapped to the current class definition



11
12
13
 
# File 'lib/vellum_ai/types/execute_workflow_async_response.rb', line 11

def additional_properties
  @additional_properties
end

#execution_id ⇒ String (readonly)

Returns The ID of the workflow execution.

Returns:

  • (String) —

    The ID of the workflow execution.



9
10
11
 
# File 'lib/vellum_ai/types/execute_workflow_async_response.rb', line 9

def execution_id
  @execution_id
end

Class Method Details

.from_json(json_object:) ⇒ Vellum::ExecuteWorkflowAsyncResponse

Parameters:

  • json_object (String)

Returns:



30
31
32
33
34
35
 
# File 'lib/vellum_ai/types/execute_workflow_async_response.rb', line 30

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  execution_id = parsed_json["execution_id"]
  new(execution_id: execution_id, additional_properties: struct)
end

.validate_raw(obj:) ⇒ Void

Parameters:

  • obj (Object)

Returns:

  • (Void) 


48
49
50
 
# File 'lib/vellum_ai/types/execute_workflow_async_response.rb', line 48

def self.validate_raw(obj:)
  obj.execution_id.is_a?(String) != false || raise("Passed value for field obj.execution_id is not the expected type, validation failed.")
end

Instance Method Details

#to_json ⇒ String

Returns:

  • (String) 


39
40
41
 
# File 'lib/vellum_ai/types/execute_workflow_async_response.rb', line 39

def to_json
  @_field_set&.to_json
end