com.factset.sdk.FactSetFunds.models.BenchmarkDetails Maven / Gradle / Ivy
Show all versions of factsetfunds Show documentation
/*
* 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
*
* The version of the OpenAPI document: 1.0.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.io.Serializable;
import com.fasterxml.jackson.annotation.JsonPropertyOrder;
import com.factset.sdk.FactSetFunds.JSON;
/**
* BenchmarkDetails
*/
@JsonPropertyOrder({
BenchmarkDetails.JSON_PROPERTY_FSYM_ID,
BenchmarkDetails.JSON_PROPERTY_BENCHMARK_ID,
BenchmarkDetails.JSON_PROPERTY_BENCHMARK_NAME,
BenchmarkDetails.JSON_PROPERTY_MULTIPLE_BENCHMARK_FLAG,
BenchmarkDetails.JSON_PROPERTY_BENCHMARK_CHANGE_DATE,
BenchmarkDetails.JSON_PROPERTY_SEGMENT,
BenchmarkDetails.JSON_PROPERTY_SEGMENT_BENCHMARK_ID,
BenchmarkDetails.JSON_PROPERTY_SEGMENT_BENCHMARK_NAME,
BenchmarkDetails.JSON_PROPERTY_SEGMENT_BENCHMARK_CURRENCY,
BenchmarkDetails.JSON_PROPERTY_SEGMENT_BENCHMARK_RETURN_TYPE,
BenchmarkDetails.JSON_PROPERTY_REQUEST_ID
})
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen")
public class BenchmarkDetails 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_BENCHMARK_ID = "benchmarkId";
private String benchmarkId;
public static final String JSON_PROPERTY_BENCHMARK_NAME = "benchmarkName";
private String benchmarkName;
public static final String JSON_PROPERTY_MULTIPLE_BENCHMARK_FLAG = "multipleBenchmarkFlag";
private String multipleBenchmarkFlag;
public static final String JSON_PROPERTY_BENCHMARK_CHANGE_DATE = "benchmarkChangeDate";
private String benchmarkChangeDate;
public static final String JSON_PROPERTY_SEGMENT = "segment";
private String segment;
public static final String JSON_PROPERTY_SEGMENT_BENCHMARK_ID = "segmentBenchmarkId";
private String segmentBenchmarkId;
public static final String JSON_PROPERTY_SEGMENT_BENCHMARK_NAME = "segmentBenchmarkName";
private String segmentBenchmarkName;
public static final String JSON_PROPERTY_SEGMENT_BENCHMARK_CURRENCY = "segmentBenchmarkCurrency";
private String segmentBenchmarkCurrency;
public static final String JSON_PROPERTY_SEGMENT_BENCHMARK_RETURN_TYPE = "segmentBenchmarkReturnType";
private String segmentBenchmarkReturnType;
public static final String JSON_PROPERTY_REQUEST_ID = "requestId";
private String requestId;
public BenchmarkDetails() {
}
public BenchmarkDetails fsymId(String fsymId) {
this.fsymId = 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
**/
@javax.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.")
@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 BenchmarkDetails benchmarkId(String benchmarkId) {
this.benchmarkId = benchmarkId;
return this;
}
/**
* The Fund's primary Benchmark Identifier.
* @return benchmarkId
**/
@javax.annotation.Nullable
@ApiModelProperty(example = "R.1000", value = "The Fund's primary Benchmark Identifier.")
@JsonProperty(JSON_PROPERTY_BENCHMARK_ID)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public String getBenchmarkId() {
return benchmarkId;
}
@JsonProperty(JSON_PROPERTY_BENCHMARK_ID)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setBenchmarkId(String benchmarkId) {
this.benchmarkId = benchmarkId;
}
public BenchmarkDetails benchmarkName(String benchmarkName) {
this.benchmarkName = benchmarkName;
return this;
}
/**
* The proper name of the Benchmark Id.
* @return benchmarkName
**/
@javax.annotation.Nullable
@ApiModelProperty(example = "Russell 1000 Index", value = "The proper name of the Benchmark Id.")
@JsonProperty(JSON_PROPERTY_BENCHMARK_NAME)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public String getBenchmarkName() {
return benchmarkName;
}
@JsonProperty(JSON_PROPERTY_BENCHMARK_NAME)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setBenchmarkName(String benchmarkName) {
this.benchmarkName = benchmarkName;
}
public BenchmarkDetails multipleBenchmarkFlag(String multipleBenchmarkFlag) {
this.multipleBenchmarkFlag = multipleBenchmarkFlag;
return this;
}
/**
* Indicates if the Fund has a composite benchmark.
* @return multipleBenchmarkFlag
**/
@javax.annotation.Nullable
@ApiModelProperty(example = "Non-Composite", value = "Indicates if the Fund has a composite benchmark.")
@JsonProperty(JSON_PROPERTY_MULTIPLE_BENCHMARK_FLAG)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public String getMultipleBenchmarkFlag() {
return multipleBenchmarkFlag;
}
@JsonProperty(JSON_PROPERTY_MULTIPLE_BENCHMARK_FLAG)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setMultipleBenchmarkFlag(String multipleBenchmarkFlag) {
this.multipleBenchmarkFlag = multipleBenchmarkFlag;
}
public BenchmarkDetails benchmarkChangeDate(String benchmarkChangeDate) {
this.benchmarkChangeDate = benchmarkChangeDate;
return this;
}
/**
* The date in which the benchmark changed for the requested fund in YYYY-MM-DD. If no benchmark changes occurred, the response value will be null.
* @return benchmarkChangeDate
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "The date in which the benchmark changed for the requested fund in YYYY-MM-DD. If no benchmark changes occurred, the response value will be null.")
@JsonProperty(JSON_PROPERTY_BENCHMARK_CHANGE_DATE)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public String getBenchmarkChangeDate() {
return benchmarkChangeDate;
}
@JsonProperty(JSON_PROPERTY_BENCHMARK_CHANGE_DATE)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setBenchmarkChangeDate(String benchmarkChangeDate) {
this.benchmarkChangeDate = benchmarkChangeDate;
}
public BenchmarkDetails segment(String segment) {
this.segment = segment;
return this;
}
/**
* The segment of the respective segment benchmark id.
* @return segment
**/
@javax.annotation.Nullable
@ApiModelProperty(example = "Equity: U.S. - Total Market Value", value = "The segment of the respective segment benchmark id.")
@JsonProperty(JSON_PROPERTY_SEGMENT)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public String getSegment() {
return segment;
}
@JsonProperty(JSON_PROPERTY_SEGMENT)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setSegment(String segment) {
this.segment = segment;
}
public BenchmarkDetails segmentBenchmarkId(String segmentBenchmarkId) {
this.segmentBenchmarkId = segmentBenchmarkId;
return this;
}
/**
* Segment Benchmark Identifier. Funds in the same segment match on all seven levels of FactSet's fund classification system.
* @return segmentBenchmarkId
**/
@javax.annotation.Nullable
@ApiModelProperty(example = "MS664292", value = "Segment Benchmark Identifier. Funds in the same segment match on all seven levels of FactSet's fund classification system.")
@JsonProperty(JSON_PROPERTY_SEGMENT_BENCHMARK_ID)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public String getSegmentBenchmarkId() {
return segmentBenchmarkId;
}
@JsonProperty(JSON_PROPERTY_SEGMENT_BENCHMARK_ID)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setSegmentBenchmarkId(String segmentBenchmarkId) {
this.segmentBenchmarkId = segmentBenchmarkId;
}
public BenchmarkDetails segmentBenchmarkName(String segmentBenchmarkName) {
this.segmentBenchmarkName = segmentBenchmarkName;
return this;
}
/**
* The segment benchmark's name in proper format. Funds in the same segment match on all seven levels of FactSet's fund classification system.
* @return segmentBenchmarkName
**/
@javax.annotation.Nullable
@ApiModelProperty(example = "MSCI USA IMI Value Index", value = "The segment benchmark's name in proper format. Funds in the same segment match on all seven levels of FactSet's fund classification system.")
@JsonProperty(JSON_PROPERTY_SEGMENT_BENCHMARK_NAME)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public String getSegmentBenchmarkName() {
return segmentBenchmarkName;
}
@JsonProperty(JSON_PROPERTY_SEGMENT_BENCHMARK_NAME)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setSegmentBenchmarkName(String segmentBenchmarkName) {
this.segmentBenchmarkName = segmentBenchmarkName;
}
public BenchmarkDetails segmentBenchmarkCurrency(String segmentBenchmarkCurrency) {
this.segmentBenchmarkCurrency = segmentBenchmarkCurrency;
return this;
}
/**
* The Segment Benchmark's currency in ISO3. Funds in the same segment match on all seven levels of FactSet's fund classification system.
* @return segmentBenchmarkCurrency
**/
@javax.annotation.Nullable
@ApiModelProperty(example = "USD", value = "The Segment Benchmark's currency in ISO3. Funds in the same segment match on all seven levels of FactSet's fund classification system.")
@JsonProperty(JSON_PROPERTY_SEGMENT_BENCHMARK_CURRENCY)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public String getSegmentBenchmarkCurrency() {
return segmentBenchmarkCurrency;
}
@JsonProperty(JSON_PROPERTY_SEGMENT_BENCHMARK_CURRENCY)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setSegmentBenchmarkCurrency(String segmentBenchmarkCurrency) {
this.segmentBenchmarkCurrency = segmentBenchmarkCurrency;
}
public BenchmarkDetails segmentBenchmarkReturnType(String segmentBenchmarkReturnType) {
this.segmentBenchmarkReturnType = segmentBenchmarkReturnType;
return this;
}
/**
* The Segment benchmarks return type. Funds in the same segment match on all seven levels of FactSet's fund classification system.
* @return segmentBenchmarkReturnType
**/
@javax.annotation.Nullable
@ApiModelProperty(example = "GROSS_RETURN", value = "The Segment benchmarks return type. Funds in the same segment match on all seven levels of FactSet's fund classification system.")
@JsonProperty(JSON_PROPERTY_SEGMENT_BENCHMARK_RETURN_TYPE)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public String getSegmentBenchmarkReturnType() {
return segmentBenchmarkReturnType;
}
@JsonProperty(JSON_PROPERTY_SEGMENT_BENCHMARK_RETURN_TYPE)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setSegmentBenchmarkReturnType(String segmentBenchmarkReturnType) {
this.segmentBenchmarkReturnType = segmentBenchmarkReturnType;
}
public BenchmarkDetails requestId(String requestId) {
this.requestId = requestId;
return this;
}
/**
* The requested Id sent as input.
* @return requestId
**/
@javax.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 benchmarkDetails object is equal to o.
*/
@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
BenchmarkDetails benchmarkDetails = (BenchmarkDetails) o;
return Objects.equals(this.fsymId, benchmarkDetails.fsymId) &&
Objects.equals(this.benchmarkId, benchmarkDetails.benchmarkId) &&
Objects.equals(this.benchmarkName, benchmarkDetails.benchmarkName) &&
Objects.equals(this.multipleBenchmarkFlag, benchmarkDetails.multipleBenchmarkFlag) &&
Objects.equals(this.benchmarkChangeDate, benchmarkDetails.benchmarkChangeDate) &&
Objects.equals(this.segment, benchmarkDetails.segment) &&
Objects.equals(this.segmentBenchmarkId, benchmarkDetails.segmentBenchmarkId) &&
Objects.equals(this.segmentBenchmarkName, benchmarkDetails.segmentBenchmarkName) &&
Objects.equals(this.segmentBenchmarkCurrency, benchmarkDetails.segmentBenchmarkCurrency) &&
Objects.equals(this.segmentBenchmarkReturnType, benchmarkDetails.segmentBenchmarkReturnType) &&
Objects.equals(this.requestId, benchmarkDetails.requestId);
}
@Override
public int hashCode() {
return Objects.hash(fsymId, benchmarkId, benchmarkName, multipleBenchmarkFlag, benchmarkChangeDate, segment, segmentBenchmarkId, segmentBenchmarkName, segmentBenchmarkCurrency, segmentBenchmarkReturnType, requestId);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class BenchmarkDetails {\n");
sb.append(" fsymId: ").append(toIndentedString(fsymId)).append("\n");
sb.append(" benchmarkId: ").append(toIndentedString(benchmarkId)).append("\n");
sb.append(" benchmarkName: ").append(toIndentedString(benchmarkName)).append("\n");
sb.append(" multipleBenchmarkFlag: ").append(toIndentedString(multipleBenchmarkFlag)).append("\n");
sb.append(" benchmarkChangeDate: ").append(toIndentedString(benchmarkChangeDate)).append("\n");
sb.append(" segment: ").append(toIndentedString(segment)).append("\n");
sb.append(" segmentBenchmarkId: ").append(toIndentedString(segmentBenchmarkId)).append("\n");
sb.append(" segmentBenchmarkName: ").append(toIndentedString(segmentBenchmarkName)).append("\n");
sb.append(" segmentBenchmarkCurrency: ").append(toIndentedString(segmentBenchmarkCurrency)).append("\n");
sb.append(" segmentBenchmarkReturnType: ").append(toIndentedString(segmentBenchmarkReturnType)).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 ");
}
}