Class: DatadogAPIClient::V2::IncidentUserDefinedFieldAttributesResponse

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

Overview

Attributes of 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.



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

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_response.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_response.rb', line 28

def collected
  @collected
end

#created ⇒ Object

Timestamp when the field was created.



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

def created
  @created
end

#default_value ⇒ Object

The default value for the field.



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

def default_value
  @default_value
end

#deleted ⇒ Object

Timestamp when the field was soft-deleted, or null if not deleted.



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

def deleted
  @deleted
end

#display_name ⇒ Object

The human-readable name shown in the UI.



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

def display_name
  @display_name
end

#metadata ⇒ Object

Metadata for autocomplete-type user-defined fields, describing how to populate autocomplete options.



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

def metadata
  @metadata
end

#modified ⇒ Object

Timestamp when the field was last modified.



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

def modified
  @modified
end

#name ⇒ Object

The unique identifier of the field.



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

def name
  @name
end

#ordinal ⇒ Object

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



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

def ordinal
  @ordinal
end

#required ⇒ Object

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



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

def required
  @required
end

#reserved ⇒ Object

When true, this field is reserved for system use and cannot be deleted.



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

def reserved
  @reserved
end

#tag_key ⇒ Object

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



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

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.



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

def type
  @type
end

#valid_values ⇒ Object

The list of allowed values for dropdown, multiselect, and autocomplete fields.



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

def valid_values
  @valid_values
end