Class: DatadogAPIClient::V2::NetworkHealthInsightAttributes

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

Overview

Detailed attributes of a network health insight.

Instance Attribute Summary collapse

Method Summary

Methods included from BaseGenericModel

included

Instance Attribute Details

#account_id ⇒ Object

AWS account identifier where the certificate is located. Only set for tls-cert insights.



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

def 
  @account_id
end

#additional_properties ⇒ Object

Returns the value of attribute additional_properties.



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

def additional_properties
  @additional_properties
end

#certificate_id ⇒ Object

ARN or identifier of the certificate. Only set for tls-cert insights.



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

def certificate_id
  @certificate_id
end

#certificate_lifetime_percent ⇒ Object

Percentage of the certificate's validity period that has elapsed, ranging from 0 to 100. Only set for tls-cert insights.



32
33
34
 
# File 'lib/datadog_api_client/v2/models/network_health_insight_attributes.rb', line 32

def certificate_lifetime_percent
  @certificate_lifetime_percent
end

#client_region ⇒ Object

AWS region where the client is located. Only set for tls-cert insights.



35
36
37
 
# File 'lib/datadog_api_client/v2/models/network_health_insight_attributes.rb', line 35

def client_region
  @client_region
end

#client_service ⇒ Object

Name of the service making the request (DNS query or TLS-secured connection). Set to N/A when the client service cannot be determined.



39
40
41
 
# File 'lib/datadog_api_client/v2/models/network_health_insight_attributes.rb', line 39

def client_service
  @client_service
end

#days_until_expiration ⇒ Object

Number of days remaining until the certificate expires. Negative values indicate the certificate has already expired. Only set for tls-cert insights.



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

def days_until_expiration
  @days_until_expiration
end

#dns_query ⇒ Object

Domain name that was being resolved when the DNS failure occurred. Only set for dns insights.



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

def dns_query
  @dns_query
end

#dns_server ⇒ Object

DNS server that received the failing query. Only set for dns insights.



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

def dns_server
  @dns_server
end

#domain_name ⇒ Object

Domain name covered by the certificate. Only set for tls-cert insights.



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

def domain_name
  @domain_name
end

#failure_magnitude ⇒ Object

Count of failed events observed during the query window. Only set for dns, tcp, and security-group insights.



56
57
58
 
# File 'lib/datadog_api_client/v2/models/network_health_insight_attributes.rb', line 56

def failure_magnitude
  @failure_magnitude
end

#failure_rate ⇒ Object

Percentage of requests that failed during the query window, ranging from 0 to 100. Only set for dns, tcp, and security-group insights.



60
61
62
 
# File 'lib/datadog_api_client/v2/models/network_health_insight_attributes.rb', line 60

def failure_rate
  @failure_rate
end

#failure_type ⇒ Object

Specific failure type within the insight category. For DNS insights: timeout, nxdomain, servfail, or general_failure. For TLS certificate insights: expired or expiring_soon. For security group insights: denied.



65
66
67
 
# File 'lib/datadog_api_client/v2/models/network_health_insight_attributes.rb', line 65

def failure_type
  @failure_type
end

#loadbalancer_id ⇒ Object

ARN of the load balancer using the certificate. Only set for tls-cert insights.



68
69
70
 
# File 'lib/datadog_api_client/v2/models/network_health_insight_attributes.rb', line 68

def loadbalancer_id
  @loadbalancer_id
end

#server_region ⇒ Object

AWS region where the server or load balancer is located. Only set for tls-cert insights.



71
72
73
 
# File 'lib/datadog_api_client/v2/models/network_health_insight_attributes.rb', line 71

def server_region
  @server_region
end

#server_service ⇒ Object

Name of the target service the client was trying to reach.



74
75
76
 
# File 'lib/datadog_api_client/v2/models/network_health_insight_attributes.rb', line 74

def server_service
  @server_service
end

#total_requests ⇒ Object

Total number of requests observed during the query window. Provides context for failure_magnitude and failure_rate. Only set for dns, tcp, and security-group insights.



78
79
80
 
# File 'lib/datadog_api_client/v2/models/network_health_insight_attributes.rb', line 78

def total_requests
  @total_requests
end

#traffic_volume ⇒ Object

Network traffic volume metrics between the client and server services during the query window.



81
82
83
 
# File 'lib/datadog_api_client/v2/models/network_health_insight_attributes.rb', line 81

def traffic_volume
  @traffic_volume
end

#type ⇒ Object

Category of network health insight. Indicates whether the insight relates to a DNS issue (dns), a TCP issue (tcp), a TLS certificate issue (tls-cert), or a security group denial (security-group).



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

def type
  @type
end