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

com.seeq.model.ColumnRuleFormulaCreatorInputV1 Maven / Gradle / Ivy

There is a newer version: 66.0.0-v202410141803
Show newest version
/*
 * Seeq REST API
 * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
 *
 * OpenAPI spec version: 65.1.6-v202409201821
 * 
 *
 * NOTE: This class is auto generated by the swagger code generator program.
 * https://github.com/swagger-api/swagger-codegen.git
 * Do not edit the class manually.
 */

package com.seeq.model;

import java.util.Objects;
import java.util.Arrays;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonValue;
import io.swagger.v3.oas.annotations.media.Schema;
import java.util.ArrayList;
import java.util.List;
import java.util.UUID;
/**
 * Creates a formula based on its inputs. Column type must be UUID
 */
@Schema(description = "Creates a formula based on its inputs. Column type must be UUID")
public class ColumnRuleFormulaCreatorInputV1 {
  @JsonProperty("columnIndexes")
  private List columnIndexes = new ArrayList();

  @JsonProperty("description")
  private String description = null;

  @JsonProperty("formula")
  private String formula = null;

  @JsonProperty("identityId")
  private UUID identityId = null;

  @JsonProperty("name")
  private String name = null;

  @JsonProperty("parameters")
  private List parameters = new ArrayList();

  @JsonProperty("permissionString")
  private String permissionString = null;

  @JsonProperty("scopedTo")
  private UUID scopedTo = null;

  @JsonProperty("securityString")
  private String securityString = null;

  public ColumnRuleFormulaCreatorInputV1 columnIndexes(List columnIndexes) {
    this.columnIndexes = columnIndexes;
    return this;
  }

  public ColumnRuleFormulaCreatorInputV1 addColumnIndexesItem(Integer columnIndexesItem) {
    this.columnIndexes.add(columnIndexesItem);
    return this;
  }

   /**
   * The indexes of the columns that should be used as item inputs to the formula. A column index is 1-based
   * @return columnIndexes
  **/
  @Schema(required = true, description = "The indexes of the columns that should be used as item inputs to the formula. A column index is 1-based")
  public List getColumnIndexes() {
    return columnIndexes;
  }

  public void setColumnIndexes(List columnIndexes) {
    this.columnIndexes = columnIndexes;
  }

  public ColumnRuleFormulaCreatorInputV1 description(String description) {
    this.description = description;
    return this;
  }

   /**
   * Clarifying information or other plain language description for items created by this rule. An input of just whitespace is equivalent to a null input.
   * @return description
  **/
  @Schema(description = "Clarifying information or other plain language description for items created by this rule. An input of just whitespace is equivalent to a null input.")
  public String getDescription() {
    return description;
  }

  public void setDescription(String description) {
    this.description = description;
  }

  public ColumnRuleFormulaCreatorInputV1 formula(String formula) {
    this.formula = formula;
    return this;
  }

   /**
   * The formula that represents the body of the function.
   * @return formula
  **/
  @Schema(required = true, description = "The formula that represents the body of the function.")
  public String getFormula() {
    return formula;
  }

  public void setFormula(String formula) {
    this.formula = formula;
  }

  public ColumnRuleFormulaCreatorInputV1 identityId(UUID identityId) {
    this.identityId = identityId;
    return this;
  }

   /**
   * The ID of the identity for which permissions will be set on items created by this rule. A null value means that the items created by this rule will have the same permissions as its associated datasource. This field cannot be set along with 'securityString'.
   * @return identityId
  **/
  @Schema(description = "The ID of the identity for which permissions will be set on items created by this rule. A null value means that the items created by this rule will have the same permissions as its associated datasource. This field cannot be set along with 'securityString'.")
  public UUID getIdentityId() {
    return identityId;
  }

  public void setIdentityId(UUID identityId) {
    this.identityId = identityId;
  }

  public ColumnRuleFormulaCreatorInputV1 name(String name) {
    this.name = name;
    return this;
  }

   /**
   * Human readable name for items created by this rule. Null or whitespace names are not permitted.
   * @return name
  **/
  @Schema(required = true, description = "Human readable name for items created by this rule. Null or whitespace names are not permitted.")
  public String getName() {
    return name;
  }

  public void setName(String name) {
    this.name = name;
  }

  public ColumnRuleFormulaCreatorInputV1 parameters(List parameters) {
    this.parameters = parameters;
    return this;
  }

  public ColumnRuleFormulaCreatorInputV1 addParametersItem(String parametersItem) {
    this.parameters.add(parametersItem);
    return this;
  }

   /**
   * Parameters to use in the formula. The position of the parameter should correspond to the position of its input item in the 'columnIndexes' field. Parameters must start with a letter and must be followed by an alphanumeric character, for example 'Sp3'.
   * @return parameters
  **/
  @Schema(required = true, description = "Parameters to use in the formula. The position of the parameter should correspond to the position of its input item in the 'columnIndexes' field. Parameters must start with a letter and must be followed by an alphanumeric character, for example 'Sp3'.")
  public List getParameters() {
    return parameters;
  }

  public void setParameters(List parameters) {
    this.parameters = parameters;
  }

  public ColumnRuleFormulaCreatorInputV1 permissionString(String permissionString) {
    this.permissionString = permissionString;
    return this;
  }

   /**
   * The permissions for the identity included for items created by this rule. Must be in a valid string form with each permission separated by a comma, for example 'r,w,m'. Acceptable permissions are: 'r' - read, 'w' - write, 'm' - manage.
   * @return permissionString
  **/
  @Schema(description = "The permissions for the identity included for items created by this rule. Must be in a valid string form with each permission separated by a comma, for example 'r,w,m'. Acceptable permissions are: 'r' - read, 'w' - write, 'm' - manage.")
  public String getPermissionString() {
    return permissionString;
  }

  public void setPermissionString(String permissionString) {
    this.permissionString = permissionString;
  }

  public ColumnRuleFormulaCreatorInputV1 scopedTo(UUID scopedTo) {
    this.scopedTo = scopedTo;
    return this;
  }

   /**
   * The ID of the workbook to which this item will be scoped. Null if the item should be globally scoped.
   * @return scopedTo
  **/
  @Schema(description = "The ID of the workbook to which this item will be scoped. Null if the item should be globally scoped.")
  public UUID getScopedTo() {
    return scopedTo;
  }

  public void setScopedTo(UUID scopedTo) {
    this.scopedTo = scopedTo;
  }

  public ColumnRuleFormulaCreatorInputV1 securityString(String securityString) {
    this.securityString = securityString;
    return this;
  }

   /**
   * Security string containing all identities and their permissions for the item. Cannot be used if permissionString is used.
   * @return securityString
  **/
  @Schema(description = "Security string containing all identities and their permissions for the item. Cannot be used if permissionString is used.")
  public String getSecurityString() {
    return securityString;
  }

  public void setSecurityString(String securityString) {
    this.securityString = securityString;
  }


  @Override
  public boolean equals(java.lang.Object o) {
    if (this == o) {
      return true;
    }
    if (o == null || getClass() != o.getClass()) {
      return false;
    }
    ColumnRuleFormulaCreatorInputV1 columnRuleFormulaCreatorInputV1 = (ColumnRuleFormulaCreatorInputV1) o;
    return Objects.equals(this.columnIndexes, columnRuleFormulaCreatorInputV1.columnIndexes) &&
        Objects.equals(this.description, columnRuleFormulaCreatorInputV1.description) &&
        Objects.equals(this.formula, columnRuleFormulaCreatorInputV1.formula) &&
        Objects.equals(this.identityId, columnRuleFormulaCreatorInputV1.identityId) &&
        Objects.equals(this.name, columnRuleFormulaCreatorInputV1.name) &&
        Objects.equals(this.parameters, columnRuleFormulaCreatorInputV1.parameters) &&
        Objects.equals(this.permissionString, columnRuleFormulaCreatorInputV1.permissionString) &&
        Objects.equals(this.scopedTo, columnRuleFormulaCreatorInputV1.scopedTo) &&
        Objects.equals(this.securityString, columnRuleFormulaCreatorInputV1.securityString);
  }

  @Override
  public int hashCode() {
    return Objects.hash(columnIndexes, description, formula, identityId, name, parameters, permissionString, scopedTo, securityString);
  }


  @Override
  public String toString() {
    StringBuilder sb = new StringBuilder();
    sb.append("class ColumnRuleFormulaCreatorInputV1 {\n");
    
    sb.append("    columnIndexes: ").append(toIndentedString(columnIndexes)).append("\n");
    sb.append("    description: ").append(toIndentedString(description)).append("\n");
    sb.append("    formula: ").append(toIndentedString(formula)).append("\n");
    sb.append("    identityId: ").append(toIndentedString(identityId)).append("\n");
    sb.append("    name: ").append(toIndentedString(name)).append("\n");
    sb.append("    parameters: ").append(toIndentedString(parameters)).append("\n");
    sb.append("    permissionString: ").append(toIndentedString(permissionString)).append("\n");
    sb.append("    scopedTo: ").append(toIndentedString(scopedTo)).append("\n");
    sb.append("    securityString: ").append(toIndentedString(securityString)).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(java.lang.Object o) {
    if (o == null) {
      return "null";
    }
    return o.toString().replace("\n", "\n    ");
  }
  
}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy