Class: Vellum::WorkspaceRead

Inherits:
Object
  • Object
show all
Defined in:
lib/vellum_ai/types/workspace_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:, created:, additional_properties: nil) ⇒ Vellum::WorkspaceRead

Parameters:

  • id (String)
  • name (String) —

    The name of the Workspace.

  • label (String)
  • created (DateTime)
  • additional_properties (OpenStruct) (defaults to: nil) —

    Additional properties unmapped to the current class definition



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

def initialize(id:, name:, label:, created:, additional_properties: nil)
  @id = id
  @name = name
  @label = label
  @created = created
  @additional_properties = additional_properties
  @_field_set = { "id": id, "name": name, "label": label, "created": created }
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



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

def additional_properties
  @additional_properties
end

#created ⇒ DateTime (readonly)

Returns:

  • (DateTime) 


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

def created
  @created
end

#id ⇒ String (readonly)

Returns:

  • (String) 


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

def id
  @id
end

#label ⇒ String (readonly)

Returns:

  • (String) 


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

def label
  @label
end

#name ⇒ String (readonly)

Returns The name of the Workspace.

Returns:

  • (String) —

    The name of the Workspace.



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

def name
  @name
end

Class Method Details

.from_json(json_object:) ⇒ Vellum::WorkspaceRead

Parameters:

  • json_object (String)

Returns:



42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/vellum_ai/types/workspace_read.rb', line 42

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"]
  created = unless parsed_json["created"].nil?
  DateTime.parse(parsed_json["created"])
else
  nil
end
  new(
    id: id,
    name: name,
    label: label,
    created: created,
    additional_properties: struct
  )
end

.validate_raw(obj:) ⇒ Void

Parameters:

  • obj (Object)

Returns:

  • (Void) 


73
74
75
76
77
78
 
# File 'lib/vellum_ai/types/workspace_read.rb', line 73

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.created.is_a?(DateTime) != false || raise("Passed value for field obj.created is not the expected type, validation failed.")
end

Instance Method Details

#to_json ⇒ String

Returns:

  • (String) 


64
65
66
 
# File 'lib/vellum_ai/types/workspace_read.rb', line 64

def to_json
  @_field_set&.to_json
end