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

Go to download
Show more of this group Show more artifacts with this name
Show all versions of openapi Show documentation
Generated client for the open API of Piiano vault
The newest version!
/*
 * 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 java.io.IOException;
import java.util.Arrays;

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;

/**
 * UpdatePropertyRequest
 */
@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 UpdatePropertyRequest {
  public static final String SERIALIZED_NAME_DESCRIPTION = "description";
  @SerializedName(SERIALIZED_NAME_DESCRIPTION)
  @javax.annotation.Nullable
  private String description;

  public static final String SERIALIZED_NAME_IS_INDEX = "is_index";
  @SerializedName(SERIALIZED_NAME_IS_INDEX)
  @javax.annotation.Nullable
  private Boolean isIndex;

  public static final String SERIALIZED_NAME_IS_SUBSTRING_INDEX = "is_substring_index";
  @SerializedName(SERIALIZED_NAME_IS_SUBSTRING_INDEX)
  @javax.annotation.Nullable
  private Boolean isSubstringIndex;

  public static final String SERIALIZED_NAME_IS_NULLABLE = "is_nullable";
  @SerializedName(SERIALIZED_NAME_IS_NULLABLE)
  @javax.annotation.Nullable
  private Boolean isNullable;

  public static final String SERIALIZED_NAME_IS_UNIQUE = "is_unique";
  @SerializedName(SERIALIZED_NAME_IS_UNIQUE)
  @javax.annotation.Nullable
  private Boolean isUnique;

  public UpdatePropertyRequest() {
  }

  public UpdatePropertyRequest description(@javax.annotation.Nullable String description) {
    this.description = description;
    return this;
  }

  /**
   * The description of the property. If not provided, is set to an empty `string`.
   * @return description
   */
  @javax.annotation.Nullable
  public String getDescription() {
    return description;
  }

  public void setDescription(@javax.annotation.Nullable String description) {
    this.description = description;
  }


  public UpdatePropertyRequest isIndex(@javax.annotation.Nullable Boolean isIndex) {
    this.isIndex = isIndex;
    return this;
  }

  /**
   * Whether the backend storage is optimized for searches on this property. Cannot be set to `true` for properties with data types `LONG_TEXT`, `JSON`, or `BLOB`, or custom data types based on those types.
   * @return isIndex
   */
  @javax.annotation.Nullable
  public Boolean isIsIndex() {
    return isIndex;
  }

  public void setIsIndex(@javax.annotation.Nullable Boolean isIndex) {
    this.isIndex = isIndex;
  }


  public UpdatePropertyRequest isSubstringIndex(@javax.annotation.Nullable Boolean isSubstringIndex) {
    this.isSubstringIndex = isSubstringIndex;
    return this;
  }

  /**
   * Whether the backend storage is optimized for substring searches on this property. Can only be set to change the value to 'false'.
   * @return isSubstringIndex
   */
  @javax.annotation.Nullable
  public Boolean isIsSubstringIndex() {
    return isSubstringIndex;
  }

  public void setIsSubstringIndex(@javax.annotation.Nullable Boolean isSubstringIndex) {
    this.isSubstringIndex = isSubstringIndex;
  }


  public UpdatePropertyRequest isNullable(@javax.annotation.Nullable Boolean isNullable) {
    this.isNullable = isNullable;
    return this;
  }

  /**
   * Whether this property can have no value.
   * @return isNullable
   */
  @javax.annotation.Nullable
  public Boolean isIsNullable() {
    return isNullable;
  }

  public void setIsNullable(@javax.annotation.Nullable Boolean isNullable) {
    this.isNullable = isNullable;
  }


  public UpdatePropertyRequest isUnique(@javax.annotation.Nullable Boolean isUnique) {
    this.isUnique = isUnique;
    return this;
  }

  /**
   * Whether the backend storage enforces unique values for active objects.
   * @return isUnique
   */
  @javax.annotation.Nullable
  public Boolean isIsUnique() {
    return isUnique;
  }

  public void setIsUnique(@javax.annotation.Nullable Boolean isUnique) {
    this.isUnique = isUnique;
  }



  @Override
  public boolean equals(Object o) {
    if (this == o) {
      return true;
    }
    if (o == null || getClass() != o.getClass()) {
      return false;
    }
    UpdatePropertyRequest updatePropertyRequest = (UpdatePropertyRequest) o;
    return Objects.equals(this.description, updatePropertyRequest.description) &&
        Objects.equals(this.isIndex, updatePropertyRequest.isIndex) &&
        Objects.equals(this.isSubstringIndex, updatePropertyRequest.isSubstringIndex) &&
        Objects.equals(this.isNullable, updatePropertyRequest.isNullable) &&
        Objects.equals(this.isUnique, updatePropertyRequest.isUnique);
  }

  @Override
  public int hashCode() {
    return Objects.hash(description, isIndex, isSubstringIndex, isNullable, isUnique);
  }

  @Override
  public String toString() {
    StringBuilder sb = new StringBuilder();
    sb.append("class UpdatePropertyRequest {\n");
    sb.append("    description: ").append(toIndentedString(description)).append("\n");
    sb.append("    isIndex: ").append(toIndentedString(isIndex)).append("\n");
    sb.append("    isSubstringIndex: ").append(toIndentedString(isSubstringIndex)).append("\n");
    sb.append("    isNullable: ").append(toIndentedString(isNullable)).append("\n");
    sb.append("    isUnique: ").append(toIndentedString(isUnique)).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("description");
    openapiFields.add("is_index");
    openapiFields.add("is_substring_index");
    openapiFields.add("is_nullable");
    openapiFields.add("is_unique");

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

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

      Set> entries = jsonElement.getAsJsonObject().entrySet();
      // check to see if the JSON string contains additional fields
      for (Map.Entry entry : entries) {
        if (!UpdatePropertyRequest.openapiFields.contains(entry.getKey())) {
          throw new IllegalArgumentException(String.format("The field `%s` in the JSON string is not defined in the `UpdatePropertyRequest` properties. JSON: %s", entry.getKey(), jsonElement.toString()));
        }
      }
        JsonObject jsonObj = jsonElement.getAsJsonObject();
      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()));
      }
  }

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

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

           @Override
           public UpdatePropertyRequest read(JsonReader in) throws IOException {
             JsonElement jsonElement = elementAdapter.read(in);
             validateJsonElement(jsonElement);
             return thisAdapter.fromJsonTree(jsonElement);
           }

       }.nullSafe();
    }
  }

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

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