org.openapitools.client.model

Class EmissionsForecastDTO

java.lang.Object

org.openapitools.client.model.EmissionsForecastDTO

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2024-12-11T00:56:28.222220Z[Etc/UTC]",
           comments="Generator version: 7.10.0")
public class EmissionsForecastDTO
extends Object

EmissionsForecastDTO

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EmissionsForecastDTO.CustomTypeAdapterFactory

Field Summary

Fields

Modifier and Type	Field and Description
static HashSet<String>	openapiFields
static HashSet<String>	openapiRequiredFields
static String	SERIALIZED_NAME_DATA_END_AT
static String	SERIALIZED_NAME_DATA_START_AT
static String	SERIALIZED_NAME_FORECAST_DATA
static String	SERIALIZED_NAME_GENERATED_AT
static String	SERIALIZED_NAME_LOCATION
static String	SERIALIZED_NAME_OPTIMAL_DATA_POINTS
static String	SERIALIZED_NAME_REQUESTED_AT
static String	SERIALIZED_NAME_WINDOW_SIZE

Constructor Summary

Constructors

Constructor and Description
EmissionsForecastDTO()

Method Summary

Modifier and Type	Method and Description
EmissionsForecastDTO	addForecastDataItem(EmissionsDataDTO forecastDataItem)
EmissionsForecastDTO	addOptimalDataPointsItem(EmissionsDataDTO optimalDataPointsItem)
EmissionsForecastDTO	dataEndAt(OffsetDateTime dataEndAt)
EmissionsForecastDTO	dataStartAt(OffsetDateTime dataStartAt)
boolean	equals(Object o)
EmissionsForecastDTO	forecastData(List<EmissionsDataDTO> forecastData)
static EmissionsForecastDTO	fromJson(String jsonString) Create an instance of EmissionsForecastDTO given an JSON string
EmissionsForecastDTO	generatedAt(OffsetDateTime generatedAt)
OffsetDateTime	getDataEndAt() End time boundary of forecasted data points.
OffsetDateTime	getDataStartAt() Start time boundary of forecasted data points.
List<EmissionsDataDTO>	getForecastData() The forecasted data points transformed and filtered to reflect the specified time and window parameters.
OffsetDateTime	getGeneratedAt() Timestamp when the forecast was generated.
String	getLocation() The location of the forecast
List<EmissionsDataDTO>	getOptimalDataPoints() The optimal forecasted data point within the 'forecastData' array.
OffsetDateTime	getRequestedAt() For current requests, this value is the timestamp the request for forecast data was made.
Integer	getWindowSize() The estimated duration (in minutes) of the workload.
int	hashCode()
EmissionsForecastDTO	location(String location)
EmissionsForecastDTO	optimalDataPoints(List<EmissionsDataDTO> optimalDataPoints)
EmissionsForecastDTO	requestedAt(OffsetDateTime requestedAt)
void	setDataEndAt(OffsetDateTime dataEndAt)
void	setDataStartAt(OffsetDateTime dataStartAt)
void	setForecastData(List<EmissionsDataDTO> forecastData)
void	setGeneratedAt(OffsetDateTime generatedAt)
void	setLocation(String location)
void	setOptimalDataPoints(List<EmissionsDataDTO> optimalDataPoints)
void	setRequestedAt(OffsetDateTime requestedAt)
void	setWindowSize(Integer windowSize)
String	toJson() Convert an instance of EmissionsForecastDTO to an JSON string
String	toString()
static void	validateJsonElement(com.google.gson.JsonElement jsonElement) Validates the JSON Element and throws an exception if issues found
EmissionsForecastDTO	windowSize(Integer windowSize)

Methods inherited from class java.lang.Object

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

Field Detail

SERIALIZED_NAME_GENERATED_AT

public static final String SERIALIZED_NAME_GENERATED_AT

See Also:

Constant Field Values

SERIALIZED_NAME_REQUESTED_AT

public static final String SERIALIZED_NAME_REQUESTED_AT

See Also:

Constant Field Values

SERIALIZED_NAME_LOCATION

public static final String SERIALIZED_NAME_LOCATION

See Also:

Constant Field Values

SERIALIZED_NAME_DATA_START_AT

public static final String SERIALIZED_NAME_DATA_START_AT

See Also:

Constant Field Values

SERIALIZED_NAME_DATA_END_AT

public static final String SERIALIZED_NAME_DATA_END_AT

See Also:

Constant Field Values

SERIALIZED_NAME_WINDOW_SIZE

public static final String SERIALIZED_NAME_WINDOW_SIZE

See Also:

Constant Field Values

SERIALIZED_NAME_OPTIMAL_DATA_POINTS

public static final String SERIALIZED_NAME_OPTIMAL_DATA_POINTS

See Also:

Constant Field Values

SERIALIZED_NAME_FORECAST_DATA

public static final String SERIALIZED_NAME_FORECAST_DATA

See Also:

Constant Field Values

openapiFields

public static HashSet<String> openapiFields

openapiRequiredFields

public static HashSet<String> openapiRequiredFields

Constructor Detail

EmissionsForecastDTO

public EmissionsForecastDTO()

Method Detail

generatedAt

public EmissionsForecastDTO generatedAt(@Nullable
                                        OffsetDateTime generatedAt)

getGeneratedAt

@Nullable
public OffsetDateTime getGeneratedAt()

Timestamp when the forecast was generated.

Returns:

generatedAt

setGeneratedAt

public void setGeneratedAt(@Nullable
                           OffsetDateTime generatedAt)

requestedAt

public EmissionsForecastDTO requestedAt(@Nullable
                                        OffsetDateTime requestedAt)

getRequestedAt

@Nullable
public OffsetDateTime getRequestedAt()

For current requests, this value is the timestamp the request for forecast data was made. For historical forecast requests, this value is the timestamp used to access the most recently generated forecast as of that time.

Returns:

requestedAt

setRequestedAt

public void setRequestedAt(@Nullable
                           OffsetDateTime requestedAt)

location

public EmissionsForecastDTO location(@Nullable
                                     String location)

getLocation

@Nullable
public String getLocation()

The location of the forecast

Returns:

location

setLocation

public void setLocation(@Nullable
                        String location)

dataStartAt

public EmissionsForecastDTO dataStartAt(@Nullable
                                        OffsetDateTime dataStartAt)

getDataStartAt

@Nullable
public OffsetDateTime getDataStartAt()

Start time boundary of forecasted data points. Ignores forecast data points before this time. Defaults to the earliest time in the forecast data.

Returns:

dataStartAt

setDataStartAt

public void setDataStartAt(@Nullable
                           OffsetDateTime dataStartAt)

dataEndAt

public EmissionsForecastDTO dataEndAt(@Nullable
                                      OffsetDateTime dataEndAt)

getDataEndAt

@Nullable
public OffsetDateTime getDataEndAt()

End time boundary of forecasted data points. Ignores forecast data points after this time. Defaults to the latest time in the forecast data.

Returns:

dataEndAt

setDataEndAt

public void setDataEndAt(@Nullable
                         OffsetDateTime dataEndAt)

windowSize

public EmissionsForecastDTO windowSize(@Nullable
                                       Integer windowSize)

getWindowSize

@Nullable
public Integer getWindowSize()

The estimated duration (in minutes) of the workload. Defaults to the duration of a single forecast data point.

Returns:

windowSize

setWindowSize

public void setWindowSize(@Nullable
                          Integer windowSize)

optimalDataPoints

public EmissionsForecastDTO optimalDataPoints(@Nullable
                                              List<EmissionsDataDTO> optimalDataPoints)

addOptimalDataPointsItem

public EmissionsForecastDTO addOptimalDataPointsItem(EmissionsDataDTO optimalDataPointsItem)

getOptimalDataPoints

@Nullable
public List<EmissionsDataDTO> getOptimalDataPoints()

The optimal forecasted data point within the 'forecastData' array. Null if 'forecastData' array is empty.

Returns:

optimalDataPoints

setOptimalDataPoints

public void setOptimalDataPoints(@Nullable
                                 List<EmissionsDataDTO> optimalDataPoints)

forecastData

public EmissionsForecastDTO forecastData(@Nullable
                                         List<EmissionsDataDTO> forecastData)

addForecastDataItem

public EmissionsForecastDTO addForecastDataItem(EmissionsDataDTO forecastDataItem)

getForecastData

@Nullable
public List<EmissionsDataDTO> getForecastData()

The forecasted data points transformed and filtered to reflect the specified time and window parameters. Points are ordered chronologically; Empty array if all data points were filtered out. E.G. dataStartAt and dataEndAt times outside the forecast period; windowSize greater than total duration of forecast data;

Returns:

forecastData

setForecastData

public void setForecastData(@Nullable
                            List<EmissionsDataDTO> forecastData)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

validateJsonElement

public static void validateJsonElement(com.google.gson.JsonElement jsonElement)
                                throws IOException

Validates the JSON Element and throws an exception if issues found

Parameters:

jsonElement - JSON Element

Throws:

IOException - if the JSON Element is invalid with respect to EmissionsForecastDTO

fromJson

public static EmissionsForecastDTO fromJson(String jsonString)
                                     throws IOException

Create an instance of EmissionsForecastDTO given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of EmissionsForecastDTO

Throws:

IOException - if the JSON string is invalid with respect to EmissionsForecastDTO

toJson

public String toJson()

Convert an instance of EmissionsForecastDTO to an JSON string

Returns:

JSON string