com.zuora.model.GetBatchQueryResponse 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.BatchQueryBatchType;
import com.zuora.model.BatchQueryStatus;
import com.zuora.model.DeletedRecord;
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;
/**
* GetBatchQueryResponse
*/
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.6.0")
public class GetBatchQueryResponse {
public static final String SERIALIZED_NAME_API_VERSION = "apiVersion";
@SerializedName(SERIALIZED_NAME_API_VERSION)
private String apiVersion;
public static final String SERIALIZED_NAME_BATCH_ID = "batchId";
@SerializedName(SERIALIZED_NAME_BATCH_ID)
private String batchId;
public static final String SERIALIZED_NAME_BATCH_TYPE = "batchType";
@SerializedName(SERIALIZED_NAME_BATCH_TYPE)
private BatchQueryBatchType batchType;
public static final String SERIALIZED_NAME_FILE_ID = "fileId";
@SerializedName(SERIALIZED_NAME_FILE_ID)
private String fileId;
public static final String SERIALIZED_NAME_FULL = "full";
@SerializedName(SERIALIZED_NAME_FULL)
private Boolean full;
public static final String SERIALIZED_NAME_MESSAGE = "message";
@SerializedName(SERIALIZED_NAME_MESSAGE)
private String message;
public static final String SERIALIZED_NAME_NAME = "name";
@SerializedName(SERIALIZED_NAME_NAME)
private String name;
public static final String SERIALIZED_NAME_QUERY = "query";
@SerializedName(SERIALIZED_NAME_QUERY)
private String query;
public static final String SERIALIZED_NAME_RECORD_COUNT = "recordCount";
@SerializedName(SERIALIZED_NAME_RECORD_COUNT)
private String recordCount;
public static final String SERIALIZED_NAME_SEGMENTS = "segments";
@SerializedName(SERIALIZED_NAME_SEGMENTS)
private List segments;
public static final String SERIALIZED_NAME_STATUS = "status";
@SerializedName(SERIALIZED_NAME_STATUS)
private BatchQueryStatus status;
public static final String SERIALIZED_NAME_LOCALIZED_STATUS = "localizedStatus";
@SerializedName(SERIALIZED_NAME_LOCALIZED_STATUS)
private BatchQueryStatus localizedStatus;
public static final String SERIALIZED_NAME_DELETED = "deleted";
@SerializedName(SERIALIZED_NAME_DELETED)
private DeletedRecord deleted;
public GetBatchQueryResponse() {
}
public GetBatchQueryResponse apiVersion(String apiVersion) {
this.apiVersion = apiVersion;
return this;
}
/**
* The API version for the query. If an API version is not specified, the latest version is used by default. Using the latest WSDL version is most useful for reporting use cases. For integration purposes, specify the WSDL version to ensure consistent query behavior, that is, what is supported and included in the response returned by the API. **Note**: As of API version 69 and later, Zuora changed the format of certain fields. See <a href=\"https://knowledgecenter.zuora.com/Zuora_Central_Platform/API/G_SOAP_API/AB_Getting_started_with_the__SOAP_API/C_Date_Field_Changes_in_the_SOAP_API\" target=\"_blank\">Date Field Changes in the SOAP API</a> for more information and a list of affected fields.
* @return apiVersion
*/
@javax.annotation.Nullable
public String getApiVersion() {
return apiVersion;
}
public void setApiVersion(String apiVersion) {
this.apiVersion = apiVersion;
}
public GetBatchQueryResponse batchId(String batchId) {
this.batchId = batchId;
return this;
}
/**
* A 32-character ID of the query batch.
* @return batchId
*/
@javax.annotation.Nullable
public String getBatchId() {
return batchId;
}
public void setBatchId(String batchId) {
this.batchId = batchId;
}
public GetBatchQueryResponse batchType(BatchQueryBatchType batchType) {
this.batchType = batchType;
return this;
}
/**
* Get batchType
* @return batchType
*/
@javax.annotation.Nullable
public BatchQueryBatchType getBatchType() {
return batchType;
}
public void setBatchType(BatchQueryBatchType batchType) {
this.batchType = batchType;
}
public GetBatchQueryResponse fileId(String fileId) {
this.fileId = fileId;
return this;
}
/**
* The ID of the query results file. Use Get Results Files to download the query results file. The query results file is formatted as requested in the batch job. Supported formats are CSV, GZIP, and ZIP.
* @return fileId
*/
@javax.annotation.Nullable
public String getFileId() {
return fileId;
}
public void setFileId(String fileId) {
this.fileId = fileId;
}
public GetBatchQueryResponse full(Boolean full) {
this.full = full;
return this;
}
/**
* This field indicates a full or incremental load. `True` = Full and `False` = Incremental.
* @return full
*/
@javax.annotation.Nullable
public Boolean getFull() {
return full;
}
public void setFull(Boolean full) {
this.full = full;
}
public GetBatchQueryResponse message(String message) {
this.message = message;
return this;
}
/**
* The error message.
* @return message
*/
@javax.annotation.Nullable
public String getMessage() {
return message;
}
public void setMessage(String message) {
this.message = message;
}
public GetBatchQueryResponse name(String name) {
this.name = name;
return this;
}
/**
* Name of the query supplied in the request.
* @return name
*/
@javax.annotation.Nullable
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public GetBatchQueryResponse query(String query) {
this.query = query;
return this;
}
/**
* The requested query string.
* @return query
*/
@javax.annotation.Nullable
public String getQuery() {
return query;
}
public void setQuery(String query) {
this.query = query;
}
public GetBatchQueryResponse recordCount(String recordCount) {
this.recordCount = recordCount;
return this;
}
/**
* The number of records included in the query output file.
* @return recordCount
*/
@javax.annotation.Nullable
public String getRecordCount() {
return recordCount;
}
public void setRecordCount(String recordCount) {
this.recordCount = recordCount;
}
public GetBatchQueryResponse segments(List segments) {
this.segments = segments;
return this;
}
public GetBatchQueryResponse addSegmentsItem(String segmentsItem) {
if (this.segments == null) {
this.segments = new ArrayList<>();
}
this.segments.add(segmentsItem);
return this;
}
/**
* Array of IDs of query results files. Replaces fileId for full data loads in stateful mode if <a href = \"https://knowledgecenter.zuora.com/Zuora_Central_Platform/API/AB_Aggregate_Query_API/G_File_Segmentation\" target=\"_blank\">File Segmentation</a> is enabled. Use Get Results Files to download each query results file. Each query results file contains at most 500,000 records and is formatted as requested in the batch job. Supported formats are CSV, GZIP, and ZIP.
* @return segments
*/
@javax.annotation.Nullable
public List getSegments() {
return segments;
}
public void setSegments(List segments) {
this.segments = segments;
}
public GetBatchQueryResponse status(BatchQueryStatus status) {
this.status = status;
return this;
}
/**
* Get status
* @return status
*/
@javax.annotation.Nullable
public BatchQueryStatus getStatus() {
return status;
}
public void setStatus(BatchQueryStatus status) {
this.status = status;
}
public GetBatchQueryResponse localizedStatus(BatchQueryStatus localizedStatus) {
this.localizedStatus = localizedStatus;
return this;
}
/**
* Get localizedStatus
* @return localizedStatus
*/
@javax.annotation.Nullable
public BatchQueryStatus getLocalizedStatus() {
return localizedStatus;
}
public void setLocalizedStatus(BatchQueryStatus localizedStatus) {
this.localizedStatus = localizedStatus;
}
public GetBatchQueryResponse deleted(DeletedRecord deleted) {
this.deleted = deleted;
return this;
}
/**
* Get deleted
* @return deleted
*/
@javax.annotation.Nullable
public DeletedRecord getDeleted() {
return deleted;
}
public void setDeleted(DeletedRecord deleted) {
this.deleted = deleted;
}
/**
* 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 GetBatchQueryResponse instance itself
*/
public GetBatchQueryResponse 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;
}
GetBatchQueryResponse getBatchQueryResponse = (GetBatchQueryResponse) o;
return Objects.equals(this.apiVersion, getBatchQueryResponse.apiVersion) &&
Objects.equals(this.batchId, getBatchQueryResponse.batchId) &&
Objects.equals(this.batchType, getBatchQueryResponse.batchType) &&
Objects.equals(this.fileId, getBatchQueryResponse.fileId) &&
Objects.equals(this.full, getBatchQueryResponse.full) &&
Objects.equals(this.message, getBatchQueryResponse.message) &&
Objects.equals(this.name, getBatchQueryResponse.name) &&
Objects.equals(this.query, getBatchQueryResponse.query) &&
Objects.equals(this.recordCount, getBatchQueryResponse.recordCount) &&
Objects.equals(this.segments, getBatchQueryResponse.segments) &&
Objects.equals(this.status, getBatchQueryResponse.status) &&
Objects.equals(this.localizedStatus, getBatchQueryResponse.localizedStatus) &&
Objects.equals(this.deleted, getBatchQueryResponse.deleted)&&
Objects.equals(this.additionalProperties, getBatchQueryResponse.additionalProperties);
}
@Override
public int hashCode() {
return Objects.hash(apiVersion, batchId, batchType, fileId, full, message, name, query, recordCount, segments, status, localizedStatus, deleted, additionalProperties);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class GetBatchQueryResponse {\n");
sb.append(" apiVersion: ").append(toIndentedString(apiVersion)).append("\n");
sb.append(" batchId: ").append(toIndentedString(batchId)).append("\n");
sb.append(" batchType: ").append(toIndentedString(batchType)).append("\n");
sb.append(" fileId: ").append(toIndentedString(fileId)).append("\n");
sb.append(" full: ").append(toIndentedString(full)).append("\n");
sb.append(" message: ").append(toIndentedString(message)).append("\n");
sb.append(" name: ").append(toIndentedString(name)).append("\n");
sb.append(" query: ").append(toIndentedString(query)).append("\n");
sb.append(" recordCount: ").append(toIndentedString(recordCount)).append("\n");
sb.append(" segments: ").append(toIndentedString(segments)).append("\n");
sb.append(" status: ").append(toIndentedString(status)).append("\n");
sb.append(" localizedStatus: ").append(toIndentedString(localizedStatus)).append("\n");
sb.append(" deleted: ").append(toIndentedString(deleted)).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("apiVersion");
openapiFields.add("batchId");
openapiFields.add("batchType");
openapiFields.add("fileId");
openapiFields.add("full");
openapiFields.add("message");
openapiFields.add("name");
openapiFields.add("query");
openapiFields.add("recordCount");
openapiFields.add("segments");
openapiFields.add("status");
openapiFields.add("localizedStatus");
openapiFields.add("deleted");
// 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 GetBatchQueryResponse
*/
public static void validateJsonElement(JsonElement jsonElement) throws IOException {
if (jsonElement == null) {
if (!GetBatchQueryResponse.openapiRequiredFields.isEmpty()) { // has required fields but JSON element is null
throw new IllegalArgumentException(String.format("The required field(s) %s in GetBatchQueryResponse is not found in the empty JSON string", GetBatchQueryResponse.openapiRequiredFields.toString()));
}
}
JsonObject jsonObj = jsonElement.getAsJsonObject();
if ((jsonObj.get("apiVersion") != null && !jsonObj.get("apiVersion").isJsonNull()) && !jsonObj.get("apiVersion").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `apiVersion` to be a primitive type in the JSON string but got `%s`", jsonObj.get("apiVersion").toString()));
}
if ((jsonObj.get("batchId") != null && !jsonObj.get("batchId").isJsonNull()) && !jsonObj.get("batchId").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `batchId` to be a primitive type in the JSON string but got `%s`", jsonObj.get("batchId").toString()));
}
if ((jsonObj.get("batchType") != null && !jsonObj.get("batchType").isJsonNull()) && !jsonObj.get("batchType").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `batchType` to be a primitive type in the JSON string but got `%s`", jsonObj.get("batchType").toString()));
}
// validate the optional field `batchType`
if (jsonObj.get("batchType") != null && !jsonObj.get("batchType").isJsonNull()) {
BatchQueryBatchType.validateJsonElement(jsonObj.get("batchType"));
}
if ((jsonObj.get("fileId") != null && !jsonObj.get("fileId").isJsonNull()) && !jsonObj.get("fileId").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `fileId` to be a primitive type in the JSON string but got `%s`", jsonObj.get("fileId").toString()));
}
if ((jsonObj.get("message") != null && !jsonObj.get("message").isJsonNull()) && !jsonObj.get("message").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `message` to be a primitive type in the JSON string but got `%s`", jsonObj.get("message").toString()));
}
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("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("recordCount") != null && !jsonObj.get("recordCount").isJsonNull()) && !jsonObj.get("recordCount").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `recordCount` to be a primitive type in the JSON string but got `%s`", jsonObj.get("recordCount").toString()));
}
// ensure the optional json data is an array if present
if (jsonObj.get("segments") != null && !jsonObj.get("segments").isJsonNull() && !jsonObj.get("segments").isJsonArray()) {
throw new IllegalArgumentException(String.format("Expected the field `segments` to be an array in the JSON string but got `%s`", jsonObj.get("segments").toString()));
}
if ((jsonObj.get("status") != null && !jsonObj.get("status").isJsonNull()) && !jsonObj.get("status").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `status` to be a primitive type in the JSON string but got `%s`", jsonObj.get("status").toString()));
}
// validate the optional field `status`
if (jsonObj.get("status") != null && !jsonObj.get("status").isJsonNull()) {
BatchQueryStatus.validateJsonElement(jsonObj.get("status"));
}
if ((jsonObj.get("localizedStatus") != null && !jsonObj.get("localizedStatus").isJsonNull()) && !jsonObj.get("localizedStatus").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `localizedStatus` to be a primitive type in the JSON string but got `%s`", jsonObj.get("localizedStatus").toString()));
}
// validate the optional field `localizedStatus`
if (jsonObj.get("localizedStatus") != null && !jsonObj.get("localizedStatus").isJsonNull()) {
BatchQueryStatus.validateJsonElement(jsonObj.get("localizedStatus"));
}
// validate the optional field `deleted`
if (jsonObj.get("deleted") != null && !jsonObj.get("deleted").isJsonNull()) {
DeletedRecord.validateJsonElement(jsonObj.get("deleted"));
}
}
public static class CustomTypeAdapterFactory implements TypeAdapterFactory {
@SuppressWarnings("unchecked")
@Override
public TypeAdapter create(Gson gson, TypeToken type) {
if (!GetBatchQueryResponse.class.isAssignableFrom(type.getRawType())) {
return null; // this class only serializes 'GetBatchQueryResponse' and its subtypes
}
final TypeAdapter elementAdapter = gson.getAdapter(JsonElement.class);
final TypeAdapter thisAdapter
= gson.getDelegateAdapter(this, TypeToken.get(GetBatchQueryResponse.class));
return (TypeAdapter) new TypeAdapter() {
@Override
public void write(JsonWriter out, GetBatchQueryResponse 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 GetBatchQueryResponse read(JsonReader in) throws IOException {
JsonElement jsonElement = elementAdapter.read(in);
validateJsonElement(jsonElement);
JsonObject jsonObj = jsonElement.getAsJsonObject();
// store additional fields in the deserialized instance
GetBatchQueryResponse 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 GetBatchQueryResponse given an JSON string
*
* @param jsonString JSON string
* @return An instance of GetBatchQueryResponse
* @throws IOException if the JSON string is invalid with respect to GetBatchQueryResponse
*/
public static GetBatchQueryResponse fromJson(String jsonString) throws IOException {
return JSON.getGson().fromJson(jsonString, GetBatchQueryResponse.class);
}
/**
* Convert an instance of GetBatchQueryResponse to an JSON string
*
* @return JSON string
*/
public String toJson() {
return JSON.getGson().toJson(this);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy