com.piiano.vault.client.openapi.model.AnalysisPIIEntity 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 java.io.IOException;
import java.math.BigDecimal;
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;
/**
* Identified PII entity type and location.
*/
@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 AnalysisPIIEntity {
public static final String SERIALIZED_NAME_TYPE = "type";
@SerializedName(SERIALIZED_NAME_TYPE)
@javax.annotation.Nullable
private String type;
public static final String SERIALIZED_NAME_SCORE = "score";
@SerializedName(SERIALIZED_NAME_SCORE)
@javax.annotation.Nullable
private BigDecimal score;
public static final String SERIALIZED_NAME_BEGIN_OFFSET = "begin_offset";
@SerializedName(SERIALIZED_NAME_BEGIN_OFFSET)
@javax.annotation.Nullable
private Integer beginOffset;
public static final String SERIALIZED_NAME_END_OFFSET = "end_offset";
@SerializedName(SERIALIZED_NAME_END_OFFSET)
@javax.annotation.Nullable
private Integer endOffset;
public AnalysisPIIEntity() {
}
public AnalysisPIIEntity type(@javax.annotation.Nullable String type) {
this.type = type;
return this;
}
/**
* PII entity type.
* @return type
*/
@javax.annotation.Nullable
public String getType() {
return type;
}
public void setType(@javax.annotation.Nullable String type) {
this.type = type;
}
public AnalysisPIIEntity score(@javax.annotation.Nullable BigDecimal score) {
this.score = score;
return this;
}
/**
* Accuracy of the PII match.
* @return score
*/
@javax.annotation.Nullable
public BigDecimal getScore() {
return score;
}
public void setScore(@javax.annotation.Nullable BigDecimal score) {
this.score = score;
}
public AnalysisPIIEntity beginOffset(@javax.annotation.Nullable Integer beginOffset) {
this.beginOffset = beginOffset;
return this;
}
/**
* Text start offset for the match.
* @return beginOffset
*/
@javax.annotation.Nullable
public Integer getBeginOffset() {
return beginOffset;
}
public void setBeginOffset(@javax.annotation.Nullable Integer beginOffset) {
this.beginOffset = beginOffset;
}
public AnalysisPIIEntity endOffset(@javax.annotation.Nullable Integer endOffset) {
this.endOffset = endOffset;
return this;
}
/**
* Text end offset for the match.
* @return endOffset
*/
@javax.annotation.Nullable
public Integer getEndOffset() {
return endOffset;
}
public void setEndOffset(@javax.annotation.Nullable Integer endOffset) {
this.endOffset = endOffset;
}
@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
AnalysisPIIEntity analysisPIIEntity = (AnalysisPIIEntity) o;
return Objects.equals(this.type, analysisPIIEntity.type) &&
Objects.equals(this.score, analysisPIIEntity.score) &&
Objects.equals(this.beginOffset, analysisPIIEntity.beginOffset) &&
Objects.equals(this.endOffset, analysisPIIEntity.endOffset);
}
@Override
public int hashCode() {
return Objects.hash(type, score, beginOffset, endOffset);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class AnalysisPIIEntity {\n");
sb.append(" type: ").append(toIndentedString(type)).append("\n");
sb.append(" score: ").append(toIndentedString(score)).append("\n");
sb.append(" beginOffset: ").append(toIndentedString(beginOffset)).append("\n");
sb.append(" endOffset: ").append(toIndentedString(endOffset)).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("type");
openapiFields.add("score");
openapiFields.add("begin_offset");
openapiFields.add("end_offset");
// 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 AnalysisPIIEntity
*/
public static void validateJsonElement(JsonElement jsonElement) throws IOException {
if (jsonElement == null) {
if (!AnalysisPIIEntity.openapiRequiredFields.isEmpty()) { // has required fields but JSON element is null
throw new IllegalArgumentException(String.format("The required field(s) %s in AnalysisPIIEntity is not found in the empty JSON string", AnalysisPIIEntity.openapiRequiredFields.toString()));
}
}
Set> entries = jsonElement.getAsJsonObject().entrySet();
// check to see if the JSON string contains additional fields
for (Map.Entry entry : entries) {
if (!AnalysisPIIEntity.openapiFields.contains(entry.getKey())) {
throw new IllegalArgumentException(String.format("The field `%s` in the JSON string is not defined in the `AnalysisPIIEntity` properties. JSON: %s", entry.getKey(), jsonElement.toString()));
}
}
JsonObject jsonObj = jsonElement.getAsJsonObject();
if ((jsonObj.get("type") != null && !jsonObj.get("type").isJsonNull()) && !jsonObj.get("type").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `type` to be a primitive type in the JSON string but got `%s`", jsonObj.get("type").toString()));
}
}
public static class CustomTypeAdapterFactory implements TypeAdapterFactory {
@SuppressWarnings("unchecked")
@Override
public TypeAdapter create(Gson gson, TypeToken type) {
if (!AnalysisPIIEntity.class.isAssignableFrom(type.getRawType())) {
return null; // this class only serializes 'AnalysisPIIEntity' and its subtypes
}
final TypeAdapter elementAdapter = gson.getAdapter(JsonElement.class);
final TypeAdapter thisAdapter
= gson.getDelegateAdapter(this, TypeToken.get(AnalysisPIIEntity.class));
return (TypeAdapter) new TypeAdapter() {
@Override
public void write(JsonWriter out, AnalysisPIIEntity value) throws IOException {
JsonObject obj = thisAdapter.toJsonTree(value).getAsJsonObject();
elementAdapter.write(out, obj);
}
@Override
public AnalysisPIIEntity read(JsonReader in) throws IOException {
JsonElement jsonElement = elementAdapter.read(in);
validateJsonElement(jsonElement);
return thisAdapter.fromJsonTree(jsonElement);
}
}.nullSafe();
}
}
/**
* Create an instance of AnalysisPIIEntity given an JSON string
*
* @param jsonString JSON string
* @return An instance of AnalysisPIIEntity
* @throws IOException if the JSON string is invalid with respect to AnalysisPIIEntity
*/
public static AnalysisPIIEntity fromJson(String jsonString) throws IOException {
return JSON.getGson().fromJson(jsonString, AnalysisPIIEntity.class);
}
/**
* Convert an instance of AnalysisPIIEntity to an JSON string
*
* @return JSON string
*/
public String toJson() {
return JSON.getGson().toJson(this);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy