com.piiano.vault.client.openapi.model.UpdateEncryptionRequest 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 com.piiano.vault.client.openapi.model.EncryptionType;
import java.io.IOException;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
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;
/**
* UpdateEncryptionRequest
*/
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-07-23T10:03:56.260605Z[Etc/UTC]")
public class UpdateEncryptionRequest {
public static final String SERIALIZED_NAME_TYPE = "type";
@SerializedName(SERIALIZED_NAME_TYPE)
private EncryptionType type = EncryptionType.RANDOMIZED;
public static final String SERIALIZED_NAME_ENCRYPTED_OBJECT = "encrypted_object";
@SerializedName(SERIALIZED_NAME_ENCRYPTED_OBJECT)
private EncryptedObjectInput encryptedObject;
public static final String SERIALIZED_NAME_FIELDS = "fields";
@SerializedName(SERIALIZED_NAME_FIELDS)
private Map fields = new HashMap<>();
public static final String SERIALIZED_NAME_PROPS = "props";
@SerializedName(SERIALIZED_NAME_PROPS)
private List props = new ArrayList<>();
public static final String SERIALIZED_NAME_SCOPE = "scope";
@SerializedName(SERIALIZED_NAME_SCOPE)
private String scope = "default";
public UpdateEncryptionRequest() {
}
public UpdateEncryptionRequest type(EncryptionType type) {
this.type = type;
return this;
}
/**
* Get type
* @return type
**/
@javax.annotation.Nullable
public EncryptionType getType() {
return type;
}
public void setType(EncryptionType type) {
this.type = type;
}
public UpdateEncryptionRequest encryptedObject(EncryptedObjectInput encryptedObject) {
this.encryptedObject = encryptedObject;
return this;
}
/**
* Get encryptedObject
* @return encryptedObject
**/
@javax.annotation.Nonnull
public EncryptedObjectInput getEncryptedObject() {
return encryptedObject;
}
public void setEncryptedObject(EncryptedObjectInput encryptedObject) {
this.encryptedObject = encryptedObject;
}
public UpdateEncryptionRequest fields(Map fields) {
this.fields = fields;
return this;
}
public UpdateEncryptionRequest putFieldsItem(String key, Object fieldsItem) {
this.fields.put(key, fieldsItem);
return this;
}
/**
* A list of maps of object properties and their values.
* @return fields
**/
@javax.annotation.Nonnull
public Map getFields() {
return fields;
}
public void setFields(Map fields) {
this.fields = fields;
}
public UpdateEncryptionRequest props(List props) {
this.props = props;
return this;
}
public UpdateEncryptionRequest addPropsItem(String propsItem) {
if (this.props == null) {
this.props = new ArrayList<>();
}
this.props.add(propsItem);
return this;
}
/**
* The properties to include in the updated encrypted object.
* @return props
**/
@javax.annotation.Nullable
public List getProps() {
return props;
}
public void setProps(List props) {
this.props = props;
}
public UpdateEncryptionRequest scope(String scope) {
this.scope = scope;
return this;
}
/**
* A classification for the updated encrypted object that is added to the ciphertext as associated data (AAD). An object encrypted with a scope can be decrypted only with the same scope.
* @return scope
**/
@javax.annotation.Nullable
public String getScope() {
return scope;
}
public void setScope(String scope) {
this.scope = scope;
}
@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
UpdateEncryptionRequest updateEncryptionRequest = (UpdateEncryptionRequest) o;
return Objects.equals(this.type, updateEncryptionRequest.type) &&
Objects.equals(this.encryptedObject, updateEncryptionRequest.encryptedObject) &&
Objects.equals(this.fields, updateEncryptionRequest.fields) &&
Objects.equals(this.props, updateEncryptionRequest.props) &&
Objects.equals(this.scope, updateEncryptionRequest.scope);
}
@Override
public int hashCode() {
return Objects.hash(type, encryptedObject, fields, props, scope);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class UpdateEncryptionRequest {\n");
sb.append(" type: ").append(toIndentedString(type)).append("\n");
sb.append(" encryptedObject: ").append(toIndentedString(encryptedObject)).append("\n");
sb.append(" fields: ").append(toIndentedString(fields)).append("\n");
sb.append(" props: ").append(toIndentedString(props)).append("\n");
sb.append(" scope: ").append(toIndentedString(scope)).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("type");
openapiFields.add("encrypted_object");
openapiFields.add("fields");
openapiFields.add("props");
openapiFields.add("scope");
// a set of required properties/fields (JSON key names)
openapiRequiredFields = new HashSet();
openapiRequiredFields.add("encrypted_object");
openapiRequiredFields.add("fields");
}
/**
* 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 UpdateEncryptionRequest
*/
public static void validateJsonObject(JsonObject jsonObj) throws IOException {
if (jsonObj == null) {
if (!UpdateEncryptionRequest.openapiRequiredFields.isEmpty()) { // has required fields but JSON object is null
throw new IllegalArgumentException(String.format("The required field(s) %s in UpdateEncryptionRequest is not found in the empty JSON string", UpdateEncryptionRequest.openapiRequiredFields.toString()));
}
}
Set> entries = jsonObj.entrySet();
// check to see if the JSON string contains additional fields
for (Entry entry : entries) {
if (!UpdateEncryptionRequest.openapiFields.contains(entry.getKey())) {
throw new IllegalArgumentException(String.format("The field `%s` in the JSON string is not defined in the `UpdateEncryptionRequest` properties. JSON: %s", entry.getKey(), jsonObj.toString()));
}
}
// check to make sure all required properties/fields are present in the JSON string
for (String requiredField : UpdateEncryptionRequest.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()));
}
}
// validate the required field `encrypted_object`
EncryptedObjectInput.validateJsonObject(jsonObj.getAsJsonObject("encrypted_object"));
// ensure the optional json data is an array if present
if (jsonObj.get("props") != null && !jsonObj.get("props").isJsonArray()) {
throw new IllegalArgumentException(String.format("Expected the field `props` to be an array in the JSON string but got `%s`", jsonObj.get("props").toString()));
}
if ((jsonObj.get("scope") != null && !jsonObj.get("scope").isJsonNull()) && !jsonObj.get("scope").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `scope` to be a primitive type in the JSON string but got `%s`", jsonObj.get("scope").toString()));
}
}
public static class CustomTypeAdapterFactory implements TypeAdapterFactory {
@SuppressWarnings("unchecked")
@Override
public TypeAdapter create(Gson gson, TypeToken type) {
if (!UpdateEncryptionRequest.class.isAssignableFrom(type.getRawType())) {
return null; // this class only serializes 'UpdateEncryptionRequest' and its subtypes
}
final TypeAdapter elementAdapter = gson.getAdapter(JsonElement.class);
final TypeAdapter thisAdapter
= gson.getDelegateAdapter(this, TypeToken.get(UpdateEncryptionRequest.class));
return (TypeAdapter) new TypeAdapter() {
@Override
public void write(JsonWriter out, UpdateEncryptionRequest value) throws IOException {
JsonObject obj = thisAdapter.toJsonTree(value).getAsJsonObject();
elementAdapter.write(out, obj);
}
@Override
public UpdateEncryptionRequest read(JsonReader in) throws IOException {
JsonObject jsonObj = elementAdapter.read(in).getAsJsonObject();
validateJsonObject(jsonObj);
return thisAdapter.fromJsonTree(jsonObj);
}
}.nullSafe();
}
}
/**
* Create an instance of UpdateEncryptionRequest given an JSON string
*
* @param jsonString JSON string
* @return An instance of UpdateEncryptionRequest
* @throws IOException if the JSON string is invalid with respect to UpdateEncryptionRequest
*/
public static UpdateEncryptionRequest fromJson(String jsonString) throws IOException {
return JSON.getGson().fromJson(jsonString, UpdateEncryptionRequest.class);
}
/**
* Convert an instance of UpdateEncryptionRequest to an JSON string
*
* @return JSON string
*/
public String toJson() {
return JSON.getGson().toJson(this);
}
}