FaketestqueryparamtersPut.md

FaketestqueryparamtersPut

public class FaketestqueryparamtersPut

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	Put The class that has a put method to call the endpoint
interface	QueryParameterCollectionFormatOperation The interface that has a queryParameterCollectionFormat method to call the endpoint
static class	PutRequest The final request inputs class
static class	PutNullableRequest The initial request inputs class
static class	Put0RequestBuilder A builder for the request input class
static class	PutRequestBuilder A builder for the request input class

Put

public static class Put 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.faketestqueryparamters.put.FaketestqueryparamtersPutQueryParameters;
import org.openapijsonschematools.client.servers.RootServer0;
import org.openapijsonschematools.client.servers.RootServer1;
import org.openapijsonschematools.client.servers.RootServer2;
import org.openapijsonschematools.client.paths.faketestqueryparamters.put.responses.FaketestqueryparamtersPutCode200Response;
import org.openapijsonschematools.client.servers.RootServerInfo;
import org.openapijsonschematools.client.paths.faketestqueryparamters.FaketestqueryparamtersPut;
import org.openapijsonschematools.client.paths.faketestqueryparamters.put.FaketestqueryparamtersPutResponses;

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

// if you want to use a server that is not SERVER_0 pass it in here and change the ServerIndex input below
ApiConfiguration.ServerInfo serverInfo = new ApiConfiguration.ServerInfoBuilder()
    .rootServerInfo(
        new RootServerInfo.RootServerInfoBuilder()
            .rootServer0(new RootServer0())
            .build()
    )
    .build();
ApiConfiguration.ServerIndexInfo serverIndexInfo = new ApiConfiguration.ServerIndexInfoBuilder()
    .rootServerInfoServerIndex(RootServerInfo.ServerIndex.SERVER_0)
    .build();
Duration timeout = Duration.ofSeconds(1L);
Map<String, List<String>> defaultHeaders = Map.of("User-Agent", List.of("OpenAPI-JSON-Schema-Generator/1.0.0/java"));
ApiConfiguration apiConfiguration = new ApiConfiguration(
    serverInfo
    serverIndexInfo,
    timeout,
    defaultHeaders
);
SchemaConfiguration schemaConfiguration = new SchemaConfiguration(new JsonSchemaKeywordFlags.Builder().build());
FaketestqueryparamtersPut.Put apiClient = new FaketestqueryparamtersPut.Put(apiConfiguration, schemaConfiguration);


// Map validation
FaketestqueryparamtersPutQueryParameters.QueryParametersMap queryParameters =
    FaketestqueryparamtersPutQueryParameters.FaketestqueryparamtersPutQueryParameters1.validate(
    new FaketestqueryparamtersPutQueryParameters.QueryParametersMapBuilder()
        .context(
            Arrays.asList(
                "a"
            )
        )
        .http(
            Arrays.asList(
                "a"
            )
        )
        .ioutil(
            Arrays.asList(
                "a"
            )
        )
        .pipe(
            Arrays.asList(
                "a"
            )
        )
        .refParam("a")

        .url(
            Arrays.asList(
                "a"
            )
        )
    .build(),
    schemaConfiguration
);

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

FaketestqueryparamtersPutResponses.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;
}
FaketestqueryparamtersPutResponses.EndpointFaketestqueryparamtersPutCode200Response castResponse = (FaketestqueryparamtersPutResponses.EndpointFaketestqueryparamtersPutCode200Response) response;

Constructor Summary

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

Method Summary

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

QueryParameterCollectionFormatOperation

public interface QueryParameterCollectionFormatOperation

an interface that allows one to call the endpoint using a method named queryParameterCollectionFormat by the operationId

Method Summary

Modifier and Type	Method and Description
FaketestqueryparamtersPutResponses.EndpointResponse	queryParameterCollectionFormat(PutRequest request)

PutRequest

public static class PutRequest

a class that stores the final request inputs

Field Summary

Modifier and Type	Field and Description
FaketestqueryparamtersPutQueryParameters.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
FaketestqueryparamtersPutQueryParameters.@Nullable QueryParametersMap	queryParameters
RootServerInfo.@Nullable ServerIndex	serverIndex
@Nullable Duration	timeout

Put0RequestBuilder

public static class Put0RequestBuilder

a builder for request inputs

Constructor Summary

Constructor and Description
Put0RequestBuilder(Put0RequestBuilder 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
Put0RequestBuilder	serverIndex(RootServerInfo.ServerIndex serverIndex) sets the optional property. Note: this will override the value in apiConfiguration
Put0RequestBuilder	timeout(Duration timeout) sets the optional property. Note: this will override the value in apiConfiguration

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
Put0RequestBuilder	queryParameters(FaketestqueryparamtersPutQueryParametersQueryParametersMap queryParameters) sets the property

[Back to top] [Back to README]