All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.zuora.model.WorkflowDefinitionAndVersions Maven / Gradle / Ivy

There is a newer version: 3.2.1
Show newest version
/*
 * 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.Workflow;
import com.zuora.model.WorkflowDefinitionActiveVersion;
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;

/**
 * A workflow. 
 */
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.6.0")
public class WorkflowDefinitionAndVersions {
  public static final String SERIALIZED_NAME_ACTIVE_VERSION = "active_version";
  @SerializedName(SERIALIZED_NAME_ACTIVE_VERSION)
  private WorkflowDefinitionActiveVersion activeVersion;

  public static final String SERIALIZED_NAME_CALLOUT_TRIGGER = "calloutTrigger";
  @SerializedName(SERIALIZED_NAME_CALLOUT_TRIGGER)
  private Boolean calloutTrigger;

  public static final String SERIALIZED_NAME_CREATED_AT = "createdAt";
  @SerializedName(SERIALIZED_NAME_CREATED_AT)
  private String createdAt;

  public static final String SERIALIZED_NAME_DESCRIPTION = "description";
  @SerializedName(SERIALIZED_NAME_DESCRIPTION)
  private String description;

  public static final String SERIALIZED_NAME_ID = "id";
  @SerializedName(SERIALIZED_NAME_ID)
  private Integer id;

  public static final String SERIALIZED_NAME_INTERVAL = "interval";
  @SerializedName(SERIALIZED_NAME_INTERVAL)
  private String interval;

  public static final String SERIALIZED_NAME_LATEST_INACTIVE_VERISONS = "latest_inactive_verisons";
  @SerializedName(SERIALIZED_NAME_LATEST_INACTIVE_VERISONS)
  private List latestInactiveVerisons;

  public static final String SERIALIZED_NAME_NAME = "name";
  @SerializedName(SERIALIZED_NAME_NAME)
  private String name;

  public static final String SERIALIZED_NAME_ONDEMAND_TRIGGER = "ondemandTrigger";
  @SerializedName(SERIALIZED_NAME_ONDEMAND_TRIGGER)
  private Boolean ondemandTrigger;

  public static final String SERIALIZED_NAME_SCHEDULED_TRIGGER = "scheduledTrigger";
  @SerializedName(SERIALIZED_NAME_SCHEDULED_TRIGGER)
  private Boolean scheduledTrigger;

  public static final String SERIALIZED_NAME_STATUS = "status";
  @SerializedName(SERIALIZED_NAME_STATUS)
  private String status;

  public static final String SERIALIZED_NAME_TIMEZONE = "timezone";
  @SerializedName(SERIALIZED_NAME_TIMEZONE)
  private String timezone;

  public static final String SERIALIZED_NAME_UPDATED_AT = "updatedAt";
  @SerializedName(SERIALIZED_NAME_UPDATED_AT)
  private String updatedAt;

  public WorkflowDefinitionAndVersions() {
  }

  public WorkflowDefinitionAndVersions activeVersion(WorkflowDefinitionActiveVersion activeVersion) {
    this.activeVersion = activeVersion;
    return this;
  }

  /**
   * Get activeVersion
   * @return activeVersion
   */
  @javax.annotation.Nullable
  public WorkflowDefinitionActiveVersion getActiveVersion() {
    return activeVersion;
  }

  public void setActiveVersion(WorkflowDefinitionActiveVersion activeVersion) {
    this.activeVersion = activeVersion;
  }


  public WorkflowDefinitionAndVersions calloutTrigger(Boolean calloutTrigger) {
    this.calloutTrigger = calloutTrigger;
    return this;
  }

  /**
   * Indicates whether the callout trigger is enabled for the retrieved workflow. 
   * @return calloutTrigger
   */
  @javax.annotation.Nullable
  public Boolean getCalloutTrigger() {
    return calloutTrigger;
  }

  public void setCalloutTrigger(Boolean calloutTrigger) {
    this.calloutTrigger = calloutTrigger;
  }


  public WorkflowDefinitionAndVersions createdAt(String createdAt) {
    this.createdAt = createdAt;
    return this;
  }

  /**
   * The date and time when the workflow is created, in the `YYYY-MM-DD HH:MM:SS` format. 
   * @return createdAt
   */
  @javax.annotation.Nullable
  public String getCreatedAt() {
    return createdAt;
  }

  public void setCreatedAt(String createdAt) {
    this.createdAt = createdAt;
  }


  public WorkflowDefinitionAndVersions description(String description) {
    this.description = description;
    return this;
  }

  /**
   * The description of the workflow definition. 
   * @return description
   */
  @javax.annotation.Nullable
  public String getDescription() {
    return description;
  }

  public void setDescription(String description) {
    this.description = description;
  }


  public WorkflowDefinitionAndVersions id(Integer id) {
    this.id = id;
    return this;
  }

  /**
   * The unique ID of the workflow definition. 
   * @return id
   */
  @javax.annotation.Nullable
  public Integer getId() {
    return id;
  }

  public void setId(Integer id) {
    this.id = id;
  }


  public WorkflowDefinitionAndVersions interval(String interval) {
    this.interval = interval;
    return this;
  }

  /**
   * The schedule of the workflow, in a CRON expression. Returns null if the schedued trigger is disabled. 
   * @return interval
   */
  @javax.annotation.Nullable
  public String getInterval() {
    return interval;
  }

  public void setInterval(String interval) {
    this.interval = interval;
  }


  public WorkflowDefinitionAndVersions latestInactiveVerisons(List latestInactiveVerisons) {
    this.latestInactiveVerisons = latestInactiveVerisons;
    return this;
  }

  public WorkflowDefinitionAndVersions addLatestInactiveVerisonsItem(Workflow latestInactiveVerisonsItem) {
    if (this.latestInactiveVerisons == null) {
      this.latestInactiveVerisons = new ArrayList<>();
    }
    this.latestInactiveVerisons.add(latestInactiveVerisonsItem);
    return this;
  }

  /**
   * The list of inactive workflow versions retrieved. Maximum number of versions retrieved is 10.   
   * @return latestInactiveVerisons
   */
  @javax.annotation.Nullable
  public List getLatestInactiveVerisons() {
    return latestInactiveVerisons;
  }

  public void setLatestInactiveVerisons(List latestInactiveVerisons) {
    this.latestInactiveVerisons = latestInactiveVerisons;
  }


  public WorkflowDefinitionAndVersions name(String name) {
    this.name = name;
    return this;
  }

  /**
   * The name of the workflow definition. 
   * @return name
   */
  @javax.annotation.Nullable
  public String getName() {
    return name;
  }

  public void setName(String name) {
    this.name = name;
  }


  public WorkflowDefinitionAndVersions ondemandTrigger(Boolean ondemandTrigger) {
    this.ondemandTrigger = ondemandTrigger;
    return this;
  }

  /**
   * Indicates whether the ondemand trigger is enabled for the workflow. 
   * @return ondemandTrigger
   */
  @javax.annotation.Nullable
  public Boolean getOndemandTrigger() {
    return ondemandTrigger;
  }

  public void setOndemandTrigger(Boolean ondemandTrigger) {
    this.ondemandTrigger = ondemandTrigger;
  }


  public WorkflowDefinitionAndVersions scheduledTrigger(Boolean scheduledTrigger) {
    this.scheduledTrigger = scheduledTrigger;
    return this;
  }

  /**
   * Indicates whether the scheduled trigger is enabled for the workflow. 
   * @return scheduledTrigger
   */
  @javax.annotation.Nullable
  public Boolean getScheduledTrigger() {
    return scheduledTrigger;
  }

  public void setScheduledTrigger(Boolean scheduledTrigger) {
    this.scheduledTrigger = scheduledTrigger;
  }


  public WorkflowDefinitionAndVersions status(String status) {
    this.status = status;
    return this;
  }

  /**
   * The status of the workflow definition. 
   * @return status
   */
  @javax.annotation.Nullable
  public String getStatus() {
    return status;
  }

  public void setStatus(String status) {
    this.status = status;
  }


  public WorkflowDefinitionAndVersions timezone(String timezone) {
    this.timezone = timezone;
    return this;
  }

  /**
   * The timezone that is configured for the scheduler of the workflow. Returns null if the scheduled trigger is disabled. 
   * @return timezone
   */
  @javax.annotation.Nullable
  public String getTimezone() {
    return timezone;
  }

  public void setTimezone(String timezone) {
    this.timezone = timezone;
  }


  public WorkflowDefinitionAndVersions updatedAt(String updatedAt) {
    this.updatedAt = updatedAt;
    return this;
  }

  /**
   * The date and time when the workflow is updated the last time, in the `YYYY-MM-DD HH:MM:SS` format. 
   * @return updatedAt
   */
  @javax.annotation.Nullable
  public String getUpdatedAt() {
    return updatedAt;
  }

  public void setUpdatedAt(String updatedAt) {
    this.updatedAt = updatedAt;
  }

  /**
   * 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 WorkflowDefinitionAndVersions instance itself
   */
  public WorkflowDefinitionAndVersions 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;
    }
    WorkflowDefinitionAndVersions workflowDefinitionAndVersions = (WorkflowDefinitionAndVersions) o;
    return Objects.equals(this.activeVersion, workflowDefinitionAndVersions.activeVersion) &&
        Objects.equals(this.calloutTrigger, workflowDefinitionAndVersions.calloutTrigger) &&
        Objects.equals(this.createdAt, workflowDefinitionAndVersions.createdAt) &&
        Objects.equals(this.description, workflowDefinitionAndVersions.description) &&
        Objects.equals(this.id, workflowDefinitionAndVersions.id) &&
        Objects.equals(this.interval, workflowDefinitionAndVersions.interval) &&
        Objects.equals(this.latestInactiveVerisons, workflowDefinitionAndVersions.latestInactiveVerisons) &&
        Objects.equals(this.name, workflowDefinitionAndVersions.name) &&
        Objects.equals(this.ondemandTrigger, workflowDefinitionAndVersions.ondemandTrigger) &&
        Objects.equals(this.scheduledTrigger, workflowDefinitionAndVersions.scheduledTrigger) &&
        Objects.equals(this.status, workflowDefinitionAndVersions.status) &&
        Objects.equals(this.timezone, workflowDefinitionAndVersions.timezone) &&
        Objects.equals(this.updatedAt, workflowDefinitionAndVersions.updatedAt)&&
        Objects.equals(this.additionalProperties, workflowDefinitionAndVersions.additionalProperties);
  }

  @Override
  public int hashCode() {
    return Objects.hash(activeVersion, calloutTrigger, createdAt, description, id, interval, latestInactiveVerisons, name, ondemandTrigger, scheduledTrigger, status, timezone, updatedAt, additionalProperties);
  }

  @Override
  public String toString() {
    StringBuilder sb = new StringBuilder();
    sb.append("class WorkflowDefinitionAndVersions {\n");
    sb.append("    activeVersion: ").append(toIndentedString(activeVersion)).append("\n");
    sb.append("    calloutTrigger: ").append(toIndentedString(calloutTrigger)).append("\n");
    sb.append("    createdAt: ").append(toIndentedString(createdAt)).append("\n");
    sb.append("    description: ").append(toIndentedString(description)).append("\n");
    sb.append("    id: ").append(toIndentedString(id)).append("\n");
    sb.append("    interval: ").append(toIndentedString(interval)).append("\n");
    sb.append("    latestInactiveVerisons: ").append(toIndentedString(latestInactiveVerisons)).append("\n");
    sb.append("    name: ").append(toIndentedString(name)).append("\n");
    sb.append("    ondemandTrigger: ").append(toIndentedString(ondemandTrigger)).append("\n");
    sb.append("    scheduledTrigger: ").append(toIndentedString(scheduledTrigger)).append("\n");
    sb.append("    status: ").append(toIndentedString(status)).append("\n");
    sb.append("    timezone: ").append(toIndentedString(timezone)).append("\n");
    sb.append("    updatedAt: ").append(toIndentedString(updatedAt)).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("active_version");
    openapiFields.add("calloutTrigger");
    openapiFields.add("createdAt");
    openapiFields.add("description");
    openapiFields.add("id");
    openapiFields.add("interval");
    openapiFields.add("latest_inactive_verisons");
    openapiFields.add("name");
    openapiFields.add("ondemandTrigger");
    openapiFields.add("scheduledTrigger");
    openapiFields.add("status");
    openapiFields.add("timezone");
    openapiFields.add("updatedAt");

    // 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 WorkflowDefinitionAndVersions
   */
  public static void validateJsonElement(JsonElement jsonElement) throws IOException {
      if (jsonElement == null) {
        if (!WorkflowDefinitionAndVersions.openapiRequiredFields.isEmpty()) { // has required fields but JSON element is null
          throw new IllegalArgumentException(String.format("The required field(s) %s in WorkflowDefinitionAndVersions is not found in the empty JSON string", WorkflowDefinitionAndVersions.openapiRequiredFields.toString()));
        }
      }
        JsonObject jsonObj = jsonElement.getAsJsonObject();
      // validate the optional field `active_version`
      if (jsonObj.get("active_version") != null && !jsonObj.get("active_version").isJsonNull()) {
        WorkflowDefinitionActiveVersion.validateJsonElement(jsonObj.get("active_version"));
      }
      if ((jsonObj.get("createdAt") != null && !jsonObj.get("createdAt").isJsonNull()) && !jsonObj.get("createdAt").isJsonPrimitive()) {
        throw new IllegalArgumentException(String.format("Expected the field `createdAt` to be a primitive type in the JSON string but got `%s`", jsonObj.get("createdAt").toString()));
      }
      if ((jsonObj.get("description") != null && !jsonObj.get("description").isJsonNull()) && !jsonObj.get("description").isJsonPrimitive()) {
        throw new IllegalArgumentException(String.format("Expected the field `description` to be a primitive type in the JSON string but got `%s`", jsonObj.get("description").toString()));
      }
      if ((jsonObj.get("interval") != null && !jsonObj.get("interval").isJsonNull()) && !jsonObj.get("interval").isJsonPrimitive()) {
        throw new IllegalArgumentException(String.format("Expected the field `interval` to be a primitive type in the JSON string but got `%s`", jsonObj.get("interval").toString()));
      }
      if (jsonObj.get("latest_inactive_verisons") != null && !jsonObj.get("latest_inactive_verisons").isJsonNull()) {
        JsonArray jsonArraylatestInactiveVerisons = jsonObj.getAsJsonArray("latest_inactive_verisons");
        if (jsonArraylatestInactiveVerisons != null) {
          // ensure the json data is an array
          if (!jsonObj.get("latest_inactive_verisons").isJsonArray()) {
            throw new IllegalArgumentException(String.format("Expected the field `latest_inactive_verisons` to be an array in the JSON string but got `%s`", jsonObj.get("latest_inactive_verisons").toString()));
          }

          // validate the optional field `latest_inactive_verisons` (array)
          for (int i = 0; i < jsonArraylatestInactiveVerisons.size(); i++) {
            Workflow.validateJsonElement(jsonArraylatestInactiveVerisons.get(i));
          };
        }
      }
      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("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()));
      }
      if ((jsonObj.get("timezone") != null && !jsonObj.get("timezone").isJsonNull()) && !jsonObj.get("timezone").isJsonPrimitive()) {
        throw new IllegalArgumentException(String.format("Expected the field `timezone` to be a primitive type in the JSON string but got `%s`", jsonObj.get("timezone").toString()));
      }
      if ((jsonObj.get("updatedAt") != null && !jsonObj.get("updatedAt").isJsonNull()) && !jsonObj.get("updatedAt").isJsonPrimitive()) {
        throw new IllegalArgumentException(String.format("Expected the field `updatedAt` to be a primitive type in the JSON string but got `%s`", jsonObj.get("updatedAt").toString()));
      }
  }

  public static class CustomTypeAdapterFactory implements TypeAdapterFactory {
    @SuppressWarnings("unchecked")
    @Override
    public  TypeAdapter create(Gson gson, TypeToken type) {
       if (!WorkflowDefinitionAndVersions.class.isAssignableFrom(type.getRawType())) {
         return null; // this class only serializes 'WorkflowDefinitionAndVersions' and its subtypes
       }
       final TypeAdapter elementAdapter = gson.getAdapter(JsonElement.class);
       final TypeAdapter thisAdapter
                        = gson.getDelegateAdapter(this, TypeToken.get(WorkflowDefinitionAndVersions.class));

       return (TypeAdapter) new TypeAdapter() {
           @Override
           public void write(JsonWriter out, WorkflowDefinitionAndVersions 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 WorkflowDefinitionAndVersions read(JsonReader in) throws IOException {
             JsonElement jsonElement = elementAdapter.read(in);
             validateJsonElement(jsonElement);
             JsonObject jsonObj = jsonElement.getAsJsonObject();
             // store additional fields in the deserialized instance
             WorkflowDefinitionAndVersions 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 WorkflowDefinitionAndVersions given an JSON string
   *
   * @param jsonString JSON string
   * @return An instance of WorkflowDefinitionAndVersions
   * @throws IOException if the JSON string is invalid with respect to WorkflowDefinitionAndVersions
   */
  public static WorkflowDefinitionAndVersions fromJson(String jsonString) throws IOException {
    return JSON.getGson().fromJson(jsonString, WorkflowDefinitionAndVersions.class);
  }

  /**
   * Convert an instance of WorkflowDefinitionAndVersions to an JSON string
   *
   * @return JSON string
   */
  public String toJson() {
    return JSON.getGson().toJson(this);
  }
}





© 2015 - 2025 Weber Informatics LLC | Privacy Policy