com.piiano.vault.client.openapi.model.Property 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.time.OffsetDateTime;
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;
/**
* Property
*/
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-06-03T12:14:24.639226Z[Etc/UTC]")
public class Property {
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_DESCRIPTION = "description";
@SerializedName(SERIALIZED_NAME_DESCRIPTION)
private String description;
public static final String SERIALIZED_NAME_IS_BUILTIN = "is_builtin";
@SerializedName(SERIALIZED_NAME_IS_BUILTIN)
private Boolean isBuiltin = false;
public static final String SERIALIZED_NAME_IS_ENCRYPTED = "is_encrypted";
@SerializedName(SERIALIZED_NAME_IS_ENCRYPTED)
private Boolean isEncrypted = true;
public static final String SERIALIZED_NAME_IS_INDEX = "is_index";
@SerializedName(SERIALIZED_NAME_IS_INDEX)
private Boolean isIndex = false;
public static final String SERIALIZED_NAME_IS_NULLABLE = "is_nullable";
@SerializedName(SERIALIZED_NAME_IS_NULLABLE)
private Boolean isNullable = false;
public static final String SERIALIZED_NAME_IS_READONLY = "is_readonly";
@SerializedName(SERIALIZED_NAME_IS_READONLY)
private Boolean isReadonly = false;
public static final String SERIALIZED_NAME_IS_UNIQUE = "is_unique";
@SerializedName(SERIALIZED_NAME_IS_UNIQUE)
private Boolean isUnique = false;
public static final String SERIALIZED_NAME_NAME = "name";
@SerializedName(SERIALIZED_NAME_NAME)
private String name;
public static final String SERIALIZED_NAME_DATA_TYPE_NAME = "data_type_name";
@SerializedName(SERIALIZED_NAME_DATA_TYPE_NAME)
private String dataTypeName;
public Property() {
}
public Property creationTime(OffsetDateTime creationTime) {
this.creationTime = creationTime;
return this;
}
/**
* The time when the property 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 Property modificationTime(OffsetDateTime modificationTime) {
this.modificationTime = modificationTime;
return this;
}
/**
* The time when the property was last modified, in RFC3339 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 Property description(String description) {
this.description = description;
return this;
}
/**
* The description of a model.
* @return description
**/
@javax.annotation.Nullable
public String getDescription() {
return description;
}
public void setDescription(String description) {
this.description = description;
}
public Property isBuiltin(Boolean isBuiltin) {
this.isBuiltin = isBuiltin;
return this;
}
/**
* Whether the property is created by Vault (or by the user). Built-in properties cannot be deleted or modified. Sending a value for this field is ignored.
* @return isBuiltin
**/
@javax.annotation.Nullable
public Boolean isIsBuiltin() {
return isBuiltin;
}
public void setIsBuiltin(Boolean isBuiltin) {
this.isBuiltin = isBuiltin;
}
public Property isEncrypted(Boolean isEncrypted) {
this.isEncrypted = isEncrypted;
return this;
}
/**
* Whether the value is stored encrypted.
* @return isEncrypted
**/
@javax.annotation.Nullable
public Boolean isIsEncrypted() {
return isEncrypted;
}
public void setIsEncrypted(Boolean isEncrypted) {
this.isEncrypted = isEncrypted;
}
public Property isIndex(Boolean isIndex) {
this.isIndex = isIndex;
return this;
}
/**
* Whether the backend storage is optimized for searches on this property. Cannot be set to `true` for properties with data types `LONG_TEXT`, `JSON`, or `BLOB`, or custom data types based on those types.
* @return isIndex
**/
@javax.annotation.Nullable
public Boolean isIsIndex() {
return isIndex;
}
public void setIsIndex(Boolean isIndex) {
this.isIndex = isIndex;
}
public Property isNullable(Boolean isNullable) {
this.isNullable = isNullable;
return this;
}
/**
* Whether the value of the property can be removed (set to null).
* @return isNullable
**/
@javax.annotation.Nullable
public Boolean isIsNullable() {
return isNullable;
}
public void setIsNullable(Boolean isNullable) {
this.isNullable = isNullable;
}
public Property isReadonly(Boolean isReadonly) {
this.isReadonly = isReadonly;
return this;
}
/**
* Whether the user can modify values of this property. Ignored for user define properties. Sending a value for this field is ignored.
* @return isReadonly
**/
@javax.annotation.Nullable
public Boolean isIsReadonly() {
return isReadonly;
}
public void setIsReadonly(Boolean isReadonly) {
this.isReadonly = isReadonly;
}
public Property isUnique(Boolean isUnique) {
this.isUnique = isUnique;
return this;
}
/**
* Whether the backend storage enforces unique values for active objects. Cannot be set to `true` for properties with data types `LONG_TEXT`, `JSON`, or `BLOB`, or custom data types based on those types.
* @return isUnique
**/
@javax.annotation.Nullable
public Boolean isIsUnique() {
return isUnique;
}
public void setIsUnique(Boolean isUnique) {
this.isUnique = isUnique;
}
public Property name(String name) {
this.name = name;
return this;
}
/**
* The name of a property.
* @return name
**/
@javax.annotation.Nonnull
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public Property dataTypeName(String dataTypeName) {
this.dataTypeName = dataTypeName;
return this;
}
/**
* The name of a data type.
* @return dataTypeName
**/
@javax.annotation.Nonnull
public String getDataTypeName() {
return dataTypeName;
}
public void setDataTypeName(String dataTypeName) {
this.dataTypeName = dataTypeName;
}
@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
Property property = (Property) o;
return Objects.equals(this.creationTime, property.creationTime) &&
Objects.equals(this.modificationTime, property.modificationTime) &&
Objects.equals(this.description, property.description) &&
Objects.equals(this.isBuiltin, property.isBuiltin) &&
Objects.equals(this.isEncrypted, property.isEncrypted) &&
Objects.equals(this.isIndex, property.isIndex) &&
Objects.equals(this.isNullable, property.isNullable) &&
Objects.equals(this.isReadonly, property.isReadonly) &&
Objects.equals(this.isUnique, property.isUnique) &&
Objects.equals(this.name, property.name) &&
Objects.equals(this.dataTypeName, property.dataTypeName);
}
@Override
public int hashCode() {
return Objects.hash(creationTime, modificationTime, description, isBuiltin, isEncrypted, isIndex, isNullable, isReadonly, isUnique, name, dataTypeName);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class Property {\n");
sb.append(" creationTime: ").append(toIndentedString(creationTime)).append("\n");
sb.append(" modificationTime: ").append(toIndentedString(modificationTime)).append("\n");
sb.append(" description: ").append(toIndentedString(description)).append("\n");
sb.append(" isBuiltin: ").append(toIndentedString(isBuiltin)).append("\n");
sb.append(" isEncrypted: ").append(toIndentedString(isEncrypted)).append("\n");
sb.append(" isIndex: ").append(toIndentedString(isIndex)).append("\n");
sb.append(" isNullable: ").append(toIndentedString(isNullable)).append("\n");
sb.append(" isReadonly: ").append(toIndentedString(isReadonly)).append("\n");
sb.append(" isUnique: ").append(toIndentedString(isUnique)).append("\n");
sb.append(" name: ").append(toIndentedString(name)).append("\n");
sb.append(" dataTypeName: ").append(toIndentedString(dataTypeName)).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("description");
openapiFields.add("is_builtin");
openapiFields.add("is_encrypted");
openapiFields.add("is_index");
openapiFields.add("is_nullable");
openapiFields.add("is_readonly");
openapiFields.add("is_unique");
openapiFields.add("name");
openapiFields.add("data_type_name");
// a set of required properties/fields (JSON key names)
openapiRequiredFields = new HashSet();
openapiRequiredFields.add("name");
openapiRequiredFields.add("data_type_name");
}
/**
* 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 Property
*/
public static void validateJsonObject(JsonObject jsonObj) throws IOException {
if (jsonObj == null) {
if (!Property.openapiRequiredFields.isEmpty()) { // has required fields but JSON object is null
throw new IllegalArgumentException(String.format("The required field(s) %s in Property is not found in the empty JSON string", Property.openapiRequiredFields.toString()));
}
}
Set> entries = jsonObj.entrySet();
// check to see if the JSON string contains additional fields
for (Entry entry : entries) {
if (!Property.openapiFields.contains(entry.getKey())) {
throw new IllegalArgumentException(String.format("The field `%s` in the JSON string is not defined in the `Property` properties. JSON: %s", entry.getKey(), jsonObj.toString()));
}
}
// check to make sure all required properties/fields are present in the JSON string
for (String requiredField : Property.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("description") != null && !jsonObj.get("description").isJsonNull()) && !jsonObj.get("description").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `description` to be a primitive type in the JSON string but got `%s`", jsonObj.get("description").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()));
}
if (!jsonObj.get("data_type_name").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `data_type_name` to be a primitive type in the JSON string but got `%s`", jsonObj.get("data_type_name").toString()));
}
}
public static class CustomTypeAdapterFactory implements TypeAdapterFactory {
@SuppressWarnings("unchecked")
@Override
public TypeAdapter create(Gson gson, TypeToken type) {
if (!Property.class.isAssignableFrom(type.getRawType())) {
return null; // this class only serializes 'Property' and its subtypes
}
final TypeAdapter elementAdapter = gson.getAdapter(JsonElement.class);
final TypeAdapter thisAdapter
= gson.getDelegateAdapter(this, TypeToken.get(Property.class));
return (TypeAdapter) new TypeAdapter() {
@Override
public void write(JsonWriter out, Property value) throws IOException {
JsonObject obj = thisAdapter.toJsonTree(value).getAsJsonObject();
elementAdapter.write(out, obj);
}
@Override
public Property read(JsonReader in) throws IOException {
JsonObject jsonObj = elementAdapter.read(in).getAsJsonObject();
validateJsonObject(jsonObj);
return thisAdapter.fromJsonTree(jsonObj);
}
}.nullSafe();
}
}
/**
* Create an instance of Property given an JSON string
*
* @param jsonString JSON string
* @return An instance of Property
* @throws IOException if the JSON string is invalid with respect to Property
*/
public static Property fromJson(String jsonString) throws IOException {
return JSON.getGson().fromJson(jsonString, Property.class);
}
/**
* Convert an instance of Property to an JSON string
*
* @return JSON string
*/
public String toJson() {
return JSON.getGson().toJson(this);
}
}