com.zuora.model.DataQueryJob 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 java.io.IOException;
import java.time.OffsetDateTime;
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 data query job.
*/
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.6.0")
public class DataQueryJob {
public static final String SERIALIZED_NAME_CREATED_BY = "createdBy";
@SerializedName(SERIALIZED_NAME_CREATED_BY)
private String createdBy;
public static final String SERIALIZED_NAME_ID = "id";
@SerializedName(SERIALIZED_NAME_ID)
private String id;
public static final String SERIALIZED_NAME_QUERY = "query";
@SerializedName(SERIALIZED_NAME_QUERY)
private String query;
public static final String SERIALIZED_NAME_REMAINING_RETRIES = "remainingRetries";
@SerializedName(SERIALIZED_NAME_REMAINING_RETRIES)
private Integer remainingRetries;
public static final String SERIALIZED_NAME_UPDATED_ON = "updatedOn";
@SerializedName(SERIALIZED_NAME_UPDATED_ON)
private OffsetDateTime updatedOn;
public static final String SERIALIZED_NAME_DATA_FILE = "dataFile";
@SerializedName(SERIALIZED_NAME_DATA_FILE)
private String dataFile;
public static final String SERIALIZED_NAME_OUTPUT_ROWS = "outputRows";
@SerializedName(SERIALIZED_NAME_OUTPUT_ROWS)
private Integer outputRows;
public static final String SERIALIZED_NAME_PROCESSING_TIME = "processingTime";
@SerializedName(SERIALIZED_NAME_PROCESSING_TIME)
private Integer processingTime;
/**
* Status of the query job. * `submitted` - query submitted to query service for processing * `accepted` - query accepted by the query service * `in_progress` - query executed by the query service * `completed` - query execution completed by the query service * `failed` - query unable to be processed by the query service * `cancelled` - query cancelled by the user If the value of this field is `completed`, the `dataFile` field contains the location of the query results. If the value of this field is `accepted` or `in_progress`, you can use [Cancel a data query job](#operation/Delete_DataQueryJob) to prevent Zuora from performing the query. Zuora then sets the status of the query job to `cancelled`.
*/
@JsonAdapter(QueryStatusEnum.Adapter.class)
public enum QueryStatusEnum {
SUBMITTED("submitted"),
ACCEPTED("accepted"),
IN_PROGRESS("in_progress"),
COMPLETED("completed"),
FAILED("failed"),
CANCELLED("cancelled");
private String value;
QueryStatusEnum(String value) {
this.value = value;
}
public String getValue() {
return value;
}
@Override
public String toString() {
return String.valueOf(value);
}
public static QueryStatusEnum fromValue(String value) {
for (QueryStatusEnum b : QueryStatusEnum.values()) {
if (b.value.equals(value)) {
return b;
}
}
throw new IllegalArgumentException("Unexpected value '" + value + "'");
}
public static class Adapter extends TypeAdapter {
@Override
public void write(final JsonWriter jsonWriter, final QueryStatusEnum enumeration) throws IOException {
jsonWriter.value(enumeration.getValue());
}
@Override
public QueryStatusEnum read(final JsonReader jsonReader) throws IOException {
String value = jsonReader.nextString();
return QueryStatusEnum.fromValue(value);
}
}
public static void validateJsonElement(JsonElement jsonElement) throws IOException {
String value = jsonElement.getAsString();
QueryStatusEnum.fromValue(value);
}
}
public static final String SERIALIZED_NAME_QUERY_STATUS = "queryStatus";
@SerializedName(SERIALIZED_NAME_QUERY_STATUS)
private QueryStatusEnum queryStatus;
public DataQueryJob() {
}
public DataQueryJob createdBy(String createdBy) {
this.createdBy = createdBy;
return this;
}
/**
* The query job creator's Id.
* @return createdBy
*/
@javax.annotation.Nullable
public String getCreatedBy() {
return createdBy;
}
public void setCreatedBy(String createdBy) {
this.createdBy = createdBy;
}
public DataQueryJob id(String id) {
this.id = id;
return this;
}
/**
* Internal identifier of the query job.
* @return id
*/
@javax.annotation.Nullable
public String getId() {
return id;
}
public void setId(String id) {
this.id = id;
}
public DataQueryJob query(String query) {
this.query = query;
return this;
}
/**
* The query that was submitted.
* @return query
*/
@javax.annotation.Nullable
public String getQuery() {
return query;
}
public void setQuery(String query) {
this.query = query;
}
public DataQueryJob remainingRetries(Integer remainingRetries) {
this.remainingRetries = remainingRetries;
return this;
}
/**
* The number of times that Zuora will retry the query if Zuora is unable to perform the query.
* @return remainingRetries
*/
@javax.annotation.Nullable
public Integer getRemainingRetries() {
return remainingRetries;
}
public void setRemainingRetries(Integer remainingRetries) {
this.remainingRetries = remainingRetries;
}
public DataQueryJob updatedOn(OffsetDateTime updatedOn) {
this.updatedOn = updatedOn;
return this;
}
/**
* Date and time when the query job was last updated, in ISO 8601 format.
* @return updatedOn
*/
@javax.annotation.Nullable
public OffsetDateTime getUpdatedOn() {
return updatedOn;
}
public void setUpdatedOn(OffsetDateTime updatedOn) {
this.updatedOn = updatedOn;
}
public DataQueryJob dataFile(String dataFile) {
this.dataFile = dataFile;
return this;
}
/**
* The URL of the query results. Only applicable if the value of the `queryStatus` field is `completed`.
* @return dataFile
*/
@javax.annotation.Nullable
public String getDataFile() {
return dataFile;
}
public void setDataFile(String dataFile) {
this.dataFile = dataFile;
}
public DataQueryJob outputRows(Integer outputRows) {
this.outputRows = outputRows;
return this;
}
/**
* The number of rows the query results. Only applicable if the value of the `queryStatus` field is `completed`.
* @return outputRows
*/
@javax.annotation.Nullable
public Integer getOutputRows() {
return outputRows;
}
public void setOutputRows(Integer outputRows) {
this.outputRows = outputRows;
}
public DataQueryJob processingTime(Integer processingTime) {
this.processingTime = processingTime;
return this;
}
/**
* Processing time of the query job, in milliseconds. Only applicable if the value of the `queryStatus` field is `completed`.
* @return processingTime
*/
@javax.annotation.Nullable
public Integer getProcessingTime() {
return processingTime;
}
public void setProcessingTime(Integer processingTime) {
this.processingTime = processingTime;
}
public DataQueryJob queryStatus(QueryStatusEnum queryStatus) {
this.queryStatus = queryStatus;
return this;
}
/**
* Status of the query job. * `submitted` - query submitted to query service for processing * `accepted` - query accepted by the query service * `in_progress` - query executed by the query service * `completed` - query execution completed by the query service * `failed` - query unable to be processed by the query service * `cancelled` - query cancelled by the user If the value of this field is `completed`, the `dataFile` field contains the location of the query results. If the value of this field is `accepted` or `in_progress`, you can use [Cancel a data query job](#operation/Delete_DataQueryJob) to prevent Zuora from performing the query. Zuora then sets the status of the query job to `cancelled`.
* @return queryStatus
*/
@javax.annotation.Nullable
public QueryStatusEnum getQueryStatus() {
return queryStatus;
}
public void setQueryStatus(QueryStatusEnum queryStatus) {
this.queryStatus = queryStatus;
}
/**
* 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 DataQueryJob instance itself
*/
public DataQueryJob 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;
}
DataQueryJob dataQueryJob = (DataQueryJob) o;
return Objects.equals(this.createdBy, dataQueryJob.createdBy) &&
Objects.equals(this.id, dataQueryJob.id) &&
Objects.equals(this.query, dataQueryJob.query) &&
Objects.equals(this.remainingRetries, dataQueryJob.remainingRetries) &&
Objects.equals(this.updatedOn, dataQueryJob.updatedOn) &&
Objects.equals(this.dataFile, dataQueryJob.dataFile) &&
Objects.equals(this.outputRows, dataQueryJob.outputRows) &&
Objects.equals(this.processingTime, dataQueryJob.processingTime) &&
Objects.equals(this.queryStatus, dataQueryJob.queryStatus)&&
Objects.equals(this.additionalProperties, dataQueryJob.additionalProperties);
}
@Override
public int hashCode() {
return Objects.hash(createdBy, id, query, remainingRetries, updatedOn, dataFile, outputRows, processingTime, queryStatus, additionalProperties);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class DataQueryJob {\n");
sb.append(" createdBy: ").append(toIndentedString(createdBy)).append("\n");
sb.append(" id: ").append(toIndentedString(id)).append("\n");
sb.append(" query: ").append(toIndentedString(query)).append("\n");
sb.append(" remainingRetries: ").append(toIndentedString(remainingRetries)).append("\n");
sb.append(" updatedOn: ").append(toIndentedString(updatedOn)).append("\n");
sb.append(" dataFile: ").append(toIndentedString(dataFile)).append("\n");
sb.append(" outputRows: ").append(toIndentedString(outputRows)).append("\n");
sb.append(" processingTime: ").append(toIndentedString(processingTime)).append("\n");
sb.append(" queryStatus: ").append(toIndentedString(queryStatus)).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("createdBy");
openapiFields.add("id");
openapiFields.add("query");
openapiFields.add("remainingRetries");
openapiFields.add("updatedOn");
openapiFields.add("dataFile");
openapiFields.add("outputRows");
openapiFields.add("processingTime");
openapiFields.add("queryStatus");
// 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 DataQueryJob
*/
public static void validateJsonElement(JsonElement jsonElement) throws IOException {
if (jsonElement == null) {
if (!DataQueryJob.openapiRequiredFields.isEmpty()) { // has required fields but JSON element is null
throw new IllegalArgumentException(String.format("The required field(s) %s in DataQueryJob is not found in the empty JSON string", DataQueryJob.openapiRequiredFields.toString()));
}
}
JsonObject jsonObj = jsonElement.getAsJsonObject();
if ((jsonObj.get("createdBy") != null && !jsonObj.get("createdBy").isJsonNull()) && !jsonObj.get("createdBy").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `createdBy` to be a primitive type in the JSON string but got `%s`", jsonObj.get("createdBy").toString()));
}
if ((jsonObj.get("id") != null && !jsonObj.get("id").isJsonNull()) && !jsonObj.get("id").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `id` to be a primitive type in the JSON string but got `%s`", jsonObj.get("id").toString()));
}
if ((jsonObj.get("query") != null && !jsonObj.get("query").isJsonNull()) && !jsonObj.get("query").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `query` to be a primitive type in the JSON string but got `%s`", jsonObj.get("query").toString()));
}
if ((jsonObj.get("dataFile") != null && !jsonObj.get("dataFile").isJsonNull()) && !jsonObj.get("dataFile").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `dataFile` to be a primitive type in the JSON string but got `%s`", jsonObj.get("dataFile").toString()));
}
if ((jsonObj.get("queryStatus") != null && !jsonObj.get("queryStatus").isJsonNull()) && !jsonObj.get("queryStatus").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `queryStatus` to be a primitive type in the JSON string but got `%s`", jsonObj.get("queryStatus").toString()));
}
// validate the optional field `queryStatus`
if (jsonObj.get("queryStatus") != null && !jsonObj.get("queryStatus").isJsonNull()) {
QueryStatusEnum.validateJsonElement(jsonObj.get("queryStatus"));
}
}
public static class CustomTypeAdapterFactory implements TypeAdapterFactory {
@SuppressWarnings("unchecked")
@Override
public TypeAdapter create(Gson gson, TypeToken type) {
if (!DataQueryJob.class.isAssignableFrom(type.getRawType())) {
return null; // this class only serializes 'DataQueryJob' and its subtypes
}
final TypeAdapter elementAdapter = gson.getAdapter(JsonElement.class);
final TypeAdapter thisAdapter
= gson.getDelegateAdapter(this, TypeToken.get(DataQueryJob.class));
return (TypeAdapter) new TypeAdapter() {
@Override
public void write(JsonWriter out, DataQueryJob 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 DataQueryJob read(JsonReader in) throws IOException {
JsonElement jsonElement = elementAdapter.read(in);
validateJsonElement(jsonElement);
JsonObject jsonObj = jsonElement.getAsJsonObject();
// store additional fields in the deserialized instance
DataQueryJob 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 DataQueryJob given an JSON string
*
* @param jsonString JSON string
* @return An instance of DataQueryJob
* @throws IOException if the JSON string is invalid with respect to DataQueryJob
*/
public static DataQueryJob fromJson(String jsonString) throws IOException {
return JSON.getGson().fromJson(jsonString, DataQueryJob.class);
}
/**
* Convert an instance of DataQueryJob to an JSON string
*
* @return JSON string
*/
public String toJson() {
return JSON.getGson().toJson(this);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy