Class: DatadogAPIClient::V2::ExperimentsReplaceExperimentProtocolRequestDataAttributes
- Inherits:
-
Object
- Object
- DatadogAPIClient::V2::ExperimentsReplaceExperimentProtocolRequestDataAttributes
- Includes:
- BaseGenericModel
- Defined in:
- lib/datadog_api_client/v2/models/experiments_replace_experiment_protocol_request_data_attributes.rb
Overview
Replace a published protocol template. Omitted optional template fields are cleared. Omitted enforcement and migration_metadata are preserved. Enabled limits require their values; allocation settings require environment_id.
Instance Attribute Summary collapse
-
#additional_properties ⇒ Object
Returns the value of attribute additional_properties.
-
#analysis_plan ⇒ Object
Statistical settings.
-
#assignment_source_default_properties ⇒ Object
Assignment properties.
-
#assignment_source_id ⇒ Object
ID of the assignment source selected by the protocol.
-
#default_duration_days ⇒ Object
readonly
Default experiment duration supplied by the protocol, in days.
-
#enforcement ⇒ Object
Complete lock map.
-
#environment_id ⇒ Object
ID of the feature flag environment used by the experiment.
-
#exposure_schedule ⇒ Object
Traffic schedule.
-
#is_duration_required_to_start ⇒ Object
readonly
Whether the protocol requires a duration before an experiment can start.
-
#is_equal_split_enforced ⇒ Object
readonly
Whether the protocol requires equal traffic allocation across variants.
-
#is_metric_limit_enabled ⇒ Object
readonly
Whether the protocol limits the number of metrics.
-
#is_minimum_duration_enabled ⇒ Object
readonly
Whether the protocol enforces a minimum experiment duration.
-
#metric_groups ⇒ Object
readonly
Metric groups.
-
#metric_limit ⇒ Object
readonly
Maximum number of metrics allowed by the protocol.
-
#migration_metadata ⇒ Object
Metadata for imported resources.
-
#minimum_duration_unit ⇒ Object
readonly
Minimum duration unit, DAYS or WEEKS.
-
#minimum_duration_value ⇒ Object
readonly
Minimum experiment duration in the specified unit.
-
#primary_metric_id ⇒ Object
ID of the primary metric supplied by the protocol.
-
#subject_type_id ⇒ Object
readonly
ID of the subject type used by this configuration.
-
#targeting_rules ⇒ Object
Targeting rules.
Method Summary
Methods included from BaseGenericModel
Instance Attribute Details
#additional_properties ⇒ Object
Returns the value of attribute additional_properties.
81 82 83 |
# File 'lib/datadog_api_client/v2/models/experiments_replace_experiment_protocol_request_data_attributes.rb', line 81 def additional_properties @additional_properties end |
#analysis_plan ⇒ Object
Statistical settings. Use default_duration_days for duration; target_duration_days is not accepted here.
25 26 27 |
# File 'lib/datadog_api_client/v2/models/experiments_replace_experiment_protocol_request_data_attributes.rb', line 25 def analysis_plan @analysis_plan end |
#assignment_source_default_properties ⇒ Object
Assignment properties.
28 29 30 |
# File 'lib/datadog_api_client/v2/models/experiments_replace_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.
31 32 33 |
# File 'lib/datadog_api_client/v2/models/experiments_replace_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.
34 35 36 |
# File 'lib/datadog_api_client/v2/models/experiments_replace_experiment_protocol_request_data_attributes.rb', line 34 def default_duration_days @default_duration_days end |
#enforcement ⇒ Object
Complete lock map. Omit this object to preserve current locks. Null is rejected; every field is required.
37 38 39 |
# File 'lib/datadog_api_client/v2/models/experiments_replace_experiment_protocol_request_data_attributes.rb', line 37 def enforcement @enforcement end |
#environment_id ⇒ Object
ID of the feature flag environment used by the experiment.
40 41 42 |
# File 'lib/datadog_api_client/v2/models/experiments_replace_experiment_protocol_request_data_attributes.rb', line 40 def environment_id @environment_id end |
#exposure_schedule ⇒ Object
Traffic schedule. Publishing and replacement require NO_ROLLOUT with exactly one step, or UNIFORM_INTERVALS with a positive selection interval and at least one step. Requires environment_id.
43 44 45 |
# File 'lib/datadog_api_client/v2/models/experiments_replace_experiment_protocol_request_data_attributes.rb', line 43 def exposure_schedule @exposure_schedule end |
#is_duration_required_to_start ⇒ Object
Whether the protocol requires a duration before an experiment can start.
46 47 48 |
# File 'lib/datadog_api_client/v2/models/experiments_replace_experiment_protocol_request_data_attributes.rb', line 46 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.
49 50 51 |
# File 'lib/datadog_api_client/v2/models/experiments_replace_experiment_protocol_request_data_attributes.rb', line 49 def is_equal_split_enforced @is_equal_split_enforced end |
#is_metric_limit_enabled ⇒ Object
Whether the protocol limits the number of metrics.
52 53 54 |
# File 'lib/datadog_api_client/v2/models/experiments_replace_experiment_protocol_request_data_attributes.rb', line 52 def is_metric_limit_enabled @is_metric_limit_enabled end |
#is_minimum_duration_enabled ⇒ Object
Whether the protocol enforces a minimum experiment duration.
55 56 57 |
# File 'lib/datadog_api_client/v2/models/experiments_replace_experiment_protocol_request_data_attributes.rb', line 55 def is_minimum_duration_enabled @is_minimum_duration_enabled end |
#metric_groups ⇒ Object
Metric groups.
58 59 60 |
# File 'lib/datadog_api_client/v2/models/experiments_replace_experiment_protocol_request_data_attributes.rb', line 58 def metric_groups @metric_groups end |
#metric_limit ⇒ Object
Maximum number of metrics allowed by the protocol.
61 62 63 |
# File 'lib/datadog_api_client/v2/models/experiments_replace_experiment_protocol_request_data_attributes.rb', line 61 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.
64 65 66 |
# File 'lib/datadog_api_client/v2/models/experiments_replace_experiment_protocol_request_data_attributes.rb', line 64 def @migration_metadata end |
#minimum_duration_unit ⇒ Object
Minimum duration unit, DAYS or WEEKS.
67 68 69 |
# File 'lib/datadog_api_client/v2/models/experiments_replace_experiment_protocol_request_data_attributes.rb', line 67 def minimum_duration_unit @minimum_duration_unit end |
#minimum_duration_value ⇒ Object
Minimum experiment duration in the specified unit.
70 71 72 |
# File 'lib/datadog_api_client/v2/models/experiments_replace_experiment_protocol_request_data_attributes.rb', line 70 def minimum_duration_value @minimum_duration_value end |
#primary_metric_id ⇒ Object
ID of the primary metric supplied by the protocol.
73 74 75 |
# File 'lib/datadog_api_client/v2/models/experiments_replace_experiment_protocol_request_data_attributes.rb', line 73 def primary_metric_id @primary_metric_id end |
#subject_type_id ⇒ Object
ID of the subject type used by this configuration.
76 77 78 |
# File 'lib/datadog_api_client/v2/models/experiments_replace_experiment_protocol_request_data_attributes.rb', line 76 def subject_type_id @subject_type_id end |
#targeting_rules ⇒ Object
Targeting rules.
79 80 81 |
# File 'lib/datadog_api_client/v2/models/experiments_replace_experiment_protocol_request_data_attributes.rb', line 79 def targeting_rules @targeting_rules end |