com.zuora.model.SubmitDataQueryRequest 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.SubmitDataQueryRequestCompression;
import com.zuora.model.SubmitDataQueryRequestOutput;
import com.zuora.model.SubmitDataQueryRequestOutputFormat;
import com.zuora.model.SubmitDataQueryRequestSourceData;
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;
/**
* SubmitDataQueryRequest
*/
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.6.0")
public class SubmitDataQueryRequest {
public static final String SERIALIZED_NAME_COLUMN_SEPARATOR = "columnSeparator";
@SerializedName(SERIALIZED_NAME_COLUMN_SEPARATOR)
private String columnSeparator;
public static final String SERIALIZED_NAME_COMPRESSION = "compression";
@SerializedName(SERIALIZED_NAME_COMPRESSION)
private SubmitDataQueryRequestCompression compression;
public static final String SERIALIZED_NAME_ENCRYPTION_KEY = "encryptionKey";
@SerializedName(SERIALIZED_NAME_ENCRYPTION_KEY)
private byte[] encryptionKey;
public static final String SERIALIZED_NAME_OUTPUT = "output";
@SerializedName(SERIALIZED_NAME_OUTPUT)
private SubmitDataQueryRequestOutput output;
public static final String SERIALIZED_NAME_OUTPUT_FORMAT = "outputFormat";
@SerializedName(SERIALIZED_NAME_OUTPUT_FORMAT)
private SubmitDataQueryRequestOutputFormat outputFormat;
public static final String SERIALIZED_NAME_QUERY = "query";
@SerializedName(SERIALIZED_NAME_QUERY)
private String query;
public static final String SERIALIZED_NAME_READ_DELETED = "readDeleted";
@SerializedName(SERIALIZED_NAME_READ_DELETED)
private Boolean readDeleted = false;
public static final String SERIALIZED_NAME_SOURCE_DATA = "sourceData";
@SerializedName(SERIALIZED_NAME_SOURCE_DATA)
private SubmitDataQueryRequestSourceData sourceData;
public static final String SERIALIZED_NAME_USE_INDEX_JOIN = "useIndexJoin";
@SerializedName(SERIALIZED_NAME_USE_INDEX_JOIN)
private Boolean useIndexJoin;
public SubmitDataQueryRequest() {
}
public SubmitDataQueryRequest columnSeparator(String columnSeparator) {
this.columnSeparator = columnSeparator;
return this;
}
/**
* The column separator. Only applicable if the `outputFormat` is `DSV`.
* @return columnSeparator
*/
@javax.annotation.Nullable
public String getColumnSeparator() {
return columnSeparator;
}
public void setColumnSeparator(String columnSeparator) {
this.columnSeparator = columnSeparator;
}
public SubmitDataQueryRequest compression(SubmitDataQueryRequestCompression compression) {
this.compression = compression;
return this;
}
/**
* Get compression
* @return compression
*/
@javax.annotation.Nonnull
public SubmitDataQueryRequestCompression getCompression() {
return compression;
}
public void setCompression(SubmitDataQueryRequestCompression compression) {
this.compression = compression;
}
public SubmitDataQueryRequest encryptionKey(byte[] encryptionKey) {
this.encryptionKey = encryptionKey;
return this;
}
/**
* Base-64 encoded public key of an RSA key-pair. Note that Data Query only supports 1024-bit RSA keys. If you set this field, Zuora encrypts the query results using the provided public key. You must use the corresponding private key to decrypt the query results.
* @return encryptionKey
*/
@javax.annotation.Nullable
public byte[] getEncryptionKey() {
return encryptionKey;
}
public void setEncryptionKey(byte[] encryptionKey) {
this.encryptionKey = encryptionKey;
}
public SubmitDataQueryRequest output(SubmitDataQueryRequestOutput output) {
this.output = output;
return this;
}
/**
* Get output
* @return output
*/
@javax.annotation.Nonnull
public SubmitDataQueryRequestOutput getOutput() {
return output;
}
public void setOutput(SubmitDataQueryRequestOutput output) {
this.output = output;
}
public SubmitDataQueryRequest outputFormat(SubmitDataQueryRequestOutputFormat outputFormat) {
this.outputFormat = outputFormat;
return this;
}
/**
* Get outputFormat
* @return outputFormat
*/
@javax.annotation.Nonnull
public SubmitDataQueryRequestOutputFormat getOutputFormat() {
return outputFormat;
}
public void setOutputFormat(SubmitDataQueryRequestOutputFormat outputFormat) {
this.outputFormat = outputFormat;
}
public SubmitDataQueryRequest query(String query) {
this.query = query;
return this;
}
/**
* The query to perform. See [SQL Queries in Data Query](https://knowledgecenter.zuora.com/DC_Developers/BA_Data_Query/BA_SQL_Queries_in_Data_Query) for more information.
* @return query
*/
@javax.annotation.Nonnull
public String getQuery() {
return query;
}
public void setQuery(String query) {
this.query = query;
}
public SubmitDataQueryRequest readDeleted(Boolean readDeleted) {
this.readDeleted = readDeleted;
return this;
}
/**
* Indicates whether the query will retrieve only the deleted record. If `readDeleted` is set to `false` or it is not included in the request body, the query will retrieve only the non-deleted records. If it is set to `true`, only the deleted records will be retrieved. If you select the `deleted` column in the `query` field, both non-deleted and deleted records will be retrieved regardless of the value in the `readDeleted` field. Note that Data Query is subject to Zuora Data Retention Policy. The retention period of deleted data is 30 days. You can only retrieve deleted data for 30 days through Data Query.
* @return readDeleted
*/
@javax.annotation.Nullable
public Boolean getReadDeleted() {
return readDeleted;
}
public void setReadDeleted(Boolean readDeleted) {
this.readDeleted = readDeleted;
}
public SubmitDataQueryRequest sourceData(SubmitDataQueryRequestSourceData sourceData) {
this.sourceData = sourceData;
return this;
}
/**
* Get sourceData
* @return sourceData
*/
@javax.annotation.Nullable
public SubmitDataQueryRequestSourceData getSourceData() {
return sourceData;
}
public void setSourceData(SubmitDataQueryRequestSourceData sourceData) {
this.sourceData = sourceData;
}
public SubmitDataQueryRequest useIndexJoin(Boolean useIndexJoin) {
this.useIndexJoin = useIndexJoin;
return this;
}
/**
* Indicates whether to use Index Join. Index join is useful when you have a specific reference value in your WHERE clause to index another large table by. See [Use Index Join](https://knowledgecenter.zuora.com/DC_Developers/BA_Data_Query/Best_practices_of_Data_Query#Use_Index_Join) for more information.
* @return useIndexJoin
*/
@javax.annotation.Nullable
public Boolean getUseIndexJoin() {
return useIndexJoin;
}
public void setUseIndexJoin(Boolean useIndexJoin) {
this.useIndexJoin = useIndexJoin;
}
/**
* 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 SubmitDataQueryRequest instance itself
*/
public SubmitDataQueryRequest 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;
}
SubmitDataQueryRequest submitDataQueryRequest = (SubmitDataQueryRequest) o;
return Objects.equals(this.columnSeparator, submitDataQueryRequest.columnSeparator) &&
Objects.equals(this.compression, submitDataQueryRequest.compression) &&
Arrays.equals(this.encryptionKey, submitDataQueryRequest.encryptionKey) &&
Objects.equals(this.output, submitDataQueryRequest.output) &&
Objects.equals(this.outputFormat, submitDataQueryRequest.outputFormat) &&
Objects.equals(this.query, submitDataQueryRequest.query) &&
Objects.equals(this.readDeleted, submitDataQueryRequest.readDeleted) &&
Objects.equals(this.sourceData, submitDataQueryRequest.sourceData) &&
Objects.equals(this.useIndexJoin, submitDataQueryRequest.useIndexJoin)&&
Objects.equals(this.additionalProperties, submitDataQueryRequest.additionalProperties);
}
@Override
public int hashCode() {
return Objects.hash(columnSeparator, compression, Arrays.hashCode(encryptionKey), output, outputFormat, query, readDeleted, sourceData, useIndexJoin, additionalProperties);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class SubmitDataQueryRequest {\n");
sb.append(" columnSeparator: ").append(toIndentedString(columnSeparator)).append("\n");
sb.append(" compression: ").append(toIndentedString(compression)).append("\n");
sb.append(" encryptionKey: ").append(toIndentedString(encryptionKey)).append("\n");
sb.append(" output: ").append(toIndentedString(output)).append("\n");
sb.append(" outputFormat: ").append(toIndentedString(outputFormat)).append("\n");
sb.append(" query: ").append(toIndentedString(query)).append("\n");
sb.append(" readDeleted: ").append(toIndentedString(readDeleted)).append("\n");
sb.append(" sourceData: ").append(toIndentedString(sourceData)).append("\n");
sb.append(" useIndexJoin: ").append(toIndentedString(useIndexJoin)).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("columnSeparator");
openapiFields.add("compression");
openapiFields.add("encryptionKey");
openapiFields.add("output");
openapiFields.add("outputFormat");
openapiFields.add("query");
openapiFields.add("readDeleted");
openapiFields.add("sourceData");
openapiFields.add("useIndexJoin");
// a set of required properties/fields (JSON key names)
openapiRequiredFields = new HashSet();
openapiRequiredFields.add("compression");
openapiRequiredFields.add("output");
openapiRequiredFields.add("outputFormat");
openapiRequiredFields.add("query");
}
/**
* 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 SubmitDataQueryRequest
*/
public static void validateJsonElement(JsonElement jsonElement) throws IOException {
if (jsonElement == null) {
if (!SubmitDataQueryRequest.openapiRequiredFields.isEmpty()) { // has required fields but JSON element is null
throw new IllegalArgumentException(String.format("The required field(s) %s in SubmitDataQueryRequest is not found in the empty JSON string", SubmitDataQueryRequest.openapiRequiredFields.toString()));
}
}
// check to make sure all required properties/fields are present in the JSON string
for (String requiredField : SubmitDataQueryRequest.openapiRequiredFields) {
if (jsonElement.getAsJsonObject().get(requiredField) == null) {
throw new IllegalArgumentException(String.format("The required field `%s` is not found in the JSON string: %s", requiredField, jsonElement.toString()));
}
}
JsonObject jsonObj = jsonElement.getAsJsonObject();
if ((jsonObj.get("columnSeparator") != null && !jsonObj.get("columnSeparator").isJsonNull()) && !jsonObj.get("columnSeparator").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `columnSeparator` to be a primitive type in the JSON string but got `%s`", jsonObj.get("columnSeparator").toString()));
}
if (!jsonObj.get("compression").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `compression` to be a primitive type in the JSON string but got `%s`", jsonObj.get("compression").toString()));
}
// validate the required field `compression`
SubmitDataQueryRequestCompression.validateJsonElement(jsonObj.get("compression"));
// validate the required field `output`
SubmitDataQueryRequestOutput.validateJsonElement(jsonObj.get("output"));
if (!jsonObj.get("outputFormat").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `outputFormat` to be a primitive type in the JSON string but got `%s`", jsonObj.get("outputFormat").toString()));
}
// validate the required field `outputFormat`
SubmitDataQueryRequestOutputFormat.validateJsonElement(jsonObj.get("outputFormat"));
if (!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("sourceData") != null && !jsonObj.get("sourceData").isJsonNull()) && !jsonObj.get("sourceData").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `sourceData` to be a primitive type in the JSON string but got `%s`", jsonObj.get("sourceData").toString()));
}
// validate the optional field `sourceData`
if (jsonObj.get("sourceData") != null && !jsonObj.get("sourceData").isJsonNull()) {
SubmitDataQueryRequestSourceData.validateJsonElement(jsonObj.get("sourceData"));
}
}
public static class CustomTypeAdapterFactory implements TypeAdapterFactory {
@SuppressWarnings("unchecked")
@Override
public TypeAdapter create(Gson gson, TypeToken type) {
if (!SubmitDataQueryRequest.class.isAssignableFrom(type.getRawType())) {
return null; // this class only serializes 'SubmitDataQueryRequest' and its subtypes
}
final TypeAdapter elementAdapter = gson.getAdapter(JsonElement.class);
final TypeAdapter thisAdapter
= gson.getDelegateAdapter(this, TypeToken.get(SubmitDataQueryRequest.class));
return (TypeAdapter) new TypeAdapter() {
@Override
public void write(JsonWriter out, SubmitDataQueryRequest 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 SubmitDataQueryRequest read(JsonReader in) throws IOException {
JsonElement jsonElement = elementAdapter.read(in);
validateJsonElement(jsonElement);
JsonObject jsonObj = jsonElement.getAsJsonObject();
// store additional fields in the deserialized instance
SubmitDataQueryRequest 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 SubmitDataQueryRequest given an JSON string
*
* @param jsonString JSON string
* @return An instance of SubmitDataQueryRequest
* @throws IOException if the JSON string is invalid with respect to SubmitDataQueryRequest
*/
public static SubmitDataQueryRequest fromJson(String jsonString) throws IOException {
return JSON.getGson().fromJson(jsonString, SubmitDataQueryRequest.class);
}
/**
* Convert an instance of SubmitDataQueryRequest to an JSON string
*
* @return JSON string
*/
public String toJson() {
return JSON.getGson().toJson(this);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy