Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $
You can buy this project and download/modify it how often you want.
com.zuora.model.CustomObjectDefinitionSchema Maven / Gradle / Ivy
/*
* Zuora API Reference
* REST API reference for the Zuora Billing, Payments, and Central Platform! Check out the [REST API Overview](https://www.zuora.com/developer/api-references/api/overview/).
*
* The version of the OpenAPI document: 2024-05-20
* 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 com.zuora.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 com.zuora.model.CustomObjectAllFieldsDefinition;
import com.zuora.model.CustomObjectDefinitionSchemaType;
import java.io.IOException;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
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.Iterator;
import java.util.List;
import java.util.Map;
import java.util.Set;
import com.zuora.JSON;
/**
* The schema of the custom object definition
*/
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.6.0")
public class CustomObjectDefinitionSchema {
public static final String SERIALIZED_NAME_AUDITABLE = "auditable";
@SerializedName(SERIALIZED_NAME_AUDITABLE)
private List auditable;
public static final String SERIALIZED_NAME_ENABLE_CREATE_RECORD_AUDITING = "enableCreateRecordAuditing";
@SerializedName(SERIALIZED_NAME_ENABLE_CREATE_RECORD_AUDITING)
private Boolean enableCreateRecordAuditing;
public static final String SERIALIZED_NAME_ENABLE_DELETE_RECORD_AUDITING = "enableDeleteRecordAuditing";
@SerializedName(SERIALIZED_NAME_ENABLE_DELETE_RECORD_AUDITING)
private Boolean enableDeleteRecordAuditing;
public static final String SERIALIZED_NAME_FILTERABLE = "filterable";
@SerializedName(SERIALIZED_NAME_FILTERABLE)
private List filterable;
public static final String SERIALIZED_NAME_LABEL = "label";
@SerializedName(SERIALIZED_NAME_LABEL)
private String label;
public static final String SERIALIZED_NAME_OBJECT = "object";
@SerializedName(SERIALIZED_NAME_OBJECT)
private String _object;
public static final String SERIALIZED_NAME_PROPERTIES = "properties";
@SerializedName(SERIALIZED_NAME_PROPERTIES)
private CustomObjectAllFieldsDefinition properties;
public static final String SERIALIZED_NAME_RELATIONSHIPS = "relationships";
@SerializedName(SERIALIZED_NAME_RELATIONSHIPS)
private List relationships;
public static final String SERIALIZED_NAME_REQUIRED = "required";
@SerializedName(SERIALIZED_NAME_REQUIRED)
private List required;
public static final String SERIALIZED_NAME_TYPE = "type";
@SerializedName(SERIALIZED_NAME_TYPE)
private CustomObjectDefinitionSchemaType type;
public static final String SERIALIZED_NAME_UNIQUE = "unique";
@SerializedName(SERIALIZED_NAME_UNIQUE)
private List unique;
public CustomObjectDefinitionSchema() {
}
public CustomObjectDefinitionSchema auditable(List auditable) {
this.auditable = auditable;
return this;
}
public CustomObjectDefinitionSchema addAuditableItem(String auditableItem) {
if (this.auditable == null) {
this.auditable = new ArrayList<>();
}
this.auditable.add(auditableItem);
return this;
}
/**
* The set of fields which Audit Trail tracks and records changes of.
* @return auditable
*/
@javax.annotation.Nullable
public List getAuditable() {
return auditable;
}
public void setAuditable(List auditable) {
this.auditable = auditable;
}
public CustomObjectDefinitionSchema enableCreateRecordAuditing(Boolean enableCreateRecordAuditing) {
this.enableCreateRecordAuditing = enableCreateRecordAuditing;
return this;
}
/**
* Indicates whether to audit the creation of custom object records of this custom object definition.
* @return enableCreateRecordAuditing
*/
@javax.annotation.Nullable
public Boolean getEnableCreateRecordAuditing() {
return enableCreateRecordAuditing;
}
public void setEnableCreateRecordAuditing(Boolean enableCreateRecordAuditing) {
this.enableCreateRecordAuditing = enableCreateRecordAuditing;
}
public CustomObjectDefinitionSchema enableDeleteRecordAuditing(Boolean enableDeleteRecordAuditing) {
this.enableDeleteRecordAuditing = enableDeleteRecordAuditing;
return this;
}
/**
* Indicates whether to audit the deletion of custom object records of this custom object definition.
* @return enableDeleteRecordAuditing
*/
@javax.annotation.Nullable
public Boolean getEnableDeleteRecordAuditing() {
return enableDeleteRecordAuditing;
}
public void setEnableDeleteRecordAuditing(Boolean enableDeleteRecordAuditing) {
this.enableDeleteRecordAuditing = enableDeleteRecordAuditing;
}
public CustomObjectDefinitionSchema filterable(List filterable) {
this.filterable = filterable;
return this;
}
public CustomObjectDefinitionSchema addFilterableItem(String filterableItem) {
if (this.filterable == null) {
this.filterable = new ArrayList<>();
}
this.filterable.add(filterableItem);
return this;
}
/**
* The set of fields that are allowed to be queried on. Queries on non-filterable fields will be rejected. You can not change a non-filterable field to filterable.
* @return filterable
*/
@javax.annotation.Nullable
public List getFilterable() {
return filterable;
}
public void setFilterable(List filterable) {
this.filterable = filterable;
}
public CustomObjectDefinitionSchema label(String label) {
this.label = label;
return this;
}
/**
* A label for the custom object
* @return label
*/
@javax.annotation.Nullable
public String getLabel() {
return label;
}
public void setLabel(String label) {
this.label = label;
}
public CustomObjectDefinitionSchema _object(String _object) {
this._object = _object;
return this;
}
/**
* The API name of the custom object
* @return _object
*/
@javax.annotation.Nullable
public String getObject() {
return _object;
}
public void setObject(String _object) {
this._object = _object;
}
public CustomObjectDefinitionSchema properties(CustomObjectAllFieldsDefinition properties) {
this.properties = properties;
return this;
}
/**
* Get properties
* @return properties
*/
@javax.annotation.Nullable
public CustomObjectAllFieldsDefinition getProperties() {
return properties;
}
public void setProperties(CustomObjectAllFieldsDefinition properties) {
this.properties = properties;
}
public CustomObjectDefinitionSchema relationships(List relationships) {
this.relationships = relationships;
return this;
}
public CustomObjectDefinitionSchema addRelationshipsItem(Object relationshipsItem) {
if (this.relationships == null) {
this.relationships = new ArrayList<>();
}
this.relationships.add(relationshipsItem);
return this;
}
/**
* An array of relationships with Zuora objects or other custom objects
* @return relationships
*/
@javax.annotation.Nullable
public List getRelationships() {
return relationships;
}
public void setRelationships(List relationships) {
this.relationships = relationships;
}
public CustomObjectDefinitionSchema required(List required) {
this.required = required;
return this;
}
public CustomObjectDefinitionSchema addRequiredItem(String requiredItem) {
if (this.required == null) {
this.required = new ArrayList<>();
}
this.required.add(requiredItem);
return this;
}
/**
* The required fields of the custom object definition. You can change required fields to optional. However, you can only change optional fields to required on the custom objects with no records.
* @return required
*/
@javax.annotation.Nullable
public List getRequired() {
return required;
}
public void setRequired(List required) {
this.required = required;
}
public CustomObjectDefinitionSchema type(CustomObjectDefinitionSchemaType type) {
this.type = type;
return this;
}
/**
* Get type
* @return type
*/
@javax.annotation.Nullable
public CustomObjectDefinitionSchemaType getType() {
return type;
}
public void setType(CustomObjectDefinitionSchemaType type) {
this.type = type;
}
public CustomObjectDefinitionSchema unique(List unique) {
this.unique = unique;
return this;
}
public CustomObjectDefinitionSchema addUniqueItem(String uniqueItem) {
if (this.unique == null) {
this.unique = new ArrayList<>();
}
this.unique.add(uniqueItem);
return this;
}
/**
* The fields with unique constraints.
* @return unique
*/
@javax.annotation.Nullable
public List getUnique() {
return unique;
}
public void setUnique(List unique) {
this.unique = unique;
}
/**
* A container for additional, undeclared properties.
* This is a holder for any undeclared properties as specified with
* the 'additionalProperties' keyword in the OAS document.
*/
private Map additionalProperties;
/**
* Set the additional (undeclared) property with the specified name and value.
* If the property does not already exist, create it otherwise replace it.
*
* @param key name of the property
* @param value value of the property
* @return the CustomObjectDefinitionSchema instance itself
*/
public CustomObjectDefinitionSchema putAdditionalProperty(String key, Object value) {
if (this.additionalProperties == null) {
this.additionalProperties = new HashMap();
}
this.additionalProperties.put(key, value);
return this;
}
/**
* Return the additional (undeclared) property.
*
* @return a map of objects
*/
public Map getAdditionalProperties() {
return additionalProperties;
}
/**
* Return the additional (undeclared) property with the specified name.
*
* @param key name of the property
* @return an object
*/
public Object getAdditionalProperty(String key) {
if (this.additionalProperties == null) {
return null;
}
return this.additionalProperties.get(key);
}
@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
CustomObjectDefinitionSchema customObjectDefinitionSchema = (CustomObjectDefinitionSchema) o;
return Objects.equals(this.auditable, customObjectDefinitionSchema.auditable) &&
Objects.equals(this.enableCreateRecordAuditing, customObjectDefinitionSchema.enableCreateRecordAuditing) &&
Objects.equals(this.enableDeleteRecordAuditing, customObjectDefinitionSchema.enableDeleteRecordAuditing) &&
Objects.equals(this.filterable, customObjectDefinitionSchema.filterable) &&
Objects.equals(this.label, customObjectDefinitionSchema.label) &&
Objects.equals(this._object, customObjectDefinitionSchema._object) &&
Objects.equals(this.properties, customObjectDefinitionSchema.properties) &&
Objects.equals(this.relationships, customObjectDefinitionSchema.relationships) &&
Objects.equals(this.required, customObjectDefinitionSchema.required) &&
Objects.equals(this.type, customObjectDefinitionSchema.type) &&
Objects.equals(this.unique, customObjectDefinitionSchema.unique)&&
Objects.equals(this.additionalProperties, customObjectDefinitionSchema.additionalProperties);
}
@Override
public int hashCode() {
return Objects.hash(auditable, enableCreateRecordAuditing, enableDeleteRecordAuditing, filterable, label, _object, properties, relationships, required, type, unique, additionalProperties);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class CustomObjectDefinitionSchema {\n");
sb.append(" auditable: ").append(toIndentedString(auditable)).append("\n");
sb.append(" enableCreateRecordAuditing: ").append(toIndentedString(enableCreateRecordAuditing)).append("\n");
sb.append(" enableDeleteRecordAuditing: ").append(toIndentedString(enableDeleteRecordAuditing)).append("\n");
sb.append(" filterable: ").append(toIndentedString(filterable)).append("\n");
sb.append(" label: ").append(toIndentedString(label)).append("\n");
sb.append(" _object: ").append(toIndentedString(_object)).append("\n");
sb.append(" properties: ").append(toIndentedString(properties)).append("\n");
sb.append(" relationships: ").append(toIndentedString(relationships)).append("\n");
sb.append(" required: ").append(toIndentedString(required)).append("\n");
sb.append(" type: ").append(toIndentedString(type)).append("\n");
sb.append(" unique: ").append(toIndentedString(unique)).append("\n");
sb.append(" additionalProperties: ").append(toIndentedString(additionalProperties)).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("auditable");
openapiFields.add("enableCreateRecordAuditing");
openapiFields.add("enableDeleteRecordAuditing");
openapiFields.add("filterable");
openapiFields.add("label");
openapiFields.add("object");
openapiFields.add("properties");
openapiFields.add("relationships");
openapiFields.add("required");
openapiFields.add("type");
openapiFields.add("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 CustomObjectDefinitionSchema
*/
public static void validateJsonElement(JsonElement jsonElement) throws IOException {
if (jsonElement == null) {
if (!CustomObjectDefinitionSchema.openapiRequiredFields.isEmpty()) { // has required fields but JSON element is null
throw new IllegalArgumentException(String.format("The required field(s) %s in CustomObjectDefinitionSchema is not found in the empty JSON string", CustomObjectDefinitionSchema.openapiRequiredFields.toString()));
}
}
JsonObject jsonObj = jsonElement.getAsJsonObject();
// ensure the optional json data is an array if present
if (jsonObj.get("auditable") != null && !jsonObj.get("auditable").isJsonNull() && !jsonObj.get("auditable").isJsonArray()) {
throw new IllegalArgumentException(String.format("Expected the field `auditable` to be an array in the JSON string but got `%s`", jsonObj.get("auditable").toString()));
}
// ensure the optional json data is an array if present
if (jsonObj.get("filterable") != null && !jsonObj.get("filterable").isJsonNull() && !jsonObj.get("filterable").isJsonArray()) {
throw new IllegalArgumentException(String.format("Expected the field `filterable` to be an array in the JSON string but got `%s`", jsonObj.get("filterable").toString()));
}
if ((jsonObj.get("label") != null && !jsonObj.get("label").isJsonNull()) && !jsonObj.get("label").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `label` to be a primitive type in the JSON string but got `%s`", jsonObj.get("label").toString()));
}
if ((jsonObj.get("object") != null && !jsonObj.get("object").isJsonNull()) && !jsonObj.get("object").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `object` to be a primitive type in the JSON string but got `%s`", jsonObj.get("object").toString()));
}
// validate the optional field `properties`
if (jsonObj.get("properties") != null && !jsonObj.get("properties").isJsonNull()) {
CustomObjectAllFieldsDefinition.validateJsonElement(jsonObj.get("properties"));
}
// ensure the optional json data is an array if present
if (jsonObj.get("relationships") != null && !jsonObj.get("relationships").isJsonNull() && !jsonObj.get("relationships").isJsonArray()) {
throw new IllegalArgumentException(String.format("Expected the field `relationships` to be an array in the JSON string but got `%s`", jsonObj.get("relationships").toString()));
}
// ensure the optional json data is an array if present
if (jsonObj.get("required") != null && !jsonObj.get("required").isJsonNull() && !jsonObj.get("required").isJsonArray()) {
throw new IllegalArgumentException(String.format("Expected the field `required` to be an array in the JSON string but got `%s`", jsonObj.get("required").toString()));
}
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()));
}
// validate the optional field `type`
if (jsonObj.get("type") != null && !jsonObj.get("type").isJsonNull()) {
CustomObjectDefinitionSchemaType.validateJsonElement(jsonObj.get("type"));
}
// ensure the optional json data is an array if present
if (jsonObj.get("unique") != null && !jsonObj.get("unique").isJsonNull() && !jsonObj.get("unique").isJsonArray()) {
throw new IllegalArgumentException(String.format("Expected the field `unique` to be an array in the JSON string but got `%s`", jsonObj.get("unique").toString()));
}
}
public static class CustomTypeAdapterFactory implements TypeAdapterFactory {
@SuppressWarnings("unchecked")
@Override
public TypeAdapter create(Gson gson, TypeToken type) {
if (!CustomObjectDefinitionSchema.class.isAssignableFrom(type.getRawType())) {
return null; // this class only serializes 'CustomObjectDefinitionSchema' and its subtypes
}
final TypeAdapter elementAdapter = gson.getAdapter(JsonElement.class);
final TypeAdapter thisAdapter
= gson.getDelegateAdapter(this, TypeToken.get(CustomObjectDefinitionSchema.class));
return (TypeAdapter) new TypeAdapter() {
@Override
public void write(JsonWriter out, CustomObjectDefinitionSchema value) throws IOException {
JsonObject obj = thisAdapter.toJsonTree(value).getAsJsonObject();
obj.remove("additionalProperties");
// support null values
out.beginObject();
Iterator iterator = obj.entrySet().iterator();
while(iterator.hasNext()) {
Map.Entry e = (Map.Entry) iterator.next();
out.name((String)e.getKey());
elementAdapter.write(out, e.getValue());
}
// end
// serialize additional properties
if (value.getAdditionalProperties() != null) {
// support null values
boolean oldSerializeNulls = out.getSerializeNulls();
out.setSerializeNulls(true); //force serialize
// end
for (Map.Entry entry : value.getAdditionalProperties().entrySet()) {
if (entry.getValue() instanceof String)
obj.addProperty(entry.getKey(), (String) entry.getValue());
else if (entry.getValue() instanceof Number)
obj.addProperty(entry.getKey(), (Number) entry.getValue());
else if (entry.getValue() instanceof Boolean)
obj.addProperty(entry.getKey(), (Boolean) entry.getValue());
else if (entry.getValue() instanceof Character)
obj.addProperty(entry.getKey(), (Character) entry.getValue());
else if (entry.getValue() == null)
obj.add(entry.getKey(), null);
else {
JsonElement jsonElement = gson.toJsonTree(entry.getValue());
if (jsonElement.isJsonArray()) {
obj.add(entry.getKey(), jsonElement.getAsJsonArray());
} else {
obj.add(entry.getKey(), jsonElement.getAsJsonObject());
}
}
out.name((String)entry.getKey());
elementAdapter.write(out, obj.get(entry.getKey()));
}
out.setSerializeNulls(oldSerializeNulls); //restore
}
out.endObject();
}
@Override
public CustomObjectDefinitionSchema read(JsonReader in) throws IOException {
JsonElement jsonElement = elementAdapter.read(in);
validateJsonElement(jsonElement);
JsonObject jsonObj = jsonElement.getAsJsonObject();
// store additional fields in the deserialized instance
CustomObjectDefinitionSchema instance = thisAdapter.fromJsonTree(jsonObj);
for (Map.Entry entry : jsonObj.entrySet()) {
if (!openapiFields.contains(entry.getKey())) {
if (entry.getValue().isJsonPrimitive()) { // primitive type
if (entry.getValue().getAsJsonPrimitive().isString())
instance.putAdditionalProperty(entry.getKey(), entry.getValue().getAsString());
else if (entry.getValue().getAsJsonPrimitive().isNumber())
instance.putAdditionalProperty(entry.getKey(), entry.getValue().getAsNumber());
else if (entry.getValue().getAsJsonPrimitive().isBoolean())
instance.putAdditionalProperty(entry.getKey(), entry.getValue().getAsBoolean());
else
throw new IllegalArgumentException(String.format("The field `%s` has unknown primitive type. Value: %s", entry.getKey(), entry.getValue().toString()));
} else if (entry.getValue().isJsonArray()) {
instance.putAdditionalProperty(entry.getKey(), gson.fromJson(entry.getValue(), List.class));
} else { // JSON object
instance.putAdditionalProperty(entry.getKey(), gson.fromJson(entry.getValue(), HashMap.class));
}
}
}
return instance;
}
}.nullSafe();
}
}
/**
* Create an instance of CustomObjectDefinitionSchema given an JSON string
*
* @param jsonString JSON string
* @return An instance of CustomObjectDefinitionSchema
* @throws IOException if the JSON string is invalid with respect to CustomObjectDefinitionSchema
*/
public static CustomObjectDefinitionSchema fromJson(String jsonString) throws IOException {
return JSON.getGson().fromJson(jsonString, CustomObjectDefinitionSchema.class);
}
/**
* Convert an instance of CustomObjectDefinitionSchema to an JSON string
*
* @return JSON string
*/
public String toJson() {
return JSON.getGson().toJson(this);
}
}
