com.segment.publicapi.models.RuleV1 Maven / Gradle / Ivy
/*
* Segment Public API
* The Segment Public API helps you manage your Segment Workspaces and its resources. You can use the API to perform CRUD (create, read, update, delete) operations at no extra charge. This includes working with resources such as Sources, Destinations, Warehouses, Tracking Plans, and the Segment Destinations and Sources Catalogs. All CRUD endpoints in the API follow REST conventions and use standard HTTP methods. Different URL endpoints represent different resources in a Workspace. See the next sections for more information on how to use the Segment Public API.
*
* The version of the OpenAPI document: 32.0.3
* 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.segment.publicapi.models;
import java.util.Objects;
import java.util.Arrays;
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 io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import java.io.IOException;
import java.math.BigDecimal;
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 java.lang.reflect.Type;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;
import java.util.Set;
import com.segment.publicapi.JSON;
/**
* Represents a rule from a Tracking Plan.
*/
@ApiModel(description = "Represents a rule from a Tracking Plan.")
public class RuleV1 {
/**
* The type for this Tracking Plan rule.
*/
@JsonAdapter(TypeEnum.Adapter.class)
public enum TypeEnum {
COMMON("COMMON"),
GROUP("GROUP"),
IDENTIFY("IDENTIFY"),
PAGE("PAGE"),
SCREEN("SCREEN"),
TRACK("TRACK");
private String value;
TypeEnum(String value) {
this.value = value;
}
public String getValue() {
return value;
}
@Override
public String toString() {
return String.valueOf(value);
}
public static TypeEnum fromValue(String value) {
for (TypeEnum b : TypeEnum.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 TypeEnum enumeration) throws IOException {
jsonWriter.value(enumeration.getValue());
}
@Override
public TypeEnum read(final JsonReader jsonReader) throws IOException {
String value = jsonReader.nextString();
return TypeEnum.fromValue(value);
}
}
}
public static final String SERIALIZED_NAME_TYPE = "type";
@SerializedName(SERIALIZED_NAME_TYPE)
private TypeEnum type;
public static final String SERIALIZED_NAME_KEY = "key";
@SerializedName(SERIALIZED_NAME_KEY)
private String key;
public static final String SERIALIZED_NAME_JSON_SCHEMA = "jsonSchema";
@SerializedName(SERIALIZED_NAME_JSON_SCHEMA)
private Object jsonSchema = null;
public static final String SERIALIZED_NAME_VERSION = "version";
@SerializedName(SERIALIZED_NAME_VERSION)
private BigDecimal version;
public static final String SERIALIZED_NAME_CREATED_AT = "createdAt";
@SerializedName(SERIALIZED_NAME_CREATED_AT)
private String createdAt;
public static final String SERIALIZED_NAME_UPDATED_AT = "updatedAt";
@SerializedName(SERIALIZED_NAME_UPDATED_AT)
private String updatedAt;
public static final String SERIALIZED_NAME_DEPRECATED_AT = "deprecatedAt";
@SerializedName(SERIALIZED_NAME_DEPRECATED_AT)
private String deprecatedAt;
public RuleV1() {
}
public RuleV1 type(TypeEnum type) {
this.type = type;
return this;
}
/**
* The type for this Tracking Plan rule.
* @return type
**/
@javax.annotation.Nonnull
@ApiModelProperty(required = true, value = "The type for this Tracking Plan rule.")
public TypeEnum getType() {
return type;
}
public void setType(TypeEnum type) {
this.type = type;
}
public RuleV1 key(String key) {
this.key = key;
return this;
}
/**
* Key to this rule (free-form string like 'Button clicked').
* @return key
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "Key to this rule (free-form string like 'Button clicked').")
public String getKey() {
return key;
}
public void setKey(String key) {
this.key = key;
}
public RuleV1 jsonSchema(Object jsonSchema) {
this.jsonSchema = jsonSchema;
return this;
}
/**
* JSON Schema of this rule.
* @return jsonSchema
**/
@javax.annotation.Nullable
@ApiModelProperty(required = true, value = "JSON Schema of this rule.")
public Object getJsonSchema() {
return jsonSchema;
}
public void setJsonSchema(Object jsonSchema) {
this.jsonSchema = jsonSchema;
}
public RuleV1 version(BigDecimal version) {
this.version = version;
return this;
}
/**
* Version of this rule.
* @return version
**/
@javax.annotation.Nonnull
@ApiModelProperty(required = true, value = "Version of this rule.")
public BigDecimal getVersion() {
return version;
}
public void setVersion(BigDecimal version) {
this.version = version;
}
public RuleV1 createdAt(String createdAt) {
this.createdAt = createdAt;
return this;
}
/**
* The timestamp of this rule's creation.
* @return createdAt
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "The timestamp of this rule's creation.")
public String getCreatedAt() {
return createdAt;
}
public void setCreatedAt(String createdAt) {
this.createdAt = createdAt;
}
public RuleV1 updatedAt(String updatedAt) {
this.updatedAt = updatedAt;
return this;
}
/**
* The timestamp of this rule's last change.
* @return updatedAt
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "The timestamp of this rule's last change.")
public String getUpdatedAt() {
return updatedAt;
}
public void setUpdatedAt(String updatedAt) {
this.updatedAt = updatedAt;
}
public RuleV1 deprecatedAt(String deprecatedAt) {
this.deprecatedAt = deprecatedAt;
return this;
}
/**
* The timestamp of this rule's deprecation.
* @return deprecatedAt
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "The timestamp of this rule's deprecation.")
public String getDeprecatedAt() {
return deprecatedAt;
}
public void setDeprecatedAt(String deprecatedAt) {
this.deprecatedAt = deprecatedAt;
}
@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
RuleV1 ruleV1 = (RuleV1) o;
return Objects.equals(this.type, ruleV1.type) &&
Objects.equals(this.key, ruleV1.key) &&
Objects.equals(this.jsonSchema, ruleV1.jsonSchema) &&
Objects.equals(this.version, ruleV1.version) &&
Objects.equals(this.createdAt, ruleV1.createdAt) &&
Objects.equals(this.updatedAt, ruleV1.updatedAt) &&
Objects.equals(this.deprecatedAt, ruleV1.deprecatedAt);
}
@Override
public int hashCode() {
return Objects.hash(type, key, jsonSchema, version, createdAt, updatedAt, deprecatedAt);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class RuleV1 {\n");
sb.append(" type: ").append(toIndentedString(type)).append("\n");
sb.append(" key: ").append(toIndentedString(key)).append("\n");
sb.append(" jsonSchema: ").append(toIndentedString(jsonSchema)).append("\n");
sb.append(" version: ").append(toIndentedString(version)).append("\n");
sb.append(" createdAt: ").append(toIndentedString(createdAt)).append("\n");
sb.append(" updatedAt: ").append(toIndentedString(updatedAt)).append("\n");
sb.append(" deprecatedAt: ").append(toIndentedString(deprecatedAt)).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("type");
openapiFields.add("key");
openapiFields.add("jsonSchema");
openapiFields.add("version");
openapiFields.add("createdAt");
openapiFields.add("updatedAt");
openapiFields.add("deprecatedAt");
// a set of required properties/fields (JSON key names)
openapiRequiredFields = new HashSet();
openapiRequiredFields.add("type");
openapiRequiredFields.add("jsonSchema");
openapiRequiredFields.add("version");
}
/**
* Validates the JSON Object and throws an exception if issues found
*
* @param jsonObj JSON Object
* @throws IOException if the JSON Object is invalid with respect to RuleV1
*/
public static void validateJsonObject(JsonObject jsonObj) throws IOException {
if (jsonObj == null) {
if (!RuleV1.openapiRequiredFields.isEmpty()) { // has required fields but JSON object is null
throw new IllegalArgumentException(String.format("The required field(s) %s in RuleV1 is not found in the empty JSON string", RuleV1.openapiRequiredFields.toString()));
}
}
Set> entries = jsonObj.entrySet();
// check to see if the JSON string contains additional fields
for (Entry entry : entries) {
if (!RuleV1.openapiFields.contains(entry.getKey())) {
throw new IllegalArgumentException(String.format("The field `%s` in the JSON string is not defined in the `RuleV1` properties. JSON: %s", entry.getKey(), jsonObj.toString()));
}
}
// check to make sure all required properties/fields are present in the JSON string
for (String requiredField : RuleV1.openapiRequiredFields) {
if (jsonObj.get(requiredField) == null) {
throw new IllegalArgumentException(String.format("The required field `%s` is not found in the JSON string: %s", requiredField, jsonObj.toString()));
}
}
if (!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()));
}
if ((jsonObj.get("key") != null && !jsonObj.get("key").isJsonNull()) && !jsonObj.get("key").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `key` to be a primitive type in the JSON string but got `%s`", jsonObj.get("key").toString()));
}
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("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()));
}
if ((jsonObj.get("deprecatedAt") != null && !jsonObj.get("deprecatedAt").isJsonNull()) && !jsonObj.get("deprecatedAt").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `deprecatedAt` to be a primitive type in the JSON string but got `%s`", jsonObj.get("deprecatedAt").toString()));
}
}
public static class CustomTypeAdapterFactory implements TypeAdapterFactory {
@SuppressWarnings("unchecked")
@Override
public TypeAdapter create(Gson gson, TypeToken type) {
if (!RuleV1.class.isAssignableFrom(type.getRawType())) {
return null; // this class only serializes 'RuleV1' and its subtypes
}
final TypeAdapter elementAdapter = gson.getAdapter(JsonElement.class);
final TypeAdapter thisAdapter
= gson.getDelegateAdapter(this, TypeToken.get(RuleV1.class));
return (TypeAdapter) new TypeAdapter() {
@Override
public void write(JsonWriter out, RuleV1 value) throws IOException {
JsonObject obj = thisAdapter.toJsonTree(value).getAsJsonObject();
elementAdapter.write(out, obj);
}
@Override
public RuleV1 read(JsonReader in) throws IOException {
JsonObject jsonObj = elementAdapter.read(in).getAsJsonObject();
validateJsonObject(jsonObj);
return thisAdapter.fromJsonTree(jsonObj);
}
}.nullSafe();
}
}
/**
* Create an instance of RuleV1 given an JSON string
*
* @param jsonString JSON string
* @return An instance of RuleV1
* @throws IOException if the JSON string is invalid with respect to RuleV1
*/
public static RuleV1 fromJson(String jsonString) throws IOException {
return JSON.getGson().fromJson(jsonString, RuleV1.class);
}
/**
* Convert an instance of RuleV1 to an JSON string
*
* @return JSON string
*/
public String toJson() {
return JSON.getGson().toJson(this);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy