com.segment.publicapi.models.LabelAlpha 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;
/**
* A label lets Workspace owners assign permissions to users, and grant these users access to groups. A Workspace owner may use labels to grant users access to groups of resources. When you add a label to a Source or Personas Spaces, any users granted access to that label gain access to those resources. All Workspaces include labels for Dev (development) and Prod (production) environments. On top of those, Free and Team plan customers may create up to five labels. Customers with the Enterprise pricing package may create an unlimited number of labels.
*/
@ApiModel(description = "A label lets Workspace owners assign permissions to users, and grant these users access to groups. A Workspace owner may use labels to grant users access to groups of resources. When you add a label to a Source or Personas Spaces, any users granted access to that label gain access to those resources. All Workspaces include labels for Dev (development) and Prod (production) environments. On top of those, Free and Team plan customers may create up to five labels. Customers with the Enterprise pricing package may create an unlimited number of labels.")
public class LabelAlpha {
public static final String SERIALIZED_NAME_KEY = "key";
@SerializedName(SERIALIZED_NAME_KEY)
private String key;
public static final String SERIALIZED_NAME_VALUE = "value";
@SerializedName(SERIALIZED_NAME_VALUE)
private String value;
public static final String SERIALIZED_NAME_DESCRIPTION = "description";
@SerializedName(SERIALIZED_NAME_DESCRIPTION)
private String description;
public LabelAlpha() {
}
public LabelAlpha key(String key) {
this.key = key;
return this;
}
/**
* The key that represents the name of this label.
* @return key
**/
@javax.annotation.Nonnull
@ApiModelProperty(required = true, value = "The key that represents the name of this label.")
public String getKey() {
return key;
}
public void setKey(String key) {
this.key = key;
}
public LabelAlpha value(String value) {
this.value = value;
return this;
}
/**
* The value associated with the key of this label.
* @return value
**/
@javax.annotation.Nonnull
@ApiModelProperty(required = true, value = "The value associated with the key of this label.")
public String getValue() {
return value;
}
public void setValue(String value) {
this.value = value;
}
public LabelAlpha description(String description) {
this.description = description;
return this;
}
/**
* An optional description of the purpose of this label.
* @return description
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "An optional description of the purpose of this label.")
public String getDescription() {
return description;
}
public void setDescription(String description) {
this.description = description;
}
@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
LabelAlpha labelAlpha = (LabelAlpha) o;
return Objects.equals(this.key, labelAlpha.key) &&
Objects.equals(this.value, labelAlpha.value) &&
Objects.equals(this.description, labelAlpha.description);
}
@Override
public int hashCode() {
return Objects.hash(key, value, description);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class LabelAlpha {\n");
sb.append(" key: ").append(toIndentedString(key)).append("\n");
sb.append(" value: ").append(toIndentedString(value)).append("\n");
sb.append(" description: ").append(toIndentedString(description)).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("key");
openapiFields.add("value");
openapiFields.add("description");
// a set of required properties/fields (JSON key names)
openapiRequiredFields = new HashSet();
openapiRequiredFields.add("key");
openapiRequiredFields.add("value");
}
/**
* 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 LabelAlpha
*/
public static void validateJsonObject(JsonObject jsonObj) throws IOException {
if (jsonObj == null) {
if (!LabelAlpha.openapiRequiredFields.isEmpty()) { // has required fields but JSON object is null
throw new IllegalArgumentException(String.format("The required field(s) %s in LabelAlpha is not found in the empty JSON string", LabelAlpha.openapiRequiredFields.toString()));
}
}
Set> entries = jsonObj.entrySet();
// check to see if the JSON string contains additional fields
for (Entry entry : entries) {
if (!LabelAlpha.openapiFields.contains(entry.getKey())) {
throw new IllegalArgumentException(String.format("The field `%s` in the JSON string is not defined in the `LabelAlpha` properties. JSON: %s", entry.getKey(), jsonObj.toString()));
}
}
// check to make sure all required properties/fields are present in the JSON string
for (String requiredField : LabelAlpha.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("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("value").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `value` to be a primitive type in the JSON string but got `%s`", jsonObj.get("value").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()));
}
}
public static class CustomTypeAdapterFactory implements TypeAdapterFactory {
@SuppressWarnings("unchecked")
@Override
public TypeAdapter create(Gson gson, TypeToken type) {
if (!LabelAlpha.class.isAssignableFrom(type.getRawType())) {
return null; // this class only serializes 'LabelAlpha' and its subtypes
}
final TypeAdapter elementAdapter = gson.getAdapter(JsonElement.class);
final TypeAdapter thisAdapter
= gson.getDelegateAdapter(this, TypeToken.get(LabelAlpha.class));
return (TypeAdapter) new TypeAdapter() {
@Override
public void write(JsonWriter out, LabelAlpha value) throws IOException {
JsonObject obj = thisAdapter.toJsonTree(value).getAsJsonObject();
elementAdapter.write(out, obj);
}
@Override
public LabelAlpha read(JsonReader in) throws IOException {
JsonObject jsonObj = elementAdapter.read(in).getAsJsonObject();
validateJsonObject(jsonObj);
return thisAdapter.fromJsonTree(jsonObj);
}
}.nullSafe();
}
}
/**
* Create an instance of LabelAlpha given an JSON string
*
* @param jsonString JSON string
* @return An instance of LabelAlpha
* @throws IOException if the JSON string is invalid with respect to LabelAlpha
*/
public static LabelAlpha fromJson(String jsonString) throws IOException {
return JSON.getGson().fromJson(jsonString, LabelAlpha.class);
}
/**
* Convert an instance of LabelAlpha to an JSON string
*
* @return JSON string
*/
public String toJson() {
return JSON.getGson().toJson(this);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy