org.openapitools.client.model.IndexModel Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of pinecone-client Show documentation
Show all versions of pinecone-client Show documentation
The Pinecone.io Java Client
/*
* Pinecone Control Plane API
* Pinecone is a vector database that makes it easy to search and retrieve billions of high-dimensional vectors.
*
* The version of the OpenAPI document: v1
* Contact: [email protected]
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
package org.openapitools.client.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 org.openapitools.client.model.IndexMetric;
import org.openapitools.client.model.IndexModelSpec;
import org.openapitools.client.model.IndexModelStatus;
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.lang.reflect.Type;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;
import org.openapitools.client.JSON;
/**
* The IndexModel describes the configuration and status of a Pinecone index.
*/
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-02-05T14:30:53.594301-05:00[America/New_York]")
public class IndexModel {
public static final String SERIALIZED_NAME_NAME = "name";
@SerializedName(SERIALIZED_NAME_NAME)
private String name;
public static final String SERIALIZED_NAME_DIMENSION = "dimension";
@SerializedName(SERIALIZED_NAME_DIMENSION)
private Integer dimension;
public static final String SERIALIZED_NAME_METRIC = "metric";
@SerializedName(SERIALIZED_NAME_METRIC)
private IndexMetric metric = IndexMetric.COSINE;
public static final String SERIALIZED_NAME_HOST = "host";
@SerializedName(SERIALIZED_NAME_HOST)
private String host;
public static final String SERIALIZED_NAME_SPEC = "spec";
@SerializedName(SERIALIZED_NAME_SPEC)
private IndexModelSpec spec;
public static final String SERIALIZED_NAME_STATUS = "status";
@SerializedName(SERIALIZED_NAME_STATUS)
private IndexModelStatus status;
public IndexModel() {
}
public IndexModel name(String name) {
this.name = name;
return this;
}
/**
* The name of the index. Resource name must be 1-45 characters long, start and end with an alphanumeric character, and consist only of lower case alphanumeric characters or '-'.
* @return name
**/
@javax.annotation.Nonnull
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public IndexModel dimension(Integer dimension) {
this.dimension = dimension;
return this;
}
/**
* The dimensions of the vectors to be inserted in the index
* minimum: 1
* maximum: 20000
* @return dimension
**/
@javax.annotation.Nonnull
public Integer getDimension() {
return dimension;
}
public void setDimension(Integer dimension) {
this.dimension = dimension;
}
public IndexModel metric(IndexMetric metric) {
this.metric = metric;
return this;
}
/**
* Get metric
* @return metric
**/
@javax.annotation.Nonnull
public IndexMetric getMetric() {
return metric;
}
public void setMetric(IndexMetric metric) {
this.metric = metric;
}
public IndexModel host(String host) {
this.host = host;
return this;
}
/**
* The URL address where the index is hosted.
* @return host
**/
@javax.annotation.Nullable
public String getHost() {
return host;
}
public void setHost(String host) {
this.host = host;
}
public IndexModel spec(IndexModelSpec spec) {
this.spec = spec;
return this;
}
/**
* Get spec
* @return spec
**/
@javax.annotation.Nonnull
public IndexModelSpec getSpec() {
return spec;
}
public void setSpec(IndexModelSpec spec) {
this.spec = spec;
}
public IndexModel status(IndexModelStatus status) {
this.status = status;
return this;
}
/**
* Get status
* @return status
**/
@javax.annotation.Nonnull
public IndexModelStatus getStatus() {
return status;
}
public void setStatus(IndexModelStatus status) {
this.status = status;
}
@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
IndexModel indexModel = (IndexModel) o;
return Objects.equals(this.name, indexModel.name) &&
Objects.equals(this.dimension, indexModel.dimension) &&
Objects.equals(this.metric, indexModel.metric) &&
Objects.equals(this.host, indexModel.host) &&
Objects.equals(this.spec, indexModel.spec) &&
Objects.equals(this.status, indexModel.status);
}
@Override
public int hashCode() {
return Objects.hash(name, dimension, metric, host, spec, status);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class IndexModel {\n");
sb.append(" name: ").append(toIndentedString(name)).append("\n");
sb.append(" dimension: ").append(toIndentedString(dimension)).append("\n");
sb.append(" metric: ").append(toIndentedString(metric)).append("\n");
sb.append(" host: ").append(toIndentedString(host)).append("\n");
sb.append(" spec: ").append(toIndentedString(spec)).append("\n");
sb.append(" status: ").append(toIndentedString(status)).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("dimension");
openapiFields.add("metric");
openapiFields.add("host");
openapiFields.add("spec");
openapiFields.add("status");
// a set of required properties/fields (JSON key names)
openapiRequiredFields = new HashSet();
openapiRequiredFields.add("name");
openapiRequiredFields.add("dimension");
openapiRequiredFields.add("metric");
openapiRequiredFields.add("spec");
openapiRequiredFields.add("status");
}
/**
* 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 IndexModel
*/
public static void validateJsonElement(JsonElement jsonElement) throws IOException {
if (jsonElement == null) {
if (!IndexModel.openapiRequiredFields.isEmpty()) { // has required fields but JSON element is null
throw new IllegalArgumentException(String.format("The required field(s) %s in IndexModel is not found in the empty JSON string", IndexModel.openapiRequiredFields.toString()));
}
}
Set> entries = jsonElement.getAsJsonObject().entrySet();
// check to see if the JSON string contains additional fields
for (Map.Entry entry : entries) {
if (!IndexModel.openapiFields.contains(entry.getKey())) {
throw new IllegalArgumentException(String.format("The field `%s` in the JSON string is not defined in the `IndexModel` properties. JSON: %s", entry.getKey(), jsonElement.toString()));
}
}
// check to make sure all required properties/fields are present in the JSON string
for (String requiredField : IndexModel.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();
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("host") != null && !jsonObj.get("host").isJsonNull()) && !jsonObj.get("host").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `host` to be a primitive type in the JSON string but got `%s`", jsonObj.get("host").toString()));
}
// validate the required field `spec`
IndexModelSpec.validateJsonElement(jsonObj.get("spec"));
// validate the required field `status`
IndexModelStatus.validateJsonElement(jsonObj.get("status"));
}
public static class CustomTypeAdapterFactory implements TypeAdapterFactory {
@SuppressWarnings("unchecked")
@Override
public TypeAdapter create(Gson gson, TypeToken type) {
if (!IndexModel.class.isAssignableFrom(type.getRawType())) {
return null; // this class only serializes 'IndexModel' and its subtypes
}
final TypeAdapter elementAdapter = gson.getAdapter(JsonElement.class);
final TypeAdapter thisAdapter
= gson.getDelegateAdapter(this, TypeToken.get(IndexModel.class));
return (TypeAdapter) new TypeAdapter() {
@Override
public void write(JsonWriter out, IndexModel value) throws IOException {
JsonObject obj = thisAdapter.toJsonTree(value).getAsJsonObject();
elementAdapter.write(out, obj);
}
@Override
public IndexModel read(JsonReader in) throws IOException {
JsonElement jsonElement = elementAdapter.read(in);
validateJsonElement(jsonElement);
return thisAdapter.fromJsonTree(jsonElement);
}
}.nullSafe();
}
}
/**
* Create an instance of IndexModel given an JSON string
*
* @param jsonString JSON string
* @return An instance of IndexModel
* @throws IOException if the JSON string is invalid with respect to IndexModel
*/
public static IndexModel fromJson(String jsonString) throws IOException {
return JSON.getGson().fromJson(jsonString, IndexModel.class);
}
/**
* Convert an instance of IndexModel to an JSON string
*
* @return JSON string
*/
public String toJson() {
return JSON.getGson().toJson(this);
}
}