Package markets.alpaca.client.broker.sse

Record Class BrokerSseDateOptions

java.lang.Object

java.lang.Record

markets.alpaca.client.broker.sse.BrokerSseDateOptions

public record BrokerSseDateOptions(LocalDate since, LocalDate until, String sinceId, String untilId)
extends Record

Optional LocalDate-based filters for Broker SSE endpoints.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	BrokerSseDateOptions.Builder

Constructor Summary

Constructors

Constructor	Description
BrokerSseDateOptions(LocalDate since, LocalDate until, String sinceId, String untilId)	Creates an instance of a BrokerSseDateOptions record class.

Method Summary

Modifier and Type	Method	Description
static BrokerSseDateOptions.Builder	builder()
static BrokerSseDateOptions	empty()
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
LocalDate	since()	Returns the value of the since record component.
String	sinceId()	Returns the value of the sinceId record component.
final String	toString()	Returns a string representation of this record class.
LocalDate	until()	Returns the value of the until record component.
String	untilId()	Returns the value of the untilId record component.

Methods inherited from class java.lang.Object

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

Constructor Details

BrokerSseDateOptions

public BrokerSseDateOptions(LocalDate since,
 LocalDate until,
 String sinceId,
 String untilId)

Creates an instance of a BrokerSseDateOptions record class.

Parameters:

since - the value for the since record component

until - the value for the until record component

sinceId - the value for the sinceId record component

untilId - the value for the untilId record component

Method Details

empty

public static BrokerSseDateOptions empty()

builder

public static BrokerSseDateOptions.Builder builder()

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.

since

public LocalDate since()

Returns the value of the since record component.

Returns:

the value of the since record component

until

public LocalDate until()

Returns the value of the until record component.

Returns:

the value of the until record component

sinceId

public String sinceId()

Returns the value of the sinceId record component.

Returns:

the value of the sinceId record component

untilId

public String untilId()

Returns the value of the untilId record component.

Returns:

the value of the untilId record component