com.factset.sdk.FactSetFunds.models.Aum Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of factsetfunds Show documentation
Show all versions of factsetfunds Show documentation
FactSet SDK for Java - factsetfunds
/*
* FactSet Funds API
* FactSet Mutual Funds data offers over 50 fund- and share class-specific data points for mutual funds listed in the United States. FactSet Mutual Funds Reference provides fund-specific reference information as well as FactSet's proprietary classification system. It includes but is not limited to the following coverage * Fund descriptions * A seven-tier classification system * Leverage information * Fees and expenses * Portfolio managers FactSet Mutual Funds Time Series provides quantitative data items on a historical basis. It includes but is not limited to the following coverage * Net asset value * Fund flows * Assets under management * Total return
This API is rate-limited to 10 requests per second and 10 concurrent requests per user.
*
* The version of the OpenAPI document: 1.1.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.FactSetFunds.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 org.openapitools.jackson.nullable.JsonNullable;
import com.fasterxml.jackson.annotation.JsonIgnore;
import org.openapitools.jackson.nullable.JsonNullable;
import java.util.NoSuchElementException;
import java.io.Serializable;
import com.fasterxml.jackson.annotation.JsonPropertyOrder;
import com.factset.sdk.FactSetFunds.JSON;
/**
* Aum
*/
@JsonPropertyOrder({
Aum.JSON_PROPERTY_FSYM_ID,
Aum.JSON_PROPERTY_FUND_LEVEL_A_U_M,
Aum.JSON_PROPERTY_SHR_CLASS_A_U_M_RPT,
Aum.JSON_PROPERTY_SHR_CLASS_A_U_M_ACT,
Aum.JSON_PROPERTY_CURRENCY,
Aum.JSON_PROPERTY_DATE,
Aum.JSON_PROPERTY_REQUEST_ID
})
@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen")
public class Aum implements Serializable {
private static final long serialVersionUID = 1L;
public static final String JSON_PROPERTY_FSYM_ID = "fsymId";
private JsonNullable fsymId = JsonNullable.undefined();
public static final String JSON_PROPERTY_FUND_LEVEL_A_U_M = "fundLevelAUM";
private JsonNullable fundLevelAUM = JsonNullable.undefined();
public static final String JSON_PROPERTY_SHR_CLASS_A_U_M_RPT = "shrClassAUMRpt";
private JsonNullable shrClassAUMRpt = JsonNullable.undefined();
public static final String JSON_PROPERTY_SHR_CLASS_A_U_M_ACT = "shrClassAUMAct";
private JsonNullable shrClassAUMAct = JsonNullable.undefined();
public static final String JSON_PROPERTY_CURRENCY = "currency";
private JsonNullable currency = JsonNullable.undefined();
public static final String JSON_PROPERTY_DATE = "date";
private JsonNullable date = JsonNullable.undefined();
public static final String JSON_PROPERTY_REQUEST_ID = "requestId";
private String requestId;
public Aum() {
}
public Aum fsymId(String fsymId) {
this.fsymId = JsonNullable.of(fsymId);
return this;
}
/**
* FactSet Security Identifier. Six alpha-numeric characters, excluding vowels, with a -S suffix (XXXXXX-S), resolved from the requestId of the Fund requested.
* @return fsymId
**/
@jakarta.annotation.Nullable
@ApiModelProperty(example = "FNK7XP-S", value = "FactSet Security Identifier. Six alpha-numeric characters, excluding vowels, with a -S suffix (XXXXXX-S), resolved from the requestId of the Fund requested.")
@JsonIgnore
public String getFsymId() {
return fsymId.orElse(null);
}
@JsonProperty(JSON_PROPERTY_FSYM_ID)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public JsonNullable getFsymId_JsonNullable() {
return fsymId;
}
@JsonProperty(JSON_PROPERTY_FSYM_ID)
public void setFsymId_JsonNullable(JsonNullable fsymId) {
this.fsymId = fsymId;
}
public void setFsymId(String fsymId) {
this.fsymId = JsonNullable.of(fsymId);
}
public Aum fundLevelAUM(Double fundLevelAUM) {
this.fundLevelAUM = JsonNullable.of(fundLevelAUM);
return this;
}
/**
* Returns fund-level Assets Under Management (AUM) data. Fund-level AUM is the sum of the market values of the positions in the fund's portfolio. This represents all share classes.
* @return fundLevelAUM
**/
@jakarta.annotation.Nullable
@ApiModelProperty(example = "1908934757.1935", value = "Returns fund-level Assets Under Management (AUM) data. Fund-level AUM is the sum of the market values of the positions in the fund's portfolio. This represents all share classes.")
@JsonIgnore
public Double getFundLevelAUM() {
return fundLevelAUM.orElse(null);
}
@JsonProperty(JSON_PROPERTY_FUND_LEVEL_A_U_M)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public JsonNullable getFundLevelAUM_JsonNullable() {
return fundLevelAUM;
}
@JsonProperty(JSON_PROPERTY_FUND_LEVEL_A_U_M)
public void setFundLevelAUM_JsonNullable(JsonNullable fundLevelAUM) {
this.fundLevelAUM = fundLevelAUM;
}
public void setFundLevelAUM(Double fundLevelAUM) {
this.fundLevelAUM = JsonNullable.of(fundLevelAUM);
}
public Aum shrClassAUMRpt(Double shrClassAUMRpt) {
this.shrClassAUMRpt = JsonNullable.of(shrClassAUMRpt);
return this;
}
/**
* As-Reported AUM. Calculated by using shares outstanding at previous close multiplied by NAV at previous close. This is typically the value seen on fund websites. As Reported AUM = (Shares Outstanding t0 * NAV t0).
* @return shrClassAUMRpt
**/
@jakarta.annotation.Nullable
@ApiModelProperty(example = "902354605.39548", value = "As-Reported AUM. Calculated by using shares outstanding at previous close multiplied by NAV at previous close. This is typically the value seen on fund websites. As Reported AUM = (Shares Outstanding t0 * NAV t0).")
@JsonIgnore
public Double getShrClassAUMRpt() {
return shrClassAUMRpt.orElse(null);
}
@JsonProperty(JSON_PROPERTY_SHR_CLASS_A_U_M_RPT)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public JsonNullable getShrClassAUMRpt_JsonNullable() {
return shrClassAUMRpt;
}
@JsonProperty(JSON_PROPERTY_SHR_CLASS_A_U_M_RPT)
public void setShrClassAUMRpt_JsonNullable(JsonNullable shrClassAUMRpt) {
this.shrClassAUMRpt = shrClassAUMRpt;
}
public void setShrClassAUMRpt(Double shrClassAUMRpt) {
this.shrClassAUMRpt = JsonNullable.of(shrClassAUMRpt);
}
public Aum shrClassAUMAct(Double shrClassAUMAct) {
this.shrClassAUMAct = JsonNullable.of(shrClassAUMAct);
return this;
}
/**
* Actual AUM. Calculated by using shares outstanding at previous close multiplied by NAV of one day prior to close. This is the value used in calculating fund flows. Actual AUM = (Shares Outstanding t0 * NAV t-1)
* @return shrClassAUMAct
**/
@jakarta.annotation.Nullable
@ApiModelProperty(example = "914573047.89582", value = "Actual AUM. Calculated by using shares outstanding at previous close multiplied by NAV of one day prior to close. This is the value used in calculating fund flows. Actual AUM = (Shares Outstanding t0 * NAV t-1)")
@JsonIgnore
public Double getShrClassAUMAct() {
return shrClassAUMAct.orElse(null);
}
@JsonProperty(JSON_PROPERTY_SHR_CLASS_A_U_M_ACT)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public JsonNullable getShrClassAUMAct_JsonNullable() {
return shrClassAUMAct;
}
@JsonProperty(JSON_PROPERTY_SHR_CLASS_A_U_M_ACT)
public void setShrClassAUMAct_JsonNullable(JsonNullable shrClassAUMAct) {
this.shrClassAUMAct = shrClassAUMAct;
}
public void setShrClassAUMAct(Double shrClassAUMAct) {
this.shrClassAUMAct = JsonNullable.of(shrClassAUMAct);
}
public Aum currency(String currency) {
this.currency = JsonNullable.of(currency);
return this;
}
/**
* The Currency of the AUM values. By default it will be in the FUnds Currency, unless otherwise requested via the currency parameter.
* @return currency
**/
@jakarta.annotation.Nullable
@ApiModelProperty(example = "USD", value = "The Currency of the AUM values. By default it will be in the FUnds Currency, unless otherwise requested via the currency parameter.")
@JsonIgnore
public String getCurrency() {
return currency.orElse(null);
}
@JsonProperty(JSON_PROPERTY_CURRENCY)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public JsonNullable getCurrency_JsonNullable() {
return currency;
}
@JsonProperty(JSON_PROPERTY_CURRENCY)
public void setCurrency_JsonNullable(JsonNullable currency) {
this.currency = currency;
}
public void setCurrency(String currency) {
this.currency = JsonNullable.of(currency);
}
public Aum date(LocalDate date) {
this.date = JsonNullable.of(date);
return this;
}
/**
* The date of the AUM in YYYY-MM-DD format.
* @return date
**/
@jakarta.annotation.Nullable
@ApiModelProperty(example = "Sun Feb 28 00:00:00 UTC 2021", value = "The date of the AUM in YYYY-MM-DD format.")
@JsonIgnore
public LocalDate getDate() {
return date.orElse(null);
}
@JsonProperty(JSON_PROPERTY_DATE)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public JsonNullable getDate_JsonNullable() {
return date;
}
@JsonProperty(JSON_PROPERTY_DATE)
public void setDate_JsonNullable(JsonNullable date) {
this.date = date;
}
public void setDate(LocalDate date) {
this.date = JsonNullable.of(date);
}
public Aum requestId(String requestId) {
this.requestId = requestId;
return this;
}
/**
* The requested Id sent as input.
* @return requestId
**/
@jakarta.annotation.Nullable
@ApiModelProperty(example = "MABAX", value = "The requested Id sent as input.")
@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 aum object is equal to o.
*/
@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
Aum aum = (Aum) o;
return equalsNullable(this.fsymId, aum.fsymId) &&
equalsNullable(this.fundLevelAUM, aum.fundLevelAUM) &&
equalsNullable(this.shrClassAUMRpt, aum.shrClassAUMRpt) &&
equalsNullable(this.shrClassAUMAct, aum.shrClassAUMAct) &&
equalsNullable(this.currency, aum.currency) &&
equalsNullable(this.date, aum.date) &&
Objects.equals(this.requestId, aum.requestId);
}
private static boolean equalsNullable(JsonNullable a, JsonNullable b) {
return a == b || (a != null && b != null && a.isPresent() && b.isPresent() && Objects.deepEquals(a.get(), b.get()));
}
@Override
public int hashCode() {
return Objects.hash(hashCodeNullable(fsymId), hashCodeNullable(fundLevelAUM), hashCodeNullable(shrClassAUMRpt), hashCodeNullable(shrClassAUMAct), hashCodeNullable(currency), hashCodeNullable(date), requestId);
}
private static int hashCodeNullable(JsonNullable a) {
if (a == null) {
return 1;
}
return a.isPresent() ? Arrays.deepHashCode(new Object[]{a.get()}) : 31;
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class Aum {\n");
sb.append(" fsymId: ").append(toIndentedString(fsymId)).append("\n");
sb.append(" fundLevelAUM: ").append(toIndentedString(fundLevelAUM)).append("\n");
sb.append(" shrClassAUMRpt: ").append(toIndentedString(shrClassAUMRpt)).append("\n");
sb.append(" shrClassAUMAct: ").append(toIndentedString(shrClassAUMAct)).append("\n");
sb.append(" currency: ").append(toIndentedString(currency)).append("\n");
sb.append(" date: ").append(toIndentedString(date)).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 ");
}
}