com.segment.publicapi.models.CreateTrackingPlanV1Input 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 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;
/**
* Creates a Tracking Plan in the Workspace.
*/
@ApiModel(description = "Creates a Tracking Plan in the Workspace.")
public class CreateTrackingPlanV1Input {
public static final String SERIALIZED_NAME_NAME = "name";
@SerializedName(SERIALIZED_NAME_NAME)
private String name;
public static final String SERIALIZED_NAME_DESCRIPTION = "description";
@SerializedName(SERIALIZED_NAME_DESCRIPTION)
private String description;
/**
* The Tracking Plan's type.
*/
@JsonAdapter(TypeEnum.Adapter.class)
public enum TypeEnum {
LIVE("LIVE"),
PROPERTY_LIBRARY("PROPERTY_LIBRARY"),
RULE_LIBRARY("RULE_LIBRARY"),
TEMPLATE("TEMPLATE");
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 CreateTrackingPlanV1Input() {
}
public CreateTrackingPlanV1Input name(String name) {
this.name = name;
return this;
}
/**
* The Tracking Plan's name. Config API note: equal to `displayName`.
* @return name
**/
@javax.annotation.Nonnull
@ApiModelProperty(required = true, value = "The Tracking Plan's name. Config API note: equal to `displayName`.")
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public CreateTrackingPlanV1Input description(String description) {
this.description = description;
return this;
}
/**
* The Tracking Plan's description.
* @return description
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "The Tracking Plan's description.")
public String getDescription() {
return description;
}
public void setDescription(String description) {
this.description = description;
}
public CreateTrackingPlanV1Input type(TypeEnum type) {
this.type = type;
return this;
}
/**
* The Tracking Plan's type.
* @return type
**/
@javax.annotation.Nonnull
@ApiModelProperty(required = true, value = "The Tracking Plan's type.")
public TypeEnum getType() {
return type;
}
public void setType(TypeEnum type) {
this.type = type;
}
@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
CreateTrackingPlanV1Input createTrackingPlanV1Input = (CreateTrackingPlanV1Input) o;
return Objects.equals(this.name, createTrackingPlanV1Input.name) &&
Objects.equals(this.description, createTrackingPlanV1Input.description) &&
Objects.equals(this.type, createTrackingPlanV1Input.type);
}
@Override
public int hashCode() {
return Objects.hash(name, description, type);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class CreateTrackingPlanV1Input {\n");
sb.append(" name: ").append(toIndentedString(name)).append("\n");
sb.append(" description: ").append(toIndentedString(description)).append("\n");
sb.append(" type: ").append(toIndentedString(type)).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("name");
openapiFields.add("description");
openapiFields.add("type");
// a set of required properties/fields (JSON key names)
openapiRequiredFields = new HashSet();
openapiRequiredFields.add("name");
openapiRequiredFields.add("type");
}
/**
* 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 CreateTrackingPlanV1Input
*/
public static void validateJsonObject(JsonObject jsonObj) throws IOException {
if (jsonObj == null) {
if (!CreateTrackingPlanV1Input.openapiRequiredFields.isEmpty()) { // has required fields but JSON object is null
throw new IllegalArgumentException(String.format("The required field(s) %s in CreateTrackingPlanV1Input is not found in the empty JSON string", CreateTrackingPlanV1Input.openapiRequiredFields.toString()));
}
}
Set> entries = jsonObj.entrySet();
// check to see if the JSON string contains additional fields
for (Entry entry : entries) {
if (!CreateTrackingPlanV1Input.openapiFields.contains(entry.getKey())) {
throw new IllegalArgumentException(String.format("The field `%s` in the JSON string is not defined in the `CreateTrackingPlanV1Input` properties. JSON: %s", entry.getKey(), jsonObj.toString()));
}
}
// check to make sure all required properties/fields are present in the JSON string
for (String requiredField : CreateTrackingPlanV1Input.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("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("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("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()));
}
}
public static class CustomTypeAdapterFactory implements TypeAdapterFactory {
@SuppressWarnings("unchecked")
@Override
public TypeAdapter create(Gson gson, TypeToken type) {
if (!CreateTrackingPlanV1Input.class.isAssignableFrom(type.getRawType())) {
return null; // this class only serializes 'CreateTrackingPlanV1Input' and its subtypes
}
final TypeAdapter elementAdapter = gson.getAdapter(JsonElement.class);
final TypeAdapter thisAdapter
= gson.getDelegateAdapter(this, TypeToken.get(CreateTrackingPlanV1Input.class));
return (TypeAdapter) new TypeAdapter() {
@Override
public void write(JsonWriter out, CreateTrackingPlanV1Input value) throws IOException {
JsonObject obj = thisAdapter.toJsonTree(value).getAsJsonObject();
elementAdapter.write(out, obj);
}
@Override
public CreateTrackingPlanV1Input read(JsonReader in) throws IOException {
JsonObject jsonObj = elementAdapter.read(in).getAsJsonObject();
validateJsonObject(jsonObj);
return thisAdapter.fromJsonTree(jsonObj);
}
}.nullSafe();
}
}
/**
* Create an instance of CreateTrackingPlanV1Input given an JSON string
*
* @param jsonString JSON string
* @return An instance of CreateTrackingPlanV1Input
* @throws IOException if the JSON string is invalid with respect to CreateTrackingPlanV1Input
*/
public static CreateTrackingPlanV1Input fromJson(String jsonString) throws IOException {
return JSON.getGson().fromJson(jsonString, CreateTrackingPlanV1Input.class);
}
/**
* Convert an instance of CreateTrackingPlanV1Input to an JSON string
*
* @return JSON string
*/
public String toJson() {
return JSON.getGson().toJson(this);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy