com.piiano.vault.client.openapi.model.HTTPCallRequest Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of openapi Show documentation
Show all versions of openapi Show documentation
Generated client for the open API of Piiano vault
/*
* Piiano Vault REST API
* --- sidebar_position: 1 sidebar_label: Overview description: The Piiano Vault REST API enables you to access and manage collections, objects, tokens, users, policies, and other resources within Piiano Vault. slug: / --- # Introduction The Piiano Vault REST API enables you to access and manage collections, objects, tokens, users, policies, and other resources within Piiano Vault in a simple, programmatic way using conventional HTTP requests and standard HTTP response codes. The API follows RESTful conventions when possible, with most operations performed by `GET`, `POST`, `PUT`, `PATCH`, and `DELETE` requests. Request and response bodies are [JSON-encoded](https://www.json.org/json-en.html). However, for collection operations, an SQL-like [PVSchema](/guides/reference/pvschema) encoding is available. This API reference provides details for each operation available in the API. When you install a local copy of Vault, you can try each operation using **Send API request**. An OpenAPI specification is available in [YAML](@site/static/assets/openapi.yaml) and [JSON](@site/static/assets/openapi.json) formats and can be used to generate client code for the API.
*
* The version of the OpenAPI document: 1.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
package com.piiano.vault.client.openapi.model;
import java.util.Objects;
import java.util.Arrays;
import com.google.gson.TypeAdapter;
import com.google.gson.annotations.JsonAdapter;
import com.google.gson.annotations.SerializedName;
import com.google.gson.stream.JsonReader;
import com.google.gson.stream.JsonWriter;
import java.io.IOException;
import java.util.HashMap;
import java.util.Map;
import com.google.gson.Gson;
import com.google.gson.GsonBuilder;
import com.google.gson.JsonArray;
import com.google.gson.JsonDeserializationContext;
import com.google.gson.JsonDeserializer;
import com.google.gson.JsonElement;
import com.google.gson.JsonObject;
import com.google.gson.JsonParseException;
import com.google.gson.TypeAdapterFactory;
import com.google.gson.reflect.TypeToken;
import java.lang.reflect.Type;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;
import java.util.Set;
import com.piiano.vault.client.openapi.JSON;
/**
* The HTTP request template.
*/
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-08-18T21:44:08.985764Z[Etc/UTC]")
public class HTTPCallRequest {
public static final String SERIALIZED_NAME_URL = "url";
@SerializedName(SERIALIZED_NAME_URL)
private String url;
/**
* The HTTP method to use.
*/
@JsonAdapter(MethodEnum.Adapter.class)
public enum MethodEnum {
GET("GET"),
HEAD("HEAD"),
POST("POST"),
PUT("PUT"),
PATCH("PATCH"),
DELETE("DELETE"),
CONNECT("CONNECT"),
OPTIONS("OPTIONS"),
TRACE("TRACE");
private String value;
MethodEnum(String value) {
this.value = value;
}
public String getValue() {
return value;
}
@Override
public String toString() {
return String.valueOf(value);
}
public static MethodEnum fromValue(String value) {
for (MethodEnum b : MethodEnum.values()) {
if (b.value.equals(value)) {
return b;
}
}
throw new IllegalArgumentException("Unexpected value '" + value + "'");
}
public static class Adapter extends TypeAdapter {
@Override
public void write(final JsonWriter jsonWriter, final MethodEnum enumeration) throws IOException {
jsonWriter.value(enumeration.getValue());
}
@Override
public MethodEnum read(final JsonReader jsonReader) throws IOException {
String value = jsonReader.nextString();
return MethodEnum.fromValue(value);
}
}
}
public static final String SERIALIZED_NAME_METHOD = "method";
@SerializedName(SERIALIZED_NAME_METHOD)
private MethodEnum method = MethodEnum.GET;
public static final String SERIALIZED_NAME_HEADERS = "headers";
@SerializedName(SERIALIZED_NAME_HEADERS)
private Map headers = new HashMap<>();
public static final String SERIALIZED_NAME_BODY = "body";
@SerializedName(SERIALIZED_NAME_BODY)
private String body;
public HTTPCallRequest() {
}
public HTTPCallRequest url(String url) {
this.url = url;
return this;
}
/**
* The URL to call.
* @return url
**/
@javax.annotation.Nonnull
public String getUrl() {
return url;
}
public void setUrl(String url) {
this.url = url;
}
public HTTPCallRequest method(MethodEnum method) {
this.method = method;
return this;
}
/**
* The HTTP method to use.
* @return method
**/
@javax.annotation.Nullable
public MethodEnum getMethod() {
return method;
}
public void setMethod(MethodEnum method) {
this.method = method;
}
public HTTPCallRequest headers(Map headers) {
this.headers = headers;
return this;
}
public HTTPCallRequest putHeadersItem(String key, String headersItem) {
if (this.headers == null) {
this.headers = new HashMap<>();
}
this.headers.put(key, headersItem);
return this;
}
/**
* The HTTP headers to send.
* @return headers
**/
@javax.annotation.Nullable
public Map getHeaders() {
return headers;
}
public void setHeaders(Map headers) {
this.headers = headers;
}
public HTTPCallRequest body(String body) {
this.body = body;
return this;
}
/**
* The HTTP body to send.
* @return body
**/
@javax.annotation.Nullable
public String getBody() {
return body;
}
public void setBody(String body) {
this.body = body;
}
@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
HTTPCallRequest htTPCallRequest = (HTTPCallRequest) o;
return Objects.equals(this.url, htTPCallRequest.url) &&
Objects.equals(this.method, htTPCallRequest.method) &&
Objects.equals(this.headers, htTPCallRequest.headers) &&
Objects.equals(this.body, htTPCallRequest.body);
}
@Override
public int hashCode() {
return Objects.hash(url, method, headers, body);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class HTTPCallRequest {\n");
sb.append(" url: ").append(toIndentedString(url)).append("\n");
sb.append(" method: ").append(toIndentedString(method)).append("\n");
sb.append(" headers: ").append(toIndentedString(headers)).append("\n");
sb.append(" body: ").append(toIndentedString(body)).append("\n");
sb.append("}");
return sb.toString();
}
/**
* Convert the given object to string with each line indented by 4 spaces
* (except the first line).
*/
private String toIndentedString(Object o) {
if (o == null) {
return "null";
}
return o.toString().replace("\n", "\n ");
}
public static HashSet openapiFields;
public static HashSet openapiRequiredFields;
static {
// a set of all properties/fields (JSON key names)
openapiFields = new HashSet();
openapiFields.add("url");
openapiFields.add("method");
openapiFields.add("headers");
openapiFields.add("body");
// a set of required properties/fields (JSON key names)
openapiRequiredFields = new HashSet();
openapiRequiredFields.add("url");
}
/**
* Validates the JSON Object and throws an exception if issues found
*
* @param jsonObj JSON Object
* @throws IOException if the JSON Object is invalid with respect to HTTPCallRequest
*/
public static void validateJsonObject(JsonObject jsonObj) throws IOException {
if (jsonObj == null) {
if (!HTTPCallRequest.openapiRequiredFields.isEmpty()) { // has required fields but JSON object is null
throw new IllegalArgumentException(String.format("The required field(s) %s in HTTPCallRequest is not found in the empty JSON string", HTTPCallRequest.openapiRequiredFields.toString()));
}
}
Set> entries = jsonObj.entrySet();
// check to see if the JSON string contains additional fields
for (Entry entry : entries) {
if (!HTTPCallRequest.openapiFields.contains(entry.getKey())) {
throw new IllegalArgumentException(String.format("The field `%s` in the JSON string is not defined in the `HTTPCallRequest` properties. JSON: %s", entry.getKey(), jsonObj.toString()));
}
}
// check to make sure all required properties/fields are present in the JSON string
for (String requiredField : HTTPCallRequest.openapiRequiredFields) {
if (jsonObj.get(requiredField) == null) {
throw new IllegalArgumentException(String.format("The required field `%s` is not found in the JSON string: %s", requiredField, jsonObj.toString()));
}
}
if (!jsonObj.get("url").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `url` to be a primitive type in the JSON string but got `%s`", jsonObj.get("url").toString()));
}
if ((jsonObj.get("method") != null && !jsonObj.get("method").isJsonNull()) && !jsonObj.get("method").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `method` to be a primitive type in the JSON string but got `%s`", jsonObj.get("method").toString()));
}
if ((jsonObj.get("body") != null && !jsonObj.get("body").isJsonNull()) && !jsonObj.get("body").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `body` to be a primitive type in the JSON string but got `%s`", jsonObj.get("body").toString()));
}
}
public static class CustomTypeAdapterFactory implements TypeAdapterFactory {
@SuppressWarnings("unchecked")
@Override
public TypeAdapter create(Gson gson, TypeToken type) {
if (!HTTPCallRequest.class.isAssignableFrom(type.getRawType())) {
return null; // this class only serializes 'HTTPCallRequest' and its subtypes
}
final TypeAdapter elementAdapter = gson.getAdapter(JsonElement.class);
final TypeAdapter thisAdapter
= gson.getDelegateAdapter(this, TypeToken.get(HTTPCallRequest.class));
return (TypeAdapter) new TypeAdapter() {
@Override
public void write(JsonWriter out, HTTPCallRequest value) throws IOException {
JsonObject obj = thisAdapter.toJsonTree(value).getAsJsonObject();
elementAdapter.write(out, obj);
}
@Override
public HTTPCallRequest read(JsonReader in) throws IOException {
JsonObject jsonObj = elementAdapter.read(in).getAsJsonObject();
validateJsonObject(jsonObj);
return thisAdapter.fromJsonTree(jsonObj);
}
}.nullSafe();
}
}
/**
* Create an instance of HTTPCallRequest given an JSON string
*
* @param jsonString JSON string
* @return An instance of HTTPCallRequest
* @throws IOException if the JSON string is invalid with respect to HTTPCallRequest
*/
public static HTTPCallRequest fromJson(String jsonString) throws IOException {
return JSON.getGson().fromJson(jsonString, HTTPCallRequest.class);
}
/**
* Convert an instance of HTTPCallRequest to an JSON string
*
* @return JSON string
*/
public String toJson() {
return JSON.getGson().toJson(this);
}
}