com.piiano.vault.client.openapi.model.Action 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;
/**
* An action definition.
*/
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-08-18T21:44:08.985764Z[Etc/UTC]")
public class Action {
public static final String SERIALIZED_NAME_NAME = "name";
@SerializedName(SERIALIZED_NAME_NAME)
private String name;
public static final String SERIALIZED_NAME_DESCRIPTION = "description";
@SerializedName(SERIALIZED_NAME_DESCRIPTION)
private String description;
public static final String SERIALIZED_NAME_FUNCTION = "function";
@SerializedName(SERIALIZED_NAME_FUNCTION)
private String function;
public static final String SERIALIZED_NAME_ROLE = "role";
@SerializedName(SERIALIZED_NAME_ROLE)
private String role;
public static final String SERIALIZED_NAME_IS_BUILTIN = "is_builtin";
@SerializedName(SERIALIZED_NAME_IS_BUILTIN)
private Boolean isBuiltin;
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 Action() {
}
public Action(
Boolean isBuiltin,
OffsetDateTime creationTime,
OffsetDateTime modificationTime
) {
this();
this.isBuiltin = isBuiltin;
this.creationTime = creationTime;
this.modificationTime = modificationTime;
}
public Action name(String name) {
this.name = name;
return this;
}
/**
* The name of the action.
* @return name
**/
@javax.annotation.Nonnull
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public Action description(String description) {
this.description = description;
return this;
}
/**
* A description of the action.
* @return description
**/
@javax.annotation.Nullable
public String getDescription() {
return description;
}
public void setDescription(String description) {
this.description = description;
}
public Action function(String function) {
this.function = function;
return this;
}
/**
* The bundle and function name formatted as `<bundle-name>.<function-name>`.
* @return function
**/
@javax.annotation.Nonnull
public String getFunction() {
return function;
}
public void setFunction(String function) {
this.function = function;
}
public Action role(String role) {
this.role = role;
return this;
}
/**
* The IAM role for the action. The role determine the operations or data available to the action. For example, a role can allow an action to read the email address from any object but deny it from reading credit card numbers.
* @return role
**/
@javax.annotation.Nullable
public String getRole() {
return role;
}
public void setRole(String role) {
this.role = role;
}
/**
* Whether this action is built-in or user-defined. Sending a value for this field is ignored.
* @return isBuiltin
**/
@javax.annotation.Nullable
public Boolean isIsBuiltin() {
return isBuiltin;
}
/**
* The time when the action was created.
* @return creationTime
**/
@javax.annotation.Nullable
public OffsetDateTime getCreationTime() {
return creationTime;
}
/**
* The time when the action was last modified.
* @return modificationTime
**/
@javax.annotation.Nullable
public OffsetDateTime getModificationTime() {
return modificationTime;
}
@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
Action action = (Action) o;
return Objects.equals(this.name, action.name) &&
Objects.equals(this.description, action.description) &&
Objects.equals(this.function, action.function) &&
Objects.equals(this.role, action.role) &&
Objects.equals(this.isBuiltin, action.isBuiltin) &&
Objects.equals(this.creationTime, action.creationTime) &&
Objects.equals(this.modificationTime, action.modificationTime);
}
@Override
public int hashCode() {
return Objects.hash(name, description, function, role, isBuiltin, creationTime, modificationTime);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class Action {\n");
sb.append(" name: ").append(toIndentedString(name)).append("\n");
sb.append(" description: ").append(toIndentedString(description)).append("\n");
sb.append(" function: ").append(toIndentedString(function)).append("\n");
sb.append(" role: ").append(toIndentedString(role)).append("\n");
sb.append(" isBuiltin: ").append(toIndentedString(isBuiltin)).append("\n");
sb.append(" creationTime: ").append(toIndentedString(creationTime)).append("\n");
sb.append(" modificationTime: ").append(toIndentedString(modificationTime)).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("name");
openapiFields.add("description");
openapiFields.add("function");
openapiFields.add("role");
openapiFields.add("is_builtin");
openapiFields.add("creation_time");
openapiFields.add("modification_time");
// a set of required properties/fields (JSON key names)
openapiRequiredFields = new HashSet();
openapiRequiredFields.add("name");
openapiRequiredFields.add("function");
}
/**
* 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 Action
*/
public static void validateJsonObject(JsonObject jsonObj) throws IOException {
if (jsonObj == null) {
if (!Action.openapiRequiredFields.isEmpty()) { // has required fields but JSON object is null
throw new IllegalArgumentException(String.format("The required field(s) %s in Action is not found in the empty JSON string", Action.openapiRequiredFields.toString()));
}
}
Set> entries = jsonObj.entrySet();
// check to see if the JSON string contains additional fields
for (Entry entry : entries) {
if (!Action.openapiFields.contains(entry.getKey())) {
throw new IllegalArgumentException(String.format("The field `%s` in the JSON string is not defined in the `Action` properties. JSON: %s", entry.getKey(), jsonObj.toString()));
}
}
// check to make sure all required properties/fields are present in the JSON string
for (String requiredField : Action.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()));
}
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("function").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `function` to be a primitive type in the JSON string but got `%s`", jsonObj.get("function").toString()));
}
if ((jsonObj.get("role") != null && !jsonObj.get("role").isJsonNull()) && !jsonObj.get("role").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `role` to be a primitive type in the JSON string but got `%s`", jsonObj.get("role").toString()));
}
}
public static class CustomTypeAdapterFactory implements TypeAdapterFactory {
@SuppressWarnings("unchecked")
@Override
public TypeAdapter create(Gson gson, TypeToken type) {
if (!Action.class.isAssignableFrom(type.getRawType())) {
return null; // this class only serializes 'Action' and its subtypes
}
final TypeAdapter elementAdapter = gson.getAdapter(JsonElement.class);
final TypeAdapter thisAdapter
= gson.getDelegateAdapter(this, TypeToken.get(Action.class));
return (TypeAdapter) new TypeAdapter() {
@Override
public void write(JsonWriter out, Action value) throws IOException {
JsonObject obj = thisAdapter.toJsonTree(value).getAsJsonObject();
elementAdapter.write(out, obj);
}
@Override
public Action read(JsonReader in) throws IOException {
JsonObject jsonObj = elementAdapter.read(in).getAsJsonObject();
validateJsonObject(jsonObj);
return thisAdapter.fromJsonTree(jsonObj);
}
}.nullSafe();
}
}
/**
* Create an instance of Action given an JSON string
*
* @param jsonString JSON string
* @return An instance of Action
* @throws IOException if the JSON string is invalid with respect to Action
*/
public static Action fromJson(String jsonString) throws IOException {
return JSON.getGson().fromJson(jsonString, Action.class);
}
/**
* Convert an instance of Action to an JSON string
*
* @return JSON string
*/
public String toJson() {
return JSON.getGson().toJson(this);
}
}