Put.md

Put

public class Put

A class that contains necessary endpoint classes

• a class that calls the endpoint method using the http verb
• a class that calls the endpoint method using the operationId name
• class(es) to store the request inputs
• builder(s) to set the request input data

Nested Class Summary

Modifier and Type	Class and Description
static class	Put1 The class that has a put method to call the endpoint
static class	PutRequest The final request inputs class
static class	PutNullableRequest The initial request inputs class
static class	Put00RequestBuilder A builder for the request input class
static class	Put01RequestBuilder A builder for the request input class
static class	Put10RequestBuilder A builder for the request input class
static class	PutRequestBuilder A builder for the request input class

Put1

public static class Put1 extends ApiClient.ApiClient1 implements PutOperation

a class that allows one to call the endpoint using a method named put

Code Sample

import org.openapijsonschematools.client.configurations.ApiConfiguration;
import org.openapijsonschematools.client.configurations.SchemaConfiguration;
import org.openapijsonschematools.client.configurations.JsonSchemaKeywordFlags;
import org.openapijsonschematools.client.exceptions.ValidationException;
import org.openapijsonschematools.client.exceptions.NotImplementedException;
import org.openapijsonschematools.client.exceptions.ApiException;
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.RootServerInfo;
import org.openapijsonschematools.client.paths.fakebodywithqueryparams.put.RequestBody;
import org.openapijsonschematools.client.components.schemas.User;
import org.openapijsonschematools.client.paths.fakebodywithqueryparams.put.QueryParameters;
import org.openapijsonschematools.client.servers.Server0;
import org.openapijsonschematools.client.servers.Server1;
import org.openapijsonschematools.client.servers.Server2;
import org.openapijsonschematools.client.paths.fakebodywithqueryparams.put.responses.Code200Response;
import org.openapijsonschematools.client.paths.fakebodywithqueryparams.Put;

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

// if you want to use a sever that is not SERVER_0 pass it in here and change the ServerIndex input below
ApiConfiguration.ServerInfo serverInfo = new ApiConfiguration.ServerInfo(
    new Server0(),
    null,
    null
);
ApiConfiguration.ServerIndexInfo serverIndexInfo = new ApiConfiguration.ServerIndexInfo()
    .rootServerInfoServerIndex(RootServerInfo.ServerIndex.SERVER_0);
Duration timeout = Duration.ofSeconds(1L);
ApiConfiguration apiConfiguration = new ApiConfiguration(
    serverInfo
    serverIndexInfo,
    timeout
);
SchemaConfiguration schemaConfiguration = new SchemaConfiguration(JsonSchemaKeywordFlags.ofNone());
Put.Put1 apiClient = new Put.Put1(apiConfiguration, schemaConfiguration);


User1BoxedMap requestBodyPayload =
    User.User1.validateAndBox(
    new User.UserMapBuilder()
        .id(1L)

        .username("a")

        .firstName("a")

        .lastName("a")

        .email("a")

        .password("a")

        .phone("a")

        .userStatus(1)

        .objectWithNoDeclaredPropsNullable(null)

    .build(),
    schemaConfiguration
);
Put.SealedRequestBody requestBody = new Put.ApplicationjsonRequestBody(requestBodyPayload);

// Map validation
QueryParameters.QueryParametersMap queryParameters =
    QueryParameters.QueryParameters1.validate(
    new QueryParameters.QueryParametersMapBuilder()
        .query("a")

    .build(),
    schemaConfiguration
);

var request = new PutRequestBuilder()
    .requestBody(requestBody)
    .queryParameters(queryParameters)
    .build();

Responses.EndpointResponse response;
try {
    response = apiClient.put(request);
} catch (ApiException e) {
    // server returned a response/contentType not defined in the openapi document
    throw e;
} catch (ValidationException e) {
    // the returned response body or header values do not conform the the schema validation requirements
    throw e;
} catch (IOException | InterruptedException e) {
    // an exception happened when making the request
    throw e;
} catch (NotImplementedException e) {
    // the request body serialization or deserialization has not yet been implemented
    // or the header content type deserialization has not yet been implemented for this contentType
    throw e;
}
Responses.EndpointCode200Response castResponse = (Responses.EndpointCode200Response) response;

Constructor Summary

Constructor and Description
Put1(ApiConfiguration apiConfiguration, SchemaConfiguration schemaConfiguration) Creates an instance

Method Summary

Modifier and Type	Method and Description
Responses.EndpointResponse	put(PutRequest request)

PutRequest

public static class PutRequest

a class that stores the final request inputs

Field Summary

Modifier and Type	Field and Description
RequestBody.SealedRequestBody	requestBody
QueryParameters.QueryParametersMap	queryParameters
RootServerInfo.@Nullable ServerIndex	serverIndex optional. Note: this will override the value in apiConfiguration
@Nullable Duration	timeout optional. Note: this will override the value in apiConfiguration

PutNullableRequest

public static class PutNullableRequest

a class that stores the initial request inputs

Field Summary

Modifier and Type	Field and Description
RequestBody.@Nullable SealedRequestBody	requestBody
QueryParameters.@Nullable QueryParametersMap	queryParameters
RootServerInfo.@Nullable ServerIndex	serverIndex
@Nullable Duration	timeout

Put00RequestBuilder

public static class Put00RequestBuilder

a builder for request inputs

Constructor Summary

Constructor and Description
Put00RequestBuilder(Put00RequestBuilder instance) Creates a builder that contains the passed instance

Method Summary

Modifier and Type	Method and Description
PutRequest	build() Returns the request input used to call an endpoint method
Put00RequestBuilder	serverIndex(RootServerInfo.ServerIndex serverIndex) sets the optional property. Note: this will override the value in apiConfiguration
Put00RequestBuilder	timeout(Duration timeout) sets the optional property. Note: this will override the value in apiConfiguration

Put01RequestBuilder

public static class Put01RequestBuilder

a builder for request inputs

Constructor Summary

Constructor and Description
Put01RequestBuilder(Put01RequestBuilder instance) Creates a builder that contains the passed instance

Method Summary

Modifier and Type	Method and Description
Put00RequestBuilder	queryParameters(QueryParametersQueryParametersMap queryParameters) sets the property

Put10RequestBuilder

public static class Put10RequestBuilder

a builder for request inputs

Constructor Summary

Constructor and Description
Put10RequestBuilder(Put10RequestBuilder instance) Creates a builder that contains the passed instance

Method Summary

Modifier and Type	Method and Description
Put00RequestBuilder	requestBody(RequestBody.SealedRequestBody requestBody) sets the property

PutRequestBuilder

public static class PutRequestBuilder

a builder for request inputs

Constructor Summary

Constructor and Description
PutRequestBuilder() Creates a builder that contains null for all parameters

Method Summary

Modifier and Type	Method and Description
Put01RequestBuilder	requestBody(RequestBody.SealedRequestBody requestBody) sets the property
Put10RequestBuilder	queryParameters(QueryParametersQueryParametersMap queryParameters) sets the property

[Back to top] [Back to README]