Class: Openlayer::Models::Projects::TestCreateResponse

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/openlayer/models/projects/test_create_response.rb,
sig/openlayer/models/projects/test_create_response.rbs

Overview

See Also:

  • Openlayer::Resources::Projects::Tests#create

Defined Under Namespace

Modules: Subtype, Type Classes: Threshold

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(id:, comment_count:, creator_id:, date_archived:, date_created:, date_updated:, description:, name:, number:, origin_project_version_id:, subtype:, suggested:, thresholds:, type:, archived: nil, default_to_all_pipelines: nil, delay_window: nil, evaluation_window: nil, exclude_pipelines: nil, include_historical_data: nil, include_pipelines: nil, uses_ml_model: nil, uses_production_data: nil, uses_reference_dataset: nil, uses_training_dataset: nil, uses_validation_dataset: nil) ⇒ Object

Some parameter documentations has been truncated, see Openlayer::Models::Projects::TestCreateResponse for more details.

Parameters:

  • id (String) —

    The test id.

  • comment_count (Integer) —

    The number of comments on the test.

  • creator_id (String, nil) —

    The test creator id.

  • date_archived (Time, nil) —

    The date the test was archived.

  • date_created (Time) —

    The creation date.

  • date_updated (Time) —

    The last updated date.

  • description (Object, nil) —

    The test description.

  • name (String) —

    The test name.

  • number (Integer) —

    The test number.

  • origin_project_version_id (String, nil) —

    The project version (commit) id where the test was created.

  • subtype (Symbol, Openlayer::Models::Projects::TestCreateResponse::Subtype) —

    The test subtype.

  • suggested (Boolean) —

    Whether the test is suggested or user-created.

  • thresholds (Array<Openlayer::Models::Projects::TestCreateResponse::Threshold>)
  • type (Symbol, Openlayer::Models::Projects::TestCreateResponse::Type) —

    The test type.

  • archived (Boolean) (defaults to: nil) —

    Whether the test is archived.

  • default_to_all_pipelines (Boolean, nil) (defaults to: nil) —

    Whether to apply the test to all pipelines (data sources) or to a specific set o

  • delay_window (Float, nil) (defaults to: nil) —

    The delay window in seconds. Only applies to tests that use production data.

  • evaluation_window (Float, nil) (defaults to: nil) —

    The evaluation window in seconds. Only applies to tests that use production data

  • exclude_pipelines (Array<String>, nil) (defaults to: nil) —

    Array of pipelines (data sources) to which the test should not be applied. Only

  • include_historical_data (Boolean, nil) (defaults to: nil) —

    Whether to include historical data in the test result. Only applies to tests tha

  • include_pipelines (Array<String>, nil) (defaults to: nil) —

    Array of pipelines (data sources) to which the test should be applied. Only appl

  • uses_ml_model (Boolean) (defaults to: nil) —

    Whether the test uses an ML model.

  • uses_production_data (Boolean) (defaults to: nil) —

    Whether the test uses production data (monitoring mode only).

  • uses_reference_dataset (Boolean) (defaults to: nil) —

    Whether the test uses a reference dataset (monitoring mode only).

  • uses_training_dataset (Boolean) (defaults to: nil) —

    Whether the test uses a training dataset.

  • uses_validation_dataset (Boolean) (defaults to: nil) —

    Whether the test uses a validation dataset.




# File 'lib/openlayer/models/projects/test_create_response.rb', line 185

Instance Attribute Details

#archived ⇒ Boolean?

Whether the test is archived.

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


42
 
# File 'lib/openlayer/models/projects/test_create_response.rb', line 42

optional :archived, Openlayer::Internal::Type::Boolean

#comment_count ⇒ Integer

Returns the value of attribute comment_count.

Returns:

  • (Integer) 


83
84
85
 
# File 'sig/openlayer/models/projects/test_create_response.rbs', line 83

def comment_count
  @comment_count
end

#creator_id ⇒ String?

Returns the value of attribute creator_id.

Returns:

  • (String, nil) 


85
86
87
 
# File 'sig/openlayer/models/projects/test_create_response.rbs', line 85

def creator_id
  @creator_id
end

#date_archived ⇒ Time?

Returns the value of attribute date_archived.

Returns:

  • (Time, nil) 


87
88
89
 
# File 'sig/openlayer/models/projects/test_create_response.rbs', line 87

def date_archived
  @date_archived
end

#date_created ⇒ Time

Returns the value of attribute date_created.

Returns:

  • (Time) 


89
90
91
 
# File 'sig/openlayer/models/projects/test_create_response.rbs', line 89

def date_created
  @date_created
end

#date_updated ⇒ Time

Returns the value of attribute date_updated.

Returns:

  • (Time) 


91
92
93
 
# File 'sig/openlayer/models/projects/test_create_response.rbs', line 91

def date_updated
  @date_updated
end

#default_to_all_pipelines ⇒ Boolean?

Whether to apply the test to all pipelines (data sources) or to a specific set of pipelines. Only applies to tests that use production data.

Parameters:

  • value (Boolean, nil)

Returns:

  • (Boolean, nil) 


49
50
51
52
 
# File 'lib/openlayer/models/projects/test_create_response.rb', line 49

optional :default_to_all_pipelines,
Openlayer::Internal::Type::Boolean,
api_name: :defaultToAllPipelines,
nil?: true

#delay_window ⇒ Float?

The delay window in seconds. Only applies to tests that use production data.

Parameters:

  • value (Float, nil)

Returns:

  • (Float, nil) 


58
 
# File 'lib/openlayer/models/projects/test_create_response.rb', line 58

optional :delay_window, Float, api_name: :delayWindow, nil?: true

#description ⇒ Object?

The test description.

Parameters:

  • value (top, nil)

Returns:

  • (Object, nil) 


12
 
# File 'lib/openlayer/models/projects/test_create_response.rb', line 12

required :description, Openlayer::Internal::Type::Unknown, nil?: true

#evaluation_window ⇒ Float?

The evaluation window in seconds. Only applies to tests that use production data.

Parameters:

  • value (Float, nil)

Returns:

  • (Float, nil) 


65
 
# File 'lib/openlayer/models/projects/test_create_response.rb', line 65

optional :evaluation_window, Float, api_name: :evaluationWindow, nil?: true

#exclude_pipelines ⇒ Array<String>?

Array of pipelines (data sources) to which the test should not be applied. Only applies to tests that use production data.

Parameters:

  • value (::Array[String], nil)

Returns:

  • (Array<String>, nil) 


72
73
74
75
 
# File 'lib/openlayer/models/projects/test_create_response.rb', line 72

optional :exclude_pipelines,
Openlayer::Internal::Type::ArrayOf[String],
api_name: :excludePipelines,
nil?: true

#id ⇒ String

Returns the value of attribute id.

Returns:

  • (String) 


81
82
83
 
# File 'sig/openlayer/models/projects/test_create_response.rbs', line 81

def id
  @id
end

#include_historical_data ⇒ Boolean?

Whether to include historical data in the test result. Only applies to tests that use production data.

Parameters:

  • value (Boolean, nil)

Returns:

  • (Boolean, nil) 


82
83
84
85
 
# File 'lib/openlayer/models/projects/test_create_response.rb', line 82

optional :include_historical_data,
Openlayer::Internal::Type::Boolean,
api_name: :includeHistoricalData,
nil?: true

#include_pipelines ⇒ Array<String>?

Array of pipelines (data sources) to which the test should be applied. Only applies to tests that use production data.

Parameters:

  • value (::Array[String], nil)

Returns:

  • (Array<String>, nil) 


92
93
94
95
 
# File 'lib/openlayer/models/projects/test_create_response.rb', line 92

optional :include_pipelines,
Openlayer::Internal::Type::ArrayOf[String],
api_name: :includePipelines,
nil?: true

#name ⇒ String

The test name.

Parameters:

  • value (String)

Returns:

  • (String) 


18
 
# File 'lib/openlayer/models/projects/test_create_response.rb', line 18

required :name, String

#number ⇒ Integer

Returns the value of attribute number.

Returns:

  • (Integer) 


93
94
95
 
# File 'sig/openlayer/models/projects/test_create_response.rbs', line 93

def number
  @number
end

#origin_project_version_id ⇒ String?

Returns the value of attribute origin_project_version_id.

Returns:

  • (String, nil) 


95
96
97
 
# File 'sig/openlayer/models/projects/test_create_response.rbs', line 95

def origin_project_version_id
  @origin_project_version_id
end

#subtype ⇒ Symbol, Openlayer::Models::Projects::TestCreateResponse::Subtype

The test subtype.

Parameters:

  • value (Openlayer::Models::Projects::TestCreateResponse::subtype)

Returns:



24
 
# File 'lib/openlayer/models/projects/test_create_response.rb', line 24

required :subtype, enum: -> { Openlayer::Models::Projects::TestCreateResponse::Subtype }

#suggested ⇒ Boolean

Returns the value of attribute suggested.

Returns:

  • (Boolean) 


97
98
99
 
# File 'sig/openlayer/models/projects/test_create_response.rbs', line 97

def suggested
  @suggested
end

#thresholds ⇒ Array<Openlayer::Models::Projects::TestCreateResponse::Threshold>

Parameters:

Returns:



29
30
 
# File 'lib/openlayer/models/projects/test_create_response.rb', line 29

required :thresholds,
-> { Openlayer::Internal::Type::ArrayOf[Openlayer::Models::Projects::TestCreateResponse::Threshold] }

#type ⇒ Symbol, Openlayer::Models::Projects::TestCreateResponse::Type

The test type.

Parameters:

  • value (Openlayer::Models::Projects::TestCreateResponse::type_)

Returns:



36
 
# File 'lib/openlayer/models/projects/test_create_response.rb', line 36

required :type, enum: -> { Openlayer::Models::Projects::TestCreateResponse::Type }

#uses_ml_model ⇒ Boolean?

Whether the test uses an ML model.

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


101
 
# File 'lib/openlayer/models/projects/test_create_response.rb', line 101

optional :uses_ml_model, Openlayer::Internal::Type::Boolean, api_name: :usesMlModel

#uses_production_data ⇒ Boolean?

Whether the test uses production data (monitoring mode only).

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


107
 
# File 'lib/openlayer/models/projects/test_create_response.rb', line 107

optional :uses_production_data, Openlayer::Internal::Type::Boolean, api_name: :usesProductionData

#uses_reference_dataset ⇒ Boolean?

Whether the test uses a reference dataset (monitoring mode only).

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


113
 
# File 'lib/openlayer/models/projects/test_create_response.rb', line 113

optional :uses_reference_dataset, Openlayer::Internal::Type::Boolean, api_name: :usesReferenceDataset

#uses_training_dataset ⇒ Boolean?

Whether the test uses a training dataset.

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


119
 
# File 'lib/openlayer/models/projects/test_create_response.rb', line 119

optional :uses_training_dataset, Openlayer::Internal::Type::Boolean, api_name: :usesTrainingDataset

#uses_validation_dataset ⇒ Boolean?

Whether the test uses a validation dataset.

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


125
126
127
 
# File 'lib/openlayer/models/projects/test_create_response.rb', line 125

optional :uses_validation_dataset,
Openlayer::Internal::Type::Boolean,
api_name: :usesValidationDataset

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/openlayer/models/projects/test_create_response.rb', line 289

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


128
 
# File 'sig/openlayer/models/projects/test_create_response.rbs', line 128

def to_hash: -> {