Class: DatadogAPIClient::V2::ExperimentsBanditV2DTODataAttributes

Inherits:
Object
  • Object
show all
Includes:
BaseGenericModel
Defined in:
lib/datadog_api_client/v2/models/experiments_bandit_v2_dto_data_attributes.rb

Overview

A bandit's setup, the policy it serves, and its latest refresh.

Instance Attribute Summary collapse

Method Summary

Methods included from BaseGenericModel

included

Instance Attribute Details

#active_policy ⇒ Object

The policy the bandit serves. null until the bandit starts.



25
26
27
# File 'lib/datadog_api_client/v2/models/experiments_bandit_v2_dto_data_attributes.rb', line 25

def active_policy
  @active_policy
end

#additional_properties ⇒ Object

Returns the value of attribute additional_properties.



102
103
104
# File 'lib/datadog_api_client/v2/models/experiments_bandit_v2_dto_data_attributes.rb', line 102

def additional_properties
  @additional_properties
end

#aggregation_window_seconds ⇒ Object

The aggregation window: how long after an exposure the bandit keeps counting its reward, in seconds.



28
29
30
# File 'lib/datadog_api_client/v2/models/experiments_bandit_v2_dto_data_attributes.rb', line 28

def aggregation_window_seconds
  @aggregation_window_seconds
end

#bayesian_prior ⇒ Object

The prior the bandit's estimates start from.



31
32
33
# File 'lib/datadog_api_client/v2/models/experiments_bandit_v2_dto_data_attributes.rb', line 31

def bayesian_prior
  @bayesian_prior
end

#config_version ⇒ Object

The version of the bandit's configuration. Each saved change adds one.



34
35
36
# File 'lib/datadog_api_client/v2/models/experiments_bandit_v2_dto_data_attributes.rb', line 34

def config_version
  @config_version
end

#created_at ⇒ Object

When the bandit was created.



37
38
39
# File 'lib/datadog_api_client/v2/models/experiments_bandit_v2_dto_data_attributes.rb', line 37

def created_at
  @created_at
end

#datadog_flag_configuration ⇒ Object

The flag rule the bandit serves through. Absent until a draft is added to a flag. Also absent when the caller lacks feature flag or environment read permissions, in which case meta.warnings includes datadog_flag_configuration_omitted.



40
41
42
# File 'lib/datadog_api_client/v2/models/experiments_bandit_v2_dto_data_attributes.rb', line 40

def datadog_flag_configuration
  @datadog_flag_configuration
end

#description ⇒ Object

The bandit's description.



43
44
45
# File 'lib/datadog_api_client/v2/models/experiments_bandit_v2_dto_data_attributes.rb', line 43

def description
  @description
end

#ended_at ⇒ Object

When the bandit was stopped or reached its scheduled end. null while it hasn't ended.



46
47
48
# File 'lib/datadog_api_client/v2/models/experiments_bandit_v2_dto_data_attributes.rb', line 46

def ended_at
  @ended_at
end

#exposure_sql_model_id ⇒ Object

The exposure SQL model the bandit reads its exposures from. null until set on a draft.



49
50
51
# File 'lib/datadog_api_client/v2/models/experiments_bandit_v2_dto_data_attributes.rb', line 49

def exposure_sql_model_id
  @exposure_sql_model_id
end

#latest_refresh ⇒ Object

The most recently started refresh. null until one starts.



52
53
54
# File 'lib/datadog_api_client/v2/models/experiments_bandit_v2_dto_data_attributes.rb', line 52

def latest_refresh
  @latest_refresh
end

#lookback_seconds ⇒ Object

How far back each refresh reads observations, in seconds.



55
56
57
# File 'lib/datadog_api_client/v2/models/experiments_bandit_v2_dto_data_attributes.rb', line 55

def lookback_seconds
  @lookback_seconds
end

#metric_id ⇒ Object

The metric the bandit optimizes. null until set on a draft.



58
59
60
# File 'lib/datadog_api_client/v2/models/experiments_bandit_v2_dto_data_attributes.rb', line 58

def metric_id
  @metric_id
end

#name ⇒ Object

The bandit's name.



61
62
63
# File 'lib/datadog_api_client/v2/models/experiments_bandit_v2_dto_data_attributes.rb', line 61

def name
  @name
end

#optimal_variant_key ⇒ Object

The key of the arm most likely to be best, when one arm leads and the bandit is outside warmup. null otherwise. Matches Get bandit results.



64
65
66
# File 'lib/datadog_api_client/v2/models/experiments_bandit_v2_dto_data_attributes.rb', line 64

def optimal_variant_key
  @optimal_variant_key
end

#optimal_variant_unavailable_reason ⇒ Object

Why no optimal variant is reported. Absent when one is, or when the cause isn't known.



67
68
69
# File 'lib/datadog_api_client/v2/models/experiments_bandit_v2_dto_data_attributes.rb', line 67

def optimal_variant_unavailable_reason
  @optimal_variant_unavailable_reason
end

#refresh_schedule_id ⇒ Object

The schedule the bandit refreshes on.



70
71
72
# File 'lib/datadog_api_client/v2/models/experiments_bandit_v2_dto_data_attributes.rb', line 70

def refresh_schedule_id
  @refresh_schedule_id
end

#scheduled_end_at ⇒ Object

When the bandit ends and serves its fallback. null when it has no scheduled end.



73
74
75
# File 'lib/datadog_api_client/v2/models/experiments_bandit_v2_dto_data_attributes.rb', line 73

def scheduled_end_at
  @scheduled_end_at
end

#scheduled_end_failure ⇒ Object

Why the scheduled end couldn't run. It isn't retried until the end date or fallback changes. Absent when there's no failure.



76
77
78
# File 'lib/datadog_api_client/v2/models/experiments_bandit_v2_dto_data_attributes.rb', line 76

def scheduled_end_failure
  @scheduled_end_failure
end

#started_at ⇒ Object

When the bandit started. null until it starts.



79
80
81
# File 'lib/datadog_api_client/v2/models/experiments_bandit_v2_dto_data_attributes.rb', line 79

def started_at
  @started_at
end

#status ⇒ Object

The bandit's status. STOPPED means the bandit was stopped and serves the variant chosen then. COMPLETED means it reached its scheduled end and serves its fallback.



82
83
84
# File 'lib/datadog_api_client/v2/models/experiments_bandit_v2_dto_data_attributes.rb', line 82

def status
  @status
end

#subject_type_id ⇒ Object

The subject type the bandit randomizes and measures by. null until set on a draft.



85
86
87
# File 'lib/datadog_api_client/v2/models/experiments_bandit_v2_dto_data_attributes.rb', line 85

def subject_type_id
  @subject_type_id
end

#tags ⇒ Object

The bandit's tags, without team tags.



88
89
90
# File 'lib/datadog_api_client/v2/models/experiments_bandit_v2_dto_data_attributes.rb', line 88

def tags
  @tags
end

#teams ⇒ Object

Handles of the teams that own the bandit.



91
92
93
# File 'lib/datadog_api_client/v2/models/experiments_bandit_v2_dto_data_attributes.rb', line 91

def teams
  @teams
end

#updated_at ⇒ Object

When the bandit was last changed.



94
95
96
# File 'lib/datadog_api_client/v2/models/experiments_bandit_v2_dto_data_attributes.rb', line 94

def updated_at
  @updated_at
end

#variants ⇒ Object

The flag variants the bandit uses: its arms in arm order, then its fallback when the fallback isn't an arm.



97
98
99
# File 'lib/datadog_api_client/v2/models/experiments_bandit_v2_dto_data_attributes.rb', line 97

def variants
  @variants
end

#warmup_seconds ⇒ Object

How long the bandit serves its arms equally after it starts, in seconds. null when it has no warmup.



100
101
102
# File 'lib/datadog_api_client/v2/models/experiments_bandit_v2_dto_data_attributes.rb', line 100

def warmup_seconds
  @warmup_seconds
end