com.zuora.model.UpdateCustomObjectCusotmField Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of zuora-sdk-java Show documentation
Show all versions of zuora-sdk-java Show documentation
The SDK of JAVA language for Zuora pricing system
/*
* 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.CustomObjectCustomFieldDefinitionUpdate;
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.Iterator;
import java.util.List;
import java.util.Map;
import java.util.Set;
import com.zuora.JSON;
/**
* A reference to a field.
*/
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.6.0")
public class UpdateCustomObjectCusotmField {
public static final String SERIALIZED_NAME_AUDITABLE = "auditable";
@SerializedName(SERIALIZED_NAME_AUDITABLE)
private Boolean auditable;
public static final String SERIALIZED_NAME_DEFINITION = "definition";
@SerializedName(SERIALIZED_NAME_DEFINITION)
private CustomObjectCustomFieldDefinitionUpdate definition;
public static final String SERIALIZED_NAME_FILTERABLE = "filterable";
@SerializedName(SERIALIZED_NAME_FILTERABLE)
private Boolean filterable;
public static final String SERIALIZED_NAME_NAME = "name";
@SerializedName(SERIALIZED_NAME_NAME)
private String name;
public static final String SERIALIZED_NAME_REQUIRED = "required";
@SerializedName(SERIALIZED_NAME_REQUIRED)
private Boolean required;
public static final String SERIALIZED_NAME_TARGET_NAME = "targetName";
@SerializedName(SERIALIZED_NAME_TARGET_NAME)
private String targetName;
public static final String SERIALIZED_NAME_UNIQUE = "unique";
@SerializedName(SERIALIZED_NAME_UNIQUE)
private Boolean unique;
public UpdateCustomObjectCusotmField() {
}
public UpdateCustomObjectCusotmField auditable(Boolean auditable) {
this.auditable = auditable;
return this;
}
/**
* Indicates whether Audit Trail will record changes of this custom field. You can change auditable fields to non-auditable, and vice versa. One custom object can have a maximum of five auditable fields.
* @return auditable
*/
@javax.annotation.Nullable
public Boolean getAuditable() {
return auditable;
}
public void setAuditable(Boolean auditable) {
this.auditable = auditable;
}
public UpdateCustomObjectCusotmField definition(CustomObjectCustomFieldDefinitionUpdate definition) {
this.definition = definition;
return this;
}
/**
* Get definition
* @return definition
*/
@javax.annotation.Nullable
public CustomObjectCustomFieldDefinitionUpdate getDefinition() {
return definition;
}
public void setDefinition(CustomObjectCustomFieldDefinitionUpdate definition) {
this.definition = definition;
}
public UpdateCustomObjectCusotmField filterable(Boolean filterable) {
this.filterable = filterable;
return this;
}
/**
* Indicates whether the field is filterable or not. Applicable to `addField` and `updateField` actions. You can change a filterable field to non-filterable and vice versa. You can also add a filterable field. One custom object can have a maximum of 10 filterable fields. Note that changing filterable fields triggers reindexing. It will take 12-24 hours before all your data are reindexed and available to query.
* @return filterable
*/
@javax.annotation.Nullable
public Boolean getFilterable() {
return filterable;
}
public void setFilterable(Boolean filterable) {
this.filterable = filterable;
}
public UpdateCustomObjectCusotmField name(String name) {
this.name = name;
return this;
}
/**
* The name of the custom field to be updated
* @return name
*/
@javax.annotation.Nullable
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public UpdateCustomObjectCusotmField required(Boolean required) {
this.required = required;
return this;
}
/**
* Indicates whether the field is required or optional. You can update a required field to optional. On the other hand, you can only update an optional field to required on the custom object with no records. You can only add a required field to the custom object with no records.
* @return required
*/
@javax.annotation.Nullable
public Boolean getRequired() {
return required;
}
public void setRequired(Boolean required) {
this.required = required;
}
public UpdateCustomObjectCusotmField targetName(String targetName) {
this.targetName = targetName;
return this;
}
/**
* Required if the `type` of the action is `renameField`
* @return targetName
*/
@javax.annotation.Nullable
public String getTargetName() {
return targetName;
}
public void setTargetName(String targetName) {
this.targetName = targetName;
}
public UpdateCustomObjectCusotmField unique(Boolean unique) {
this.unique = unique;
return this;
}
/**
* Indicates whether to specify a unique constraint to the field. You can remove the unique constraint on the field. However, you can only add a unique constraint to a filterable field if the custom object contains no record. One custom object can have a maximum of five fields with unique constraints.
* @return unique
*/
@javax.annotation.Nullable
public Boolean getUnique() {
return unique;
}
public void setUnique(Boolean 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 UpdateCustomObjectCusotmField instance itself
*/
public UpdateCustomObjectCusotmField 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;
}
UpdateCustomObjectCusotmField updateCustomObjectCusotmField = (UpdateCustomObjectCusotmField) o;
return Objects.equals(this.auditable, updateCustomObjectCusotmField.auditable) &&
Objects.equals(this.definition, updateCustomObjectCusotmField.definition) &&
Objects.equals(this.filterable, updateCustomObjectCusotmField.filterable) &&
Objects.equals(this.name, updateCustomObjectCusotmField.name) &&
Objects.equals(this.required, updateCustomObjectCusotmField.required) &&
Objects.equals(this.targetName, updateCustomObjectCusotmField.targetName) &&
Objects.equals(this.unique, updateCustomObjectCusotmField.unique)&&
Objects.equals(this.additionalProperties, updateCustomObjectCusotmField.additionalProperties);
}
@Override
public int hashCode() {
return Objects.hash(auditable, definition, filterable, name, required, targetName, unique, additionalProperties);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class UpdateCustomObjectCusotmField {\n");
sb.append(" auditable: ").append(toIndentedString(auditable)).append("\n");
sb.append(" definition: ").append(toIndentedString(definition)).append("\n");
sb.append(" filterable: ").append(toIndentedString(filterable)).append("\n");
sb.append(" name: ").append(toIndentedString(name)).append("\n");
sb.append(" required: ").append(toIndentedString(required)).append("\n");
sb.append(" targetName: ").append(toIndentedString(targetName)).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("definition");
openapiFields.add("filterable");
openapiFields.add("name");
openapiFields.add("required");
openapiFields.add("targetName");
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 UpdateCustomObjectCusotmField
*/
public static void validateJsonElement(JsonElement jsonElement) throws IOException {
if (jsonElement == null) {
if (!UpdateCustomObjectCusotmField.openapiRequiredFields.isEmpty()) { // has required fields but JSON element is null
throw new IllegalArgumentException(String.format("The required field(s) %s in UpdateCustomObjectCusotmField is not found in the empty JSON string", UpdateCustomObjectCusotmField.openapiRequiredFields.toString()));
}
}
JsonObject jsonObj = jsonElement.getAsJsonObject();
// validate the optional field `definition`
if (jsonObj.get("definition") != null && !jsonObj.get("definition").isJsonNull()) {
CustomObjectCustomFieldDefinitionUpdate.validateJsonElement(jsonObj.get("definition"));
}
if ((jsonObj.get("name") != null && !jsonObj.get("name").isJsonNull()) && !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("targetName") != null && !jsonObj.get("targetName").isJsonNull()) && !jsonObj.get("targetName").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `targetName` to be a primitive type in the JSON string but got `%s`", jsonObj.get("targetName").toString()));
}
}
public static class CustomTypeAdapterFactory implements TypeAdapterFactory {
@SuppressWarnings("unchecked")
@Override
public TypeAdapter create(Gson gson, TypeToken type) {
if (!UpdateCustomObjectCusotmField.class.isAssignableFrom(type.getRawType())) {
return null; // this class only serializes 'UpdateCustomObjectCusotmField' and its subtypes
}
final TypeAdapter elementAdapter = gson.getAdapter(JsonElement.class);
final TypeAdapter thisAdapter
= gson.getDelegateAdapter(this, TypeToken.get(UpdateCustomObjectCusotmField.class));
return (TypeAdapter) new TypeAdapter() {
@Override
public void write(JsonWriter out, UpdateCustomObjectCusotmField 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 UpdateCustomObjectCusotmField read(JsonReader in) throws IOException {
JsonElement jsonElement = elementAdapter.read(in);
validateJsonElement(jsonElement);
JsonObject jsonObj = jsonElement.getAsJsonObject();
// store additional fields in the deserialized instance
UpdateCustomObjectCusotmField 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 UpdateCustomObjectCusotmField given an JSON string
*
* @param jsonString JSON string
* @return An instance of UpdateCustomObjectCusotmField
* @throws IOException if the JSON string is invalid with respect to UpdateCustomObjectCusotmField
*/
public static UpdateCustomObjectCusotmField fromJson(String jsonString) throws IOException {
return JSON.getGson().fromJson(jsonString, UpdateCustomObjectCusotmField.class);
}
/**
* Convert an instance of UpdateCustomObjectCusotmField to an JSON string
*
* @return JSON string
*/
public String toJson() {
return JSON.getGson().toJson(this);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy