Record Class SymbolAnalysisRequest

java.lang.Object

java.lang.Record

com.bluebell.greenhouse.platform.models.api.dto.symbol.analysis.SymbolAnalysisRequest

Record Components:

symbolUid - optional symbol uid

symbolAliasUid - optional symbol alias uid

preferredDataSource - optional preferred data source code

timeInterval - required market time interval code

start - optional start date

end - optional end date

lookbackBars - optional lookback bars

asOf - optional end anchor date

sentimentBucketDays - optional sentiment bucketing interval

forwardHorizonBars - optional forward horizon bar counts

sigmaThresholds - optional sigma thresholds

strategyReferenceCodes - optional strategy reference codes

public record SymbolAnalysisRequest(String symbolUid, String symbolAliasUid, String preferredDataSource, String timeInterval, LocalDate start, LocalDate end, Integer lookbackBars, LocalDate asOf, Integer sentimentBucketDays, List<Integer> forwardHorizonBars, List<Double> sigmaThresholds, List<String> strategyReferenceCodes)
extends Record

Request payload for symbol analysis service workflows.

Version:

2.0.4

Author:

Stephen Prizio

Constructor Summary

Constructors

Constructor	Description
SymbolAnalysisRequest(String symbolUid, String symbolAliasUid, String preferredDataSource, String timeInterval, LocalDate start, LocalDate end, Integer lookbackBars, LocalDate asOf, Integer sentimentBucketDays, List<Integer> forwardHorizonBars, List<Double> sigmaThresholds, List<String> strategyReferenceCodes)	Creates an instance of a SymbolAnalysisRequest record class.

Method Summary

Modifier and Type	Method	Description
LocalDate	asOf()	Returns the value of the asOf record component.
LocalDate	end()	Returns the value of the end record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
List<Integer>	forwardHorizonBars()	Returns the value of the forwardHorizonBars record component.
static SymbolAnalysisRequest	from(SymbolAnalysisQueryParameters queryParameters)	Builds a SymbolAnalysisRequest from bound query parameters.
final int	hashCode()	Returns a hash code value for this object.
Integer	lookbackBars()	Returns the value of the lookbackBars record component.
String	preferredDataSource()	Returns the value of the preferredDataSource record component.
Integer	sentimentBucketDays()	Returns the value of the sentimentBucketDays record component.
List<Double>	sigmaThresholds()	Returns the value of the sigmaThresholds record component.
LocalDate	start()	Returns the value of the start record component.
List<String>	strategyReferenceCodes()	Returns the value of the strategyReferenceCodes record component.
String	symbolAliasUid()	Returns the value of the symbolAliasUid record component.
String	symbolUid()	Returns the value of the symbolUid record component.
String	timeInterval()	Returns the value of the timeInterval record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

SymbolAnalysisRequest

public SymbolAnalysisRequest(String symbolUid,
 String symbolAliasUid,
 String preferredDataSource,
 String timeInterval,
 LocalDate start,
 LocalDate end,
 Integer lookbackBars,
 LocalDate asOf,
 Integer sentimentBucketDays,
 List<Integer> forwardHorizonBars,
 List<Double> sigmaThresholds,
 List<String> strategyReferenceCodes)

Creates an instance of a SymbolAnalysisRequest record class.

Parameters:

symbolUid - the value for the symbolUid record component

symbolAliasUid - the value for the symbolAliasUid record component

preferredDataSource - the value for the preferredDataSource record component

timeInterval - the value for the timeInterval record component

start - the value for the start record component

end - the value for the end record component

lookbackBars - the value for the lookbackBars record component

asOf - the value for the asOf record component

sentimentBucketDays - the value for the sentimentBucketDays record component

forwardHorizonBars - the value for the forwardHorizonBars record component

sigmaThresholds - the value for the sigmaThresholds record component

strategyReferenceCodes - the value for the strategyReferenceCodes record component

Method Details

from

public static SymbolAnalysisRequest from(SymbolAnalysisQueryParameters queryParameters)

Builds a SymbolAnalysisRequest from bound query parameters.

Parameters:

queryParameters - SymbolAnalysisQueryParameters

Returns:

SymbolAnalysisRequest

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

symbolUid

public String symbolUid()

Returns the value of the symbolUid record component.

Returns:

the value of the symbolUid record component

symbolAliasUid

public String symbolAliasUid()

Returns the value of the symbolAliasUid record component.

Returns:

the value of the symbolAliasUid record component

preferredDataSource

public String preferredDataSource()

Returns the value of the preferredDataSource record component.

Returns:

the value of the preferredDataSource record component

timeInterval

public String timeInterval()

Returns the value of the timeInterval record component.

Returns:

the value of the timeInterval record component

start

public LocalDate start()

Returns the value of the start record component.

Returns:

the value of the start record component

end

public LocalDate end()

Returns the value of the end record component.

Returns:

the value of the end record component

lookbackBars

public Integer lookbackBars()

Returns the value of the lookbackBars record component.

Returns:

the value of the lookbackBars record component

asOf

public LocalDate asOf()

Returns the value of the asOf record component.

Returns:

the value of the asOf record component

sentimentBucketDays

public Integer sentimentBucketDays()

Returns the value of the sentimentBucketDays record component.

Returns:

the value of the sentimentBucketDays record component

forwardHorizonBars

public List<Integer> forwardHorizonBars()

Returns the value of the forwardHorizonBars record component.

Returns:

the value of the forwardHorizonBars record component

sigmaThresholds

public List<Double> sigmaThresholds()

Returns the value of the sigmaThresholds record component.

Returns:

the value of the sigmaThresholds record component

strategyReferenceCodes

public List<String> strategyReferenceCodes()

Returns the value of the strategyReferenceCodes record component.

Returns:

the value of the strategyReferenceCodes record component