CommonparamsubdirDelete.md

CommonparamsubdirDelete

public class CommonparamsubdirDelete

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	Delete The class that has a delete method to call the endpoint
interface	DeleteCommonParamOperation The interface that has a deleteCommonParam 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

Delete

public static class Delete 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.commonparamsubdir.delete.CommonparamsubdirDeleteHeaderParameters;
import org.openapijsonschematools.client.RootServerInfo;
import org.openapijsonschematools.client.paths.commonparamsubdir.delete.CommonparamsubdirDeletePathParameters;
import org.openapijsonschematools.client.servers.RootServer0;
import org.openapijsonschematools.client.servers.RootServer1;
import org.openapijsonschematools.client.servers.RootServer2;
import org.openapijsonschematools.client.paths.commonparamsubdir.delete.responses.CommonparamsubdirDeleteCode200Response;
import org.openapijsonschematools.client.servers.RootServerInfo;
import org.openapijsonschematools.client.paths.commonparamsubdir.CommonparamsubdirDelete;
import org.openapijsonschematools.client.paths.commonparamsubdir.delete.CommonparamsubdirDeleteResponses;

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());
CommonparamsubdirDelete.Delete apiClient = new CommonparamsubdirDelete.Delete(apiConfiguration, schemaConfiguration);


// Map validation
CommonparamsubdirDeletePathParameters.PathParametersMap pathParameters =
    CommonparamsubdirDeletePathParameters.CommonparamsubdirDeletePathParameters1.validate(
    new CommonparamsubdirDeletePathParameters.PathParametersMapBuilder()
        .subDir("c")

    .build(),
    schemaConfiguration
);

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

CommonparamsubdirDeleteResponses.EndpointResponse response;
try {
    response = apiClient.delete(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;
}
CommonparamsubdirDeleteResponses.EndpointCommonparamsubdirDeleteCode200Response castResponse = (CommonparamsubdirDeleteResponses.EndpointCommonparamsubdirDeleteCode200Response) response;

Constructor Summary

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

Method Summary

Modifier and Type	Method and Description
CommonparamsubdirDeleteResponses.EndpointResponse	delete(DeleteRequest request)

DeleteCommonParamOperation

public interface DeleteCommonParamOperation

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

Method Summary

Modifier and Type	Method and Description
CommonparamsubdirDeleteResponses.EndpointResponse	deleteCommonParam(DeleteRequest request)

DeleteRequest

public static class DeleteRequest

a class that stores the final request inputs

Field Summary

Modifier and Type	Field and Description
CommonparamsubdirDeletePathParameters.PathParametersMap	pathParameters
CommonparamsubdirDeleteHeaderParameters.@Nullable HeaderParametersMap	headerParameters optional
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

DeleteNullableRequest

public static class DeleteNullableRequest

a class that stores the initial request inputs

Field Summary

Modifier and Type	Field and Description
CommonparamsubdirDeletePathParameters.@Nullable PathParametersMap	pathParameters
CommonparamsubdirDeleteHeaderParameters.@Nullable HeaderParametersMap	headerParameters
RootServerInfo.@Nullable ServerIndex	serverIndex
@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(CommonparamsubdirDeleteHeaderParametersHeaderParametersMap headerParameters) sets the optional property
Delete0RequestBuilder	serverIndex(RootServerInfo.ServerIndex serverIndex) 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(CommonparamsubdirDeletePathParametersPathParametersMap pathParameters) sets the property

[Back to top] [Back to README]