NetworkHealthInsightAttributes (datadog-api-client 2.56.0 API)

java.lang.Object
- com.datadog.api.client.v2.model.NetworkHealthInsightAttributes

@Generated(value="https://github.com/DataDog/datadog-api-client-java/blob/master/.generator")
public class NetworkHealthInsightAttributes
extends Object

Detailed attributes of a network health insight.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`JSON_PROPERTY_ACCOUNT_ID`
`static String`	`JSON_PROPERTY_CERTIFICATE_ID`
`static String`	`JSON_PROPERTY_CERTIFICATE_LIFETIME_PERCENT`
`static String`	`JSON_PROPERTY_CLIENT_REGION`
`static String`	`JSON_PROPERTY_CLIENT_SERVICE`
`static String`	`JSON_PROPERTY_DAYS_UNTIL_EXPIRATION`
`static String`	`JSON_PROPERTY_DNS_QUERY`
`static String`	`JSON_PROPERTY_DNS_SERVER`
`static String`	`JSON_PROPERTY_DOMAIN_NAME`
`static String`	`JSON_PROPERTY_FAILURE_MAGNITUDE`
`static String`	`JSON_PROPERTY_FAILURE_RATE`
`static String`	`JSON_PROPERTY_FAILURE_TYPE`
`static String`	`JSON_PROPERTY_LOADBALANCER_ID`
`static String`	`JSON_PROPERTY_SERVER_REGION`
`static String`	`JSON_PROPERTY_SERVER_SERVICE`
`static String`	`JSON_PROPERTY_TOTAL_REQUESTS`
`static String`	`JSON_PROPERTY_TRAFFIC_VOLUME`
`static String`	`JSON_PROPERTY_TYPE`
`boolean`	`unparsed`

Constructor Summary

Constructors
Constructor and Description

NetworkHealthInsightAttributes()

Constructors
Constructor and Description
`NetworkHealthInsightAttributes()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`NetworkHealthInsightAttributes`	`accountId(String accountId)`
`NetworkHealthInsightAttributes`	`certificateId(String certificateId)`
`NetworkHealthInsightAttributes`	`certificateLifetimePercent(Double certificateLifetimePercent)`
`NetworkHealthInsightAttributes`	`clientRegion(String clientRegion)`
`NetworkHealthInsightAttributes`	`clientService(String clientService)`
`NetworkHealthInsightAttributes`	`daysUntilExpiration(Long daysUntilExpiration)`
`NetworkHealthInsightAttributes`	`dnsQuery(String dnsQuery)`
`NetworkHealthInsightAttributes`	`dnsServer(String dnsServer)`
`NetworkHealthInsightAttributes`	`domainName(String domainName)`
`boolean`	`equals(Object o)` Return true if this NetworkHealthInsightAttributes object is equal to o.
`NetworkHealthInsightAttributes`	`failureMagnitude(Long failureMagnitude)`
`NetworkHealthInsightAttributes`	`failureRate(Double failureRate)`
`NetworkHealthInsightAttributes`	`failureType(NetworkHealthInsightFailureType failureType)`
`String`	`getAccountId()` AWS account identifier where the certificate is located.
`Map<String,Object>`	`getAdditionalProperties()` Return the additional (undeclared) property.
`Object`	`getAdditionalProperty(String key)` Return the additional (undeclared) property with the specified name.
`String`	`getCertificateId()` ARN or identifier of the certificate.
`Double`	`getCertificateLifetimePercent()` Percentage of the certificate's validity period that has elapsed, ranging from 0 to 100.
`String`	`getClientRegion()` AWS region where the client is located.
`String`	`getClientService()` Name of the service making the request (DNS query or TLS-secured connection).
`Long`	`getDaysUntilExpiration()` Number of days remaining until the certificate expires.
`String`	`getDnsQuery()` Domain name that was being resolved when the DNS failure occurred.
`String`	`getDnsServer()` DNS server that received the failing query.
`String`	`getDomainName()` Domain name covered by the certificate.
`Long`	`getFailureMagnitude()` Count of failed events observed during the query window.
`Double`	`getFailureRate()` Percentage of requests that failed during the query window, ranging from 0 to 100.
`NetworkHealthInsightFailureType`	`getFailureType()` Specific failure type within the insight category.
`String`	`getLoadbalancerId()` ARN of the load balancer using the certificate.
`String`	`getServerRegion()` AWS region where the server or load balancer is located.
`String`	`getServerService()` Name of the target service the client was trying to reach.
`Long`	`getTotalRequests()` Total number of requests observed during the query window.
`NetworkHealthInsightTrafficVolume`	`getTrafficVolume()` Network traffic volume metrics between the client and server services during the query window.
`NetworkHealthInsightCategory`	`getType()` Category of network health insight.
`int`	`hashCode()`
`NetworkHealthInsightAttributes`	`loadbalancerId(String loadbalancerId)`
`NetworkHealthInsightAttributes`	`putAdditionalProperty(String key, Object value)` Set the additional (undeclared) property with the specified name and value.
`NetworkHealthInsightAttributes`	`serverRegion(String serverRegion)`
`NetworkHealthInsightAttributes`	`serverService(String serverService)`
`void`	`setAccountId(String accountId)`
`void`	`setCertificateId(String certificateId)`
`void`	`setCertificateLifetimePercent(Double certificateLifetimePercent)`
`void`	`setClientRegion(String clientRegion)`
`void`	`setClientService(String clientService)`
`void`	`setDaysUntilExpiration(Long daysUntilExpiration)`
`void`	`setDnsQuery(String dnsQuery)`
`void`	`setDnsServer(String dnsServer)`
`void`	`setDomainName(String domainName)`
`void`	`setFailureMagnitude(Long failureMagnitude)`
`void`	`setFailureRate(Double failureRate)`
`void`	`setFailureType(NetworkHealthInsightFailureType failureType)`
`void`	`setLoadbalancerId(String loadbalancerId)`
`void`	`setServerRegion(String serverRegion)`
`void`	`setServerService(String serverService)`
`void`	`setTotalRequests(Long totalRequests)`
`void`	`setTrafficVolume(NetworkHealthInsightTrafficVolume trafficVolume)`
`void`	`setType(NetworkHealthInsightCategory type)`
`String`	`toString()`
`NetworkHealthInsightAttributes`	`totalRequests(Long totalRequests)`
`NetworkHealthInsightAttributes`	`trafficVolume(NetworkHealthInsightTrafficVolume trafficVolume)`
`NetworkHealthInsightAttributes`	`type(NetworkHealthInsightCategory type)`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

unparsed
```
public boolean unparsed
```

JSON_PROPERTY_ACCOUNT_ID

public static final String JSON_PROPERTY_ACCOUNT_ID

See Also:: Constant Field Values

JSON_PROPERTY_CERTIFICATE_ID

public static final String JSON_PROPERTY_CERTIFICATE_ID

See Also:: Constant Field Values

JSON_PROPERTY_CERTIFICATE_LIFETIME_PERCENT

public static final String JSON_PROPERTY_CERTIFICATE_LIFETIME_PERCENT

See Also:: Constant Field Values

JSON_PROPERTY_CLIENT_REGION

public static final String JSON_PROPERTY_CLIENT_REGION

See Also:: Constant Field Values

JSON_PROPERTY_CLIENT_SERVICE

public static final String JSON_PROPERTY_CLIENT_SERVICE

See Also:: Constant Field Values

JSON_PROPERTY_DAYS_UNTIL_EXPIRATION

public static final String JSON_PROPERTY_DAYS_UNTIL_EXPIRATION

See Also:: Constant Field Values

JSON_PROPERTY_DNS_QUERY

public static final String JSON_PROPERTY_DNS_QUERY

See Also:: Constant Field Values

JSON_PROPERTY_DNS_SERVER

public static final String JSON_PROPERTY_DNS_SERVER

See Also:: Constant Field Values

JSON_PROPERTY_DOMAIN_NAME

public static final String JSON_PROPERTY_DOMAIN_NAME

See Also:: Constant Field Values

JSON_PROPERTY_FAILURE_MAGNITUDE

public static final String JSON_PROPERTY_FAILURE_MAGNITUDE

See Also:: Constant Field Values

JSON_PROPERTY_FAILURE_RATE

public static final String JSON_PROPERTY_FAILURE_RATE

See Also:: Constant Field Values

JSON_PROPERTY_FAILURE_TYPE

public static final String JSON_PROPERTY_FAILURE_TYPE

See Also:: Constant Field Values

JSON_PROPERTY_LOADBALANCER_ID

public static final String JSON_PROPERTY_LOADBALANCER_ID

See Also:: Constant Field Values

JSON_PROPERTY_SERVER_REGION

public static final String JSON_PROPERTY_SERVER_REGION

See Also:: Constant Field Values

JSON_PROPERTY_SERVER_SERVICE

public static final String JSON_PROPERTY_SERVER_SERVICE

See Also:: Constant Field Values

JSON_PROPERTY_TOTAL_REQUESTS

public static final String JSON_PROPERTY_TOTAL_REQUESTS

See Also:: Constant Field Values

JSON_PROPERTY_TRAFFIC_VOLUME

public static final String JSON_PROPERTY_TRAFFIC_VOLUME

See Also:: Constant Field Values

JSON_PROPERTY_TYPE

public static final String JSON_PROPERTY_TYPE

See Also:: Constant Field Values

Constructor Detail
- NetworkHealthInsightAttributes
```
public NetworkHealthInsightAttributes()
```

Method Detail
- accountId
```
public NetworkHealthInsightAttributes accountId(String accountId)
```
- getAccountId
```
@Nullable
public String getAccountId()
```
  AWS account identifier where the certificate is located. Only set for tls-cert insights.
  
  Returns:
  
  accountId
- setAccountId
```
public void setAccountId(String accountId)
```
- certificateId
```
public NetworkHealthInsightAttributes certificateId(String certificateId)
```
- getCertificateId
```
@Nullable
public String getCertificateId()
```
  ARN or identifier of the certificate. Only set for tls-cert insights.
  
  Returns:
  
  certificateId
- setCertificateId
```
public void setCertificateId(String certificateId)
```
- certificateLifetimePercent
```
public NetworkHealthInsightAttributes certificateLifetimePercent(Double certificateLifetimePercent)
```
- getCertificateLifetimePercent
```
@Nullable
public Double getCertificateLifetimePercent()
```
  Percentage of the certificate's validity period that has elapsed, ranging from 0 to 100. Only set for tls-cert insights.
  
  Returns:
  
  certificateLifetimePercent
- setCertificateLifetimePercent
```
public void setCertificateLifetimePercent(Double certificateLifetimePercent)
```
- clientRegion
```
public NetworkHealthInsightAttributes clientRegion(String clientRegion)
```
- getClientRegion
```
@Nullable
public String getClientRegion()
```
  AWS region where the client is located. Only set for tls-cert insights.
  
  Returns:
  
  clientRegion
- setClientRegion
```
public void setClientRegion(String clientRegion)
```
- clientService
```
public NetworkHealthInsightAttributes clientService(String clientService)
```
- getClientService
```
@Nullable
public String getClientService()
```
  Name of the service making the request (DNS query or TLS-secured connection). Set to N/A when the client service cannot be determined.
  
  Returns:
  
  clientService
- setClientService
```
public void setClientService(String clientService)
```
- daysUntilExpiration
```
public NetworkHealthInsightAttributes daysUntilExpiration(Long daysUntilExpiration)
```
- getDaysUntilExpiration
```
@Nullable
public Long getDaysUntilExpiration()
```
  Number of days remaining until the certificate expires. Negative values indicate the certificate has already expired. Only set for tls-cert insights.
  
  Returns:
  
  daysUntilExpiration
- setDaysUntilExpiration
```
public void setDaysUntilExpiration(Long daysUntilExpiration)
```
- dnsQuery
```
public NetworkHealthInsightAttributes dnsQuery(String dnsQuery)
```
- getDnsQuery
```
@Nullable
public String getDnsQuery()
```
  Domain name that was being resolved when the DNS failure occurred. Only set for dns insights.
  
  Returns:
  
  dnsQuery
- setDnsQuery
```
public void setDnsQuery(String dnsQuery)
```
- dnsServer
```
public NetworkHealthInsightAttributes dnsServer(String dnsServer)
```
- getDnsServer
```
@Nullable
public String getDnsServer()
```
  DNS server that received the failing query. Only set for dns insights.
  
  Returns:
  
  dnsServer
- setDnsServer
```
public void setDnsServer(String dnsServer)
```
- domainName
```
public NetworkHealthInsightAttributes domainName(String domainName)
```
- getDomainName
```
@Nullable
public String getDomainName()
```
  Domain name covered by the certificate. Only set for tls-cert insights.
  
  Returns:
  
  domainName
- setDomainName
```
public void setDomainName(String domainName)
```
- failureMagnitude
```
public NetworkHealthInsightAttributes failureMagnitude(Long failureMagnitude)
```
- getFailureMagnitude
```
@Nullable
public Long getFailureMagnitude()
```
  Count of failed events observed during the query window. Only set for dns, tcp, and security-group insights. minimum: 0
  
  Returns:
  
  failureMagnitude
- setFailureMagnitude
```
public void setFailureMagnitude(Long failureMagnitude)
```
- failureRate
```
public NetworkHealthInsightAttributes failureRate(Double failureRate)
```
- getFailureRate
```
@Nullable
public Double getFailureRate()
```
  Percentage of requests that failed during the query window, ranging from 0 to 100. Only set for dns, tcp, and security-group insights. minimum: 0 maximum: 100
  
  Returns:
  
  failureRate
- setFailureRate
```
public void setFailureRate(Double failureRate)
```
- failureType
```
public NetworkHealthInsightAttributes failureType(NetworkHealthInsightFailureType failureType)
```
- getFailureType
```
@Nullable
public NetworkHealthInsightFailureType getFailureType()
```
  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.
  
  Returns:
  
  failureType
- setFailureType
```
public void setFailureType(NetworkHealthInsightFailureType failureType)
```
- loadbalancerId
```
public NetworkHealthInsightAttributes loadbalancerId(String loadbalancerId)
```
- getLoadbalancerId
```
@Nullable
public String getLoadbalancerId()
```
  ARN of the load balancer using the certificate. Only set for tls-cert insights.
  
  Returns:
  
  loadbalancerId
- setLoadbalancerId
```
public void setLoadbalancerId(String loadbalancerId)
```
- serverRegion
```
public NetworkHealthInsightAttributes serverRegion(String serverRegion)
```
- getServerRegion
```
@Nullable
public String getServerRegion()
```
  AWS region where the server or load balancer is located. Only set for tls-cert insights.
  
  Returns:
  
  serverRegion
- setServerRegion
```
public void setServerRegion(String serverRegion)
```
- serverService
```
public NetworkHealthInsightAttributes serverService(String serverService)
```
- getServerService
```
@Nullable
public String getServerService()
```
  Name of the target service the client was trying to reach.
  
  Returns:
  
  serverService
- setServerService
```
public void setServerService(String serverService)
```
- totalRequests
```
public NetworkHealthInsightAttributes totalRequests(Long totalRequests)
```
- getTotalRequests
```
@Nullable
public Long getTotalRequests()
```
  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. minimum: 0
  
  Returns:
  
  totalRequests
- setTotalRequests
```
public void setTotalRequests(Long totalRequests)
```
- trafficVolume
```
public NetworkHealthInsightAttributes trafficVolume(NetworkHealthInsightTrafficVolume trafficVolume)
```
- getTrafficVolume
```
@Nullable
public NetworkHealthInsightTrafficVolume getTrafficVolume()
```
  Network traffic volume metrics between the client and server services during the query window.
  
  Returns:
  
  trafficVolume
- setTrafficVolume
```
public void setTrafficVolume(NetworkHealthInsightTrafficVolume trafficVolume)
```
- type
```
public NetworkHealthInsightAttributes type(NetworkHealthInsightCategory type)
```
- getType
```
@Nullable
public NetworkHealthInsightCategory getType()
```
  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).
  
  Returns:
  
  type
- setType
```
public void setType(NetworkHealthInsightCategory type)
```
- putAdditionalProperty
```
public NetworkHealthInsightAttributes putAdditionalProperty(String key,
                                                            Object value)
```
  Set the additional (undeclared) property with the specified name and value. If the property does not already exist, create it otherwise replace it.
  
  Parameters:
  
  key - The arbitrary key to set
  
  value - The associated value
  
  Returns:
  
  NetworkHealthInsightAttributes
- getAdditionalProperties
```
public Map<String,Object> getAdditionalProperties()
```
  Return the additional (undeclared) property.
  
  Returns:
  
  The additional properties
- getAdditionalProperty
```
public Object getAdditionalProperty(String key)
```
  Return the additional (undeclared) property with the specified name.
  
  Parameters:
  
  key - The arbitrary key to get
  
  Returns:
  
  The specific additional property for the given key
- equals
```
public boolean equals(Object o)
```
  Return true if this NetworkHealthInsightAttributes object is equal to o.
  
  Overrides:
  
  equals in class Object
- hashCode
```
public int hashCode()
```
  Overrides:
  
  hashCode in class Object
- toString
```
public String toString()
```
  Overrides:
  
  toString in class Object

Class NetworkHealthInsightAttributes

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

unparsed

JSON_PROPERTY_ACCOUNT_ID

JSON_PROPERTY_CERTIFICATE_ID

JSON_PROPERTY_CERTIFICATE_LIFETIME_PERCENT

JSON_PROPERTY_CLIENT_REGION

JSON_PROPERTY_CLIENT_SERVICE

JSON_PROPERTY_DAYS_UNTIL_EXPIRATION

JSON_PROPERTY_DNS_QUERY

JSON_PROPERTY_DNS_SERVER

JSON_PROPERTY_DOMAIN_NAME

JSON_PROPERTY_FAILURE_MAGNITUDE

JSON_PROPERTY_FAILURE_RATE

JSON_PROPERTY_FAILURE_TYPE

JSON_PROPERTY_LOADBALANCER_ID

JSON_PROPERTY_SERVER_REGION

JSON_PROPERTY_SERVER_SERVICE

JSON_PROPERTY_TOTAL_REQUESTS

JSON_PROPERTY_TRAFFIC_VOLUME

JSON_PROPERTY_TYPE

Constructor Detail

NetworkHealthInsightAttributes

Method Detail

accountId

getAccountId

setAccountId

certificateId

getCertificateId

setCertificateId

certificateLifetimePercent

getCertificateLifetimePercent

setCertificateLifetimePercent

clientRegion

getClientRegion

setClientRegion

clientService

getClientService

setClientService

daysUntilExpiration

getDaysUntilExpiration

setDaysUntilExpiration

dnsQuery

getDnsQuery

setDnsQuery

dnsServer

getDnsServer

setDnsServer

domainName

getDomainName

setDomainName

failureMagnitude

getFailureMagnitude

setFailureMagnitude

failureRate

getFailureRate

setFailureRate

failureType

getFailureType

setFailureType

loadbalancerId

getLoadbalancerId

setLoadbalancerId

serverRegion

getServerRegion

setServerRegion

serverService

getServerService

setServerService

totalRequests

getTotalRequests

setTotalRequests

trafficVolume

getTrafficVolume

setTrafficVolume

type