com.piiano.vault.client.openapi.model.Paging 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 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;
/**
* Pagination information.
*/
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-07-23T10:03:56.260605Z[Etc/UTC]")
public class Paging {
public static final String SERIALIZED_NAME_SIZE = "size";
@SerializedName(SERIALIZED_NAME_SIZE)
private Integer size;
public static final String SERIALIZED_NAME_REMAINING_COUNT = "remaining_count";
@SerializedName(SERIALIZED_NAME_REMAINING_COUNT)
private Integer remainingCount;
public static final String SERIALIZED_NAME_CURSOR = "cursor";
@SerializedName(SERIALIZED_NAME_CURSOR)
private String cursor;
public Paging() {
}
public Paging size(Integer size) {
this.size = size;
return this;
}
/**
* Number of results in the current page.
* @return size
**/
@javax.annotation.Nonnull
public Integer getSize() {
return size;
}
public void setSize(Integer size) {
this.size = size;
}
public Paging remainingCount(Integer remainingCount) {
this.remainingCount = remainingCount;
return this;
}
/**
* The remaining number of objects that can be read in ensuing calls to this method.
* @return remainingCount
**/
@javax.annotation.Nonnull
public Integer getRemainingCount() {
return remainingCount;
}
public void setRemainingCount(Integer remainingCount) {
this.remainingCount = remainingCount;
}
public Paging cursor(String cursor) {
this.cursor = cursor;
return this;
}
/**
* An opaque string you should provide to get the next page.
* @return cursor
**/
@javax.annotation.Nonnull
public String getCursor() {
return cursor;
}
public void setCursor(String cursor) {
this.cursor = cursor;
}
@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
Paging paging = (Paging) o;
return Objects.equals(this.size, paging.size) &&
Objects.equals(this.remainingCount, paging.remainingCount) &&
Objects.equals(this.cursor, paging.cursor);
}
@Override
public int hashCode() {
return Objects.hash(size, remainingCount, cursor);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class Paging {\n");
sb.append(" size: ").append(toIndentedString(size)).append("\n");
sb.append(" remainingCount: ").append(toIndentedString(remainingCount)).append("\n");
sb.append(" cursor: ").append(toIndentedString(cursor)).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("size");
openapiFields.add("remaining_count");
openapiFields.add("cursor");
// a set of required properties/fields (JSON key names)
openapiRequiredFields = new HashSet();
openapiRequiredFields.add("size");
openapiRequiredFields.add("remaining_count");
openapiRequiredFields.add("cursor");
}
/**
* 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 Paging
*/
public static void validateJsonObject(JsonObject jsonObj) throws IOException {
if (jsonObj == null) {
if (!Paging.openapiRequiredFields.isEmpty()) { // has required fields but JSON object is null
throw new IllegalArgumentException(String.format("The required field(s) %s in Paging is not found in the empty JSON string", Paging.openapiRequiredFields.toString()));
}
}
Set> entries = jsonObj.entrySet();
// check to see if the JSON string contains additional fields
for (Entry entry : entries) {
if (!Paging.openapiFields.contains(entry.getKey())) {
throw new IllegalArgumentException(String.format("The field `%s` in the JSON string is not defined in the `Paging` properties. JSON: %s", entry.getKey(), jsonObj.toString()));
}
}
// check to make sure all required properties/fields are present in the JSON string
for (String requiredField : Paging.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("cursor").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `cursor` to be a primitive type in the JSON string but got `%s`", jsonObj.get("cursor").toString()));
}
}
public static class CustomTypeAdapterFactory implements TypeAdapterFactory {
@SuppressWarnings("unchecked")
@Override
public TypeAdapter create(Gson gson, TypeToken type) {
if (!Paging.class.isAssignableFrom(type.getRawType())) {
return null; // this class only serializes 'Paging' and its subtypes
}
final TypeAdapter elementAdapter = gson.getAdapter(JsonElement.class);
final TypeAdapter thisAdapter
= gson.getDelegateAdapter(this, TypeToken.get(Paging.class));
return (TypeAdapter) new TypeAdapter() {
@Override
public void write(JsonWriter out, Paging value) throws IOException {
JsonObject obj = thisAdapter.toJsonTree(value).getAsJsonObject();
elementAdapter.write(out, obj);
}
@Override
public Paging read(JsonReader in) throws IOException {
JsonObject jsonObj = elementAdapter.read(in).getAsJsonObject();
validateJsonObject(jsonObj);
return thisAdapter.fromJsonTree(jsonObj);
}
}.nullSafe();
}
}
/**
* Create an instance of Paging given an JSON string
*
* @param jsonString JSON string
* @return An instance of Paging
* @throws IOException if the JSON string is invalid with respect to Paging
*/
public static Paging fromJson(String jsonString) throws IOException {
return JSON.getGson().fromJson(jsonString, Paging.class);
}
/**
* Convert an instance of Paging to an JSON string
*
* @return JSON string
*/
public String toJson() {
return JSON.getGson().toJson(this);
}
}