All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.piiano.vault.client.openapi.model.Query Maven / Gradle / Ivy

/*
 * 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.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;

/**
 * A query is a map of operators to match against the properties of an object.  Multiple operators can be combined in a single query. 
 */
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-10-03T19:37:14.732769Z[Etc/UTC]")
public class Query {
  public static final String SERIALIZED_NAME_IN = "in";
  @SerializedName(SERIALIZED_NAME_IN)
  private Map> in = new HashMap<>();

  public static final String SERIALIZED_NAME_MATCH = "match";
  @SerializedName(SERIALIZED_NAME_MATCH)
  private Map match = new HashMap<>();

  public static final String SERIALIZED_NAME_LIKE = "like";
  @SerializedName(SERIALIZED_NAME_LIKE)
  private Map like = new HashMap<>();

  public Query() {
  }

  public Query in(Map> in) {
    
    this.in = in;
    return this;
  }

  public Query putInItem(String key, List inItem) {
    if (this.in == null) {
      this.in = new HashMap<>();
    }
    this.in.put(key, inItem);
    return this;
  }

   /**
   * The `in` query operator allows you to match a property value against a list of values.  Each key in the map is a property name, and the value is a list of values to match.  The SQL equivalent of this query is:  ```sql SELECT * FROM objects WHERE property1 IN (value1, value2) AND property2 IN (value1, value2); ``` 
   * @return in
  **/
  @javax.annotation.Nullable

  public Map> getIn() {
    return in;
  }


  public void setIn(Map> in) {
    this.in = in;
  }


  public Query match(Map match) {
    
    this.match = match;
    return this;
  }

  public Query putMatchItem(String key, Object matchItem) {
    if (this.match == null) {
      this.match = new HashMap<>();
    }
    this.match.put(key, matchItem);
    return this;
  }

   /**
   * The `match` query operator allows you to match a property value against a specific value.  Each key in the map is a property name, and the value is the value to match.  The SQL equivalent of this query is:  ```sql SELECT * FROM objects WHERE property1 = value1 AND property2 = value2; ``` 
   * @return match
  **/
  @javax.annotation.Nullable

  public Map getMatch() {
    return match;
  }


  public void setMatch(Map match) {
    this.match = match;
  }


  public Query like(Map like) {
    
    this.like = like;
    return this;
  }

  public Query putLikeItem(String key, Object likeItem) {
    if (this.like == null) {
      this.like = new HashMap<>();
    }
    this.like.put(key, likeItem);
    return this;
  }

   /**
   * The `like` query operator allows you to match a property value against a search pattern.  Each key in the map is a property name, and the value is the pattern to match.  The SQL equivalent of this query is:  ```sql SELECT * FROM objects WHERE property1 LIKE pattern1 AND property2 LIKE pattern2; ``` 
   * @return like
  **/
  @javax.annotation.Nullable

  public Map getLike() {
    return like;
  }


  public void setLike(Map like) {
    this.like = like;
  }



  @Override
  public boolean equals(Object o) {
    if (this == o) {
      return true;
    }
    if (o == null || getClass() != o.getClass()) {
      return false;
    }
    Query query = (Query) o;
    return Objects.equals(this.in, query.in) &&
        Objects.equals(this.match, query.match) &&
        Objects.equals(this.like, query.like);
  }

  @Override
  public int hashCode() {
    return Objects.hash(in, match, like);
  }

  @Override
  public String toString() {
    StringBuilder sb = new StringBuilder();
    sb.append("class Query {\n");
    sb.append("    in: ").append(toIndentedString(in)).append("\n");
    sb.append("    match: ").append(toIndentedString(match)).append("\n");
    sb.append("    like: ").append(toIndentedString(like)).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("in");
    openapiFields.add("match");
    openapiFields.add("like");

    // a set of required properties/fields (JSON key names)
    openapiRequiredFields = new HashSet();
  }

 /**
  * 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 Query
  */
  public static void validateJsonObject(JsonObject jsonObj) throws IOException {
      if (jsonObj == null) {
        if (!Query.openapiRequiredFields.isEmpty()) { // has required fields but JSON object is null
          throw new IllegalArgumentException(String.format("The required field(s) %s in Query is not found in the empty JSON string", Query.openapiRequiredFields.toString()));
        }
      }

      Set> entries = jsonObj.entrySet();
      // check to see if the JSON string contains additional fields
      for (Entry entry : entries) {
        if (!Query.openapiFields.contains(entry.getKey())) {
          throw new IllegalArgumentException(String.format("The field `%s` in the JSON string is not defined in the `Query` properties. JSON: %s", entry.getKey(), jsonObj.toString()));
        }
      }
  }

  public static class CustomTypeAdapterFactory implements TypeAdapterFactory {
    @SuppressWarnings("unchecked")
    @Override
    public  TypeAdapter create(Gson gson, TypeToken type) {
       if (!Query.class.isAssignableFrom(type.getRawType())) {
         return null; // this class only serializes 'Query' and its subtypes
       }
       final TypeAdapter elementAdapter = gson.getAdapter(JsonElement.class);
       final TypeAdapter thisAdapter
                        = gson.getDelegateAdapter(this, TypeToken.get(Query.class));

       return (TypeAdapter) new TypeAdapter() {
           @Override
           public void write(JsonWriter out, Query value) throws IOException {
             JsonObject obj = thisAdapter.toJsonTree(value).getAsJsonObject();
             elementAdapter.write(out, obj);
           }

           @Override
           public Query read(JsonReader in) throws IOException {
             JsonObject jsonObj = elementAdapter.read(in).getAsJsonObject();
             validateJsonObject(jsonObj);
             return thisAdapter.fromJsonTree(jsonObj);
           }

       }.nullSafe();
    }
  }

 /**
  * Create an instance of Query given an JSON string
  *
  * @param jsonString JSON string
  * @return An instance of Query
  * @throws IOException if the JSON string is invalid with respect to Query
  */
  public static Query fromJson(String jsonString) throws IOException {
    return JSON.getGson().fromJson(jsonString, Query.class);
  }

 /**
  * Convert an instance of Query to an JSON string
  *
  * @return JSON string
  */
  public String toJson() {
    return JSON.getGson().toJson(this);
  }
}