com.segment.publicapi.models.DestinationSubscription 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.util.Map;
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;
/**
* The Destination subscription.
*/
@ApiModel(description = "The Destination subscription.")
public class DestinationSubscription {
public static final String SERIALIZED_NAME_ID = "id";
@SerializedName(SERIALIZED_NAME_ID)
private String id;
public static final String SERIALIZED_NAME_NAME = "name";
@SerializedName(SERIALIZED_NAME_NAME)
private String name;
public static final String SERIALIZED_NAME_ACTION_ID = "actionId";
@SerializedName(SERIALIZED_NAME_ACTION_ID)
private String actionId;
public static final String SERIALIZED_NAME_ACTION_SLUG = "actionSlug";
@SerializedName(SERIALIZED_NAME_ACTION_SLUG)
private String actionSlug;
public static final String SERIALIZED_NAME_DESTINATION_ID = "destinationId";
@SerializedName(SERIALIZED_NAME_DESTINATION_ID)
private String destinationId;
public static final String SERIALIZED_NAME_ENABLED = "enabled";
@SerializedName(SERIALIZED_NAME_ENABLED)
private Boolean enabled;
public static final String SERIALIZED_NAME_SETTINGS = "settings";
@SerializedName(SERIALIZED_NAME_SETTINGS)
private Map settings;
public static final String SERIALIZED_NAME_TRIGGER = "trigger";
@SerializedName(SERIALIZED_NAME_TRIGGER)
private String trigger;
public DestinationSubscription() {
}
public DestinationSubscription id(String id) {
this.id = id;
return this;
}
/**
* The unique identifier for the subscription.
* @return id
**/
@javax.annotation.Nonnull
@ApiModelProperty(required = true, value = "The unique identifier for the subscription.")
public String getId() {
return id;
}
public void setId(String id) {
this.id = id;
}
public DestinationSubscription name(String name) {
this.name = name;
return this;
}
/**
* The name of the subscription.
* @return name
**/
@javax.annotation.Nonnull
@ApiModelProperty(required = true, value = "The name of the subscription.")
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public DestinationSubscription actionId(String actionId) {
this.actionId = actionId;
return this;
}
/**
* The unique identifier for the Destination action to trigger.
* @return actionId
**/
@javax.annotation.Nonnull
@ApiModelProperty(required = true, value = "The unique identifier for the Destination action to trigger.")
public String getActionId() {
return actionId;
}
public void setActionId(String actionId) {
this.actionId = actionId;
}
public DestinationSubscription actionSlug(String actionSlug) {
this.actionSlug = actionSlug;
return this;
}
/**
* The URL-friendly key for the associated Destination action.
* @return actionSlug
**/
@javax.annotation.Nonnull
@ApiModelProperty(required = true, value = "The URL-friendly key for the associated Destination action.")
public String getActionSlug() {
return actionSlug;
}
public void setActionSlug(String actionSlug) {
this.actionSlug = actionSlug;
}
public DestinationSubscription destinationId(String destinationId) {
this.destinationId = destinationId;
return this;
}
/**
* The associated Destination instance id.
* @return destinationId
**/
@javax.annotation.Nonnull
@ApiModelProperty(required = true, value = "The associated Destination instance id.")
public String getDestinationId() {
return destinationId;
}
public void setDestinationId(String destinationId) {
this.destinationId = destinationId;
}
public DestinationSubscription enabled(Boolean enabled) {
this.enabled = enabled;
return this;
}
/**
* Is the subscription enabled.
* @return enabled
**/
@javax.annotation.Nonnull
@ApiModelProperty(required = true, value = "Is the subscription enabled.")
public Boolean getEnabled() {
return enabled;
}
public void setEnabled(Boolean enabled) {
this.enabled = enabled;
}
public DestinationSubscription settings(Map settings) {
this.settings = settings;
return this;
}
/**
* The customer settings for action fields.
* @return settings
**/
@javax.annotation.Nonnull
@ApiModelProperty(required = true, value = "The customer settings for action fields.")
public Map getSettings() {
return settings;
}
public void setSettings(Map settings) {
this.settings = settings;
}
public DestinationSubscription trigger(String trigger) {
this.trigger = trigger;
return this;
}
/**
* FQL string that describes what events should trigger a Destination action.
* @return trigger
**/
@javax.annotation.Nonnull
@ApiModelProperty(required = true, value = "FQL string that describes what events should trigger a Destination action.")
public String getTrigger() {
return trigger;
}
public void setTrigger(String trigger) {
this.trigger = trigger;
}
@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
DestinationSubscription destinationSubscription = (DestinationSubscription) o;
return Objects.equals(this.id, destinationSubscription.id) &&
Objects.equals(this.name, destinationSubscription.name) &&
Objects.equals(this.actionId, destinationSubscription.actionId) &&
Objects.equals(this.actionSlug, destinationSubscription.actionSlug) &&
Objects.equals(this.destinationId, destinationSubscription.destinationId) &&
Objects.equals(this.enabled, destinationSubscription.enabled) &&
Objects.equals(this.settings, destinationSubscription.settings) &&
Objects.equals(this.trigger, destinationSubscription.trigger);
}
@Override
public int hashCode() {
return Objects.hash(id, name, actionId, actionSlug, destinationId, enabled, settings, trigger);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class DestinationSubscription {\n");
sb.append(" id: ").append(toIndentedString(id)).append("\n");
sb.append(" name: ").append(toIndentedString(name)).append("\n");
sb.append(" actionId: ").append(toIndentedString(actionId)).append("\n");
sb.append(" actionSlug: ").append(toIndentedString(actionSlug)).append("\n");
sb.append(" destinationId: ").append(toIndentedString(destinationId)).append("\n");
sb.append(" enabled: ").append(toIndentedString(enabled)).append("\n");
sb.append(" settings: ").append(toIndentedString(settings)).append("\n");
sb.append(" trigger: ").append(toIndentedString(trigger)).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("id");
openapiFields.add("name");
openapiFields.add("actionId");
openapiFields.add("actionSlug");
openapiFields.add("destinationId");
openapiFields.add("enabled");
openapiFields.add("settings");
openapiFields.add("trigger");
// a set of required properties/fields (JSON key names)
openapiRequiredFields = new HashSet();
openapiRequiredFields.add("id");
openapiRequiredFields.add("name");
openapiRequiredFields.add("actionId");
openapiRequiredFields.add("actionSlug");
openapiRequiredFields.add("destinationId");
openapiRequiredFields.add("enabled");
openapiRequiredFields.add("settings");
openapiRequiredFields.add("trigger");
}
/**
* 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 DestinationSubscription
*/
public static void validateJsonObject(JsonObject jsonObj) throws IOException {
if (jsonObj == null) {
if (!DestinationSubscription.openapiRequiredFields.isEmpty()) { // has required fields but JSON object is null
throw new IllegalArgumentException(String.format("The required field(s) %s in DestinationSubscription is not found in the empty JSON string", DestinationSubscription.openapiRequiredFields.toString()));
}
}
Set> entries = jsonObj.entrySet();
// check to see if the JSON string contains additional fields
for (Entry entry : entries) {
if (!DestinationSubscription.openapiFields.contains(entry.getKey())) {
throw new IllegalArgumentException(String.format("The field `%s` in the JSON string is not defined in the `DestinationSubscription` properties. JSON: %s", entry.getKey(), jsonObj.toString()));
}
}
// check to make sure all required properties/fields are present in the JSON string
for (String requiredField : DestinationSubscription.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("id").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `id` to be a primitive type in the JSON string but got `%s`", jsonObj.get("id").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("actionId").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `actionId` to be a primitive type in the JSON string but got `%s`", jsonObj.get("actionId").toString()));
}
if (!jsonObj.get("actionSlug").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `actionSlug` to be a primitive type in the JSON string but got `%s`", jsonObj.get("actionSlug").toString()));
}
if (!jsonObj.get("destinationId").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `destinationId` to be a primitive type in the JSON string but got `%s`", jsonObj.get("destinationId").toString()));
}
if (!jsonObj.get("trigger").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `trigger` to be a primitive type in the JSON string but got `%s`", jsonObj.get("trigger").toString()));
}
}
public static class CustomTypeAdapterFactory implements TypeAdapterFactory {
@SuppressWarnings("unchecked")
@Override
public TypeAdapter create(Gson gson, TypeToken type) {
if (!DestinationSubscription.class.isAssignableFrom(type.getRawType())) {
return null; // this class only serializes 'DestinationSubscription' and its subtypes
}
final TypeAdapter elementAdapter = gson.getAdapter(JsonElement.class);
final TypeAdapter thisAdapter
= gson.getDelegateAdapter(this, TypeToken.get(DestinationSubscription.class));
return (TypeAdapter) new TypeAdapter() {
@Override
public void write(JsonWriter out, DestinationSubscription value) throws IOException {
JsonObject obj = thisAdapter.toJsonTree(value).getAsJsonObject();
elementAdapter.write(out, obj);
}
@Override
public DestinationSubscription read(JsonReader in) throws IOException {
JsonObject jsonObj = elementAdapter.read(in).getAsJsonObject();
validateJsonObject(jsonObj);
return thisAdapter.fromJsonTree(jsonObj);
}
}.nullSafe();
}
}
/**
* Create an instance of DestinationSubscription given an JSON string
*
* @param jsonString JSON string
* @return An instance of DestinationSubscription
* @throws IOException if the JSON string is invalid with respect to DestinationSubscription
*/
public static DestinationSubscription fromJson(String jsonString) throws IOException {
return JSON.getGson().fromJson(jsonString, DestinationSubscription.class);
}
/**
* Convert an instance of DestinationSubscription to an JSON string
*
* @return JSON string
*/
public String toJson() {
return JSON.getGson().toJson(this);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy