com.piiano.vault.client.openapi.model.Collection 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.Property;
import java.io.IOException;
import java.time.OffsetDateTime;
import java.util.ArrayList;
import java.util.List;
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;
/**
* Collection
*/
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-08-15T11:38:23.394549Z[Etc/UTC]")
public class Collection {
public static final String SERIALIZED_NAME_CREATION_TIME = "creation_time";
@SerializedName(SERIALIZED_NAME_CREATION_TIME)
private OffsetDateTime creationTime;
public static final String SERIALIZED_NAME_MODIFICATION_TIME = "modification_time";
@SerializedName(SERIALIZED_NAME_MODIFICATION_TIME)
private OffsetDateTime modificationTime;
public static final String SERIALIZED_NAME_NAME = "name";
@SerializedName(SERIALIZED_NAME_NAME)
private String name;
public static final String SERIALIZED_NAME_PROPERTIES = "properties";
@SerializedName(SERIALIZED_NAME_PROPERTIES)
private List properties = new ArrayList<>();
/**
* The schema prototype the collection is based on.
*/
@JsonAdapter(TypeEnum.Adapter.class)
public enum TypeEnum {
PERSONS("PERSONS"),
DATA("DATA");
private String value;
TypeEnum(String value) {
this.value = value;
}
public String getValue() {
return value;
}
@Override
public String toString() {
return String.valueOf(value);
}
public static TypeEnum fromValue(String value) {
for (TypeEnum b : TypeEnum.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 TypeEnum enumeration) throws IOException {
jsonWriter.value(enumeration.getValue());
}
@Override
public TypeEnum read(final JsonReader jsonReader) throws IOException {
String value = jsonReader.nextString();
return TypeEnum.fromValue(value);
}
}
}
public static final String SERIALIZED_NAME_TYPE = "type";
@SerializedName(SERIALIZED_NAME_TYPE)
private TypeEnum type;
public Collection() {
}
public Collection creationTime(OffsetDateTime creationTime) {
this.creationTime = creationTime;
return this;
}
/**
* The time when the collection was created, in RFC3339Nano format. Vault sets this value automatically. Sending a value for this field is ignored.
* @return creationTime
**/
@javax.annotation.Nullable
public OffsetDateTime getCreationTime() {
return creationTime;
}
public void setCreationTime(OffsetDateTime creationTime) {
this.creationTime = creationTime;
}
public Collection modificationTime(OffsetDateTime modificationTime) {
this.modificationTime = modificationTime;
return this;
}
/**
* The time when the collection was last modified, in RFC3339Nano format. Vault sets this value automatically. Sending a value for this field is ignored.
* @return modificationTime
**/
@javax.annotation.Nullable
public OffsetDateTime getModificationTime() {
return modificationTime;
}
public void setModificationTime(OffsetDateTime modificationTime) {
this.modificationTime = modificationTime;
}
public Collection name(String name) {
this.name = name;
return this;
}
/**
* The name of a collection.
* @return name
**/
@javax.annotation.Nonnull
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public Collection properties(List properties) {
this.properties = properties;
return this;
}
public Collection addPropertiesItem(Property propertiesItem) {
this.properties.add(propertiesItem);
return this;
}
/**
* Get properties
* @return properties
**/
@javax.annotation.Nonnull
public List getProperties() {
return properties;
}
public void setProperties(List properties) {
this.properties = properties;
}
public Collection type(TypeEnum type) {
this.type = type;
return this;
}
/**
* The schema prototype the collection is based on.
* @return type
**/
@javax.annotation.Nonnull
public TypeEnum getType() {
return type;
}
public void setType(TypeEnum type) {
this.type = type;
}
@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
Collection collection = (Collection) o;
return Objects.equals(this.creationTime, collection.creationTime) &&
Objects.equals(this.modificationTime, collection.modificationTime) &&
Objects.equals(this.name, collection.name) &&
Objects.equals(this.properties, collection.properties) &&
Objects.equals(this.type, collection.type);
}
@Override
public int hashCode() {
return Objects.hash(creationTime, modificationTime, name, properties, type);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class Collection {\n");
sb.append(" creationTime: ").append(toIndentedString(creationTime)).append("\n");
sb.append(" modificationTime: ").append(toIndentedString(modificationTime)).append("\n");
sb.append(" name: ").append(toIndentedString(name)).append("\n");
sb.append(" properties: ").append(toIndentedString(properties)).append("\n");
sb.append(" type: ").append(toIndentedString(type)).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("creation_time");
openapiFields.add("modification_time");
openapiFields.add("name");
openapiFields.add("properties");
openapiFields.add("type");
// a set of required properties/fields (JSON key names)
openapiRequiredFields = new HashSet();
openapiRequiredFields.add("name");
openapiRequiredFields.add("properties");
openapiRequiredFields.add("type");
}
/**
* 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 Collection
*/
public static void validateJsonObject(JsonObject jsonObj) throws IOException {
if (jsonObj == null) {
if (!Collection.openapiRequiredFields.isEmpty()) { // has required fields but JSON object is null
throw new IllegalArgumentException(String.format("The required field(s) %s in Collection is not found in the empty JSON string", Collection.openapiRequiredFields.toString()));
}
}
Set> entries = jsonObj.entrySet();
// check to see if the JSON string contains additional fields
for (Entry entry : entries) {
if (!Collection.openapiFields.contains(entry.getKey())) {
throw new IllegalArgumentException(String.format("The field `%s` in the JSON string is not defined in the `Collection` properties. JSON: %s", entry.getKey(), jsonObj.toString()));
}
}
// check to make sure all required properties/fields are present in the JSON string
for (String requiredField : Collection.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("name").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `name` to be a primitive type in the JSON string but got `%s`", jsonObj.get("name").toString()));
}
// ensure the json data is an array
if (!jsonObj.get("properties").isJsonArray()) {
throw new IllegalArgumentException(String.format("Expected the field `properties` to be an array in the JSON string but got `%s`", jsonObj.get("properties").toString()));
}
JsonArray jsonArrayproperties = jsonObj.getAsJsonArray("properties");
// validate the required field `properties` (array)
for (int i = 0; i < jsonArrayproperties.size(); i++) {
Property.validateJsonObject(jsonArrayproperties.get(i).getAsJsonObject());
};
if (!jsonObj.get("type").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `type` to be a primitive type in the JSON string but got `%s`", jsonObj.get("type").toString()));
}
}
public static class CustomTypeAdapterFactory implements TypeAdapterFactory {
@SuppressWarnings("unchecked")
@Override
public TypeAdapter create(Gson gson, TypeToken type) {
if (!Collection.class.isAssignableFrom(type.getRawType())) {
return null; // this class only serializes 'Collection' and its subtypes
}
final TypeAdapter elementAdapter = gson.getAdapter(JsonElement.class);
final TypeAdapter thisAdapter
= gson.getDelegateAdapter(this, TypeToken.get(Collection.class));
return (TypeAdapter) new TypeAdapter() {
@Override
public void write(JsonWriter out, Collection value) throws IOException {
JsonObject obj = thisAdapter.toJsonTree(value).getAsJsonObject();
elementAdapter.write(out, obj);
}
@Override
public Collection read(JsonReader in) throws IOException {
JsonObject jsonObj = elementAdapter.read(in).getAsJsonObject();
validateJsonObject(jsonObj);
return thisAdapter.fromJsonTree(jsonObj);
}
}.nullSafe();
}
}
/**
* Create an instance of Collection given an JSON string
*
* @param jsonString JSON string
* @return An instance of Collection
* @throws IOException if the JSON string is invalid with respect to Collection
*/
public static Collection fromJson(String jsonString) throws IOException {
return JSON.getGson().fromJson(jsonString, Collection.class);
}
/**
* Convert an instance of Collection to an JSON string
*
* @return JSON string
*/
public String toJson() {
return JSON.getGson().toJson(this);
}
}