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

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

There is a newer version: 66.0.0-v202407310200
Show newest version
/*
 * Seeq REST API
 * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
 *
 * OpenAPI spec version: 60.1.3-v202304250417
 * 
 *
 * 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 com.seeq.model.ExportItemV1;
import io.swagger.v3.oas.annotations.media.Schema;
import java.util.ArrayList;
import java.util.List;
/**
 * ExportItemsV1
 */
public class ExportItemsV1 {
  @JsonProperty("autoupdateTimeRange")
  private Boolean autoupdateTimeRange = false;

  @JsonProperty("capsuleTime")
  private Boolean capsuleTime = false;

  @JsonProperty("chainView")
  private Boolean chainView = false;

  @JsonProperty("exportCapsules")
  private Boolean exportCapsules = false;

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

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

  @JsonProperty("gridEnabled")
  private Boolean gridEnabled = true;

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

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

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

  @JsonProperty("originalTimestampsEnabled")
  private Boolean originalTimestampsEnabled = false;

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

  @JsonProperty("statisticsEnabled")
  private Boolean statisticsEnabled = true;

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

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

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

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

  public ExportItemsV1 autoupdateTimeRange(Boolean autoupdateTimeRange) {
    this.autoupdateTimeRange = autoupdateTimeRange;
    return this;
  }

   /**
   * Boolean indicating if the time range for export should be updated to 'now' when the export is started.
   * @return autoupdateTimeRange
  **/
  @Schema(description = "Boolean indicating if the time range for export should be updated to 'now' when the export is started.")
  public Boolean getAutoupdateTimeRange() {
    return autoupdateTimeRange;
  }

  public void setAutoupdateTimeRange(Boolean autoupdateTimeRange) {
    this.autoupdateTimeRange = autoupdateTimeRange;
  }

  public ExportItemsV1 capsuleTime(Boolean capsuleTime) {
    this.capsuleTime = capsuleTime;
    return this;
  }

   /**
   * True if capsule time is displayed, false otherwise.
   * @return capsuleTime
  **/
  @Schema(description = "True if capsule time is displayed, false otherwise.")
  public Boolean getCapsuleTime() {
    return capsuleTime;
  }

  public void setCapsuleTime(Boolean capsuleTime) {
    this.capsuleTime = capsuleTime;
  }

  public ExportItemsV1 chainView(Boolean chainView) {
    this.chainView = chainView;
    return this;
  }

   /**
   * True if capsule time is displayed, false otherwise.
   * @return chainView
  **/
  @Schema(description = "True if capsule time is displayed, false otherwise.")
  public Boolean getChainView() {
    return chainView;
  }

  public void setChainView(Boolean chainView) {
    this.chainView = chainView;
  }

  public ExportItemsV1 exportCapsules(Boolean exportCapsules) {
    this.exportCapsules = exportCapsules;
    return this;
  }

   /**
   * True if the capsule table should be exported, false otherwise.
   * @return exportCapsules
  **/
  @Schema(description = "True if the capsule table should be exported, false otherwise.")
  public Boolean getExportCapsules() {
    return exportCapsules;
  }

  public void setExportCapsules(Boolean exportCapsules) {
    this.exportCapsules = exportCapsules;
  }

  public ExportItemsV1 exportName(String exportName) {
    this.exportName = exportName;
    return this;
  }

   /**
   * The desired name for the export. This name is used to create an OData endpoint for accessing the data being exported.
   * @return exportName
  **/
  @Schema(required = true, description = "The desired name for the export. This name is used to create an OData endpoint for accessing the data being exported.")
  public String getExportName() {
    return exportName;
  }

  public void setExportName(String exportName) {
    this.exportName = exportName;
  }

  public ExportItemsV1 format(String format) {
    this.format = format;
    return this;
  }

   /**
   * The desired export output format. Currently only 'xlsx' and 'odata' are supported.
   * @return format
  **/
  @Schema(required = true, description = "The desired export output format. Currently only 'xlsx' and 'odata' are supported.")
  public String getFormat() {
    return format;
  }

  public void setFormat(String format) {
    this.format = format;
  }

  public ExportItemsV1 gridEnabled(Boolean gridEnabled) {
    this.gridEnabled = gridEnabled;
    return this;
  }

   /**
   * Boolean indicating whether the data grid should be included.
   * @return gridEnabled
  **/
  @Schema(description = "Boolean indicating whether the data grid should be included.")
  public Boolean getGridEnabled() {
    return gridEnabled;
  }

  public void setGridEnabled(Boolean gridEnabled) {
    this.gridEnabled = gridEnabled;
  }

  public ExportItemsV1 gridOrigin(String gridOrigin) {
    this.gridOrigin = gridOrigin;
    return this;
  }

   /**
   * The origin timestamp for gridding. If not specified, the origin generally defaults to basic time alignment conventions. See the resample() operator's documentation for full details.
   * @return gridOrigin
  **/
  @Schema(description = "The origin timestamp for gridding. If not specified, the origin generally defaults to basic time alignment conventions. See the resample() operator's documentation for full details.")
  public String getGridOrigin() {
    return gridOrigin;
  }

  public void setGridOrigin(String gridOrigin) {
    this.gridOrigin = gridOrigin;
  }

  public ExportItemsV1 gridSize(String gridSize) {
    this.gridSize = gridSize;
    return this;
  }

   /**
   * The desired sample period for the export. An automatic grid size is used when gridSize is set to 'false'.
   * @return gridSize
  **/
  @Schema(description = "The desired sample period for the export. An automatic grid size is used when gridSize is set to 'false'.")
  public String getGridSize() {
    return gridSize;
  }

  public void setGridSize(String gridSize) {
    this.gridSize = gridSize;
  }

  public ExportItemsV1 items(List items) {
    this.items = items;
    return this;
  }

  public ExportItemsV1 addItemsItem(ExportItemV1 itemsItem) {
    this.items.add(itemsItem);
    return this;
  }

   /**
   * A list of Series and Capsules to be exported
   * @return items
  **/
  @Schema(required = true, description = "A list of Series and Capsules to be exported")
  public List getItems() {
    return items;
  }

  public void setItems(List items) {
    this.items = items;
  }

  public ExportItemsV1 originalTimestampsEnabled(Boolean originalTimestampsEnabled) {
    this.originalTimestampsEnabled = originalTimestampsEnabled;
    return this;
  }

   /**
   * True if the original sample period should be used. A manual or automatic grid size may be used when false.
   * @return originalTimestampsEnabled
  **/
  @Schema(description = "True if the original sample period should be used. A manual or automatic grid size may be used when false.")
  public Boolean getOriginalTimestampsEnabled() {
    return originalTimestampsEnabled;
  }

  public void setOriginalTimestampsEnabled(Boolean originalTimestampsEnabled) {
    this.originalTimestampsEnabled = originalTimestampsEnabled;
  }

  public ExportItemsV1 scopedTo(String scopedTo) {
    this.scopedTo = scopedTo;
    return this;
  }

   /**
   * The ID of the workbook to which this item will be scoped. Only valid for OData exports. If not provided, the export will have global scope.
   * @return scopedTo
  **/
  @Schema(description = "The ID of the workbook to which this item will be scoped. Only valid for OData exports. If not provided, the export will have global scope.")
  public String getScopedTo() {
    return scopedTo;
  }

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

  public ExportItemsV1 statisticsEnabled(Boolean statisticsEnabled) {
    this.statisticsEnabled = statisticsEnabled;
    return this;
  }

   /**
   * Boolean indicating whether the summary statistics should be included. This flag only applies to Excel exports.
   * @return statisticsEnabled
  **/
  @Schema(description = "Boolean indicating whether the summary statistics should be included. This flag only applies to Excel exports.")
  public Boolean getStatisticsEnabled() {
    return statisticsEnabled;
  }

  public void setStatisticsEnabled(Boolean statisticsEnabled) {
    this.statisticsEnabled = statisticsEnabled;
  }

  public ExportItemsV1 swapIn(String swapIn) {
    this.swapIn = swapIn;
    return this;
  }

   /**
   * The ID of an asset to swap in. Any parameters in the formula that are named the same in both the swapIn and swapOut assets will be swapped.
   * @return swapIn
  **/
  @Schema(description = "The ID of an asset to swap in. Any parameters in the formula that are named the same in both the swapIn and swapOut assets will be swapped.")
  public String getSwapIn() {
    return swapIn;
  }

  public void setSwapIn(String swapIn) {
    this.swapIn = swapIn;
  }

  public ExportItemsV1 swapOut(String swapOut) {
    this.swapOut = swapOut;
    return this;
  }

   /**
   * The ID of an asset to swap out. Any parameters in the formula that are named the same in both the swapIn and swapOut assets will be swapped.
   * @return swapOut
  **/
  @Schema(description = "The ID of an asset to swap out. Any parameters in the formula that are named the same in both the swapIn and swapOut assets will be swapped.")
  public String getSwapOut() {
    return swapOut;
  }

  public void setSwapOut(String swapOut) {
    this.swapOut = swapOut;
  }

  public ExportItemsV1 timeZone(String timeZone) {
    this.timeZone = timeZone;
    return this;
  }

   /**
   * The time zone for all timestamps in this export. If not specified, the server's timezone will be used.
   * @return timeZone
  **/
  @Schema(description = "The time zone for all timestamps in this export. If not specified, the server's timezone will be used.")
  public String getTimeZone() {
    return timeZone;
  }

  public void setTimeZone(String timeZone) {
    this.timeZone = timeZone;
  }

  public ExportItemsV1 worksheetLink(String worksheetLink) {
    this.worksheetLink = worksheetLink;
    return this;
  }

   /**
   * The worksheet link of the workbook to be added to the export.
   * @return worksheetLink
  **/
  @Schema(description = "The worksheet link of the workbook to be added to the export.")
  public String getWorksheetLink() {
    return worksheetLink;
  }

  public void setWorksheetLink(String worksheetLink) {
    this.worksheetLink = worksheetLink;
  }


  @Override
  public boolean equals(java.lang.Object o) {
    if (this == o) {
      return true;
    }
    if (o == null || getClass() != o.getClass()) {
      return false;
    }
    ExportItemsV1 exportItemsV1 = (ExportItemsV1) o;
    return Objects.equals(this.autoupdateTimeRange, exportItemsV1.autoupdateTimeRange) &&
        Objects.equals(this.capsuleTime, exportItemsV1.capsuleTime) &&
        Objects.equals(this.chainView, exportItemsV1.chainView) &&
        Objects.equals(this.exportCapsules, exportItemsV1.exportCapsules) &&
        Objects.equals(this.exportName, exportItemsV1.exportName) &&
        Objects.equals(this.format, exportItemsV1.format) &&
        Objects.equals(this.gridEnabled, exportItemsV1.gridEnabled) &&
        Objects.equals(this.gridOrigin, exportItemsV1.gridOrigin) &&
        Objects.equals(this.gridSize, exportItemsV1.gridSize) &&
        Objects.equals(this.items, exportItemsV1.items) &&
        Objects.equals(this.originalTimestampsEnabled, exportItemsV1.originalTimestampsEnabled) &&
        Objects.equals(this.scopedTo, exportItemsV1.scopedTo) &&
        Objects.equals(this.statisticsEnabled, exportItemsV1.statisticsEnabled) &&
        Objects.equals(this.swapIn, exportItemsV1.swapIn) &&
        Objects.equals(this.swapOut, exportItemsV1.swapOut) &&
        Objects.equals(this.timeZone, exportItemsV1.timeZone) &&
        Objects.equals(this.worksheetLink, exportItemsV1.worksheetLink);
  }

  @Override
  public int hashCode() {
    return Objects.hash(autoupdateTimeRange, capsuleTime, chainView, exportCapsules, exportName, format, gridEnabled, gridOrigin, gridSize, items, originalTimestampsEnabled, scopedTo, statisticsEnabled, swapIn, swapOut, timeZone, worksheetLink);
  }


  @Override
  public String toString() {
    StringBuilder sb = new StringBuilder();
    sb.append("class ExportItemsV1 {\n");
    
    sb.append("    autoupdateTimeRange: ").append(toIndentedString(autoupdateTimeRange)).append("\n");
    sb.append("    capsuleTime: ").append(toIndentedString(capsuleTime)).append("\n");
    sb.append("    chainView: ").append(toIndentedString(chainView)).append("\n");
    sb.append("    exportCapsules: ").append(toIndentedString(exportCapsules)).append("\n");
    sb.append("    exportName: ").append(toIndentedString(exportName)).append("\n");
    sb.append("    format: ").append(toIndentedString(format)).append("\n");
    sb.append("    gridEnabled: ").append(toIndentedString(gridEnabled)).append("\n");
    sb.append("    gridOrigin: ").append(toIndentedString(gridOrigin)).append("\n");
    sb.append("    gridSize: ").append(toIndentedString(gridSize)).append("\n");
    sb.append("    items: ").append(toIndentedString(items)).append("\n");
    sb.append("    originalTimestampsEnabled: ").append(toIndentedString(originalTimestampsEnabled)).append("\n");
    sb.append("    scopedTo: ").append(toIndentedString(scopedTo)).append("\n");
    sb.append("    statisticsEnabled: ").append(toIndentedString(statisticsEnabled)).append("\n");
    sb.append("    swapIn: ").append(toIndentedString(swapIn)).append("\n");
    sb.append("    swapOut: ").append(toIndentedString(swapOut)).append("\n");
    sb.append("    timeZone: ").append(toIndentedString(timeZone)).append("\n");
    sb.append("    worksheetLink: ").append(toIndentedString(worksheetLink)).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