HealthCheckResult.md

HealthCheckResult

org.openapijsonschematools.client.components.schemas.HealthCheckResult.java public class HealthCheckResult

A class that contains necessary nested schema classes, and classes to store validated list and map payloads

Nested Class Summary

Modifier and Type	Class and Description
static class	HealthCheckResult.HealthCheckResult1 schema class
static class	HealthCheckResult.HealthCheckResultMap output class for Map payloads
static class	HealthCheckResult.NullableMessage schema class

HealthCheckResult1

public static class HealthCheckResult1
extends JsonSchema

A schema class that validates payloads

Description

Just a string to inform instance is up and running. Make it nullable in hope to get it as pointer in generated model.

Code Sample

import org.openapijsonschematools.client.configurations.JsonSchemaKeywordFlags;
import org.openapijsonschematools.client.configurations.SchemaConfiguration;
import org.openapijsonschematools.client.exceptions.ValidationException;
import org.openapijsonschematools.client.schemas.MapMaker;
import org.openapijsonschematools.client.schemas.validation.FrozenList;
import org.openapijsonschematools.client.schemas.validation.FrozenMap;

import java.util.Arrays;
import java.util.List;
import java.util.AbstractMap;

static final SchemaConfiguration configuration = new SchemaConfiguration(JsonSchemaKeywordFlags.ofNone());

// Map validation
HealthCheckResult.HealthCheckResultMap validatedPayload =
    HealthCheckResult.HealthCheckResult1.validate(
    MapMaker.makeMap(
        new AbstractMap.SimpleEntry<>(
            "NullableMessage",
            (Void) null
        )
    ),
    configuration
);

Field Summary

Modifier and Type	Field and Description
static LinkedHashMap<String, KeywordValidator>	keywordToValidator new LinkedHashMap<>(Map.ofEntries(     new KeywordEntry("type", new TypeValidator(Set.of(FrozenMap.class))),     new KeywordEntry("properties", new PropertiesValidator(Map.ofEntries(         new PropertyEntry("NullableMessage", NullableMessage.class))     ))) ));

Method Summary

Modifier and Type	Method and Description
static HealthCheckResultMap	validate(Map<String, Object> arg, SchemaConfiguration configuration)

HealthCheckResultMap

public static class HealthCheckResultMap
extends FrozenMap<String, Object>

A class to store validated Map payloads

Method Summary

Modifier and Type	Method and Description
static HealthCheckResultMap	of(Map<String, Object> arg, SchemaConfiguration configuration)
String	NullableMessage() [optional]
Object	getAdditionalProperty(String name) provides type safety for additional properties

Input Map Keys

type: Map<String, Object>

Key	Type	Description	Notes
NullableMessage	String		[optional]
anyStringName	Object	any string name can be used but the value must be the correct type	[optional]

NullableMessage

public static class NullableMessage
extends JsonSchema

A schema class that validates payloads

Code Sample

import org.openapijsonschematools.client.configurations.JsonSchemaKeywordFlags;
import org.openapijsonschematools.client.configurations.SchemaConfiguration;
import org.openapijsonschematools.client.exceptions.ValidationException;
import org.openapijsonschematools.client.schemas.MapMaker;
import org.openapijsonschematools.client.schemas.validation.FrozenList;
import org.openapijsonschematools.client.schemas.validation.FrozenMap;

import java.util.Arrays;
import java.util.List;
import java.util.AbstractMap;

static final SchemaConfiguration configuration = new SchemaConfiguration(JsonSchemaKeywordFlags.ofNone());

// null validation
Void validatedPayload = HealthCheckResult.NullableMessage.validate(
    (Void) null,
    configuration
);

// String validation
String validatedPayload = HealthCheckResult.NullableMessage.validate(
    "a",
    configuration
);

Field Summary

Modifier and Type	Field and Description
static LinkedHashMap<String, KeywordValidator>	keywordToValidator new LinkedHashMap<>(Map.ofEntries(     new KeywordEntry("type", new TypeValidator(Set.of(         Void.class,         String.class     ))) ));

Method Summary

Modifier and Type	Method and Description
static Void	validate(Void arg, SchemaConfiguration configuration)
static String	validate(String arg, SchemaConfiguration configuration)

[Back to top] [Back to Component Schemas] [Back to README]