Class: Vellum::TestSuiteRunDeploymentReleaseTagExecConfig

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

Overview

Execution configuration for running a Test Suite against a Prompt Deployment

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(data:, test_case_ids: nil, additional_properties: nil) ⇒ TestSuiteRunDeploymentReleaseTagExecConfig

Parameters:

  • data (TestSuiteRunDeploymentReleaseTagExecConfigData)
  • test_case_ids (Array<String>) (defaults to: nil) —

    Optionally specify a subset of test case ids to run. If not provided, all test cases within the test suite will be run by default.

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

    Additional properties unmapped to the current class definition



15
16
17
18
19
20
21
22
 
# File 'lib/vellum_ai/types/test_suite_run_deployment_release_tag_exec_config.rb', line 15

def initialize(data:, test_case_ids: nil, additional_properties: nil)
  # @type [TestSuiteRunDeploymentReleaseTagExecConfigData]
  @data = data
  # @type [Array<String>] Optionally specify a subset of test case ids to run. If not provided, all test cases within the test suite will be run by default.
  @test_case_ids = test_case_ids
  # @type [OpenStruct] Additional properties unmapped to the current class definition
  @additional_properties = additional_properties
end

Instance Attribute Details

#additional_properties ⇒ Object (readonly)

Returns the value of attribute additional_properties.



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

def additional_properties
  @additional_properties
end

#data ⇒ Object (readonly)

Returns the value of attribute data.



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

def data
  @data
end

#test_case_ids ⇒ Object (readonly)

Returns the value of attribute test_case_ids.



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

def test_case_ids
  @test_case_ids
end

Class Method Details

.from_json(json_object:) ⇒ TestSuiteRunDeploymentReleaseTagExecConfig

Deserialize a JSON object to an instance of TestSuiteRunDeploymentReleaseTagExecConfig

Parameters:

  • json_object (JSON)

Returns:



28
29
30
31
32
33
34
35
36
37
38
39
 
# File 'lib/vellum_ai/types/test_suite_run_deployment_release_tag_exec_config.rb', line 28

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  if parsed_json["data"].nil?
    data = nil
  else
    data = parsed_json["data"].to_json
    data = TestSuiteRunDeploymentReleaseTagExecConfigData.from_json(json_object: data)
  end
  test_case_ids = struct.test_case_ids
  new(data: data, test_case_ids: test_case_ids, additional_properties: struct)
end

.validate_raw(obj:) ⇒ Void

Leveraged for Union-type generation, validate_raw attempts to parse the given hash and check each fields type against the current object’s property definitions.

Parameters:

  • obj (Object)

Returns:

  • (Void) 


52
53
54
55
 
# File 'lib/vellum_ai/types/test_suite_run_deployment_release_tag_exec_config.rb', line 52

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

Instance Method Details

#to_json(*_args) ⇒ JSON

Serialize an instance of TestSuiteRunDeploymentReleaseTagExecConfig to a JSON object

Returns:

  • (JSON) 


44
45
46
 
# File 'lib/vellum_ai/types/test_suite_run_deployment_release_tag_exec_config.rb', line 44

def to_json(*_args)
  { "data": @data, "test_case_ids": @test_case_ids }.to_json
end