public class Get
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
| Modifier and Type | Class and Description |
|---|---|
| static class | Get1 The class that has a get method to call the endpoint |
| static class | GetRequest The request inputs class |
| static class | GetRequestBuilder A builder for the request input class |
public static class Get1 extends ApiClient.ApiClient1 implements GetOperation
a class that allows one to call the endpoint using a method named get
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.servers.Server0;
import org.openapijsonschematools.client.servers.Server1;
import org.openapijsonschematools.client.servers.Server2;
import org.openapijsonschematools.client.paths.fakewildcardresponses.get.responses.Code1XXResponse;
import org.openapijsonschematools.client.paths.fakewildcardresponses.get.responses.Code200Response;
import org.openapijsonschematools.client.paths.fakewildcardresponses.get.responses.Code2XXResponse;
import org.openapijsonschematools.client.paths.fakewildcardresponses.get.responses.Code3XXResponse;
import org.openapijsonschematools.client.paths.fakewildcardresponses.get.responses.Code4XXResponse;
import org.openapijsonschematools.client.paths.fakewildcardresponses.get.responses.Code5XXResponse;
import org.openapijsonschematools.client.paths.fakewildcardresponses.Get;
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());
Get.Get1 apiClient = new Get.Get1(apiConfiguration, schemaConfiguration);
var request = new GetRequestBuilder().build();
Responses.EndpointResponse response;
try {
response = apiClient.get(request);
} catch (Code4XXResponse.ResponseApiException | Code5XXResponse.ResponseApiException e) {
// server returned an error response defined in the openapi document
throw e;
} 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;
}
if (response instanceof Responses.EndpointCode1XXResponse castResponse) {
Code1XXResponse.ApplicationjsonResponseBody deserializedBody = (Code1XXResponse.ApplicationjsonResponseBody) castResponse.body;
// handle deserialized body here
} else if (response instanceof Responses.EndpointCode2XXResponse castResponse) {
Code2XXResponse.ApplicationjsonResponseBody deserializedBody = (Code2XXResponse.ApplicationjsonResponseBody) castResponse.body;
// handle deserialized body here
} else if (response instanceof Responses.EndpointCode200Response castResponse) {
Code200Response.ApplicationjsonResponseBody deserializedBody = (Code200Response.ApplicationjsonResponseBody) castResponse.body;
// handle deserialized body here
} else {
Responses.EndpointCode3XXResponse castResponse = (Responses.EndpointCode3XXResponse) response;
Code3XXResponse.ApplicationjsonResponseBody deserializedBody = (Code3XXResponse.ApplicationjsonResponseBody) castResponse.body;
// handle deserialized body here
}
| Constructor and Description |
|---|
| Get1(ApiConfiguration apiConfiguration, SchemaConfiguration schemaConfiguration) Creates an instance |
| Modifier and Type | Method and Description |
|---|---|
| Responses.EndpointResponse | get(GetRequest request) |
public static class GetRequest
a class that stores the final request inputs
| Modifier and Type | Field and Description |
|---|---|
| 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 |
public static class GetRequestBuilder
a builder for request inputs
| Constructor and Description |
|---|
| GetRequestBuilder() Creates a builder that contains null for all parameters |
| Modifier and Type | Method and Description |
|---|---|
| GetRequest | build() Returns the request input used to call an endpoint method |
| GetRequestBuilder | serverIndex(RootServerInfo.ServerIndex serverIndex) sets the optional property. Note: this will override the value in apiConfiguration |
| GetRequestBuilder | timeout(Duration timeout) sets the optional property. Note: this will override the value in apiConfiguration |