com.factset.sdk.FactSetTrading.models.Instrument Maven / Gradle / Ivy

Go to download
/*
 * EMS API
 * Allow clients to trade orders.
 *
 * The version of the OpenAPI document: 1
 * 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.FactSetTrading.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.io.Serializable;
import com.fasterxml.jackson.annotation.JsonPropertyOrder;
import com.factset.sdk.FactSetTrading.JSON;


/**
 * Instrument
 */
@JsonPropertyOrder({
  Instrument.JSON_PROPERTY_SYMBOL,
  Instrument.JSON_PROPERTY_SECURITY_TYPE,
  Instrument.JSON_PROPERTY_CFI_CODE,
  Instrument.JSON_PROPERTY_SECURITY_EXCHANGE,
  Instrument.JSON_PROPERTY_ISSUER,
  Instrument.JSON_PROPERTY_SECURITY_DESCRIPTION,
  Instrument.JSON_PROPERTY_MATURITY_MONTH_YEAR,
  Instrument.JSON_PROPERTY_MATURITY_DAY
})
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen")
public class Instrument implements Serializable {
  private static final long serialVersionUID = 1L;

  public static final String JSON_PROPERTY_SYMBOL = "symbol";
  private String symbol;

  public static final String JSON_PROPERTY_SECURITY_TYPE = "securityType";
  private String securityType;

  public static final String JSON_PROPERTY_CFI_CODE = "cfiCode";
  private String cfiCode;

  public static final String JSON_PROPERTY_SECURITY_EXCHANGE = "securityExchange";
  private String securityExchange;

  public static final String JSON_PROPERTY_ISSUER = "issuer";
  private String issuer;

  public static final String JSON_PROPERTY_SECURITY_DESCRIPTION = "securityDescription";
  private String securityDescription;

  public static final String JSON_PROPERTY_MATURITY_MONTH_YEAR = "maturityMonthYear";
  private String maturityMonthYear;

  public static final String JSON_PROPERTY_MATURITY_DAY = "maturityDay";
  private String maturityDay;

  public Instrument() { 
  }

  @JsonCreator
  public Instrument(
    @JsonProperty(value=JSON_PROPERTY_SYMBOL, required=true) String symbol
  ) {
    this();
    this.symbol = symbol;
  }

  public Instrument symbol(String symbol) {
    this.symbol = symbol;
    return this;
  }

   /**
   * Symbol
   * @return symbol
  **/
  @javax.annotation.Nonnull
  @ApiModelProperty(example = "TATAMOTORS", required = true, value = "Symbol")
  @JsonProperty(JSON_PROPERTY_SYMBOL)
  @JsonInclude(value = JsonInclude.Include.ALWAYS)

  public String getSymbol() {
    return symbol;
  }


  @JsonProperty(JSON_PROPERTY_SYMBOL)
  @JsonInclude(value = JsonInclude.Include.ALWAYS)
  public void setSymbol(String symbol) {
    this.symbol = symbol;
  }


  public Instrument securityType(String securityType) {
    this.securityType = securityType;
    return this;
  }

   /**
   * Security Type
   * @return securityType
  **/
  @javax.annotation.Nullable
  @ApiModelProperty(value = "Security Type")
  @JsonProperty(JSON_PROPERTY_SECURITY_TYPE)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)

  public String getSecurityType() {
    return securityType;
  }


  @JsonProperty(JSON_PROPERTY_SECURITY_TYPE)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
  public void setSecurityType(String securityType) {
    this.securityType = securityType;
  }


  public Instrument cfiCode(String cfiCode) {
    this.cfiCode = cfiCode;
    return this;
  }

   /**
   * Cfi Code
   * @return cfiCode
  **/
  @javax.annotation.Nullable
  @ApiModelProperty(value = "Cfi Code")
  @JsonProperty(JSON_PROPERTY_CFI_CODE)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)

  public String getCfiCode() {
    return cfiCode;
  }


  @JsonProperty(JSON_PROPERTY_CFI_CODE)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
  public void setCfiCode(String cfiCode) {
    this.cfiCode = cfiCode;
  }


  public Instrument securityExchange(String securityExchange) {
    this.securityExchange = securityExchange;
    return this;
  }

   /**
   * Security exchange
   * @return securityExchange
  **/
  @javax.annotation.Nullable
  @ApiModelProperty(value = "Security exchange")
  @JsonProperty(JSON_PROPERTY_SECURITY_EXCHANGE)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)

  public String getSecurityExchange() {
    return securityExchange;
  }


  @JsonProperty(JSON_PROPERTY_SECURITY_EXCHANGE)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
  public void setSecurityExchange(String securityExchange) {
    this.securityExchange = securityExchange;
  }


  public Instrument issuer(String issuer) {
    this.issuer = issuer;
    return this;
  }

   /**
   * Issuer
   * @return issuer
  **/
  @javax.annotation.Nullable
  @ApiModelProperty(value = "Issuer")
  @JsonProperty(JSON_PROPERTY_ISSUER)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)

  public String getIssuer() {
    return issuer;
  }


  @JsonProperty(JSON_PROPERTY_ISSUER)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
  public void setIssuer(String issuer) {
    this.issuer = issuer;
  }


  public Instrument securityDescription(String securityDescription) {
    this.securityDescription = securityDescription;
    return this;
  }

   /**
   * Security Description
   * @return securityDescription
  **/
  @javax.annotation.Nullable
  @ApiModelProperty(value = "Security Description")
  @JsonProperty(JSON_PROPERTY_SECURITY_DESCRIPTION)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)

  public String getSecurityDescription() {
    return securityDescription;
  }


  @JsonProperty(JSON_PROPERTY_SECURITY_DESCRIPTION)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
  public void setSecurityDescription(String securityDescription) {
    this.securityDescription = securityDescription;
  }


  public Instrument maturityMonthYear(String maturityMonthYear) {
    this.maturityMonthYear = maturityMonthYear;
    return this;
  }

   /**
   * Maturity month year
   * @return maturityMonthYear
  **/
  @javax.annotation.Nullable
  @ApiModelProperty(value = "Maturity month year")
  @JsonProperty(JSON_PROPERTY_MATURITY_MONTH_YEAR)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)

  public String getMaturityMonthYear() {
    return maturityMonthYear;
  }


  @JsonProperty(JSON_PROPERTY_MATURITY_MONTH_YEAR)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
  public void setMaturityMonthYear(String maturityMonthYear) {
    this.maturityMonthYear = maturityMonthYear;
  }


  public Instrument maturityDay(String maturityDay) {
    this.maturityDay = maturityDay;
    return this;
  }

   /**
   * Maturity day
   * @return maturityDay
  **/
  @javax.annotation.Nullable
  @ApiModelProperty(value = "Maturity day")
  @JsonProperty(JSON_PROPERTY_MATURITY_DAY)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)

  public String getMaturityDay() {
    return maturityDay;
  }


  @JsonProperty(JSON_PROPERTY_MATURITY_DAY)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
  public void setMaturityDay(String maturityDay) {
    this.maturityDay = maturityDay;
  }


  /**
   * Return true if this Instrument object is equal to o.
   */
  @Override
  public boolean equals(Object o) {
    if (this == o) {
      return true;
    }
    if (o == null || getClass() != o.getClass()) {
      return false;
    }
    Instrument instrument = (Instrument) o;
    return Objects.equals(this.symbol, instrument.symbol) &&
        Objects.equals(this.securityType, instrument.securityType) &&
        Objects.equals(this.cfiCode, instrument.cfiCode) &&
        Objects.equals(this.securityExchange, instrument.securityExchange) &&
        Objects.equals(this.issuer, instrument.issuer) &&
        Objects.equals(this.securityDescription, instrument.securityDescription) &&
        Objects.equals(this.maturityMonthYear, instrument.maturityMonthYear) &&
        Objects.equals(this.maturityDay, instrument.maturityDay);
  }

  @Override
  public int hashCode() {
    return Objects.hash(symbol, securityType, cfiCode, securityExchange, issuer, securityDescription, maturityMonthYear, maturityDay);
  }

  @Override
  public String toString() {
    StringBuilder sb = new StringBuilder();
    sb.append("class Instrument {\n");
    sb.append("    symbol: ").append(toIndentedString(symbol)).append("\n");
    sb.append("    securityType: ").append(toIndentedString(securityType)).append("\n");
    sb.append("    cfiCode: ").append(toIndentedString(cfiCode)).append("\n");
    sb.append("    securityExchange: ").append(toIndentedString(securityExchange)).append("\n");
    sb.append("    issuer: ").append(toIndentedString(issuer)).append("\n");
    sb.append("    securityDescription: ").append(toIndentedString(securityDescription)).append("\n");
    sb.append("    maturityMonthYear: ").append(toIndentedString(maturityMonthYear)).append("\n");
    sb.append("    maturityDay: ").append(toIndentedString(maturityDay)).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    ");
  }

}