com.piiano.vault.client.openapi.model.TokenMetadata 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 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.TokenAggregatedMetadata;
import com.piiano.vault.client.openapi.model.TokenRefMetadata;
import com.piiano.vault.client.openapi.model.TokenType;
import java.io.IOException;
import java.util.ArrayList;
import java.util.Arrays;
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 com.google.gson.TypeAdapter;
import com.google.gson.stream.JsonReader;
import com.google.gson.stream.JsonWriter;
import java.io.IOException;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;
import com.piiano.vault.client.openapi.JSON;
/**
* TokenMetadata
*/
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-12-25T08:22:24.146953566Z[Etc/UTC]", comments = "Generator version: 7.10.0")
public class TokenMetadata {
public static final String SERIALIZED_NAME_AGG = "agg";
@SerializedName(SERIALIZED_NAME_AGG)
@javax.annotation.Nullable
private TokenAggregatedMetadata agg;
public static final String SERIALIZED_NAME_TYPE = "type";
@SerializedName(SERIALIZED_NAME_TYPE)
@javax.annotation.Nonnull
private TokenType type;
public static final String SERIALIZED_NAME_SCOPE = "scope";
@SerializedName(SERIALIZED_NAME_SCOPE)
@javax.annotation.Nonnull
private String scope;
public static final String SERIALIZED_NAME_TOKEN_ID = "token_id";
@SerializedName(SERIALIZED_NAME_TOKEN_ID)
@javax.annotation.Nonnull
private String tokenId;
public static final String SERIALIZED_NAME_TOKENS = "tokens";
@SerializedName(SERIALIZED_NAME_TOKENS)
@javax.annotation.Nonnull
private List tokens = new ArrayList<>();
public TokenMetadata() {
}
public TokenMetadata agg(@javax.annotation.Nullable TokenAggregatedMetadata agg) {
this.agg = agg;
return this;
}
/**
* Get agg
* @return agg
*/
@javax.annotation.Nullable
public TokenAggregatedMetadata getAgg() {
return agg;
}
public void setAgg(@javax.annotation.Nullable TokenAggregatedMetadata agg) {
this.agg = agg;
}
public TokenMetadata type(@javax.annotation.Nonnull TokenType type) {
this.type = type;
return this;
}
/**
* Get type
* @return type
*/
@javax.annotation.Nonnull
public TokenType getType() {
return type;
}
public void setType(@javax.annotation.Nonnull TokenType type) {
this.type = type;
}
public TokenMetadata scope(@javax.annotation.Nonnull String scope) {
this.scope = scope;
return this;
}
/**
* The scope of the tokens.
* @return scope
*/
@javax.annotation.Nonnull
public String getScope() {
return scope;
}
public void setScope(@javax.annotation.Nonnull String scope) {
this.scope = scope;
}
public TokenMetadata tokenId(@javax.annotation.Nonnull String tokenId) {
this.tokenId = tokenId;
return this;
}
/**
* The shared ID of the tokens.
* @return tokenId
*/
@javax.annotation.Nonnull
public String getTokenId() {
return tokenId;
}
public void setTokenId(@javax.annotation.Nonnull String tokenId) {
this.tokenId = tokenId;
}
public TokenMetadata tokens(@javax.annotation.Nonnull List tokens) {
this.tokens = tokens;
return this;
}
public TokenMetadata addTokensItem(TokenRefMetadata tokensItem) {
if (this.tokens == null) {
this.tokens = new ArrayList<>();
}
this.tokens.add(tokensItem);
return this;
}
/**
* The metadata for each token.
* @return tokens
*/
@javax.annotation.Nonnull
public List getTokens() {
return tokens;
}
public void setTokens(@javax.annotation.Nonnull List tokens) {
this.tokens = tokens;
}
@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
TokenMetadata tokenMetadata = (TokenMetadata) o;
return Objects.equals(this.agg, tokenMetadata.agg) &&
Objects.equals(this.type, tokenMetadata.type) &&
Objects.equals(this.scope, tokenMetadata.scope) &&
Objects.equals(this.tokenId, tokenMetadata.tokenId) &&
Objects.equals(this.tokens, tokenMetadata.tokens);
}
@Override
public int hashCode() {
return Objects.hash(agg, type, scope, tokenId, tokens);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class TokenMetadata {\n");
sb.append(" agg: ").append(toIndentedString(agg)).append("\n");
sb.append(" type: ").append(toIndentedString(type)).append("\n");
sb.append(" scope: ").append(toIndentedString(scope)).append("\n");
sb.append(" tokenId: ").append(toIndentedString(tokenId)).append("\n");
sb.append(" tokens: ").append(toIndentedString(tokens)).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("agg");
openapiFields.add("type");
openapiFields.add("scope");
openapiFields.add("token_id");
openapiFields.add("tokens");
// a set of required properties/fields (JSON key names)
openapiRequiredFields = new HashSet();
openapiRequiredFields.add("type");
openapiRequiredFields.add("scope");
openapiRequiredFields.add("token_id");
openapiRequiredFields.add("tokens");
}
/**
* Validates the JSON Element and throws an exception if issues found
*
* @param jsonElement JSON Element
* @throws IOException if the JSON Element is invalid with respect to TokenMetadata
*/
public static void validateJsonElement(JsonElement jsonElement) throws IOException {
if (jsonElement == null) {
if (!TokenMetadata.openapiRequiredFields.isEmpty()) { // has required fields but JSON element is null
throw new IllegalArgumentException(String.format("The required field(s) %s in TokenMetadata is not found in the empty JSON string", TokenMetadata.openapiRequiredFields.toString()));
}
}
Set> entries = jsonElement.getAsJsonObject().entrySet();
// check to see if the JSON string contains additional fields
for (Map.Entry entry : entries) {
if (!TokenMetadata.openapiFields.contains(entry.getKey())) {
throw new IllegalArgumentException(String.format("The field `%s` in the JSON string is not defined in the `TokenMetadata` properties. JSON: %s", entry.getKey(), jsonElement.toString()));
}
}
// check to make sure all required properties/fields are present in the JSON string
for (String requiredField : TokenMetadata.openapiRequiredFields) {
if (jsonElement.getAsJsonObject().get(requiredField) == null) {
throw new IllegalArgumentException(String.format("The required field `%s` is not found in the JSON string: %s", requiredField, jsonElement.toString()));
}
}
JsonObject jsonObj = jsonElement.getAsJsonObject();
// validate the optional field `agg`
if (jsonObj.get("agg") != null && !jsonObj.get("agg").isJsonNull()) {
TokenAggregatedMetadata.validateJsonElement(jsonObj.get("agg"));
}
// validate the required field `type`
TokenType.validateJsonElement(jsonObj.get("type"));
if (!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()));
}
if (!jsonObj.get("token_id").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `token_id` to be a primitive type in the JSON string but got `%s`", jsonObj.get("token_id").toString()));
}
// ensure the json data is an array
if (!jsonObj.get("tokens").isJsonArray()) {
throw new IllegalArgumentException(String.format("Expected the field `tokens` to be an array in the JSON string but got `%s`", jsonObj.get("tokens").toString()));
}
JsonArray jsonArraytokens = jsonObj.getAsJsonArray("tokens");
// validate the required field `tokens` (array)
for (int i = 0; i < jsonArraytokens.size(); i++) {
TokenRefMetadata.validateJsonElement(jsonArraytokens.get(i));
};
}
public static class CustomTypeAdapterFactory implements TypeAdapterFactory {
@SuppressWarnings("unchecked")
@Override
public TypeAdapter create(Gson gson, TypeToken type) {
if (!TokenMetadata.class.isAssignableFrom(type.getRawType())) {
return null; // this class only serializes 'TokenMetadata' and its subtypes
}
final TypeAdapter elementAdapter = gson.getAdapter(JsonElement.class);
final TypeAdapter thisAdapter
= gson.getDelegateAdapter(this, TypeToken.get(TokenMetadata.class));
return (TypeAdapter) new TypeAdapter() {
@Override
public void write(JsonWriter out, TokenMetadata value) throws IOException {
JsonObject obj = thisAdapter.toJsonTree(value).getAsJsonObject();
elementAdapter.write(out, obj);
}
@Override
public TokenMetadata read(JsonReader in) throws IOException {
JsonElement jsonElement = elementAdapter.read(in);
validateJsonElement(jsonElement);
return thisAdapter.fromJsonTree(jsonElement);
}
}.nullSafe();
}
}
/**
* Create an instance of TokenMetadata given an JSON string
*
* @param jsonString JSON string
* @return An instance of TokenMetadata
* @throws IOException if the JSON string is invalid with respect to TokenMetadata
*/
public static TokenMetadata fromJson(String jsonString) throws IOException {
return JSON.getGson().fromJson(jsonString, TokenMetadata.class);
}
/**
* Convert an instance of TokenMetadata to an JSON string
*
* @return JSON string
*/
public String toJson() {
return JSON.getGson().toJson(this);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy