Package markets.alpaca.client.rest

Record Class AlpacaApiResponse<T>

java.lang.Object

java.lang.Record

markets.alpaca.client.rest.AlpacaApiResponse<T>

Record Components:

body - deserialized response body; may be null for endpoints with no response body

statusCode - HTTP status code returned by the server

headers - HTTP response headers

public record AlpacaApiResponse<T>(T body, int statusCode, Map<String,List<String>> headers)
extends Record

Result metadata for a generated REST API call completed through AlpacaFutures.

Constructor Summary

Constructors

Constructor	Description
AlpacaApiResponse(T body, int statusCode, Map<String,List<String>> headers)	Creates an instance of a AlpacaApiResponse record class.

Method Summary

Modifier and Type	Method	Description
T	body()	Returns the value of the body record component.
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.
Map<String,List<String>>	headers()	HTTP response headers.
int	statusCode()	Returns the value of the statusCode record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

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

Constructor Details

AlpacaApiResponse

public AlpacaApiResponse(T body,
 int statusCode,
 Map<String,List<String>> headers)

Creates an instance of a AlpacaApiResponse record class.

Parameters:

body - the value for the body record component

statusCode - the value for the statusCode record component

headers - the value for the headers record component

Method Details

headers

public Map<String,List<String>> headers()

HTTP response headers.

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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.

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.

body

public T body()

Returns the value of the body record component.

Returns:

the value of the body record component

statusCode

public int statusCode()

Returns the value of the statusCode record component.

Returns:

the value of the statusCode record component