Skip to content
This repository was archived by the owner on Dec 25, 2024. It is now read-only.

Latest commit

 

History

History
231 lines (186 loc) · 10.6 KB

HealthCheckResult.md

File metadata and controls

231 lines (186 loc) · 10.6 KB

HealthCheckResult

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

A class that contains necessary nested

  • schema classes (which validate payloads), extends JsonSchema
  • sealed interfaces which store validated payloads, java version of a sum type
  • boxed classes which store validated payloads, sealed permits class implementations
  • classes to store validated map payloads, extends FrozenMap
  • classes to build inputs for map payloads

Nested Class Summary

Modifier and Type Class and Description
sealed interface HealthCheckResult.HealthCheckResult1Boxed
sealed interface for validated payloads
record HealthCheckResult.HealthCheckResult1BoxedMap
boxed class to store validated Map payloads
static class HealthCheckResult.HealthCheckResult1
schema class
static class HealthCheckResult.HealthCheckResultMapBuilder
builder for Map payloads
static class HealthCheckResult.HealthCheckResultMap
output class for Map payloads
sealed interface HealthCheckResult.NullableMessageBoxed
sealed interface for validated payloads
record HealthCheckResult.NullableMessageBoxedVoid
boxed class to store validated null payloads
record HealthCheckResult.NullableMessageBoxedString
boxed class to store validated String payloads
static class HealthCheckResult.NullableMessage
schema class

HealthCheckResult1Boxed

public sealed interface HealthCheckResult1Boxed
permits
HealthCheckResult1BoxedMap

sealed interface that stores validated payloads using boxed classes

HealthCheckResult1BoxedMap

public record HealthCheckResult1BoxedMap
implements HealthCheckResult1Boxed

record that stores validated Map payloads, sealed permits implementation

Constructor Summary

Constructor and Description
HealthCheckResult1BoxedMap(HealthCheckResultMap data)
Creates an instance, private visibility

Method Summary

Modifier and Type Method and Description
HealthCheckResultMap data()
validated payload
@Nullable Object getData()
validated payload

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.validation.MapUtils;
import org.openapijsonschematools.client.schemas.validation.FrozenList;
import org.openapijsonschematools.client.schemas.validation.FrozenMap;
import org.openapijsonschematools.client.components.schemas.HealthCheckResult;

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

static final SchemaConfiguration configuration = new SchemaConfiguration(new JsonSchemaKeywordFlags.Builder().build());

// Map validation
HealthCheckResult.HealthCheckResultMap validatedPayload =
    HealthCheckResult.HealthCheckResult1.validate(
    new HealthCheckResult.HealthCheckResultMapBuilder()
        .NullableMessage(null)

    .build(),
    configuration
);

Field Summary

Modifier and Type Field and Description
Set<Class<?>> type = Set.of(Map.class)
Map<String, Class<? extends JsonSchema>> properties = Map.ofEntries(
    new PropertyEntry("NullableMessage", NullableMessage.class))
)

Method Summary

Modifier and Type Method and Description
HealthCheckResultMap validate(Map<?, ?> arg, SchemaConfiguration configuration)
HealthCheckResult1BoxedMap validateAndBox(Map<?, ?> arg, SchemaConfiguration configuration)
HealthCheckResult1Boxed validateAndBox(@Nullable Object arg, SchemaConfiguration configuration)
@Nullable Object validate(@Nullable Object arg, SchemaConfiguration configuration)

HealthCheckResultMapBuilder

public class HealthCheckResultMapBuilder
builder for Map<String, @Nullable Object>

A class that builds the Map input type

Constructor Summary

Constructor and Description
HealthCheckResultMapBuilder()
Creates a builder that contains an empty map

Method Summary

Modifier and Type Method and Description
Map<String, @Nullable Object> build()
Returns map input that should be used with Schema.validate
HealthCheckResultMapBuilder NullableMessage(Void value)
HealthCheckResultMapBuilder NullableMessage(String value)
HealthCheckResultMapBuilder additionalProperty(String key, Void value)
HealthCheckResultMapBuilder additionalProperty(String key, boolean value)
HealthCheckResultMapBuilder additionalProperty(String key, String value)
HealthCheckResultMapBuilder additionalProperty(String key, int value)
HealthCheckResultMapBuilder additionalProperty(String key, float value)
HealthCheckResultMapBuilder additionalProperty(String key, long value)
HealthCheckResultMapBuilder additionalProperty(String key, double value)
HealthCheckResultMapBuilder additionalProperty(String key, List<?> value)
HealthCheckResultMapBuilder additionalProperty(String key, Map<String, ?> value)

HealthCheckResultMap

public static class HealthCheckResultMap
extends FrozenMap<String, @Nullable Object>

A class to store validated Map payloads

Method Summary

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

NullableMessageBoxed

public sealed interface NullableMessageBoxed
permits
NullableMessageBoxedVoid, NullableMessageBoxedString

sealed interface that stores validated payloads using boxed classes

NullableMessageBoxedVoid

public record NullableMessageBoxedVoid
implements NullableMessageBoxed

record that stores validated null payloads, sealed permits implementation

Constructor Summary

Constructor and Description
NullableMessageBoxedVoid(Void data)
Creates an instance, private visibility

Method Summary

Modifier and Type Method and Description
Void data()
validated payload
@Nullable Object getData()
validated payload

NullableMessageBoxedString

public record NullableMessageBoxedString
implements NullableMessageBoxed

record that stores validated String payloads, sealed permits implementation

Constructor Summary

Constructor and Description
NullableMessageBoxedString(String data)
Creates an instance, private visibility

Method Summary

Modifier and Type Method and Description
String data()
validated payload
@Nullable Object getData()
validated payload

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.validation.MapUtils;
import org.openapijsonschematools.client.schemas.validation.FrozenList;
import org.openapijsonschematools.client.schemas.validation.FrozenMap;
import org.openapijsonschematools.client.components.schemas.HealthCheckResult;

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

static final SchemaConfiguration configuration = new SchemaConfiguration(new JsonSchemaKeywordFlags.Builder().build());

// 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
Set<Class<?>> type = Set.of(
    Void.class,
    String.class
)

Method Summary

Modifier and Type Method and Description
Void validate(Void arg, SchemaConfiguration configuration)
NullableMessageBoxedVoid validateAndBox(Void arg, SchemaConfiguration configuration)
String validate(String arg, SchemaConfiguration configuration)
NullableMessageBoxedString validateAndBox(String arg, SchemaConfiguration configuration)
NullableMessageBoxed validateAndBox(@Nullable Object arg, SchemaConfiguration configuration)
@Nullable Object validate(@Nullable Object arg, SchemaConfiguration configuration)

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