Class: Vellum::WorkflowDeploymentRead

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

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(id:, name:, label:, status: OMIT, environment: OMIT, created:, last_deployed_on:, last_deployed_history_item_id:, input_variables:, output_variables:, description: OMIT, additional_properties: nil) ⇒ Vellum::WorkflowDeploymentRead

Parameters:

  • description (String) (defaults to: OMIT) —

    A human-readable description of the workflow deployment

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

    Additional properties unmapped to the current class definition



71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/vellum_ai/types/workflow_deployment_read.rb', line 71

def initialize(id:, name:, label:, status: OMIT, environment: OMIT, created:, last_deployed_on:, last_deployed_history_item_id:, input_variables:, output_variables:, description: OMIT, additional_properties: nil)
  @id = id
  @name = name
  @label = label
  @status = status if status != OMIT
  @environment = environment if environment != OMIT
  @created = created
  @last_deployed_on = last_deployed_on
  @last_deployed_history_item_id = last_deployed_history_item_id
  @input_variables = input_variables
  @output_variables = output_variables
  @description = description if description != OMIT
  @additional_properties = additional_properties
  @_field_set = { "id": id, "name": name, "label": label, "status": status, "environment": environment, "created": created, "last_deployed_on": last_deployed_on, "last_deployed_history_item_id": last_deployed_history_item_id, "input_variables": input_variables, "output_variables": output_variables, "description": description }.reject do | _k, v |
  v == OMIT
end
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



43
44
45
 
# File 'lib/vellum_ai/types/workflow_deployment_read.rb', line 43

def additional_properties
  @additional_properties
end

#created ⇒ DateTime (readonly)

Returns:

  • (DateTime) 


28
29
30
 
# File 'lib/vellum_ai/types/workflow_deployment_read.rb', line 28

def created
  @created
end

#description ⇒ String (readonly)

Returns A human-readable description of the workflow deployment.

Returns:

  • (String) —

    A human-readable description of the workflow deployment



41
42
43
 
# File 'lib/vellum_ai/types/workflow_deployment_read.rb', line 41

def description
  @description
end

#environment ⇒ Object (readonly)

  • ‘PRODUCTION` - Production



26
27
28
 
# File 'lib/vellum_ai/types/workflow_deployment_read.rb', line 26

def environment
  @environment
end

#id ⇒ String (readonly)

Returns:

  • (String) 


13
14
15
 
# File 'lib/vellum_ai/types/workflow_deployment_read.rb', line 13

def id
  @id
end

#input_variables ⇒ Object (readonly)

it is executed.



36
37
38
 
# File 'lib/vellum_ai/types/workflow_deployment_read.rb', line 36

def input_variables
  @input_variables
end

#label ⇒ String (readonly)

Returns A human-readable label for the workflow deployment.

Returns:

  • (String) —

    A human-readable label for the workflow deployment



17
18
19
 
# File 'lib/vellum_ai/types/workflow_deployment_read.rb', line 17

def label
  @label
end

#last_deployed_history_item_id ⇒ Object (readonly)

Release Tag



33
34
35
 
# File 'lib/vellum_ai/types/workflow_deployment_read.rb', line 33

def last_deployed_history_item_id
  @last_deployed_history_item_id
end

#last_deployed_on ⇒ DateTime (readonly)

Returns:

  • (DateTime) 


30
31
32
 
# File 'lib/vellum_ai/types/workflow_deployment_read.rb', line 30

def last_deployed_on
  @last_deployed_on
end

#name ⇒ String (readonly)

Returns A name that uniquely identifies this workflow deployment within its workspace.

Returns:

  • (String) —

    A name that uniquely identifies this workflow deployment within its workspace



15
16
17
 
# File 'lib/vellum_ai/types/workflow_deployment_read.rb', line 15

def name
  @name
end

#output_variables ⇒ Object (readonly)

executed.



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

def output_variables
  @output_variables
end

#status ⇒ Object (readonly)

  • ‘ARCHIVED` - Archived



21
22
23
 
# File 'lib/vellum_ai/types/workflow_deployment_read.rb', line 21

def status
  @status
end

Class Method Details

.from_json(json_object:) ⇒ Vellum::WorkflowDeploymentRead

Parameters:

  • json_object (String)

Returns:



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/vellum_ai/types/workflow_deployment_read.rb', line 92

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  id = parsed_json["id"]
  name = parsed_json["name"]
  label = parsed_json["label"]
  status = parsed_json["status"]
  environment = parsed_json["environment"]
  created = unless parsed_json["created"].nil?
  DateTime.parse(parsed_json["created"])
else
  nil
end
  last_deployed_on = unless parsed_json["last_deployed_on"].nil?
  DateTime.parse(parsed_json["last_deployed_on"])
else
  nil
end
  last_deployed_history_item_id = parsed_json["last_deployed_history_item_id"]
  input_variables = parsed_json["input_variables"]&.map do | item |
  item = item.to_json
  Vellum::VellumVariable.from_json(json_object: item)
end
  output_variables = parsed_json["output_variables"]&.map do | item |
  item = item.to_json
  Vellum::VellumVariable.from_json(json_object: item)
end
  description = parsed_json["description"]
  new(
    id: id,
    name: name,
    label: label,
    status: status,
    environment: environment,
    created: created,
    last_deployed_on: last_deployed_on,
    last_deployed_history_item_id: last_deployed_history_item_id,
    input_variables: input_variables,
    output_variables: output_variables,
    description: description,
    additional_properties: struct
  )
end

.validate_raw(obj:) ⇒ Void

Parameters:

  • obj (Object)

Returns:

  • (Void) 


147
148
149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/vellum_ai/types/workflow_deployment_read.rb', line 147

def self.validate_raw(obj:)
  obj.id.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
  obj.name.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
  obj.label.is_a?(String) != false || raise("Passed value for field obj.label is not the expected type, validation failed.")
  obj.status&.is_a?(Vellum::EntityStatus) != false || raise("Passed value for field obj.status is not the expected type, validation failed.")
  obj.environment&.is_a?(Vellum::EnvironmentEnum) != false || raise("Passed value for field obj.environment is not the expected type, validation failed.")
  obj.created.is_a?(DateTime) != false || raise("Passed value for field obj.created is not the expected type, validation failed.")
  obj.last_deployed_on.is_a?(DateTime) != false || raise("Passed value for field obj.last_deployed_on is not the expected type, validation failed.")
  obj.last_deployed_history_item_id.is_a?(String) != false || raise("Passed value for field obj.last_deployed_history_item_id is not the expected type, validation failed.")
  obj.input_variables.is_a?(Array) != false || raise("Passed value for field obj.input_variables is not the expected type, validation failed.")
  obj.output_variables.is_a?(Array) != false || raise("Passed value for field obj.output_variables is not the expected type, validation failed.")
  obj.description&.is_a?(String) != false || raise("Passed value for field obj.description is not the expected type, validation failed.")
end

Instance Method Details

#to_json ⇒ String

Returns:

  • (String) 


138
139
140
 
# File 'lib/vellum_ai/types/workflow_deployment_read.rb', line 138

def to_json
  @_field_set&.to_json
end