Class: DatadogAPIClient::V2::ExperimentsCreateExperimentV2RequestDataAttributes

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

Overview

Configuration and descriptive fields for the new experiment draft.

Instance Attribute Summary collapse

Method Summary

Methods included from BaseGenericModel

included

Instance Attribute Details

#additional_properties ⇒ Object

Returns the value of attribute additional_properties.



84
85
86
 
# File 'lib/datadog_api_client/v2/models/experiments_create_experiment_v2_request_data_attributes.rb', line 84

def additional_properties
  @additional_properties
end

#assignments_end_date ⇒ Object

End of the window assignments are read from. Optional; must be after assignments_start_date.



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

def assignments_end_date
  @assignments_end_date
end

#assignments_start_date ⇒ Object

Start of the window assignments are read from. Optional.



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

def assignments_start_date
  @assignments_start_date
end

#datadog_flag_configuration ⇒ Object

Feature flag, environment, and targeting configuration for a Datadog experiment.



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

def datadog_flag_configuration
  @datadog_flag_configuration
end

#decision_metrics ⇒ Object

Metrics selected to support the experiment decision.



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

def decision_metrics
  @decision_metrics
end

#events_end_date ⇒ Object

End of the window metric events are read from. Optional; must be after events_start_date.



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

def events_end_date
  @events_end_date
end

#events_start_date ⇒ Object

Start of the window metric events are read from. Optional; must fall within the assignments window.



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

def events_start_date
  @events_start_date
end

#hypothesis ⇒ Object

What the experiment is expected to show. Optional and free-form.



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

def hypothesis
  @hypothesis
end

#migration_metadata ⇒ Object

Metadata associated with migration of this resource.



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

def migration_metadata
  @migration_metadata
end

#name ⇒ Object

Display name for the experiment. The only required attribute: a request carrying nothing but a name is accepted.



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

def name
  @name
end

#protocol_id ⇒ Object

Published protocol whose defaults create this draft. May be combined with hypothesis, tags, teams, related links, and date overrides. Omit subject_type_id, decision_metrics, variants, warehouse_exposure_configuration, datadog_flag_configuration, traffic_exposure, and structured_metadata.



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

def protocol_id
  @protocol_id
end

#related_links ⇒ Object

External links associated with the experiment.



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

def related_links
  @related_links
end

#split_by_properties ⇒ Object

Complete Datadog split-by selection. Identify each property by column_name. Omit this field to copy organization defaults.



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

def split_by_properties
  @split_by_properties
end

#structured_metadata ⇒ Object

Custom metadata fields and their values for the experiment.



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

def structured_metadata
  @structured_metadata
end

#subject_type_id ⇒ Object

Canonical ID of an existing subject type. Optional; defaults to the organization default.



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

def subject_type_id
  @subject_type_id
end

#summary ⇒ Object

Summary of the experiment. Optional and free-form.



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

def summary
  @summary
end

#tags ⇒ Object

Non-team tag names to apply. Optional.



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

def tags
  @tags
end

#teams ⇒ Object

Team handles that own the experiment. Optional.



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

def teams
  @teams
end

#traffic_exposure ⇒ Object

Traffic exposure fraction or schedule configured for the experiment.



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

def traffic_exposure
  @traffic_exposure
end

#variants ⇒ Object

Variants selected for the experiment and their traffic allocations.



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

def variants
  @variants
end

#warehouse_exposure_configuration ⇒ Object

Warehouse model and experiment key used to read assignment data.



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

def warehouse_exposure_configuration
  @warehouse_exposure_configuration
end