Class: Openlayer::Models::Commits::TestResultListResponse::Item

Inherits:

Internal::Type::BaseModel

Object
Internal::Type::BaseModel
Openlayer::Models::Commits::TestResultListResponse::Item

show all

Defined in:: lib/openlayer/models/commits/test_result_list_response.rb

Defined Under Namespace

Modules: Status Classes: ExpectedValue, Goal, RowsBody

Instance Attribute Summary collapse

#expected_values ⇒ Array<Openlayer::Models::Commits::TestResultListResponse::Item::ExpectedValue>^?
#goal ⇒ Openlayer::Models::Commits::TestResultListResponse::Item::Goal^?
#rows ⇒ String^?

The URL to the rows of the test result.
#rows_body ⇒ Openlayer::Models::Commits::TestResultListResponse::Item::RowsBody^?

The body of the rows request.
#status ⇒ Symbol, Openlayer::Models::Commits::TestResultListResponse::Item::Status

The status of the test.
#status_message ⇒ String^?

The status message.

Class Method Summary collapse

.values ⇒ Array<Symbol>

Instance Method Summary collapse

#initialize(lower_threshold: nil, measurement: nil, upper_threshold: nil) ⇒ Object constructor

Constructor Details

#initialize(lower_threshold: nil, measurement: nil, upper_threshold: nil) ⇒ `Object`

Parameters:

lower_threshold (Float, nil) (defaults to: nil) —

the lower threshold for the expected value
measurement (String) (defaults to: nil) —

One of the ‘measurement` values in the test’s thresholds
upper_threshold (Float, nil) (defaults to: nil) —

The upper threshold for the expected value

# File 'lib/openlayer/models/commits/test_result_list_response.rb', line 17

class Item < Openlayer::Internal::Type::BaseModel
  # @!attribute status
  #   The status of the test.
  #
  #   @return [Symbol, Openlayer::Models::Commits::TestResultListResponse::Item::Status]
  required :status, enum: -> { Openlayer::Models::Commits::TestResultListResponse::Item::Status }

  # @!attribute status_message
  #   The status message.
  #
  #   @return [String, nil]
  required :status_message, String, api_name: :statusMessage, nil?: true

  # @!attribute expected_values
  #
  #   @return [Array<Openlayer::Models::Commits::TestResultListResponse::Item::ExpectedValue>, nil]
  optional :expected_values,
           -> { Openlayer::Internal::Type::ArrayOf[Openlayer::Models::Commits::TestResultListResponse::Item::ExpectedValue] },
           api_name: :expectedValues

  # @!attribute goal
  #
  #   @return [Openlayer::Models::Commits::TestResultListResponse::Item::Goal, nil]
  optional :goal, -> { Openlayer::Models::Commits::TestResultListResponse::Item::Goal }

  # @!attribute rows
  #   The URL to the rows of the test result.
  #
  #   @return [String, nil]
  optional :rows, String

  # @!attribute rows_body
  #   The body of the rows request.
  #
  #   @return [Openlayer::Models::Commits::TestResultListResponse::Item::RowsBody, nil]
  optional :rows_body,
           -> { Openlayer::Models::Commits::TestResultListResponse::Item::RowsBody },
           api_name: :rowsBody,
           nil?: true

  response_only do
    # @!attribute id
    #   Project version (commit) id.
    #
    #   @return [String]
    required :id, String

    # @!attribute date_created
    #   The creation date.
    #
    #   @return [Time]
    required :date_created, Time, api_name: :dateCreated

    # @!attribute date_data_ends
    #   The data end date.
    #
    #   @return [Time, nil]
    required :date_data_ends, Time, api_name: :dateDataEnds, nil?: true

    # @!attribute date_data_starts
    #   The data start date.
    #
    #   @return [Time, nil]
    required :date_data_starts, Time, api_name: :dateDataStarts, nil?: true

    # @!attribute date_updated
    #   The last updated date.
    #
    #   @return [Time]
    required :date_updated, Time, api_name: :dateUpdated

    # @!attribute inference_pipeline_id
    #   The inference pipeline id.
    #
    #   @return [String, nil]
    required :inference_pipeline_id, String, api_name: :inferencePipelineId, nil?: true

    # @!attribute project_version_id
    #   The project version (commit) id.
    #
    #   @return [String, nil]
    required :project_version_id, String, api_name: :projectVersionId, nil?: true

    # @!attribute goal_id
    #   The test id.
    #
    #   @return [String, nil]
    optional :goal_id, String, api_name: :goalId, nil?: true
  end

  # @!method initialize(id:, date_created:, date_data_ends:, date_data_starts:, date_updated:, inference_pipeline_id:, project_version_id:, status:, status_message:, expected_values: nil, goal: nil, goal_id: nil, rows: nil, rows_body: nil)
  #   @param id [String] Project version (commit) id.
  #
  #   @param date_created [Time] The creation date.
  #
  #   @param date_data_ends [Time, nil] The data end date.
  #
  #   @param date_data_starts [Time, nil] The data start date.
  #
  #   @param date_updated [Time] The last updated date.
  #
  #   @param inference_pipeline_id [String, nil] The inference pipeline id.
  #
  #   @param project_version_id [String, nil] The project version (commit) id.
  #
  #   @param status [Symbol, Openlayer::Models::Commits::TestResultListResponse::Item::Status] The status of the test.
  #
  #   @param status_message [String, nil] The status message.
  #
  #   @param expected_values [Array<Openlayer::Models::Commits::TestResultListResponse::Item::ExpectedValue>]
  #
  #   @param goal [Openlayer::Models::Commits::TestResultListResponse::Item::Goal]
  #
  #   @param goal_id [String, nil] The test id.
  #
  #   @param rows [String] The URL to the rows of the test result.
  #
  #   @param rows_body [Openlayer::Models::Commits::TestResultListResponse::Item::RowsBody, nil] The body of the rows request.

  # The status of the test.
  #
  # @see Openlayer::Models::Commits::TestResultListResponse::Item#status
  module Status
    extend Openlayer::Internal::Type::Enum

    RUNNING = :running
    PASSING = :passing
    FAILING = :failing
    SKIPPED = :skipped
    ERROR = :error

    # @!method self.values
    #   @return [Array<Symbol>]
  end

  class ExpectedValue < Openlayer::Internal::Type::BaseModel
    # @!attribute lower_threshold
    #   the lower threshold for the expected value
    #
    #   @return [Float, nil]
    optional :lower_threshold, Float, api_name: :lowerThreshold, nil?: true

    # @!attribute measurement
    #   One of the `measurement` values in the test's thresholds
    #
    #   @return [String, nil]
    optional :measurement, String

    # @!attribute upper_threshold
    #   The upper threshold for the expected value
    #
    #   @return [Float, nil]
    optional :upper_threshold, Float, api_name: :upperThreshold, nil?: true

    # @!method initialize(lower_threshold: nil, measurement: nil, upper_threshold: nil)
    #   @param lower_threshold [Float, nil] the lower threshold for the expected value
    #
    #   @param measurement [String] One of the `measurement` values in the test's thresholds
    #
    #   @param upper_threshold [Float, nil] The upper threshold for the expected value
  end

  # @see Openlayer::Models::Commits::TestResultListResponse::Item#goal
  class Goal < Openlayer::Internal::Type::BaseModel
    # @!attribute description
    #   The test description.
    #
    #   @return [Object, nil]
    required :description, Openlayer::Internal::Type::Unknown, nil?: true

    # @!attribute name
    #   The test name.
    #
    #   @return [String]
    required :name, String

    # @!attribute subtype
    #   The test subtype.
    #
    #   @return [Symbol, Openlayer::Models::Commits::TestResultListResponse::Item::Goal::Subtype]
    required :subtype, enum: -> { Openlayer::Models::Commits::TestResultListResponse::Item::Goal::Subtype }

    # @!attribute thresholds
    #
    #   @return [Array<Openlayer::Models::Commits::TestResultListResponse::Item::Goal::Threshold>]
    required :thresholds,
             -> { Openlayer::Internal::Type::ArrayOf[Openlayer::Models::Commits::TestResultListResponse::Item::Goal::Threshold] }

    # @!attribute type
    #   The test type.
    #
    #   @return [Symbol, Openlayer::Models::Commits::TestResultListResponse::Item::Goal::Type]
    required :type, enum: -> { Openlayer::Models::Commits::TestResultListResponse::Item::Goal::Type }

    # @!attribute archived
    #   Whether the test is archived.
    #
    #   @return [Boolean, nil]
    optional :archived, Openlayer::Internal::Type::Boolean

    # @!attribute delay_window
    #   The delay window in seconds. Only applies to tests that use production data.
    #
    #   @return [Float, nil]
    optional :delay_window, Float, api_name: :delayWindow, nil?: true

    # @!attribute evaluation_window
    #   The evaluation window in seconds. Only applies to tests that use production
    #   data.
    #
    #   @return [Float, nil]
    optional :evaluation_window, Float, api_name: :evaluationWindow, nil?: true

    # @!attribute uses_ml_model
    #   Whether the test uses an ML model.
    #
    #   @return [Boolean, nil]
    optional :uses_ml_model, Openlayer::Internal::Type::Boolean, api_name: :usesMlModel

    # @!attribute uses_production_data
    #   Whether the test uses production data (monitoring mode only).
    #
    #   @return [Boolean, nil]
    optional :uses_production_data, Openlayer::Internal::Type::Boolean, api_name: :usesProductionData

    # @!attribute uses_reference_dataset
    #   Whether the test uses a reference dataset (monitoring mode only).
    #
    #   @return [Boolean, nil]
    optional :uses_reference_dataset,
             Openlayer::Internal::Type::Boolean,
             api_name: :usesReferenceDataset

    # @!attribute uses_training_dataset
    #   Whether the test uses a training dataset.
    #
    #   @return [Boolean, nil]
    optional :uses_training_dataset,
             Openlayer::Internal::Type::Boolean,
             api_name: :usesTrainingDataset

    # @!attribute uses_validation_dataset
    #   Whether the test uses a validation dataset.
    #
    #   @return [Boolean, nil]
    optional :uses_validation_dataset,
             Openlayer::Internal::Type::Boolean,
             api_name: :usesValidationDataset

    response_only do
      # @!attribute id
      #   The test id.
      #
      #   @return [String]
      required :id, String

      # @!attribute comment_count
      #   The number of comments on the test.
      #
      #   @return [Integer]
      required :comment_count, Integer, api_name: :commentCount

      # @!attribute creator_id
      #   The test creator id.
      #
      #   @return [String, nil]
      required :creator_id, String, api_name: :creatorId, nil?: true

      # @!attribute date_archived
      #   The date the test was archived.
      #
      #   @return [Time, nil]
      required :date_archived, Time, api_name: :dateArchived, nil?: true

      # @!attribute date_created
      #   The creation date.
      #
      #   @return [Time]
      required :date_created, Time, api_name: :dateCreated

      # @!attribute date_updated
      #   The last updated date.
      #
      #   @return [Time]
      required :date_updated, Time, api_name: :dateUpdated

      # @!attribute number
      #   The test number.
      #
      #   @return [Integer]
      required :number, Integer

      # @!attribute origin_project_version_id
      #   The project version (commit) id where the test was created.
      #
      #   @return [String, nil]
      required :origin_project_version_id, String, api_name: :originProjectVersionId, nil?: true

      # @!attribute suggested
      #   Whether the test is suggested or user-created.
      #
      #   @return [Boolean]
      required :suggested, Openlayer::Internal::Type::Boolean
    end

    # @!method 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, 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)
    #   Some parameter documentations has been truncated, see
    #   {Openlayer::Models::Commits::TestResultListResponse::Item::Goal} for more
    #   details.
    #
    #   @param id [String] The test id.
    #
    #   @param comment_count [Integer] The number of comments on the test.
    #
    #   @param creator_id [String, nil] The test creator id.
    #
    #   @param date_archived [Time, nil] The date the test was archived.
    #
    #   @param date_created [Time] The creation date.
    #
    #   @param date_updated [Time] The last updated date.
    #
    #   @param description [Object, nil] The test description.
    #
    #   @param name [String] The test name.
    #
    #   @param number [Integer] The test number.
    #
    #   @param origin_project_version_id [String, nil] The project version (commit) id where the test was created.
    #
    #   @param subtype [Symbol, Openlayer::Models::Commits::TestResultListResponse::Item::Goal::Subtype] The test subtype.
    #
    #   @param suggested [Boolean] Whether the test is suggested or user-created.
    #
    #   @param thresholds [Array<Openlayer::Models::Commits::TestResultListResponse::Item::Goal::Threshold>]
    #
    #   @param type [Symbol, Openlayer::Models::Commits::TestResultListResponse::Item::Goal::Type] The test type.
    #
    #   @param archived [Boolean] Whether the test is archived.
    #
    #   @param delay_window [Float, nil] The delay window in seconds. Only applies to tests that use production data.
    #
    #   @param evaluation_window [Float, nil] The evaluation window in seconds. Only applies to tests that use production data
    #
    #   @param uses_ml_model [Boolean] Whether the test uses an ML model.
    #
    #   @param uses_production_data [Boolean] Whether the test uses production data (monitoring mode only).
    #
    #   @param uses_reference_dataset [Boolean] Whether the test uses a reference dataset (monitoring mode only).
    #
    #   @param uses_training_dataset [Boolean] Whether the test uses a training dataset.
    #
    #   @param uses_validation_dataset [Boolean] Whether the test uses a validation dataset.

    # The test subtype.
    #
    # @see Openlayer::Models::Commits::TestResultListResponse::Item::Goal#subtype
    module Subtype
      extend Openlayer::Internal::Type::Enum

      ANOMALOUS_COLUMN_COUNT = :anomalousColumnCount
      CHARACTER_LENGTH = :characterLength
      CLASS_IMBALANCE_RATIO = :classImbalanceRatio
      EXPECT_COLUMN_A_TO_BE_IN_COLUMN_B = :expectColumnAToBeInColumnB
      COLUMN_AVERAGE = :columnAverage
      COLUMN_DRIFT = :columnDrift
      COLUMN_STATISTIC = :columnStatistic
      COLUMN_VALUES_MATCH = :columnValuesMatch
      CONFLICTING_LABEL_ROW_COUNT = :conflictingLabelRowCount
      CONTAINS_PII = :containsPii
      CONTAINS_VALID_URL = :containsValidUrl
      CORRELATED_FEATURE_COUNT = :correlatedFeatureCount
      CUSTOM_METRIC_THRESHOLD = :customMetricThreshold
      DUPLICATE_ROW_COUNT = :duplicateRowCount
      EMPTY_FEATURE = :emptyFeature
      EMPTY_FEATURE_COUNT = :emptyFeatureCount
      DRIFTED_FEATURE_COUNT = :driftedFeatureCount
      FEATURE_MISSING_VALUES = :featureMissingValues
      FEATURE_VALUE_VALIDATION = :featureValueValidation
      GREAT_EXPECTATIONS = :greatExpectations
      GROUP_BY_COLUMN_STATS_CHECK = :groupByColumnStatsCheck
      ILL_FORMED_ROW_COUNT = :illFormedRowCount
      IS_CODE = :isCode
      IS_JSON = :isJson
      LLM_RUBRIC_THRESHOLD_V2 = :llmRubricThresholdV2
      LABEL_DRIFT = :labelDrift
      METRIC_THRESHOLD = :metricThreshold
      NEW_CATEGORY_COUNT = :newCategoryCount
      NEW_LABEL_COUNT = :newLabelCount
      NULL_ROW_COUNT = :nullRowCount
      ROW_COUNT = :rowCount
      PP_SCORE_VALUE_VALIDATION = :ppScoreValueValidation
      QUASI_CONSTANT_FEATURE = :quasiConstantFeature
      QUASI_CONSTANT_FEATURE_COUNT = :quasiConstantFeatureCount
      SQL_QUERY = :sqlQuery
      DTYPE_VALIDATION = :dtypeValidation
      SENTENCE_LENGTH = :sentenceLength
      SIZE_RATIO = :sizeRatio
      SPECIAL_CHARACTERS_RATIO = :specialCharactersRatio
      STRING_VALIDATION = :stringValidation
      TRAIN_VAL_LEAKAGE_ROW_COUNT = :trainValLeakageRowCount

      # @!method self.values
      #   @return [Array<Symbol>]
    end

    class Threshold < Openlayer::Internal::Type::BaseModel
      # @!attribute insight_name
      #   The insight name to be evaluated.
      #
      #   @return [Symbol, Openlayer::Models::Commits::TestResultListResponse::Item::Goal::Threshold::InsightName, nil]
      optional :insight_name,
               enum: -> { Openlayer::Models::Commits::TestResultListResponse::Item::Goal::Threshold::InsightName },
               api_name: :insightName

      # @!attribute insight_parameters
      #   The insight parameters. Required only for some test subtypes. For example, for
      #   tests that require a column name, the insight parameters will be [{'name':
      #   'column_name', 'value': 'Age'}]
      #
      #   @return [Array<Openlayer::Models::Commits::TestResultListResponse::Item::Goal::Threshold::InsightParameter>, nil]
      optional :insight_parameters,
               -> { Openlayer::Internal::Type::ArrayOf[Openlayer::Models::Commits::TestResultListResponse::Item::Goal::Threshold::InsightParameter] },
               api_name: :insightParameters,
               nil?: true

      # @!attribute measurement
      #   The measurement to be evaluated.
      #
      #   @return [String, nil]
      optional :measurement, String

      # @!attribute operator
      #   The operator to be used for the evaluation.
      #
      #   @return [Symbol, Openlayer::Models::Commits::TestResultListResponse::Item::Goal::Threshold::Operator, nil]
      optional :operator,
               enum: -> { Openlayer::Models::Commits::TestResultListResponse::Item::Goal::Threshold::Operator }

      # @!attribute threshold_mode
      #   Whether to use automatic anomaly detection or manual thresholds
      #
      #   @return [Symbol, Openlayer::Models::Commits::TestResultListResponse::Item::Goal::Threshold::ThresholdMode, nil]
      optional :threshold_mode,
               enum: -> { Openlayer::Models::Commits::TestResultListResponse::Item::Goal::Threshold::ThresholdMode },
               api_name: :thresholdMode

      # @!attribute value
      #   The value to be compared.
      #
      #   @return [Float, Boolean, String, Array<String>, nil]
      optional :value,
               union: -> { Openlayer::Models::Commits::TestResultListResponse::Item::Goal::Threshold::Value }

      # @!method initialize(insight_name: nil, insight_parameters: nil, measurement: nil, operator: nil, threshold_mode: nil, value: nil)
      #   Some parameter documentations has been truncated, see
      #   {Openlayer::Models::Commits::TestResultListResponse::Item::Goal::Threshold} for
      #   more details.
      #
      #   @param insight_name [Symbol, Openlayer::Models::Commits::TestResultListResponse::Item::Goal::Threshold::InsightName] The insight name to be evaluated.
      #
      #   @param insight_parameters [Array<Openlayer::Models::Commits::TestResultListResponse::Item::Goal::Threshold::InsightParameter>, nil] The insight parameters. Required only for some test subtypes. For example, for t
      #
      #   @param measurement [String] The measurement to be evaluated.
      #
      #   @param operator [Symbol, Openlayer::Models::Commits::TestResultListResponse::Item::Goal::Threshold::Operator] The operator to be used for the evaluation.
      #
      #   @param threshold_mode [Symbol, Openlayer::Models::Commits::TestResultListResponse::Item::Goal::Threshold::ThresholdMode] Whether to use automatic anomaly detection or manual thresholds
      #
      #   @param value [Float, Boolean, String, Array<String>] The value to be compared.

      # The insight name to be evaluated.
      #
      # @see Openlayer::Models::Commits::TestResultListResponse::Item::Goal::Threshold#insight_name
      module InsightName
        extend Openlayer::Internal::Type::Enum

        CHARACTER_LENGTH = :characterLength
        CLASS_IMBALANCE = :classImbalance
        EXPECT_COLUMN_A_TO_BE_IN_COLUMN_B = :expectColumnAToBeInColumnB
        COLUMN_AVERAGE = :columnAverage
        COLUMN_DRIFT = :columnDrift
        COLUMN_VALUES_MATCH = :columnValuesMatch
        CONFIDENCE_DISTRIBUTION = :confidenceDistribution
        CONFLICTING_LABEL_ROW_COUNT = :conflictingLabelRowCount
        CONTAINS_PII = :containsPii
        CONTAINS_VALID_URL = :containsValidUrl
        CORRELATED_FEATURES = :correlatedFeatures
        CUSTOM_METRIC = :customMetric
        DUPLICATE_ROW_COUNT = :duplicateRowCount
        EMPTY_FEATURES = :emptyFeatures
        FEATURE_DRIFT = :featureDrift
        FEATURE_PROFILE = :featureProfile
        GREAT_EXPECTATIONS = :greatExpectations
        GROUP_BY_COLUMN_STATS_CHECK = :groupByColumnStatsCheck
        ILL_FORMED_ROW_COUNT = :illFormedRowCount
        IS_CODE = :isCode
        IS_JSON = :isJson
        LLM_RUBRIC_V2 = :llmRubricV2
        LABEL_DRIFT = :labelDrift
        METRICS = :metrics
        NEW_CATEGORIES = :newCategories
        NEW_LABELS = :newLabels
        NULL_ROW_COUNT = :nullRowCount
        PP_SCORE = :ppScore
        QUASI_CONSTANT_FEATURES = :quasiConstantFeatures
        SENTENCE_LENGTH = :sentenceLength
        SIZE_RATIO = :sizeRatio
        SPECIAL_CHARACTERS = :specialCharacters
        STRING_VALIDATION = :stringValidation
        TRAIN_VAL_LEAKAGE_ROW_COUNT = :trainValLeakageRowCount

        # @!method self.values
        #   @return [Array<Symbol>]
      end

      class InsightParameter < Openlayer::Internal::Type::BaseModel
        # @!attribute name
        #   The name of the insight filter.
        #
        #   @return [String]
        required :name, String

        # @!attribute value
        #
        #   @return [Object]
        required :value, Openlayer::Internal::Type::Unknown

        # @!method initialize(name:, value:)
        #   @param name [String] The name of the insight filter.
        #
        #   @param value [Object]
      end

      # The operator to be used for the evaluation.
      #
      # @see Openlayer::Models::Commits::TestResultListResponse::Item::Goal::Threshold#operator
      module Operator
        extend Openlayer::Internal::Type::Enum

        IS = :is
        GREATER = :>
        GREATER_OR_EQUALS = :">="
        LESS = :<
        LESS_OR_EQUALS = :"<="
        NOT_EQUALS = :"!="

        # @!method self.values
        #   @return [Array<Symbol>]
      end

      # Whether to use automatic anomaly detection or manual thresholds
      #
      # @see Openlayer::Models::Commits::TestResultListResponse::Item::Goal::Threshold#threshold_mode
      module ThresholdMode
        extend Openlayer::Internal::Type::Enum

        AUTOMATIC = :automatic
        MANUAL = :manual

        # @!method self.values
        #   @return [Array<Symbol>]
      end

      # The value to be compared.
      #
      # @see Openlayer::Models::Commits::TestResultListResponse::Item::Goal::Threshold#value
      module Value
        extend Openlayer::Internal::Type::Union

        variant Float

        variant Openlayer::Internal::Type::Boolean

        variant String

        variant -> { Openlayer::Models::Commits::TestResultListResponse::Item::Goal::Threshold::Value::StringArray }

        # @!method self.variants
        #   @return [Array(Float, Boolean, String, Array<String>)]

        # @type [Openlayer::Internal::Type::Converter]
        StringArray = Openlayer::Internal::Type::ArrayOf[String]
      end
    end

    # The test type.
    #
    # @see Openlayer::Models::Commits::TestResultListResponse::Item::Goal#type
    module Type
      extend Openlayer::Internal::Type::Enum

      INTEGRITY = :integrity
      CONSISTENCY = :consistency
      PERFORMANCE = :performance

      # @!method self.values
      #   @return [Array<Symbol>]
    end
  end

  # @see Openlayer::Models::Commits::TestResultListResponse::Item#rows_body
  class RowsBody < Openlayer::Internal::Type::BaseModel
    # @!attribute column_filters
    #
    #   @return [Array<Openlayer::Models::Commits::TestResultListResponse::Item::RowsBody::ColumnFilter::SetColumnFilter, Openlayer::Models::Commits::TestResultListResponse::Item::RowsBody::ColumnFilter::NumericColumnFilter, Openlayer::Models::Commits::TestResultListResponse::Item::RowsBody::ColumnFilter::StringColumnFilter>, nil]
    optional :column_filters,
             -> { Openlayer::Internal::Type::ArrayOf[union: Openlayer::Models::Commits::TestResultListResponse::Item::RowsBody::ColumnFilter] },
             api_name: :columnFilters,
             nil?: true

    # @!attribute exclude_row_id_list
    #
    #   @return [Array<Integer>, nil]
    optional :exclude_row_id_list,
             Openlayer::Internal::Type::ArrayOf[Integer],
             api_name: :excludeRowIdList,
             nil?: true

    # @!attribute not_search_query_and
    #
    #   @return [Array<String>, nil]
    optional :not_search_query_and,
             Openlayer::Internal::Type::ArrayOf[String],
             api_name: :notSearchQueryAnd,
             nil?: true

    # @!attribute not_search_query_or
    #
    #   @return [Array<String>, nil]
    optional :not_search_query_or,
             Openlayer::Internal::Type::ArrayOf[String],
             api_name: :notSearchQueryOr,
             nil?: true

    # @!attribute row_id_list
    #
    #   @return [Array<Integer>, nil]
    optional :row_id_list,
             Openlayer::Internal::Type::ArrayOf[Integer],
             api_name: :rowIdList,
             nil?: true

    # @!attribute search_query_and
    #
    #   @return [Array<String>, nil]
    optional :search_query_and,
             Openlayer::Internal::Type::ArrayOf[String],
             api_name: :searchQueryAnd,
             nil?: true

    # @!attribute search_query_or
    #
    #   @return [Array<String>, nil]
    optional :search_query_or,
             Openlayer::Internal::Type::ArrayOf[String],
             api_name: :searchQueryOr,
             nil?: true

    # @!method initialize(column_filters: nil, exclude_row_id_list: nil, not_search_query_and: nil, not_search_query_or: nil, row_id_list: nil, search_query_and: nil, search_query_or: nil)
    #   The body of the rows request.
    #
    #   @param column_filters [Array<Openlayer::Models::Commits::TestResultListResponse::Item::RowsBody::ColumnFilter::SetColumnFilter, Openlayer::Models::Commits::TestResultListResponse::Item::RowsBody::ColumnFilter::NumericColumnFilter, Openlayer::Models::Commits::TestResultListResponse::Item::RowsBody::ColumnFilter::StringColumnFilter>, nil]
    #   @param exclude_row_id_list [Array<Integer>, nil]
    #   @param not_search_query_and [Array<String>, nil]
    #   @param not_search_query_or [Array<String>, nil]
    #   @param row_id_list [Array<Integer>, nil]
    #   @param search_query_and [Array<String>, nil]
    #   @param search_query_or [Array<String>, nil]

    module ColumnFilter
      extend Openlayer::Internal::Type::Union

      variant -> { Openlayer::Models::Commits::TestResultListResponse::Item::RowsBody::ColumnFilter::SetColumnFilter }

      variant -> { Openlayer::Models::Commits::TestResultListResponse::Item::RowsBody::ColumnFilter::NumericColumnFilter }

      variant -> { Openlayer::Models::Commits::TestResultListResponse::Item::RowsBody::ColumnFilter::StringColumnFilter }

      class SetColumnFilter < Openlayer::Internal::Type::BaseModel
        # @!attribute measurement
        #   The name of the column.
        #
        #   @return [String]
        required :measurement, String

        # @!attribute operator
        #
        #   @return [Symbol, Openlayer::Models::Commits::TestResultListResponse::Item::RowsBody::ColumnFilter::SetColumnFilter::Operator]
        required :operator,
                 enum: -> { Openlayer::Models::Commits::TestResultListResponse::Item::RowsBody::ColumnFilter::SetColumnFilter::Operator }

        # @!attribute value
        #
        #   @return [Array<String, Float>]
        required :value,
                 -> do
                   Openlayer::Internal::Type::ArrayOf[
                     union: Openlayer::Models::Commits::TestResultListResponse::Item::RowsBody::ColumnFilter::SetColumnFilter::Value
                   ]
                 end

        # @!method initialize(measurement:, operator:, value:)
        #   @param measurement [String] The name of the column.
        #
        #   @param operator [Symbol, Openlayer::Models::Commits::TestResultListResponse::Item::RowsBody::ColumnFilter::SetColumnFilter::Operator]
        #
        #   @param value [Array<String, Float>]

        # @see Openlayer::Models::Commits::TestResultListResponse::Item::RowsBody::ColumnFilter::SetColumnFilter#operator
        module Operator
          extend Openlayer::Internal::Type::Enum

          CONTAINS_NONE = :contains_none
          CONTAINS_ANY = :contains_any
          CONTAINS_ALL = :contains_all
          ONE_OF = :one_of
          NONE_OF = :none_of

          # @!method self.values
          #   @return [Array<Symbol>]
        end

        module Value
          extend Openlayer::Internal::Type::Union

          variant String

          variant Float

          # @!method self.variants
          #   @return [Array(String, Float)]
        end
      end

      class NumericColumnFilter < Openlayer::Internal::Type::BaseModel
        # @!attribute measurement
        #   The name of the column.
        #
        #   @return [String]
        required :measurement, String

        # @!attribute operator
        #
        #   @return [Symbol, Openlayer::Models::Commits::TestResultListResponse::Item::RowsBody::ColumnFilter::NumericColumnFilter::Operator]
        required :operator,
                 enum: -> { Openlayer::Models::Commits::TestResultListResponse::Item::RowsBody::ColumnFilter::NumericColumnFilter::Operator }

        # @!attribute value
        #
        #   @return [Float, nil]
        required :value, Float, nil?: true

        # @!method initialize(measurement:, operator:, value:)
        #   @param measurement [String] The name of the column.
        #
        #   @param operator [Symbol, Openlayer::Models::Commits::TestResultListResponse::Item::RowsBody::ColumnFilter::NumericColumnFilter::Operator]
        #
        #   @param value [Float, nil]

        # @see Openlayer::Models::Commits::TestResultListResponse::Item::RowsBody::ColumnFilter::NumericColumnFilter#operator
        module Operator
          extend Openlayer::Internal::Type::Enum

          GREATER = :>
          GREATER_OR_EQUALS = :">="
          IS = :is
          LESS = :<
          LESS_OR_EQUALS = :"<="
          NOT_EQUALS = :"!="

          # @!method self.values
          #   @return [Array<Symbol>]
        end
      end

      class StringColumnFilter < Openlayer::Internal::Type::BaseModel
        # @!attribute measurement
        #   The name of the column.
        #
        #   @return [String]
        required :measurement, String

        # @!attribute operator
        #
        #   @return [Symbol, Openlayer::Models::Commits::TestResultListResponse::Item::RowsBody::ColumnFilter::StringColumnFilter::Operator]
        required :operator,
                 enum: -> { Openlayer::Models::Commits::TestResultListResponse::Item::RowsBody::ColumnFilter::StringColumnFilter::Operator }

        # @!attribute value
        #
        #   @return [String, Boolean]
        required :value,
                 union: -> { Openlayer::Models::Commits::TestResultListResponse::Item::RowsBody::ColumnFilter::StringColumnFilter::Value }

        # @!method initialize(measurement:, operator:, value:)
        #   @param measurement [String] The name of the column.
        #
        #   @param operator [Symbol, Openlayer::Models::Commits::TestResultListResponse::Item::RowsBody::ColumnFilter::StringColumnFilter::Operator]
        #
        #   @param value [String, Boolean]

        # @see Openlayer::Models::Commits::TestResultListResponse::Item::RowsBody::ColumnFilter::StringColumnFilter#operator
        module Operator
          extend Openlayer::Internal::Type::Enum

          IS = :is
          NOT_EQUALS = :"!="

          # @!method self.values
          #   @return [Array<Symbol>]
        end

        # @see Openlayer::Models::Commits::TestResultListResponse::Item::RowsBody::ColumnFilter::StringColumnFilter#value
        module Value
          extend Openlayer::Internal::Type::Union

          variant String

          variant Openlayer::Internal::Type::Boolean

          # @!method self.variants
          #   @return [Array(String, Boolean)]
        end
      end

      # @!method self.variants
      #   @return [Array(Openlayer::Models::Commits::TestResultListResponse::Item::RowsBody::ColumnFilter::SetColumnFilter, Openlayer::Models::Commits::TestResultListResponse::Item::RowsBody::ColumnFilter::NumericColumnFilter, Openlayer::Models::Commits::TestResultListResponse::Item::RowsBody::ColumnFilter::StringColumnFilter)]
    end
  end
end

Instance Attribute Details

#expected_values ⇒ `Array<Openlayer::Models::Commits::TestResultListResponse::Item::ExpectedValue>`^?

Returns:

(Array<Openlayer::Models::Commits::TestResultListResponse::Item::ExpectedValue>, nil)



33
34
35

# File 'lib/openlayer/models/commits/test_result_list_response.rb', line 33

optional :expected_values,
-> { Openlayer::Internal::Type::ArrayOf[Openlayer::Models::Commits::TestResultListResponse::Item::ExpectedValue] },
api_name: :expectedValues

#goal ⇒ `Openlayer::Models::Commits::TestResultListResponse::Item::Goal`^?

Returns:

(Openlayer::Models::Commits::TestResultListResponse::Item::Goal, nil)

40	# File 'lib/openlayer/models/commits/test_result_list_response.rb', line 40 optional :goal, -> { Openlayer::Models::Commits::TestResultListResponse::Item::Goal }

#rows ⇒ `String`^?

The URL to the rows of the test result.

Returns:

(String, nil)

46	# File 'lib/openlayer/models/commits/test_result_list_response.rb', line 46 optional :rows, String

#rows_body ⇒ `Openlayer::Models::Commits::TestResultListResponse::Item::RowsBody`^?

The body of the rows request.

Returns:

(Openlayer::Models::Commits::TestResultListResponse::Item::RowsBody, nil)

# File 'lib/openlayer/models/commits/test_result_list_response.rb', line 52

optional :rows_body,
-> { Openlayer::Models::Commits::TestResultListResponse::Item::RowsBody },
api_name: :rowsBody,
nil?: true

#status ⇒ `Symbol`, `Openlayer::Models::Commits::TestResultListResponse::Item::Status`

The status of the test.

Returns:

(Symbol, Openlayer::Models::Commits::TestResultListResponse::Item::Status)

22	# File 'lib/openlayer/models/commits/test_result_list_response.rb', line 22 required :status, enum: -> { Openlayer::Models::Commits::TestResultListResponse::Item::Status }

#status_message ⇒ `String`^?

The status message.

Returns:

(String, nil)

28	# File 'lib/openlayer/models/commits/test_result_list_response.rb', line 28 required :status_message, String, api_name: :statusMessage, nil?: true

Class Method Details

.values ⇒ `Array<Symbol>`

Returns:

(Array<Symbol>)

# File 'lib/openlayer/models/commits/test_result_list_response.rb', line 148

Class: Openlayer::Models::Commits::TestResultListResponse::Item

Defined Under Namespace

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

Methods included from Internal::Type::Converter

Methods included from Internal::Util::SorbetRuntimeSupport

Constructor Details

#initialize(lower_threshold: nil, measurement: nil, upper_threshold: nil) ⇒ Object

Instance Attribute Details

#expected_values ⇒ Array<Openlayer::Models::Commits::TestResultListResponse::Item::ExpectedValue>?

#goal ⇒ Openlayer::Models::Commits::TestResultListResponse::Item::Goal?

#rows ⇒ String?

#rows_body ⇒ Openlayer::Models::Commits::TestResultListResponse::Item::RowsBody?

#status ⇒ Symbol, Openlayer::Models::Commits::TestResultListResponse::Item::Status

#status_message ⇒ String?

Class Method Details

.values ⇒ Array<Symbol>

#initialize(lower_threshold: nil, measurement: nil, upper_threshold: nil) ⇒ `Object`

#expected_values ⇒ `Array<Openlayer::Models::Commits::TestResultListResponse::Item::ExpectedValue>`^?

#goal ⇒ `Openlayer::Models::Commits::TestResultListResponse::Item::Goal`^?

#rows ⇒ `String`^?

#rows_body ⇒ `Openlayer::Models::Commits::TestResultListResponse::Item::RowsBody`^?

#status ⇒ `Symbol`, `Openlayer::Models::Commits::TestResultListResponse::Item::Status`

#status_message ⇒ `String`^?

.values ⇒ `Array<Symbol>`