Class: Openlayer::Models::Projects::TestCreateParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Openlayer::Models::Projects::TestCreateParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/openlayer/models/projects/test_create_params.rb

Overview

See Also:

• Resources::Projects::Tests#create

Defined Under Namespace

Modules: Subtype, Type Classes: Threshold

Instance Attribute Summary

• #archived ⇒ Boolean^?

  Whether the test is archived.

• #default_to_all_pipelines ⇒ Boolean^?

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

• #delay_window ⇒ Float^?

  The delay window in seconds.

• #description ⇒ Object^?

  The test description.

• #evaluation_window ⇒ Float^?

  The evaluation window in seconds.

• #exclude_pipelines ⇒ Array<String>^?

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

• #include_historical_data ⇒ Boolean^?

  Whether to include historical data in the test result.

• #include_pipelines ⇒ Array<String>^?

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

• #name ⇒ String

  The test name.

• #project_id ⇒ String
• #subtype ⇒ Symbol, Openlayer::Models::Projects::TestCreateParams::Subtype

  The test subtype.

• #thresholds ⇒ Array<Openlayer::Models::Projects::TestCreateParams::Threshold>
• #type ⇒ Symbol, Openlayer::Models::Projects::TestCreateParams::Type

  The test type.

• #uses_ml_model ⇒ Boolean^?

  Whether the test uses an ML model.

• #uses_production_data ⇒ Boolean^?

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

• #uses_reference_dataset ⇒ Boolean^?

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

• #uses_training_dataset ⇒ Boolean^?

  Whether the test uses a training dataset.

• #uses_validation_dataset ⇒ Boolean^?

  Whether the test uses a validation dataset.

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(project_id:, description:, name:, subtype:, 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, request_options: {}) ⇒ Object constructor

  Some parameter documentations has been truncated, see TestCreateParams for more details.

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

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(project_id:, description:, name:, subtype:, 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, request_options: {}) ⇒ Object

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

Parameters:

• project_id (String)
• description (Object, nil) —

  The test description.

• name (String) —

  The test name.

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

  The test subtype.

• thresholds (Array<Openlayer::Models::Projects::TestCreateParams::Threshold>)
• type (Symbol, Openlayer::Models::Projects::TestCreateParams::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.

• request_options (Openlayer::RequestOptions, Hash{Symbol=>Object}) (defaults to: {})

# File 'lib/openlayer/models/projects/test_create_params.rb', line 137

Instance Attribute Details

#archived ⇒ Boolean^?

Whether the test is archived.

Returns:

• (Boolean, nil)

# File 'lib/openlayer/models/projects/test_create_params.rb', line 50

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

#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.

Returns:

• (Boolean, nil)

# File 'lib/openlayer/models/projects/test_create_params.rb', line 57

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.

Returns:

• (Float, nil)

# File 'lib/openlayer/models/projects/test_create_params.rb', line 66

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

#description ⇒ Object^?

The test description.

Returns:

• (Object, nil)

# File 'lib/openlayer/models/projects/test_create_params.rb', line 20

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

#evaluation_window ⇒ Float^?

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

Returns:

• (Float, nil)

# File 'lib/openlayer/models/projects/test_create_params.rb', line 73

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.

Returns:

• (Array<String>, nil)

# File 'lib/openlayer/models/projects/test_create_params.rb', line 80

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

#include_historical_data ⇒ Boolean^?

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

Returns:

• (Boolean, nil)

# File 'lib/openlayer/models/projects/test_create_params.rb', line 90

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.

Returns:

• (Array<String>, nil)

# File 'lib/openlayer/models/projects/test_create_params.rb', line 100

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

#name ⇒ String

The test name.

Returns:

• (String)

# File 'lib/openlayer/models/projects/test_create_params.rb', line 26

required :name, String

#project_id ⇒ String

Returns:

• (String)

# File 'lib/openlayer/models/projects/test_create_params.rb', line 14

required :project_id, String

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

The test subtype.

Returns:

• (Symbol, Openlayer::Models::Projects::TestCreateParams::Subtype)

# File 'lib/openlayer/models/projects/test_create_params.rb', line 32

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

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

Returns:

• (Array<Openlayer::Models::Projects::TestCreateParams::Threshold>)

# File 'lib/openlayer/models/projects/test_create_params.rb', line 37

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

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

The test type.

Returns:

• (Symbol, Openlayer::Models::Projects::TestCreateParams::Type)

# File 'lib/openlayer/models/projects/test_create_params.rb', line 44

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

#uses_ml_model ⇒ Boolean^?

Whether the test uses an ML model.

Returns:

• (Boolean, nil)

# File 'lib/openlayer/models/projects/test_create_params.rb', line 109

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

#uses_production_data ⇒ Boolean^?

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

Returns:

• (Boolean, nil)

# File 'lib/openlayer/models/projects/test_create_params.rb', line 115

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).

Returns:

• (Boolean, nil)

# File 'lib/openlayer/models/projects/test_create_params.rb', line 121

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

#uses_training_dataset ⇒ Boolean^?

Whether the test uses a training dataset.

Returns:

• (Boolean, nil)

# File 'lib/openlayer/models/projects/test_create_params.rb', line 127

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

#uses_validation_dataset ⇒ Boolean^?

Whether the test uses a validation dataset.

Returns:

• (Boolean, nil)

# File 'lib/openlayer/models/projects/test_create_params.rb', line 133

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_params.rb', line 225