com.zuora.model.TimeSlicedNetMetrics 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.TimeSlicedNetMetricsGeneratedReason;
import com.zuora.model.TimeSlicedNetMetricsType;
import java.io.IOException;
import java.math.BigDecimal;
import java.time.LocalDate;
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;
/**
* TimeSlicedNetMetrics
*/
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.6.0")
public class TimeSlicedNetMetrics {
public static final String SERIALIZED_NAME_AMOUNT = "amount";
@SerializedName(SERIALIZED_NAME_AMOUNT)
private BigDecimal amount;
public static final String SERIALIZED_NAME_DISCOUNT_CHARGE_NUMBER = "discountChargeNumber";
@SerializedName(SERIALIZED_NAME_DISCOUNT_CHARGE_NUMBER)
private String discountChargeNumber;
public static final String SERIALIZED_NAME_END_DATE = "endDate";
@SerializedName(SERIALIZED_NAME_END_DATE)
private LocalDate endDate;
public static final String SERIALIZED_NAME_GENERATED_REASON = "generatedReason";
@SerializedName(SERIALIZED_NAME_GENERATED_REASON)
private TimeSlicedNetMetricsGeneratedReason generatedReason;
public static final String SERIALIZED_NAME_INVOICE_OWNER = "invoiceOwner";
@SerializedName(SERIALIZED_NAME_INVOICE_OWNER)
private String invoiceOwner;
public static final String SERIALIZED_NAME_ORDER_ITEM_ID = "orderItemId";
@SerializedName(SERIALIZED_NAME_ORDER_ITEM_ID)
private String orderItemId;
public static final String SERIALIZED_NAME_START_DATE = "startDate";
@SerializedName(SERIALIZED_NAME_START_DATE)
private LocalDate startDate;
public static final String SERIALIZED_NAME_SUBSCRIPTION_OWNER = "subscriptionOwner";
@SerializedName(SERIALIZED_NAME_SUBSCRIPTION_OWNER)
private String subscriptionOwner;
public static final String SERIALIZED_NAME_TERM_NUMBER = "termNumber";
@SerializedName(SERIALIZED_NAME_TERM_NUMBER)
private Long termNumber;
public static final String SERIALIZED_NAME_TYPE = "type";
@SerializedName(SERIALIZED_NAME_TYPE)
private TimeSlicedNetMetricsType type;
public TimeSlicedNetMetrics() {
}
public TimeSlicedNetMetrics amount(BigDecimal amount) {
this.amount = amount;
return this;
}
/**
* Get amount
* @return amount
*/
@javax.annotation.Nullable
public BigDecimal getAmount() {
return amount;
}
public void setAmount(BigDecimal amount) {
this.amount = amount;
}
public TimeSlicedNetMetrics discountChargeNumber(String discountChargeNumber) {
this.discountChargeNumber = discountChargeNumber;
return this;
}
/**
* Get discountChargeNumber
* @return discountChargeNumber
*/
@javax.annotation.Nullable
public String getDiscountChargeNumber() {
return discountChargeNumber;
}
public void setDiscountChargeNumber(String discountChargeNumber) {
this.discountChargeNumber = discountChargeNumber;
}
public TimeSlicedNetMetrics endDate(LocalDate endDate) {
this.endDate = endDate;
return this;
}
/**
* Get endDate
* @return endDate
*/
@javax.annotation.Nullable
public LocalDate getEndDate() {
return endDate;
}
public void setEndDate(LocalDate endDate) {
this.endDate = endDate;
}
public TimeSlicedNetMetrics generatedReason(TimeSlicedNetMetricsGeneratedReason generatedReason) {
this.generatedReason = generatedReason;
return this;
}
/**
* Get generatedReason
* @return generatedReason
*/
@javax.annotation.Nullable
public TimeSlicedNetMetricsGeneratedReason getGeneratedReason() {
return generatedReason;
}
public void setGeneratedReason(TimeSlicedNetMetricsGeneratedReason generatedReason) {
this.generatedReason = generatedReason;
}
public TimeSlicedNetMetrics invoiceOwner(String invoiceOwner) {
this.invoiceOwner = invoiceOwner;
return this;
}
/**
* The acount number of the billing account that is billed for the subscription.
* @return invoiceOwner
*/
@javax.annotation.Nullable
public String getInvoiceOwner() {
return invoiceOwner;
}
public void setInvoiceOwner(String invoiceOwner) {
this.invoiceOwner = invoiceOwner;
}
public TimeSlicedNetMetrics orderItemId(String orderItemId) {
this.orderItemId = orderItemId;
return this;
}
/**
* The ID of the order item referenced by the order metrics. This field is only available to existing Orders customers who already have access to the field. **Note:** The following Order Metrics have been deprecated. Any new customers who onboard on [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders) or [Orders Harmonization](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Orders_Harmonization/Orders_Harmonization) will not get these metrics. * The Order ELP and Order Item objects * The \"Generated Reason\" and \"Order Item ID\" fields in the Order MRR, Order TCB, Order TCV, and Order Quantity objects Existing Orders customers who have these metrics will continue to be supported.
* @return orderItemId
*/
@javax.annotation.Nullable
public String getOrderItemId() {
return orderItemId;
}
public void setOrderItemId(String orderItemId) {
this.orderItemId = orderItemId;
}
public TimeSlicedNetMetrics startDate(LocalDate startDate) {
this.startDate = startDate;
return this;
}
/**
* Get startDate
* @return startDate
*/
@javax.annotation.Nullable
public LocalDate getStartDate() {
return startDate;
}
public void setStartDate(LocalDate startDate) {
this.startDate = startDate;
}
public TimeSlicedNetMetrics subscriptionOwner(String subscriptionOwner) {
this.subscriptionOwner = subscriptionOwner;
return this;
}
/**
* The acount number of the billing account that owns the subscription.
* @return subscriptionOwner
*/
@javax.annotation.Nullable
public String getSubscriptionOwner() {
return subscriptionOwner;
}
public void setSubscriptionOwner(String subscriptionOwner) {
this.subscriptionOwner = subscriptionOwner;
}
public TimeSlicedNetMetrics termNumber(Long termNumber) {
this.termNumber = termNumber;
return this;
}
/**
* Get termNumber
* @return termNumber
*/
@javax.annotation.Nullable
public Long getTermNumber() {
return termNumber;
}
public void setTermNumber(Long termNumber) {
this.termNumber = termNumber;
}
public TimeSlicedNetMetrics type(TimeSlicedNetMetricsType type) {
this.type = type;
return this;
}
/**
* Get type
* @return type
*/
@javax.annotation.Nullable
public TimeSlicedNetMetricsType getType() {
return type;
}
public void setType(TimeSlicedNetMetricsType type) {
this.type = type;
}
/**
* 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 TimeSlicedNetMetrics instance itself
*/
public TimeSlicedNetMetrics 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;
}
TimeSlicedNetMetrics timeSlicedNetMetrics = (TimeSlicedNetMetrics) o;
return Objects.equals(this.amount, timeSlicedNetMetrics.amount) &&
Objects.equals(this.discountChargeNumber, timeSlicedNetMetrics.discountChargeNumber) &&
Objects.equals(this.endDate, timeSlicedNetMetrics.endDate) &&
Objects.equals(this.generatedReason, timeSlicedNetMetrics.generatedReason) &&
Objects.equals(this.invoiceOwner, timeSlicedNetMetrics.invoiceOwner) &&
Objects.equals(this.orderItemId, timeSlicedNetMetrics.orderItemId) &&
Objects.equals(this.startDate, timeSlicedNetMetrics.startDate) &&
Objects.equals(this.subscriptionOwner, timeSlicedNetMetrics.subscriptionOwner) &&
Objects.equals(this.termNumber, timeSlicedNetMetrics.termNumber) &&
Objects.equals(this.type, timeSlicedNetMetrics.type)&&
Objects.equals(this.additionalProperties, timeSlicedNetMetrics.additionalProperties);
}
@Override
public int hashCode() {
return Objects.hash(amount, discountChargeNumber, endDate, generatedReason, invoiceOwner, orderItemId, startDate, subscriptionOwner, termNumber, type, additionalProperties);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class TimeSlicedNetMetrics {\n");
sb.append(" amount: ").append(toIndentedString(amount)).append("\n");
sb.append(" discountChargeNumber: ").append(toIndentedString(discountChargeNumber)).append("\n");
sb.append(" endDate: ").append(toIndentedString(endDate)).append("\n");
sb.append(" generatedReason: ").append(toIndentedString(generatedReason)).append("\n");
sb.append(" invoiceOwner: ").append(toIndentedString(invoiceOwner)).append("\n");
sb.append(" orderItemId: ").append(toIndentedString(orderItemId)).append("\n");
sb.append(" startDate: ").append(toIndentedString(startDate)).append("\n");
sb.append(" subscriptionOwner: ").append(toIndentedString(subscriptionOwner)).append("\n");
sb.append(" termNumber: ").append(toIndentedString(termNumber)).append("\n");
sb.append(" type: ").append(toIndentedString(type)).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("amount");
openapiFields.add("discountChargeNumber");
openapiFields.add("endDate");
openapiFields.add("generatedReason");
openapiFields.add("invoiceOwner");
openapiFields.add("orderItemId");
openapiFields.add("startDate");
openapiFields.add("subscriptionOwner");
openapiFields.add("termNumber");
openapiFields.add("type");
// 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 TimeSlicedNetMetrics
*/
public static void validateJsonElement(JsonElement jsonElement) throws IOException {
if (jsonElement == null) {
if (!TimeSlicedNetMetrics.openapiRequiredFields.isEmpty()) { // has required fields but JSON element is null
throw new IllegalArgumentException(String.format("The required field(s) %s in TimeSlicedNetMetrics is not found in the empty JSON string", TimeSlicedNetMetrics.openapiRequiredFields.toString()));
}
}
JsonObject jsonObj = jsonElement.getAsJsonObject();
if ((jsonObj.get("discountChargeNumber") != null && !jsonObj.get("discountChargeNumber").isJsonNull()) && !jsonObj.get("discountChargeNumber").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `discountChargeNumber` to be a primitive type in the JSON string but got `%s`", jsonObj.get("discountChargeNumber").toString()));
}
if ((jsonObj.get("generatedReason") != null && !jsonObj.get("generatedReason").isJsonNull()) && !jsonObj.get("generatedReason").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `generatedReason` to be a primitive type in the JSON string but got `%s`", jsonObj.get("generatedReason").toString()));
}
// validate the optional field `generatedReason`
if (jsonObj.get("generatedReason") != null && !jsonObj.get("generatedReason").isJsonNull()) {
TimeSlicedNetMetricsGeneratedReason.validateJsonElement(jsonObj.get("generatedReason"));
}
if ((jsonObj.get("invoiceOwner") != null && !jsonObj.get("invoiceOwner").isJsonNull()) && !jsonObj.get("invoiceOwner").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `invoiceOwner` to be a primitive type in the JSON string but got `%s`", jsonObj.get("invoiceOwner").toString()));
}
if ((jsonObj.get("orderItemId") != null && !jsonObj.get("orderItemId").isJsonNull()) && !jsonObj.get("orderItemId").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `orderItemId` to be a primitive type in the JSON string but got `%s`", jsonObj.get("orderItemId").toString()));
}
if ((jsonObj.get("subscriptionOwner") != null && !jsonObj.get("subscriptionOwner").isJsonNull()) && !jsonObj.get("subscriptionOwner").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `subscriptionOwner` to be a primitive type in the JSON string but got `%s`", jsonObj.get("subscriptionOwner").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()) {
TimeSlicedNetMetricsType.validateJsonElement(jsonObj.get("type"));
}
}
public static class CustomTypeAdapterFactory implements TypeAdapterFactory {
@SuppressWarnings("unchecked")
@Override
public TypeAdapter create(Gson gson, TypeToken type) {
if (!TimeSlicedNetMetrics.class.isAssignableFrom(type.getRawType())) {
return null; // this class only serializes 'TimeSlicedNetMetrics' and its subtypes
}
final TypeAdapter elementAdapter = gson.getAdapter(JsonElement.class);
final TypeAdapter thisAdapter
= gson.getDelegateAdapter(this, TypeToken.get(TimeSlicedNetMetrics.class));
return (TypeAdapter) new TypeAdapter() {
@Override
public void write(JsonWriter out, TimeSlicedNetMetrics 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 TimeSlicedNetMetrics read(JsonReader in) throws IOException {
JsonElement jsonElement = elementAdapter.read(in);
validateJsonElement(jsonElement);
JsonObject jsonObj = jsonElement.getAsJsonObject();
// store additional fields in the deserialized instance
TimeSlicedNetMetrics 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 TimeSlicedNetMetrics given an JSON string
*
* @param jsonString JSON string
* @return An instance of TimeSlicedNetMetrics
* @throws IOException if the JSON string is invalid with respect to TimeSlicedNetMetrics
*/
public static TimeSlicedNetMetrics fromJson(String jsonString) throws IOException {
return JSON.getGson().fromJson(jsonString, TimeSlicedNetMetrics.class);
}
/**
* Convert an instance of TimeSlicedNetMetrics to an JSON string
*
* @return JSON string
*/
public String toJson() {
return JSON.getGson().toJson(this);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy