All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.segment.publicapi.models.Group 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;

/**
 * Group settings.
 */
@ApiModel(description = "Group settings.")

public class Group {
  public static final String SERIALIZED_NAME_ALLOW_UNPLANNED_TRAITS = "allowUnplannedTraits";
  @SerializedName(SERIALIZED_NAME_ALLOW_UNPLANNED_TRAITS)
  private Boolean allowUnplannedTraits;

  public static final String SERIALIZED_NAME_ALLOW_TRAITS_ON_VIOLATIONS = "allowTraitsOnViolations";
  @SerializedName(SERIALIZED_NAME_ALLOW_TRAITS_ON_VIOLATIONS)
  private Boolean allowTraitsOnViolations;

  /**
   * The common group event on violations.  Config API note: equal to `commonGroupEventOnViolations`.
   */
  @JsonAdapter(CommonEventOnViolationsEnum.Adapter.class)
  public enum CommonEventOnViolationsEnum {
    ALLOW("ALLOW"),
    
    BLOCK("BLOCK"),
    
    OMIT_TRAITS("OMIT_TRAITS");

    private String value;

    CommonEventOnViolationsEnum(String value) {
      this.value = value;
    }

    public String getValue() {
      return value;
    }

    @Override
    public String toString() {
      return String.valueOf(value);
    }

    public static CommonEventOnViolationsEnum fromValue(String value) {
      for (CommonEventOnViolationsEnum b : CommonEventOnViolationsEnum.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 CommonEventOnViolationsEnum enumeration) throws IOException {
        jsonWriter.value(enumeration.getValue());
      }

      @Override
      public CommonEventOnViolationsEnum read(final JsonReader jsonReader) throws IOException {
        String value =  jsonReader.nextString();
        return CommonEventOnViolationsEnum.fromValue(value);
      }
    }
  }

  public static final String SERIALIZED_NAME_COMMON_EVENT_ON_VIOLATIONS = "commonEventOnViolations";
  @SerializedName(SERIALIZED_NAME_COMMON_EVENT_ON_VIOLATIONS)
  private CommonEventOnViolationsEnum commonEventOnViolations;

  public Group() {
  }

  public Group allowUnplannedTraits(Boolean allowUnplannedTraits) {
    
    this.allowUnplannedTraits = allowUnplannedTraits;
    return this;
  }

   /**
   * Enable to allow unplanned group traits.  Config API note: equal to `allowUnplannedGroupTraits`.
   * @return allowUnplannedTraits
  **/
  @javax.annotation.Nullable
  @ApiModelProperty(value = "Enable to allow unplanned group traits.  Config API note: equal to `allowUnplannedGroupTraits`.")

  public Boolean getAllowUnplannedTraits() {
    return allowUnplannedTraits;
  }


  public void setAllowUnplannedTraits(Boolean allowUnplannedTraits) {
    this.allowUnplannedTraits = allowUnplannedTraits;
  }


  public Group allowTraitsOnViolations(Boolean allowTraitsOnViolations) {
    
    this.allowTraitsOnViolations = allowTraitsOnViolations;
    return this;
  }

   /**
   * Enable to allow group traits on violations.  Config API note: equal to `allowGroupTraitsOnViolations`.
   * @return allowTraitsOnViolations
  **/
  @javax.annotation.Nullable
  @ApiModelProperty(value = "Enable to allow group traits on violations.  Config API note: equal to `allowGroupTraitsOnViolations`.")

  public Boolean getAllowTraitsOnViolations() {
    return allowTraitsOnViolations;
  }


  public void setAllowTraitsOnViolations(Boolean allowTraitsOnViolations) {
    this.allowTraitsOnViolations = allowTraitsOnViolations;
  }


  public Group commonEventOnViolations(CommonEventOnViolationsEnum commonEventOnViolations) {
    
    this.commonEventOnViolations = commonEventOnViolations;
    return this;
  }

   /**
   * The common group event on violations.  Config API note: equal to `commonGroupEventOnViolations`.
   * @return commonEventOnViolations
  **/
  @javax.annotation.Nullable
  @ApiModelProperty(value = "The common group event on violations.  Config API note: equal to `commonGroupEventOnViolations`.")

  public CommonEventOnViolationsEnum getCommonEventOnViolations() {
    return commonEventOnViolations;
  }


  public void setCommonEventOnViolations(CommonEventOnViolationsEnum commonEventOnViolations) {
    this.commonEventOnViolations = commonEventOnViolations;
  }



  @Override
  public boolean equals(Object o) {
    if (this == o) {
      return true;
    }
    if (o == null || getClass() != o.getClass()) {
      return false;
    }
    Group group = (Group) o;
    return Objects.equals(this.allowUnplannedTraits, group.allowUnplannedTraits) &&
        Objects.equals(this.allowTraitsOnViolations, group.allowTraitsOnViolations) &&
        Objects.equals(this.commonEventOnViolations, group.commonEventOnViolations);
  }

  @Override
  public int hashCode() {
    return Objects.hash(allowUnplannedTraits, allowTraitsOnViolations, commonEventOnViolations);
  }

  @Override
  public String toString() {
    StringBuilder sb = new StringBuilder();
    sb.append("class Group {\n");
    sb.append("    allowUnplannedTraits: ").append(toIndentedString(allowUnplannedTraits)).append("\n");
    sb.append("    allowTraitsOnViolations: ").append(toIndentedString(allowTraitsOnViolations)).append("\n");
    sb.append("    commonEventOnViolations: ").append(toIndentedString(commonEventOnViolations)).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("allowUnplannedTraits");
    openapiFields.add("allowTraitsOnViolations");
    openapiFields.add("commonEventOnViolations");

    // a set of required properties/fields (JSON key names)
    openapiRequiredFields = new HashSet();
  }

 /**
  * 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 Group
  */
  public static void validateJsonObject(JsonObject jsonObj) throws IOException {
      if (jsonObj == null) {
        if (!Group.openapiRequiredFields.isEmpty()) { // has required fields but JSON object is null
          throw new IllegalArgumentException(String.format("The required field(s) %s in Group is not found in the empty JSON string", Group.openapiRequiredFields.toString()));
        }
      }

      Set> entries = jsonObj.entrySet();
      // check to see if the JSON string contains additional fields
      for (Entry entry : entries) {
        if (!Group.openapiFields.contains(entry.getKey())) {
          throw new IllegalArgumentException(String.format("The field `%s` in the JSON string is not defined in the `Group` properties. JSON: %s", entry.getKey(), jsonObj.toString()));
        }
      }
      if ((jsonObj.get("commonEventOnViolations") != null && !jsonObj.get("commonEventOnViolations").isJsonNull()) && !jsonObj.get("commonEventOnViolations").isJsonPrimitive()) {
        throw new IllegalArgumentException(String.format("Expected the field `commonEventOnViolations` to be a primitive type in the JSON string but got `%s`", jsonObj.get("commonEventOnViolations").toString()));
      }
  }

  public static class CustomTypeAdapterFactory implements TypeAdapterFactory {
    @SuppressWarnings("unchecked")
    @Override
    public  TypeAdapter create(Gson gson, TypeToken type) {
       if (!Group.class.isAssignableFrom(type.getRawType())) {
         return null; // this class only serializes 'Group' and its subtypes
       }
       final TypeAdapter elementAdapter = gson.getAdapter(JsonElement.class);
       final TypeAdapter thisAdapter
                        = gson.getDelegateAdapter(this, TypeToken.get(Group.class));

       return (TypeAdapter) new TypeAdapter() {
           @Override
           public void write(JsonWriter out, Group value) throws IOException {
             JsonObject obj = thisAdapter.toJsonTree(value).getAsJsonObject();
             elementAdapter.write(out, obj);
           }

           @Override
           public Group read(JsonReader in) throws IOException {
             JsonObject jsonObj = elementAdapter.read(in).getAsJsonObject();
             validateJsonObject(jsonObj);
             return thisAdapter.fromJsonTree(jsonObj);
           }

       }.nullSafe();
    }
  }

 /**
  * Create an instance of Group given an JSON string
  *
  * @param jsonString JSON string
  * @return An instance of Group
  * @throws IOException if the JSON string is invalid with respect to Group
  */
  public static Group fromJson(String jsonString) throws IOException {
    return JSON.getGson().fromJson(jsonString, Group.class);
  }

 /**
  * Convert an instance of Group to an JSON string
  *
  * @return JSON string
  */
  public String toJson() {
    return JSON.getGson().toJson(this);
  }
}





© 2015 - 2025 Weber Informatics LLC | Privacy Policy