Class: DatadogAPIClient::V2::IncidentUserDefinedFieldAttributesCreateRequest

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

Overview

Attributes for creating an incident user-defined field.

Instance Attribute Summary collapse

Method Summary

Methods included from BaseGenericModel

included

Instance Attribute Details

#additional_properties ⇒ Object

Returns the value of attribute additional_properties.



54
55
56
 
# File 'lib/datadog_api_client/v2/models/incident_user_defined_field_attributes_create_request.rb', line 54

def additional_properties
  @additional_properties
end

#category ⇒ Object

The section in which the field appears: "what_happened" or "why_it_happened". When null, the field appears in the Attributes section.



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

def category
  @category
end

#collected ⇒ Object

The lifecycle stage at which the app prompts users to fill out this field. Cannot be set on required fields.



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

def collected
  @collected
end

#default_value ⇒ Object

The default value for the field. Must be one of the valid values when valid_values is set.



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

def default_value
  @default_value
end

#display_name ⇒ Object

The human-readable name shown in the UI. Defaults to a formatted version of the name if not provided.



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

def display_name
  @display_name
end

#name ⇒ Object

The unique identifier of the field. Must start with a letter or digit and contain only letters, digits, underscores, or periods.



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

def name
  @name
end

#ordinal ⇒ Object

A decimal string representing the field's display order in the UI.



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

def ordinal
  @ordinal
end

#required ⇒ Object

When true, users must fill out this field on incidents.



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

def required
  @required
end

#tag_key ⇒ Object

For metric tag-type fields only, the metric tag key that powers the autocomplete options.



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

def tag_key
  @tag_key
end

#type ⇒ Object

The data type of the field. 1=dropdown, 2=multiselect, 3=textbox, 4=textarray, 5=metrictag, 6=autocomplete, 7=number, 8=datetime.



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

def type
  @type
end

#valid_values ⇒ Object

The list of allowed values for dropdown and multiselect fields. Limited to 1000 values.



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

def valid_values
  @valid_values
end