Delete.md

Delete

public class Delete

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	Delete1 The class that has a delete method to call the endpoint
static class	DeleteRequest The final request inputs class
static class	DeleteNullableRequest The initial request inputs class
static class	Delete0RequestBuilder A builder for the request input class
static class	DeleteRequestBuilder A builder for the request input class

Delete1

public static class Delete1 extends ApiClient.ApiClient1 implements DeleteOperation

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

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.petpetid.delete.HeaderParameters;
import org.openapijsonschematools.client.RootServerInfo;
import org.openapijsonschematools.client.paths.petpetid.delete.PetpetidDeleteSecurityInfo;
import org.openapijsonschematools.client.paths.petpetid.delete.PathParameters;
import org.openapijsonschematools.client.servers.Server0;
import org.openapijsonschematools.client.servers.Server1;
import org.openapijsonschematools.client.servers.Server2;
import org.openapijsonschematools.client.securityschemes.SecurityScheme;
import org.openapijsonschematools.client.components.securityschemes.ApiKey;
import org.openapijsonschematools.client.components.securityschemes.PetstoreAuth;
import org.openapijsonschematools.client.paths.petpetid.delete.responses.Code400Response;
import org.openapijsonschematools.client.paths.petpetid.Delete;

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);
List<SecurityScheme> securitySchemes = new ArrayList();
securitySchemes.add(
    new ApiKey("someApiKey");
);
ApiConfiguration.SecurityIndexInfo securityIndexInfo = new ApiConfiguration.SecurityIndexInfo();
    .petpetidDeleteSecurityInfoSecurityIndex(PetpetidDeleteSecurityInfo.SecurityIndex.SECURITY_0);
Duration timeout = Duration.ofSeconds(1L);
ApiConfiguration apiConfiguration = new ApiConfiguration(
    serverInfo
    serverIndexInfo,
    securitySchemes,
    securityIndexInfo,
    timeout
);
SchemaConfiguration schemaConfiguration = new SchemaConfiguration(JsonSchemaKeywordFlags.ofNone());
Delete.Delete1 apiClient = new Delete.Delete1(apiConfiguration, schemaConfiguration);


// Map validation
PathParameters.PathParametersMap pathParameters =
    PathParameters.PathParameters1.validate(
    new PathParameters.PathParametersMapBuilder()
        .petId(1L)

    .build(),
    schemaConfiguration
);

var request = new DeleteRequestBuilder()
    .pathParameters(pathParameters)
    .build();

Void response;
try {
    response = apiClient.delete(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;
}

Constructor Summary

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

Method Summary

Modifier and Type	Method and Description
Void	delete(DeleteRequest request)

DeleteRequest

public static class DeleteRequest

a class that stores the final request inputs

Field Summary

Modifier and Type	Field and Description
PathParameters.PathParametersMap	pathParameters
HeaderParameters.@Nullable HeaderParametersMap	headerParameters optional
RootServerInfo.@Nullable ServerIndex	serverIndex optional. Note: this will override the value in apiConfiguration
PetpetidDeleteSecurityInfo.@Nullable SecurityIndex	securityIndex optional. Note: this will override the value in apiConfiguration
@Nullable Duration	timeout optional. Note: this will override the value in apiConfiguration

DeleteNullableRequest

public static class DeleteNullableRequest

a class that stores the initial request inputs

Field Summary

Modifier and Type	Field and Description
PathParameters.@Nullable PathParametersMap	pathParameters
HeaderParameters.@Nullable HeaderParametersMap	headerParameters
RootServerInfo.@Nullable ServerIndex	serverIndex
PetpetidDeleteSecurityInfo.@Nullable SecurityIndex	securityIndex
@Nullable Duration	timeout

Delete0RequestBuilder

public static class Delete0RequestBuilder

a builder for request inputs

Constructor Summary

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

Method Summary

Modifier and Type	Method and Description
DeleteRequest	build() Returns the request input used to call an endpoint method
Delete0RequestBuilder	headerParameters(HeaderParametersHeaderParametersMap headerParameters) sets the optional property
Delete0RequestBuilder	serverIndex(RootServerInfo.ServerIndex serverIndex) sets the optional property. Note: this will override the value in apiConfiguration
Delete0RequestBuilder	securityIndex(PetpetidDeleteSecurityInfo.SecurityIndex securityIndex) sets the optional property. Note: this will override the value in apiConfiguration
Delete0RequestBuilder	timeout(Duration timeout) sets the optional property. Note: this will override the value in apiConfiguration

DeleteRequestBuilder

public static class DeleteRequestBuilder

a builder for request inputs

Constructor Summary

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

Method Summary

Modifier and Type	Method and Description
Delete0RequestBuilder	pathParameters(PathParametersPathParametersMap pathParameters) sets the property

[Back to top] [Back to README]