Class: DatadogAPIClient::V2::ExperimentsPatchBanditV2RequestDataAttributes

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

Overview

The attributes to change. Omitted attributes are unchanged. Which ones can change depends on the bandit's status.

Instance Attribute Summary collapse

Method Summary

Methods included from BaseGenericModel

included

Instance Attribute Details

#additional_properties ⇒ Object

Returns the value of attribute additional_properties.



69
70
71
# File 'lib/datadog_api_client/v2/models/experiments_patch_bandit_v2_request_data_attributes.rb', line 69

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. null restores the default of 3600 (1 hour). Only a draft can change it.



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

def aggregation_window_seconds
  @aggregation_window_seconds
end

#bayesian_prior ⇒ Object

The prior the bandit's estimates start from, in the metric's units. Omitted fields keep their current values, or their defaults on create. A change takes effect on the next refresh.



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

def bayesian_prior
  @bayesian_prior
end

#datadog_flag_configuration ⇒ Object

The flag and environment the bandit serves on, and who it serves there. The server chooses the rule's allocation_key. On create, feature_flag_id and environment_id are required, and null is the same as omitting it. On update, omitted fields are unchanged, and null takes a draft off its flag, which also clears its variants and scheduled end. Moving a draft to another flag clears its variants unless the request sets them. Only a draft can change it.



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

def datadog_flag_configuration
  @datadog_flag_configuration
end

#description ⇒ Object

The bandit's description.



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

def description
  @description
end

#exposure_sql_model_id ⇒ Object

The exposure SQL model the bandit reads its exposures from. Only a draft can change it.



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

def exposure_sql_model_id
  @exposure_sql_model_id
end

#lookback_seconds ⇒ Object

How far back each refresh reads observations, in seconds. null restores the default of 2592000 (30 days). Only a draft can change it.



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

def lookback_seconds
  @lookback_seconds
end

#metric_id ⇒ Object

The metric the bandit optimizes. It must read a warehouse metric source. Only a draft can change it.



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

def metric_id
  @metric_id
end

#name ⇒ Object

The bandit's name.



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

def name
  @name
end

#refresh_schedule_id ⇒ Object

The schedule the bandit refreshes on.



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

def refresh_schedule_id
  @refresh_schedule_id
end

#scheduled_end_at ⇒ Object

When the bandit ends and serves its fallback. Needs a fallback variant. null removes the scheduled end.



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

def scheduled_end_at
  @scheduled_end_at
end

#subject_type_id ⇒ Object

The subject type the bandit randomizes and measures by. Only a draft can change it.



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

def subject_type_id
  @subject_type_id
end

#tags ⇒ Object

Replaces the bandit's tags and keeps its teams. Allowed in any status.



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

def tags
  @tags
end

#teams ⇒ Object

Replaces the bandit's teams and keeps its tags. Allowed in any status.



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

def teams
  @teams
end

#variants ⇒ Object

Replaces the variants the bandit uses. Once the bandit has started, only is_fallback can change, so send the current arms with a different is_fallback. Only a draft can have an empty list.



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

def variants
  @variants
end

#warmup_seconds ⇒ Object

How long the bandit serves its arms equally after it starts, in seconds. null removes the warmup. Only a draft can change it.



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

def warmup_seconds
  @warmup_seconds
end