com.piiano.vault.client.openapi.model.InputObject 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 com.piiano.vault.client.openapi.model.EncryptedObjectInput;
import java.io.IOException;
import java.util.HashMap;
import java.util.Map;
import java.util.UUID;
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 input object, defined as one and only one of the following properties. - `id`: the ID of an object. - `fields`: property values of an object. - `encrypted`: an encrypted object. - `request_index`: the index of the object in the request array. In stateless mode, `id` is not supported and either `fields` or `encrypted` must be supplied.
*/
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-08-18T21:44:08.985764Z[Etc/UTC]")
public class InputObject {
public static final String SERIALIZED_NAME_ID = "id";
@SerializedName(SERIALIZED_NAME_ID)
private UUID id;
public static final String SERIALIZED_NAME_FIELDS = "fields";
@SerializedName(SERIALIZED_NAME_FIELDS)
private Map fields = new HashMap<>();
public static final String SERIALIZED_NAME_ENCRYPTED = "encrypted";
@SerializedName(SERIALIZED_NAME_ENCRYPTED)
private EncryptedObjectInput encrypted;
public static final String SERIALIZED_NAME_REQUEST_INDEX = "request_index";
@SerializedName(SERIALIZED_NAME_REQUEST_INDEX)
private Integer requestIndex;
public InputObject() {
}
public InputObject id(UUID id) {
this.id = id;
return this;
}
/**
* The ID of an object.
* @return id
**/
@javax.annotation.Nullable
public UUID getId() {
return id;
}
public void setId(UUID id) {
this.id = id;
}
public InputObject fields(Map fields) {
this.fields = fields;
return this;
}
public InputObject putFieldsItem(String key, Object fieldsItem) {
if (this.fields == null) {
this.fields = new HashMap<>();
}
this.fields.put(key, fieldsItem);
return this;
}
/**
* A list of maps of object properties and their values.
* @return fields
**/
@javax.annotation.Nullable
public Map getFields() {
return fields;
}
public void setFields(Map fields) {
this.fields = fields;
}
public InputObject encrypted(EncryptedObjectInput encrypted) {
this.encrypted = encrypted;
return this;
}
/**
* Get encrypted
* @return encrypted
**/
@javax.annotation.Nullable
public EncryptedObjectInput getEncrypted() {
return encrypted;
}
public void setEncrypted(EncryptedObjectInput encrypted) {
this.encrypted = encrypted;
}
public InputObject requestIndex(Integer requestIndex) {
this.requestIndex = requestIndex;
return this;
}
/**
* The index of the object in the request array.
* minimum: 0
* @return requestIndex
**/
@javax.annotation.Nullable
public Integer getRequestIndex() {
return requestIndex;
}
public void setRequestIndex(Integer requestIndex) {
this.requestIndex = requestIndex;
}
@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
InputObject inputObject = (InputObject) o;
return Objects.equals(this.id, inputObject.id) &&
Objects.equals(this.fields, inputObject.fields) &&
Objects.equals(this.encrypted, inputObject.encrypted) &&
Objects.equals(this.requestIndex, inputObject.requestIndex);
}
@Override
public int hashCode() {
return Objects.hash(id, fields, encrypted, requestIndex);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class InputObject {\n");
sb.append(" id: ").append(toIndentedString(id)).append("\n");
sb.append(" fields: ").append(toIndentedString(fields)).append("\n");
sb.append(" encrypted: ").append(toIndentedString(encrypted)).append("\n");
sb.append(" requestIndex: ").append(toIndentedString(requestIndex)).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("id");
openapiFields.add("fields");
openapiFields.add("encrypted");
openapiFields.add("request_index");
// a set of required properties/fields (JSON key names)
openapiRequiredFields = new HashSet();
}
/**
* 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 InputObject
*/
public static void validateJsonObject(JsonObject jsonObj) throws IOException {
if (jsonObj == null) {
if (!InputObject.openapiRequiredFields.isEmpty()) { // has required fields but JSON object is null
throw new IllegalArgumentException(String.format("The required field(s) %s in InputObject is not found in the empty JSON string", InputObject.openapiRequiredFields.toString()));
}
}
Set> entries = jsonObj.entrySet();
// check to see if the JSON string contains additional fields
for (Entry entry : entries) {
if (!InputObject.openapiFields.contains(entry.getKey())) {
throw new IllegalArgumentException(String.format("The field `%s` in the JSON string is not defined in the `InputObject` properties. JSON: %s", entry.getKey(), jsonObj.toString()));
}
}
if ((jsonObj.get("id") != null && !jsonObj.get("id").isJsonNull()) && !jsonObj.get("id").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `id` to be a primitive type in the JSON string but got `%s`", jsonObj.get("id").toString()));
}
// validate the optional field `encrypted`
if (jsonObj.get("encrypted") != null && !jsonObj.get("encrypted").isJsonNull()) {
EncryptedObjectInput.validateJsonObject(jsonObj.getAsJsonObject("encrypted"));
}
}
public static class CustomTypeAdapterFactory implements TypeAdapterFactory {
@SuppressWarnings("unchecked")
@Override
public TypeAdapter create(Gson gson, TypeToken type) {
if (!InputObject.class.isAssignableFrom(type.getRawType())) {
return null; // this class only serializes 'InputObject' and its subtypes
}
final TypeAdapter elementAdapter = gson.getAdapter(JsonElement.class);
final TypeAdapter thisAdapter
= gson.getDelegateAdapter(this, TypeToken.get(InputObject.class));
return (TypeAdapter) new TypeAdapter() {
@Override
public void write(JsonWriter out, InputObject value) throws IOException {
JsonObject obj = thisAdapter.toJsonTree(value).getAsJsonObject();
elementAdapter.write(out, obj);
}
@Override
public InputObject read(JsonReader in) throws IOException {
JsonObject jsonObj = elementAdapter.read(in).getAsJsonObject();
validateJsonObject(jsonObj);
return thisAdapter.fromJsonTree(jsonObj);
}
}.nullSafe();
}
}
/**
* Create an instance of InputObject given an JSON string
*
* @param jsonString JSON string
* @return An instance of InputObject
* @throws IOException if the JSON string is invalid with respect to InputObject
*/
public static InputObject fromJson(String jsonString) throws IOException {
return JSON.getGson().fromJson(jsonString, InputObject.class);
}
/**
* Convert an instance of InputObject to an JSON string
*
* @return JSON string
*/
public String toJson() {
return JSON.getGson().toJson(this);
}
}