Get.md

Get

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

Nested Class Summary

Modifier and Type	Class and Description
static class	Get1 The class that has a get method to call the endpoint
static class	GetRequest The final request inputs class
static class	GetNullableRequest The initial request inputs class
static class	Get0RequestBuilder A builder for the request input class
static class	GetRequestBuilder A builder for the request input class

Get1

public static class Get1 extends ApiClient.ApiClient1 implements GetOperation

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

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.paths.petfindbystatus.PetfindbystatusServerInfo;
import org.openapijsonschematools.client.paths.petfindbystatus.get.PetfindbystatusGetSecurityInfo;
import org.openapijsonschematools.client.paths.petfindbystatus.get.QueryParameters;
import org.openapijsonschematools.client.paths.petfindbystatus.servers.PetfindbystatusServer0;
import org.openapijsonschematools.client.paths.petfindbystatus.servers.PetfindbystatusServer1;
import org.openapijsonschematools.client.securityschemes.SecurityScheme;
import org.openapijsonschematools.client.components.securityschemes.ApiKey;
import org.openapijsonschematools.client.components.securityschemes.HttpSignatureTest;
import org.openapijsonschematools.client.components.securityschemes.PetstoreAuth;
import org.openapijsonschematools.client.paths.petfindbystatus.get.responses.Code200Response;
import org.openapijsonschematools.client.paths.petfindbystatus.get.responses.Code400Response;
import org.openapijsonschematools.client.paths.petfindbystatus.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 PetfindbystatusServer0(),
    null
);
ApiConfiguration.ServerIndexInfo serverIndexInfo = new ApiConfiguration.ServerIndexInfo()
    .petfindbystatusServerInfoServerIndex(PetfindbystatusServerInfo.ServerIndex.SERVER_0);
List<SecurityScheme> securitySchemes = new ArrayList();
securitySchemes.add(
    new ApiKey("someApiKey");
);
ApiConfiguration.SecurityIndexInfo securityIndexInfo = new ApiConfiguration.SecurityIndexInfo();
    .petfindbystatusGetSecurityInfoSecurityIndex(PetfindbystatusGetSecurityInfo.SecurityIndex.SECURITY_0);
Duration timeout = Duration.ofSeconds(1L);
ApiConfiguration apiConfiguration = new ApiConfiguration(
    serverInfo
    serverIndexInfo,
    securitySchemes,
    securityIndexInfo,
    timeout
);
SchemaConfiguration schemaConfiguration = new SchemaConfiguration(JsonSchemaKeywordFlags.ofNone());
Get.Get1 apiClient = new Get.Get1(apiConfiguration, schemaConfiguration);


// Map validation
QueryParameters.QueryParametersMap queryParameters =
    QueryParameters.QueryParameters1.validate(
    new QueryParameters.QueryParametersMapBuilder()
        .status(
            Arrays.asList(
                "available"
            )
        )
    .build(),
    schemaConfiguration
);

var request = new GetRequestBuilder()
    .queryParameters(queryParameters)
    .build();

Responses.EndpointResponse response;
try {
    response = apiClient.get(request);
} catch (Code400Response.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;
}
Responses.EndpointCode200Response castResponse = (Responses.EndpointCode200Response) response;
}

Constructor Summary

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

Method Summary

Modifier and Type	Method and Description
Responses.EndpointResponse	get(GetRequest request)

GetRequest

public static class GetRequest

a class that stores the final request inputs

Field Summary

Modifier and Type	Field and Description
QueryParameters.QueryParametersMap	queryParameters
PetfindbystatusServerInfo.@Nullable ServerIndex	serverIndex optional. Note: this will override the value in apiConfiguration
PetfindbystatusGetSecurityInfo.@Nullable SecurityIndex	securityIndex optional. Note: this will override the value in apiConfiguration
@Nullable Duration	timeout optional. Note: this will override the value in apiConfiguration

GetNullableRequest

public static class GetNullableRequest

a class that stores the initial request inputs

Field Summary

Modifier and Type	Field and Description
QueryParameters.@Nullable QueryParametersMap	queryParameters
PetfindbystatusServerInfo.@Nullable ServerIndex	serverIndex
PetfindbystatusGetSecurityInfo.@Nullable SecurityIndex	securityIndex
@Nullable Duration	timeout

Get0RequestBuilder

public static class Get0RequestBuilder

a builder for request inputs

Constructor Summary

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

Method Summary

Modifier and Type	Method and Description
GetRequest	build() Returns the request input used to call an endpoint method
Get0RequestBuilder	serverIndex(PetfindbystatusServerInfo.ServerIndex serverIndex) sets the optional property. Note: this will override the value in apiConfiguration
Get0RequestBuilder	securityIndex(PetfindbystatusGetSecurityInfo.SecurityIndex securityIndex) sets the optional property. Note: this will override the value in apiConfiguration
Get0RequestBuilder	timeout(Duration timeout) sets the optional property. Note: this will override the value in apiConfiguration

GetRequestBuilder

public static class GetRequestBuilder

a builder for request inputs

Constructor Summary

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

Method Summary

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

[Back to top] [Back to README]