Class: DatadogAPIClient::V2::ExperimentsPatchExperimentProtocolRequestDataAttributes

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

Overview

Partial protocol update. Omitted attributes remain unchanged. Published protocols accept only name, description, and migration_metadata; archived protocols reject updates.

Instance Attribute Summary collapse

Method Summary

Methods included from BaseGenericModel

included

Instance Attribute Details

#additional_properties ⇒ Object

Returns the value of attribute additional_properties.



87
88
89
 
# File 'lib/datadog_api_client/v2/models/experiments_patch_experiment_protocol_request_data_attributes.rb', line 87

def additional_properties
  @additional_properties
end

#analysis_plan ⇒ Object

Partial statistical settings. Omitted fields remain unchanged. Null clears the whole plan. Null clears nullable fields; null or an empty string clears confidence_interval_method.



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

def analysis_plan
  @analysis_plan
end

#assignment_source_default_properties ⇒ Object

Assignment properties. Omission or null preserves them; an array replaces them.



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

def assignment_source_default_properties
  @assignment_source_default_properties
end

#assignment_source_id ⇒ Object

ID of the assignment source selected by the protocol. Omission or null keeps the current value. An empty string clears it.



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

def assignment_source_id
  @assignment_source_id
end

#default_duration_days ⇒ Object

Default experiment duration supplied by the protocol, in days. Omission preserves it; null clears it. Sets analysis_plan.target_duration_days on experiments created from this protocol.



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

def default_duration_days
  @default_duration_days
end

#description ⇒ Object

Description. Empty string clears it; omission or null preserves it.



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

def description
  @description
end

#enforcement ⇒ Object

Partial lock map. Omitted fields remain unchanged. Null clears the whole map. Empty or null field values become EDITABLE, except subject_type, flag_source, and confidence_interval_method, which remain LOCKED.



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

def enforcement
  @enforcement
end

#environment_id ⇒ Object

ID of the feature flag environment used by the experiment. Omission or null keeps the current value. An empty string clears it.



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

def environment_id
  @environment_id
end

#exposure_schedule ⇒ Object

Partial traffic schedule. Omitted fields remain unchanged. Null clears the whole schedule. Null clears nullable fields and rollout_steps; null sets strategy to an empty string and autostart to false.



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

def exposure_schedule
  @exposure_schedule
end

#is_duration_required_to_start ⇒ Object

Whether the protocol requires a duration before an experiment can start. Omission or null preserves it.



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

def is_duration_required_to_start
  @is_duration_required_to_start
end

#is_equal_split_enforced ⇒ Object

Whether the protocol requires equal traffic allocation across variants. Omission or null preserves it.



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

def is_equal_split_enforced
  @is_equal_split_enforced
end

#is_metric_limit_enabled ⇒ Object

Whether the protocol limits the number of metrics. Omission or null preserves it.



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

def is_metric_limit_enabled
  @is_metric_limit_enabled
end

#is_minimum_duration_enabled ⇒ Object

Whether the protocol enforces a minimum experiment duration. Omission or null preserves it.



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

def is_minimum_duration_enabled
  @is_minimum_duration_enabled
end

#metric_groups ⇒ Object

Metric groups. Omission or null preserves them; an array replaces them.



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

def metric_groups
  @metric_groups
end

#metric_limit ⇒ Object

Maximum number of metrics allowed by the protocol. Omission preserves it; null clears it.



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

def metric_limit
  @metric_limit
end

#migration_metadata ⇒ Object

Metadata for imported resources. Must encode to at most 4096 bytes. Null clears it; omission preserves it on update.



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

def migration_metadata
  @migration_metadata
end

#minimum_duration_unit ⇒ Object

Minimum duration unit, DAYS or WEEKS. Empty string clears it. Omission or null preserves it.



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

def minimum_duration_unit
  @minimum_duration_unit
end

#minimum_duration_value ⇒ Object

Minimum experiment duration in the specified unit. Omission preserves it; null clears it.



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

def minimum_duration_value
  @minimum_duration_value
end

#name ⇒ Object

Protocol name. Leading and trailing spaces are removed. The trimmed name must contain 1 to 255 characters.



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

def name
  @name
end

#primary_metric_id ⇒ Object

ID of the primary metric supplied by the protocol. Omission or null keeps the current value. An empty string clears it.



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

def primary_metric_id
  @primary_metric_id
end

#subject_type_id ⇒ Object

ID of the subject type used by this configuration. Omission or null keeps the current value. An empty string clears it.



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

def subject_type_id
  @subject_type_id
end

#targeting_rules ⇒ Object

Targeting rules. Omission or null preserves them; an array replaces them.



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

def targeting_rules
  @targeting_rules
end