Open Kilda Java Documentation
org.openkilda.messaging.model.HealthCheck Class Reference
Inheritance diagram for org.openkilda.messaging.model.HealthCheck:

Public Member Functions

 HealthCheck ()
 
 HealthCheck (@JsonProperty("name") String name, @JsonProperty("version") String version, @JsonProperty("description") String description, @JsonProperty("components") Map< String, String > components)
 
String getName ()
 
void setName (final String name)
 
String getVersion ()
 
void setServiceVersion (final String version)
 
String getDescription ()
 
void setDescription (final String description)
 
Map< String, String > getComponents ()
 
void setComponents (Map< String, String > components)
 
String toString ()
 
boolean equals (Object obj)
 
int hashCode ()
 
boolean hasNonOperational ()
 

Detailed Description

Health-Check model representation class.

Definition at line 36 of file HealthCheck.java.

Constructor & Destructor Documentation

◆ HealthCheck() [1/2]

org.openkilda.messaging.model.HealthCheck.HealthCheck ( )

Constructs the health-check model.

Definition at line 69 of file HealthCheck.java.

◆ HealthCheck() [2/2]

org.openkilda.messaging.model.HealthCheck.HealthCheck ( @JsonProperty("name") String  name,
@JsonProperty("version") String  version,
@JsonProperty("description") String  description,
@JsonProperty("components") Map< String, String >  components 
)

Constructs the health-check model.

Parameters
nameservice name
versionservice version
descriptionservice description
componentscomponents status

Definition at line 81 of file HealthCheck.java.

Member Function Documentation

◆ equals()

boolean org.openkilda.messaging.model.HealthCheck.equals ( Object  obj)

Definition at line 180 of file HealthCheck.java.

◆ getComponents()

Map<String, String> org.openkilda.messaging.model.HealthCheck.getComponents ( )

Get components statuses.

Returns
components statuses

Definition at line 150 of file HealthCheck.java.

◆ getDescription()

String org.openkilda.messaging.model.HealthCheck.getDescription ( )

Gets service description.

Returns
service description

Definition at line 132 of file HealthCheck.java.

◆ getName()

String org.openkilda.messaging.model.HealthCheck.getName ( )

Gets service name.

Returns
service name

Definition at line 96 of file HealthCheck.java.

◆ getVersion()

String org.openkilda.messaging.model.HealthCheck.getVersion ( )

Gets service version.

Returns
service version

Definition at line 114 of file HealthCheck.java.

◆ hashCode()

int org.openkilda.messaging.model.HealthCheck.hashCode ( )

Definition at line 200 of file HealthCheck.java.

◆ hasNonOperational()

boolean org.openkilda.messaging.model.HealthCheck.hasNonOperational ( )

Checks topologies status.

Returns
true in case of any non operational topologies

Definition at line 209 of file HealthCheck.java.

◆ setComponents()

void org.openkilda.messaging.model.HealthCheck.setComponents ( Map< String, String >  components)

Sets components statuses.

Parameters
componentscomponents statuses

Definition at line 159 of file HealthCheck.java.

◆ setDescription()

void org.openkilda.messaging.model.HealthCheck.setDescription ( final String  description)

Sets service version.

Parameters
descriptionservice version

Definition at line 141 of file HealthCheck.java.

◆ setName()

void org.openkilda.messaging.model.HealthCheck.setName ( final String  name)

Sets service name.

Parameters
nameservice name

Definition at line 105 of file HealthCheck.java.

◆ setServiceVersion()

void org.openkilda.messaging.model.HealthCheck.setServiceVersion ( final String  version)

Sets service version.

Parameters
versionservice version

Definition at line 123 of file HealthCheck.java.

◆ toString()

String org.openkilda.messaging.model.HealthCheck.toString ( )

Definition at line 167 of file HealthCheck.java.


The documentation for this class was generated from the following file: