src.main.java.com.smartbear.readyapi.client.model.DataSourceTestStep Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ready-api-testserver-client Show documentation
Java client library for creating and executing test recipes against Ready!API TestServer
The newest version!
package com.smartbear.readyapi.client.model;

import java.util.Objects;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.smartbear.readyapi.client.model.DataSource;
import com.smartbear.readyapi.client.model.TestStep;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import java.util.ArrayList;
import java.util.List;



/**
 * Data structure for the <a herf=\"http://readyapi.smartbear.com/structure/steps/data/source/start\">Data Source</a> test step.
 **/

@ApiModel(description = "Data structure for the Data Source test step.")
@javax.annotation.Generated(value = "class io.swagger.codegen.languages.JavaClientCodegen", date = "2016-07-29T13:25:49.703+02:00")
public class DataSourceTestStep extends TestStep  {
  
  private String type = null;
  private String name = null;
  private DataSource dataSource = null;
  private List testSteps = new ArrayList();
  private Boolean restartOnRun = false;
  private Boolean preload = false;
  private Boolean failOnEmpty = false;
  private Boolean skipLoopOnEmpty = false;
  private Boolean trimValues = false;
  private Boolean entitizeValues = false;
  private Boolean expandProperties = false;
  private Boolean shared = false;
  private Boolean restartShared = false;
  private String startRow = null;
  private String endRow = null;

  
  /**
   * Test step type. Possible values: DataSource
Groovy
JDBC Request
Property Transfer
REST Request
TestStepStruct
   **/
  public DataSourceTestStep type(String type) {
    this.type = type;
    return this;
  }
  
  @ApiModelProperty(example = "null", value = "Test step type. Possible values: DataSource
Groovy
JDBC Request
Property Transfer
REST Request
TestStepStruct")
  @JsonProperty("type")
  public String getType() {
    return type;
  }
  public void setType(String type) {
    this.type = type;
  }

  
  /**
   * Test step name. This name is used to refer to the test step in the test recipe.
   **/
  public DataSourceTestStep name(String name) {
    this.name = name;
    return this;
  }
  
  @ApiModelProperty(example = "null", value = "Test step name. This name is used to refer to the test step in the test recipe.")
  @JsonProperty("name")
  public String getName() {
    return name;
  }
  public void setName(String name) {
    this.name = name;
  }

  
  /**
   **/
  public DataSourceTestStep dataSource(DataSource dataSource) {
    this.dataSource = dataSource;
    return this;
  }
  
  @ApiModelProperty(example = "null", value = "")
  @JsonProperty("dataSource")
  public DataSource getDataSource() {
    return dataSource;
  }
  public void setDataSource(DataSource dataSource) {
    this.dataSource = dataSource;
  }

  
  /**
   * Array of test steps using the data source and forming a data source loop.
   **/
  public DataSourceTestStep testSteps(List testSteps) {
    this.testSteps = testSteps;
    return this;
  }
  
  @ApiModelProperty(example = "null", value = "Array of test steps using the data source and forming a data source loop.")
  @JsonProperty("testSteps")
  public List getTestSteps() {
    return testSteps;
  }
  public void setTestSteps(List testSteps) {
    this.testSteps = testSteps;
  }

  
  @ApiModelProperty(example = "null", value = "If true, the iterator is set to the first row each time the test reaches the DataSource test step.")
  @JsonProperty("restartOnRun")
  public Boolean getRestartOnRun() {
    return restartOnRun;
  }

  
  /**
   * If true, the TestServer tries to preload the data before running the test.
   **/
  public DataSourceTestStep preload(Boolean preload) {
    this.preload = preload;
    return this;
  }
  
  @ApiModelProperty(example = "null", value = "If true, the TestServer tries to preload the data before running the test.")
  @JsonProperty("preload")
  public Boolean getPreload() {
    return preload;
  }
  public void setPreload(Boolean preload) {
    this.preload = preload;
  }

  
  /**
   * If true, the test step fails if the data source is empty.
   **/
  public DataSourceTestStep failOnEmpty(Boolean failOnEmpty) {
    this.failOnEmpty = failOnEmpty;
    return this;
  }
  
  @ApiModelProperty(example = "null", value = "If true, the test step fails if the data source is empty.")
  @JsonProperty("failOnEmpty")
  public Boolean getFailOnEmpty() {
    return failOnEmpty;
  }
  public void setFailOnEmpty(Boolean failOnEmpty) {
    this.failOnEmpty = failOnEmpty;
  }

  
  /**
   * If true, skips the data source loop if the data source is empty.
   **/
  public DataSourceTestStep skipLoopOnEmpty(Boolean skipLoopOnEmpty) {
    this.skipLoopOnEmpty = skipLoopOnEmpty;
    return this;
  }
  
  @ApiModelProperty(example = "null", value = "If true, skips the data source loop if the data source is empty.")
  @JsonProperty("skipLoopOnEmpty")
  public Boolean getSkipLoopOnEmpty() {
    return skipLoopOnEmpty;
  }
  public void setSkipLoopOnEmpty(Boolean skipLoopOnEmpty) {
    this.skipLoopOnEmpty = skipLoopOnEmpty;
  }

  
  /**
   * If true, all leading and trailing spaces are removed.
   **/
  public DataSourceTestStep trimValues(Boolean trimValues) {
    this.trimValues = trimValues;
    return this;
  }
  
  @ApiModelProperty(example = "null", value = "If true, all leading and trailing spaces are removed.")
  @JsonProperty("trimValues")
  public Boolean getTrimValues() {
    return trimValues;
  }
  public void setTrimValues(Boolean trimValues) {
    this.trimValues = trimValues;
  }

  
  /**
   * If true, all HTML symbols are replaced with appropriate entities.
   **/
  public DataSourceTestStep entitizeValues(Boolean entitizeValues) {
    this.entitizeValues = entitizeValues;
    return this;
  }
  
  @ApiModelProperty(example = "null", value = "If true, all HTML symbols are replaced with appropriate entities.")
  @JsonProperty("entitizeValues")
  public Boolean getEntitizeValues() {
    return entitizeValues;
  }
  public void setEntitizeValues(Boolean entitizeValues) {
    this.entitizeValues = entitizeValues;
  }

  
  /**
   * If true, TestServer expands property expansion expressions in retrieved values.
   **/
  public DataSourceTestStep expandProperties(Boolean expandProperties) {
    this.expandProperties = expandProperties;
    return this;
  }
  
  @ApiModelProperty(example = "null", value = "If true, TestServer expands property expansion expressions in retrieved values.")
  @JsonProperty("expandProperties")
  public Boolean getExpandProperties() {
    return expandProperties;
  }
  public void setExpandProperties(Boolean expandProperties) {
    this.expandProperties = expandProperties;
  }

  
  /**
   * If true, the data source iterator is used by all concurrent virtual users.
   **/
  public DataSourceTestStep shared(Boolean shared) {
    this.shared = shared;
    return this;
  }
  
  @ApiModelProperty(example = "null", value = "If true, the data source iterator is used by all concurrent virtual users.")
  @JsonProperty("shared")
  public Boolean getShared() {
    return shared;
  }
  public void setShared(Boolean shared) {
    this.shared = shared;
  }

  
  /**
   * If true and shared is also true, resets the iterator when it reaches the end of data source.
   **/
  public DataSourceTestStep restartShared(Boolean restartShared) {
    this.restartShared = restartShared;
    return this;
  }
  
  @ApiModelProperty(example = "null", value = "If true and shared is also true, resets the iterator when it reaches the end of data source.")
  @JsonProperty("restartShared")
  public Boolean getRestartShared() {
    return restartShared;
  }
  public void setRestartShared(Boolean restartShared) {
    this.restartShared = restartShared;
  }

  
  /**
   * Zero-based index of the initial row that the data source uses.
   **/
  public DataSourceTestStep startRow(String startRow) {
    this.startRow = startRow;
    return this;
  }
  
  @ApiModelProperty(example = "null", value = "Zero-based index of the initial row that the data source uses.")
  @JsonProperty("startRow")
  public String getStartRow() {
    return startRow;
  }
  public void setStartRow(String startRow) {
    this.startRow = startRow;
  }

  
  /**
   * Zero-based index of the last row that the data source uses
   **/
  public DataSourceTestStep endRow(String endRow) {
    this.endRow = endRow;
    return this;
  }
  
  @ApiModelProperty(example = "null", value = "Zero-based index of the last row that the data source uses")
  @JsonProperty("endRow")
  public String getEndRow() {
    return endRow;
  }
  public void setEndRow(String endRow) {
    this.endRow = endRow;
  }

  

  @Override
  public boolean equals(java.lang.Object o) {
    if (this == o) {
      return true;
    }
    if (o == null || getClass() != o.getClass()) {
      return false;
    }
    DataSourceTestStep dataSourceTestStep = (DataSourceTestStep) o;
    return Objects.equals(this.type, dataSourceTestStep.type) &&
        Objects.equals(this.name, dataSourceTestStep.name) &&
        Objects.equals(this.dataSource, dataSourceTestStep.dataSource) &&
        Objects.equals(this.testSteps, dataSourceTestStep.testSteps) &&
        Objects.equals(this.restartOnRun, dataSourceTestStep.restartOnRun) &&
        Objects.equals(this.preload, dataSourceTestStep.preload) &&
        Objects.equals(this.failOnEmpty, dataSourceTestStep.failOnEmpty) &&
        Objects.equals(this.skipLoopOnEmpty, dataSourceTestStep.skipLoopOnEmpty) &&
        Objects.equals(this.trimValues, dataSourceTestStep.trimValues) &&
        Objects.equals(this.entitizeValues, dataSourceTestStep.entitizeValues) &&
        Objects.equals(this.expandProperties, dataSourceTestStep.expandProperties) &&
        Objects.equals(this.shared, dataSourceTestStep.shared) &&
        Objects.equals(this.restartShared, dataSourceTestStep.restartShared) &&
        Objects.equals(this.startRow, dataSourceTestStep.startRow) &&
        Objects.equals(this.endRow, dataSourceTestStep.endRow) &&
        super.equals(o);
  }

  @Override
  public int hashCode() {
    return Objects.hash(type, name, dataSource, testSteps, restartOnRun, preload, failOnEmpty, skipLoopOnEmpty, trimValues, entitizeValues, expandProperties, shared, restartShared, startRow, endRow, super.hashCode());
  }

  @Override
  public String toString() {
    StringBuilder sb = new StringBuilder();
    sb.append("class DataSourceTestStep {\n");
    sb.append("    ").append(toIndentedString(super.toString())).append("\n");
    sb.append("    type: ").append(toIndentedString(type)).append("\n");
    sb.append("    name: ").append(toIndentedString(name)).append("\n");
    sb.append("    dataSource: ").append(toIndentedString(dataSource)).append("\n");
    sb.append("    testSteps: ").append(toIndentedString(testSteps)).append("\n");
    sb.append("    restartOnRun: ").append(toIndentedString(restartOnRun)).append("\n");
    sb.append("    preload: ").append(toIndentedString(preload)).append("\n");
    sb.append("    failOnEmpty: ").append(toIndentedString(failOnEmpty)).append("\n");
    sb.append("    skipLoopOnEmpty: ").append(toIndentedString(skipLoopOnEmpty)).append("\n");
    sb.append("    trimValues: ").append(toIndentedString(trimValues)).append("\n");
    sb.append("    entitizeValues: ").append(toIndentedString(entitizeValues)).append("\n");
    sb.append("    expandProperties: ").append(toIndentedString(expandProperties)).append("\n");
    sb.append("    shared: ").append(toIndentedString(shared)).append("\n");
    sb.append("    restartShared: ").append(toIndentedString(restartShared)).append("\n");
    sb.append("    startRow: ").append(toIndentedString(startRow)).append("\n");
    sb.append("    endRow: ").append(toIndentedString(endRow)).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    ");
  }
}