com.segment.publicapi.models.DestinationV1 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 com.segment.publicapi.models.Metadata;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import java.io.IOException;
import java.util.HashMap;
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;
/**
* Business tools or apps that you can connect to the data flowing through Segment. This is equal to the Destination object in Config API, with the following fields omitted: - catalogId - createTime - updateTime - connectionMode.
*/
@ApiModel(description = "Business tools or apps that you can connect to the data flowing through Segment. This is equal to the Destination object in Config API, with the following fields omitted: - catalogId - createTime - updateTime - connectionMode.")
public class DestinationV1 {
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_ENABLED = "enabled";
@SerializedName(SERIALIZED_NAME_ENABLED)
private Boolean enabled;
public static final String SERIALIZED_NAME_METADATA = "metadata";
@SerializedName(SERIALIZED_NAME_METADATA)
private Metadata metadata;
public static final String SERIALIZED_NAME_SOURCE_ID = "sourceId";
@SerializedName(SERIALIZED_NAME_SOURCE_ID)
private String sourceId;
public static final String SERIALIZED_NAME_SETTINGS = "settings";
@SerializedName(SERIALIZED_NAME_SETTINGS)
private Map settings = new HashMap<>();
public DestinationV1() {
}
public DestinationV1 id(String id) {
this.id = id;
return this;
}
/**
* The unique identifier of this instance of a Destination. Config API note: analogous to `name`.
* @return id
**/
@javax.annotation.Nonnull
@ApiModelProperty(required = true, value = "The unique identifier of this instance of a Destination. Config API note: analogous to `name`.")
public String getId() {
return id;
}
public void setId(String id) {
this.id = id;
}
public DestinationV1 name(String name) {
this.name = name;
return this;
}
/**
* The name of this instance of a Destination. Config API note: equal to `displayName`.
* @return name
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "The name of this instance of a Destination. Config API note: equal to `displayName`.")
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public DestinationV1 enabled(Boolean enabled) {
this.enabled = enabled;
return this;
}
/**
* Whether this instance of a Destination receives data.
* @return enabled
**/
@javax.annotation.Nonnull
@ApiModelProperty(required = true, value = "Whether this instance of a Destination receives data.")
public Boolean getEnabled() {
return enabled;
}
public void setEnabled(Boolean enabled) {
this.enabled = enabled;
}
public DestinationV1 metadata(Metadata metadata) {
this.metadata = metadata;
return this;
}
/**
* Get metadata
* @return metadata
**/
@javax.annotation.Nonnull
@ApiModelProperty(required = true, value = "")
public Metadata getMetadata() {
return metadata;
}
public void setMetadata(Metadata metadata) {
this.metadata = metadata;
}
public DestinationV1 sourceId(String sourceId) {
this.sourceId = sourceId;
return this;
}
/**
* The id of a Source connected to this instance of a Destination. Config API note: analogous to `parent`.
* @return sourceId
**/
@javax.annotation.Nonnull
@ApiModelProperty(required = true, value = "The id of a Source connected to this instance of a Destination. Config API note: analogous to `parent`.")
public String getSourceId() {
return sourceId;
}
public void setSourceId(String sourceId) {
this.sourceId = sourceId;
}
public DestinationV1 settings(Map settings) {
this.settings = settings;
return this;
}
public DestinationV1 putSettingsItem(String key, Object settingsItem) {
this.settings.put(key, settingsItem);
return this;
}
/**
* The collection of settings associated with a Destination. Config API note: equal to `config`.
* @return settings
**/
@javax.annotation.Nonnull
@ApiModelProperty(required = true, value = "The collection of settings associated with a Destination. Config API note: equal to `config`.")
public Map getSettings() {
return settings;
}
public void setSettings(Map settings) {
this.settings = settings;
}
@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
DestinationV1 destinationV1 = (DestinationV1) o;
return Objects.equals(this.id, destinationV1.id) &&
Objects.equals(this.name, destinationV1.name) &&
Objects.equals(this.enabled, destinationV1.enabled) &&
Objects.equals(this.metadata, destinationV1.metadata) &&
Objects.equals(this.sourceId, destinationV1.sourceId) &&
Objects.equals(this.settings, destinationV1.settings);
}
@Override
public int hashCode() {
return Objects.hash(id, name, enabled, metadata, sourceId, settings);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class DestinationV1 {\n");
sb.append(" id: ").append(toIndentedString(id)).append("\n");
sb.append(" name: ").append(toIndentedString(name)).append("\n");
sb.append(" enabled: ").append(toIndentedString(enabled)).append("\n");
sb.append(" metadata: ").append(toIndentedString(metadata)).append("\n");
sb.append(" sourceId: ").append(toIndentedString(sourceId)).append("\n");
sb.append(" settings: ").append(toIndentedString(settings)).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("enabled");
openapiFields.add("metadata");
openapiFields.add("sourceId");
openapiFields.add("settings");
// a set of required properties/fields (JSON key names)
openapiRequiredFields = new HashSet();
openapiRequiredFields.add("id");
openapiRequiredFields.add("enabled");
openapiRequiredFields.add("metadata");
openapiRequiredFields.add("sourceId");
openapiRequiredFields.add("settings");
}
/**
* 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 DestinationV1
*/
public static void validateJsonObject(JsonObject jsonObj) throws IOException {
if (jsonObj == null) {
if (!DestinationV1.openapiRequiredFields.isEmpty()) { // has required fields but JSON object is null
throw new IllegalArgumentException(String.format("The required field(s) %s in DestinationV1 is not found in the empty JSON string", DestinationV1.openapiRequiredFields.toString()));
}
}
Set> entries = jsonObj.entrySet();
// check to see if the JSON string contains additional fields
for (Entry entry : entries) {
if (!DestinationV1.openapiFields.contains(entry.getKey())) {
throw new IllegalArgumentException(String.format("The field `%s` in the JSON string is not defined in the `DestinationV1` properties. JSON: %s", entry.getKey(), jsonObj.toString()));
}
}
// check to make sure all required properties/fields are present in the JSON string
for (String requiredField : DestinationV1.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") != 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("sourceId").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `sourceId` to be a primitive type in the JSON string but got `%s`", jsonObj.get("sourceId").toString()));
}
}
public static class CustomTypeAdapterFactory implements TypeAdapterFactory {
@SuppressWarnings("unchecked")
@Override
public TypeAdapter create(Gson gson, TypeToken type) {
if (!DestinationV1.class.isAssignableFrom(type.getRawType())) {
return null; // this class only serializes 'DestinationV1' and its subtypes
}
final TypeAdapter elementAdapter = gson.getAdapter(JsonElement.class);
final TypeAdapter thisAdapter
= gson.getDelegateAdapter(this, TypeToken.get(DestinationV1.class));
return (TypeAdapter) new TypeAdapter() {
@Override
public void write(JsonWriter out, DestinationV1 value) throws IOException {
JsonObject obj = thisAdapter.toJsonTree(value).getAsJsonObject();
elementAdapter.write(out, obj);
}
@Override
public DestinationV1 read(JsonReader in) throws IOException {
JsonObject jsonObj = elementAdapter.read(in).getAsJsonObject();
validateJsonObject(jsonObj);
return thisAdapter.fromJsonTree(jsonObj);
}
}.nullSafe();
}
}
/**
* Create an instance of DestinationV1 given an JSON string
*
* @param jsonString JSON string
* @return An instance of DestinationV1
* @throws IOException if the JSON string is invalid with respect to DestinationV1
*/
public static DestinationV1 fromJson(String jsonString) throws IOException {
return JSON.getGson().fromJson(jsonString, DestinationV1.class);
}
/**
* Convert an instance of DestinationV1 to an JSON string
*
* @return JSON string
*/
public String toJson() {
return JSON.getGson().toJson(this);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy