• Home
• com.factset.sdk
• factsetbenchmarks
• 0.20.0
• source code
• IndexSnapshot.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

com.factset.sdk.FactSetBenchmarks.models.IndexSnapshot Maven / Gradle / Ivy

/*
 * FactSet Benchmarks API
 * FactSet Benchmarks API gives access to Index Constituents, Prices, Returns, and Ratios. For a sample list of identifiers, use the /metrics endpoint. Equity Only - Fixed Income Benchmark support coming soon. 
 *
 * The version of the OpenAPI document: 1.5.0
 * 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.factset.sdk.FactSetBenchmarks.models;

import java.util.Objects;
import java.util.Arrays;
import java.util.Map;
import java.util.HashMap;
import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonTypeName;
import com.fasterxml.jackson.annotation.JsonValue;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import java.time.LocalDate;
import java.io.Serializable;
import com.fasterxml.jackson.annotation.JsonPropertyOrder;
import com.factset.sdk.FactSetBenchmarks.JSON;


/**
 * IndexSnapshot
 */
@JsonPropertyOrder({
  IndexSnapshot.JSON_PROPERTY_FSYM_ID,
  IndexSnapshot.JSON_PROPERTY_DATE,
  IndexSnapshot.JSON_PROPERTY_NAME,
  IndexSnapshot.JSON_PROPERTY_CONSTITUENT_NUMBER,
  IndexSnapshot.JSON_PROPERTY_CURRENCY,
  IndexSnapshot.JSON_PROPERTY_MARKET_VALUE,
  IndexSnapshot.JSON_PROPERTY_PRICE,
  IndexSnapshot.JSON_PROPERTY_PRICE_RETURN_PERCENT1_D,
  IndexSnapshot.JSON_PROPERTY_PRICE_RETURN_PERCENT_Q_T_D,
  IndexSnapshot.JSON_PROPERTY_PRICE_RETURN_PERCENT_Y_T_D,
  IndexSnapshot.JSON_PROPERTY_TOTAL_RETURN_LEVEL,
  IndexSnapshot.JSON_PROPERTY_TOTAL_RETURN_PERCENT1_D,
  IndexSnapshot.JSON_PROPERTY_TOTAL_RETURN_PERCENT_Q_T_D,
  IndexSnapshot.JSON_PROPERTY_TOTAL_RETURN_PERCENT_Y_T_D,
  IndexSnapshot.JSON_PROPERTY_RETURN_TYPE,
  IndexSnapshot.JSON_PROPERTY_REQUEST_ID
})
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen")
public class IndexSnapshot implements Serializable {
  private static final long serialVersionUID = 1L;

  public static final String JSON_PROPERTY_FSYM_ID = "fsymId";
  private String fsymId;

  public static final String JSON_PROPERTY_DATE = "date";
  private LocalDate date;

  public static final String JSON_PROPERTY_NAME = "name";
  private String name;

  public static final String JSON_PROPERTY_CONSTITUENT_NUMBER = "constituentNumber";
  private Integer constituentNumber;

  public static final String JSON_PROPERTY_CURRENCY = "currency";
  private String currency;

  public static final String JSON_PROPERTY_MARKET_VALUE = "marketValue";
  private Double marketValue;

  public static final String JSON_PROPERTY_PRICE = "price";
  private Double price;

  public static final String JSON_PROPERTY_PRICE_RETURN_PERCENT1_D = "priceReturnPercent1D";
  private Double priceReturnPercent1D;

  public static final String JSON_PROPERTY_PRICE_RETURN_PERCENT_Q_T_D = "priceReturnPercentQTD";
  private Double priceReturnPercentQTD;

  public static final String JSON_PROPERTY_PRICE_RETURN_PERCENT_Y_T_D = "priceReturnPercentYTD";
  private Double priceReturnPercentYTD;

  public static final String JSON_PROPERTY_TOTAL_RETURN_LEVEL = "totalReturnLevel";
  private Double totalReturnLevel;

  public static final String JSON_PROPERTY_TOTAL_RETURN_PERCENT1_D = "totalReturnPercent1D";
  private Double totalReturnPercent1D;

  public static final String JSON_PROPERTY_TOTAL_RETURN_PERCENT_Q_T_D = "totalReturnPercentQTD";
  private Double totalReturnPercentQTD;

  public static final String JSON_PROPERTY_TOTAL_RETURN_PERCENT_Y_T_D = "totalReturnPercentYTD";
  private Double totalReturnPercentYTD;

  public static final String JSON_PROPERTY_RETURN_TYPE = "returnType";
  private String returnType;

  public static final String JSON_PROPERTY_REQUEST_ID = "requestId";
  private String requestId;

  public IndexSnapshot() { 
  }

  public IndexSnapshot fsymId(String fsymId) {
    this.fsymId = fsymId;
    return this;
  }

   /**
   * Requested Identifier. Must be a valid Benchmark Identifier recognized by FactSet.
   * @return fsymId
  **/
  @javax.annotation.Nullable
  @ApiModelProperty(example = "SP50", value = "Requested Identifier. Must be a valid Benchmark Identifier recognized by FactSet.")
  @JsonProperty(JSON_PROPERTY_FSYM_ID)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)

  public String getFsymId() {
    return fsymId;
  }


  @JsonProperty(JSON_PROPERTY_FSYM_ID)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
  public void setFsymId(String fsymId) {
    this.fsymId = fsymId;
  }


  public IndexSnapshot date(LocalDate date) {
    this.date = date;
    return this;
  }

   /**
   * The respective date for values as of the date requested in YYYY-MM-DD format.
   * @return date
  **/
  @javax.annotation.Nullable
  @ApiModelProperty(example = "Wed Jul 01 00:00:00 UTC 2020", value = "The respective date for values as of the date requested in YYYY-MM-DD format.")
  @JsonProperty(JSON_PROPERTY_DATE)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)

  public LocalDate getDate() {
    return date;
  }


  @JsonProperty(JSON_PROPERTY_DATE)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
  public void setDate(LocalDate date) {
    this.date = date;
  }


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

   /**
   * Proper Name of Index.
   * @return name
  **/
  @javax.annotation.Nullable
  @ApiModelProperty(example = "S&P 500", value = "Proper Name of Index.")
  @JsonProperty(JSON_PROPERTY_NAME)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)

  public String getName() {
    return name;
  }


  @JsonProperty(JSON_PROPERTY_NAME)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
  public void setName(String name) {
    this.name = name;
  }


  public IndexSnapshot constituentNumber(Integer constituentNumber) {
    this.constituentNumber = constituentNumber;
    return this;
  }

   /**
   * The total number of constituents as of the date requested.
   * @return constituentNumber
  **/
  @javax.annotation.Nullable
  @ApiModelProperty(example = "502", value = "The total number of constituents as of the date requested.")
  @JsonProperty(JSON_PROPERTY_CONSTITUENT_NUMBER)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)

  public Integer getConstituentNumber() {
    return constituentNumber;
  }


  @JsonProperty(JSON_PROPERTY_CONSTITUENT_NUMBER)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
  public void setConstituentNumber(Integer constituentNumber) {
    this.constituentNumber = constituentNumber;
  }


  public IndexSnapshot currency(String currency) {
    this.currency = currency;
    return this;
  }

   /**
   * Currency Code used in adjustments. If no Currency was requested, the service will default to the local Calendar.
   * @return currency
  **/
  @javax.annotation.Nullable
  @ApiModelProperty(example = "USD", value = "Currency Code used in adjustments. If no Currency was requested, the service will default to the local Calendar.")
  @JsonProperty(JSON_PROPERTY_CURRENCY)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)

  public String getCurrency() {
    return currency;
  }


  @JsonProperty(JSON_PROPERTY_CURRENCY)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
  public void setCurrency(String currency) {
    this.currency = currency;
  }


  public IndexSnapshot marketValue(Double marketValue) {
    this.marketValue = marketValue;
    return this;
  }

   /**
   * Index Level Market Capitalization as of the date requested expressed in millions.
   * @return marketValue
  **/
  @javax.annotation.Nullable
  @ApiModelProperty(example = "27696158.012077", value = "Index Level Market Capitalization as of the date requested expressed in millions.")
  @JsonProperty(JSON_PROPERTY_MARKET_VALUE)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)

  public Double getMarketValue() {
    return marketValue;
  }


  @JsonProperty(JSON_PROPERTY_MARKET_VALUE)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
  public void setMarketValue(Double marketValue) {
    this.marketValue = marketValue;
  }


  public IndexSnapshot price(Double price) {
    this.price = price;
    return this;
  }

   /**
   * Index Level Price
   * @return price
  **/
  @javax.annotation.Nullable
  @ApiModelProperty(example = "3349.15600690205", value = "Index Level Price")
  @JsonProperty(JSON_PROPERTY_PRICE)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)

  public Double getPrice() {
    return price;
  }


  @JsonProperty(JSON_PROPERTY_PRICE)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
  public void setPrice(Double price) {
    this.price = price;
  }


  public IndexSnapshot priceReturnPercent1D(Double priceReturnPercent1D) {
    this.priceReturnPercent1D = priceReturnPercent1D;
    return this;
  }

   /**
   * Index Level Price - 1 Day percent change
   * @return priceReturnPercent1D
  **/
  @javax.annotation.Nullable
  @ApiModelProperty(example = "0.642620385795123", value = "Index Level Price - 1 Day percent change")
  @JsonProperty(JSON_PROPERTY_PRICE_RETURN_PERCENT1_D)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)

  public Double getPriceReturnPercent1D() {
    return priceReturnPercent1D;
  }


  @JsonProperty(JSON_PROPERTY_PRICE_RETURN_PERCENT1_D)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
  public void setPriceReturnPercent1D(Double priceReturnPercent1D) {
    this.priceReturnPercent1D = priceReturnPercent1D;
  }


  public IndexSnapshot priceReturnPercentQTD(Double priceReturnPercentQTD) {
    this.priceReturnPercentQTD = priceReturnPercentQTD;
    return this;
  }

   /**
   * Index Level Price - Quarter-to-Date percent change
   * @return priceReturnPercentQTD
  **/
  @javax.annotation.Nullable
  @ApiModelProperty(example = "8.02735451465131", value = "Index Level Price - Quarter-to-Date percent change")
  @JsonProperty(JSON_PROPERTY_PRICE_RETURN_PERCENT_Q_T_D)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)

  public Double getPriceReturnPercentQTD() {
    return priceReturnPercentQTD;
  }


  @JsonProperty(JSON_PROPERTY_PRICE_RETURN_PERCENT_Q_T_D)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
  public void setPriceReturnPercentQTD(Double priceReturnPercentQTD) {
    this.priceReturnPercentQTD = priceReturnPercentQTD;
  }


  public IndexSnapshot priceReturnPercentYTD(Double priceReturnPercentYTD) {
    this.priceReturnPercentYTD = priceReturnPercentYTD;
    return this;
  }

   /**
   * Index Level Price - Year-to-Date percent change
   * @return priceReturnPercentYTD
  **/
  @javax.annotation.Nullable
  @ApiModelProperty(example = "3.66394447660916", value = "Index Level Price - Year-to-Date percent change")
  @JsonProperty(JSON_PROPERTY_PRICE_RETURN_PERCENT_Y_T_D)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)

  public Double getPriceReturnPercentYTD() {
    return priceReturnPercentYTD;
  }


  @JsonProperty(JSON_PROPERTY_PRICE_RETURN_PERCENT_Y_T_D)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
  public void setPriceReturnPercentYTD(Double priceReturnPercentYTD) {
    this.priceReturnPercentYTD = priceReturnPercentYTD;
  }


  public IndexSnapshot totalReturnLevel(Double totalReturnLevel) {
    this.totalReturnLevel = totalReturnLevel;
    return this;
  }

   /**
   * Index Level Total Return Amount. (Gross or Net depends on requested returnType)
   * @return totalReturnLevel
  **/
  @javax.annotation.Nullable
  @ApiModelProperty(example = "6870.86168040129", value = "Index Level Total Return Amount. (Gross or Net depends on requested returnType)")
  @JsonProperty(JSON_PROPERTY_TOTAL_RETURN_LEVEL)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)

  public Double getTotalReturnLevel() {
    return totalReturnLevel;
  }


  @JsonProperty(JSON_PROPERTY_TOTAL_RETURN_LEVEL)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
  public void setTotalReturnLevel(Double totalReturnLevel) {
    this.totalReturnLevel = totalReturnLevel;
  }


  public IndexSnapshot totalReturnPercent1D(Double totalReturnPercent1D) {
    this.totalReturnPercent1D = totalReturnPercent1D;
    return this;
  }

   /**
   * Index Level Total Return - 1 Day percent change. (Gross or Net depends on requested returnType)
   * @return totalReturnPercent1D
  **/
  @javax.annotation.Nullable
  @ApiModelProperty(example = "0.653957589855003", value = "Index Level Total Return - 1 Day percent change. (Gross or Net depends on requested returnType)")
  @JsonProperty(JSON_PROPERTY_TOTAL_RETURN_PERCENT1_D)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)

  public Double getTotalReturnPercent1D() {
    return totalReturnPercent1D;
  }


  @JsonProperty(JSON_PROPERTY_TOTAL_RETURN_PERCENT1_D)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
  public void setTotalReturnPercent1D(Double totalReturnPercent1D) {
    this.totalReturnPercent1D = totalReturnPercent1D;
  }


  public IndexSnapshot totalReturnPercentQTD(Double totalReturnPercentQTD) {
    this.totalReturnPercentQTD = totalReturnPercentQTD;
    return this;
  }

   /**
   * Index Level Total Return - Quarter-to-Date percent change. (Gross or Net depends on requested returnType)
   * @return totalReturnPercentQTD
  **/
  @javax.annotation.Nullable
  @ApiModelProperty(example = "8.17415047623613", value = "Index Level Total Return - Quarter-to-Date percent change. (Gross or Net depends on requested returnType)")
  @JsonProperty(JSON_PROPERTY_TOTAL_RETURN_PERCENT_Q_T_D)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)

  public Double getTotalReturnPercentQTD() {
    return totalReturnPercentQTD;
  }


  @JsonProperty(JSON_PROPERTY_TOTAL_RETURN_PERCENT_Q_T_D)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
  public void setTotalReturnPercentQTD(Double totalReturnPercentQTD) {
    this.totalReturnPercentQTD = totalReturnPercentQTD;
  }


  public IndexSnapshot totalReturnPercentYTD(Double totalReturnPercentYTD) {
    this.totalReturnPercentYTD = totalReturnPercentYTD;
    return this;
  }

   /**
   * Index Level Total Return - Year-to-Date percent change. (Gross or Net depends on requested returnType)
   * @return totalReturnPercentYTD
  **/
  @javax.annotation.Nullable
  @ApiModelProperty(example = "4.84152796547426", value = "Index Level Total Return - Year-to-Date percent change. (Gross or Net depends on requested returnType)")
  @JsonProperty(JSON_PROPERTY_TOTAL_RETURN_PERCENT_Y_T_D)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)

  public Double getTotalReturnPercentYTD() {
    return totalReturnPercentYTD;
  }


  @JsonProperty(JSON_PROPERTY_TOTAL_RETURN_PERCENT_Y_T_D)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
  public void setTotalReturnPercentYTD(Double totalReturnPercentYTD) {
    this.totalReturnPercentYTD = totalReturnPercentYTD;
  }


  public IndexSnapshot returnType(String returnType) {
    this.returnType = returnType;
    return this;
  }

   /**
   * The requested Return Type - GROSS or NET
   * @return returnType
  **/
  @javax.annotation.Nullable
  @ApiModelProperty(example = "GROSS", value = "The requested Return Type - GROSS or NET")
  @JsonProperty(JSON_PROPERTY_RETURN_TYPE)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)

  public String getReturnType() {
    return returnType;
  }


  @JsonProperty(JSON_PROPERTY_RETURN_TYPE)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
  public void setReturnType(String returnType) {
    this.returnType = returnType;
  }


  public IndexSnapshot requestId(String requestId) {
    this.requestId = requestId;
    return this;
  }

   /**
   * Benchmark Identifier specified in the request
   * @return requestId
  **/
  @javax.annotation.Nullable
  @ApiModelProperty(example = "SP50", value = "Benchmark Identifier specified in the request")
  @JsonProperty(JSON_PROPERTY_REQUEST_ID)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)

  public String getRequestId() {
    return requestId;
  }


  @JsonProperty(JSON_PROPERTY_REQUEST_ID)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
  public void setRequestId(String requestId) {
    this.requestId = requestId;
  }


  /**
   * Return true if this indexSnapshot object is equal to o.
   */
  @Override
  public boolean equals(Object o) {
    if (this == o) {
      return true;
    }
    if (o == null || getClass() != o.getClass()) {
      return false;
    }
    IndexSnapshot indexSnapshot = (IndexSnapshot) o;
    return Objects.equals(this.fsymId, indexSnapshot.fsymId) &&
        Objects.equals(this.date, indexSnapshot.date) &&
        Objects.equals(this.name, indexSnapshot.name) &&
        Objects.equals(this.constituentNumber, indexSnapshot.constituentNumber) &&
        Objects.equals(this.currency, indexSnapshot.currency) &&
        Objects.equals(this.marketValue, indexSnapshot.marketValue) &&
        Objects.equals(this.price, indexSnapshot.price) &&
        Objects.equals(this.priceReturnPercent1D, indexSnapshot.priceReturnPercent1D) &&
        Objects.equals(this.priceReturnPercentQTD, indexSnapshot.priceReturnPercentQTD) &&
        Objects.equals(this.priceReturnPercentYTD, indexSnapshot.priceReturnPercentYTD) &&
        Objects.equals(this.totalReturnLevel, indexSnapshot.totalReturnLevel) &&
        Objects.equals(this.totalReturnPercent1D, indexSnapshot.totalReturnPercent1D) &&
        Objects.equals(this.totalReturnPercentQTD, indexSnapshot.totalReturnPercentQTD) &&
        Objects.equals(this.totalReturnPercentYTD, indexSnapshot.totalReturnPercentYTD) &&
        Objects.equals(this.returnType, indexSnapshot.returnType) &&
        Objects.equals(this.requestId, indexSnapshot.requestId);
  }

  @Override
  public int hashCode() {
    return Objects.hash(fsymId, date, name, constituentNumber, currency, marketValue, price, priceReturnPercent1D, priceReturnPercentQTD, priceReturnPercentYTD, totalReturnLevel, totalReturnPercent1D, totalReturnPercentQTD, totalReturnPercentYTD, returnType, requestId);
  }

  @Override
  public String toString() {
    StringBuilder sb = new StringBuilder();
    sb.append("class IndexSnapshot {\n");
    sb.append("    fsymId: ").append(toIndentedString(fsymId)).append("\n");
    sb.append("    date: ").append(toIndentedString(date)).append("\n");
    sb.append("    name: ").append(toIndentedString(name)).append("\n");
    sb.append("    constituentNumber: ").append(toIndentedString(constituentNumber)).append("\n");
    sb.append("    currency: ").append(toIndentedString(currency)).append("\n");
    sb.append("    marketValue: ").append(toIndentedString(marketValue)).append("\n");
    sb.append("    price: ").append(toIndentedString(price)).append("\n");
    sb.append("    priceReturnPercent1D: ").append(toIndentedString(priceReturnPercent1D)).append("\n");
    sb.append("    priceReturnPercentQTD: ").append(toIndentedString(priceReturnPercentQTD)).append("\n");
    sb.append("    priceReturnPercentYTD: ").append(toIndentedString(priceReturnPercentYTD)).append("\n");
    sb.append("    totalReturnLevel: ").append(toIndentedString(totalReturnLevel)).append("\n");
    sb.append("    totalReturnPercent1D: ").append(toIndentedString(totalReturnPercent1D)).append("\n");
    sb.append("    totalReturnPercentQTD: ").append(toIndentedString(totalReturnPercentQTD)).append("\n");
    sb.append("    totalReturnPercentYTD: ").append(toIndentedString(totalReturnPercentYTD)).append("\n");
    sb.append("    returnType: ").append(toIndentedString(returnType)).append("\n");
    sb.append("    requestId: ").append(toIndentedString(requestId)).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    ");
  }

}