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.

• #delay_window ⇒ Float^?

  The delay window in seconds.

• #description ⇒ Object^?

  The test description.

• #evaluation_window ⇒ Float^?

  The evaluation window in seconds.

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

• #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(description: , name: , subtype: , thresholds: , type: , archived: nil, delay_window: nil, evaluation_window: 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(description: , name: , subtype: , thresholds: , type: , archived: nil, delay_window: nil, evaluation_window: 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:

• description (Object, nil) (defaults to: ) —

  The test description.

• name (String) (defaults to: ) —

  The test name.

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

  The test subtype.

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

  The test type.

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

  Whether the test is archived.

• 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

• 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 92

Instance Attribute Details

#archived ⇒ Boolean^?

Whether the test is archived.

Returns:

• (Boolean, nil)

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

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

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

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 15

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 58

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

#name ⇒ String

The test name.

Returns:

• (String)

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

required :name, 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 27

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 32

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 39

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 64

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 70

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 76

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 82

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 88

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 170