org.openapitools.client.model

Class EmissionsForecastBatchParametersDTO

java.lang.Object

org.openapitools.client.model.EmissionsForecastBatchParametersDTO

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

EmissionsForecastBatchParametersDTO

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EmissionsForecastBatchParametersDTO.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_LOCATION
static String	SERIALIZED_NAME_REQUESTED_AT
static String	SERIALIZED_NAME_WINDOW_SIZE

Constructor Summary

Constructors

Constructor and Description
EmissionsForecastBatchParametersDTO()

Method Summary

Modifier and Type	Method and Description
EmissionsForecastBatchParametersDTO	dataEndAt(OffsetDateTime dataEndAt)
EmissionsForecastBatchParametersDTO	dataStartAt(OffsetDateTime dataStartAt)
boolean	equals(Object o)
static EmissionsForecastBatchParametersDTO	fromJson(String jsonString) Create an instance of EmissionsForecastBatchParametersDTO given an JSON string
OffsetDateTime	getDataEndAt() End time boundary of forecasted data points.
OffsetDateTime	getDataStartAt() Start time boundary of forecasted data points.Ignores current forecast data points before this time.
String	getLocation() The location of the forecast
OffsetDateTime	getRequestedAt() For historical forecast requests, this value is the timestamp used to access the most recently generated forecast as of that time.
Integer	getWindowSize() The estimated duration (in minutes) of the workload.
int	hashCode()
EmissionsForecastBatchParametersDTO	location(String location)
EmissionsForecastBatchParametersDTO	requestedAt(OffsetDateTime requestedAt)
void	setDataEndAt(OffsetDateTime dataEndAt)
void	setDataStartAt(OffsetDateTime dataStartAt)
void	setLocation(String location)
void	setRequestedAt(OffsetDateTime requestedAt)
void	setWindowSize(Integer windowSize)
String	toJson() Convert an instance of EmissionsForecastBatchParametersDTO 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
EmissionsForecastBatchParametersDTO	windowSize(Integer windowSize)

Methods inherited from class java.lang.Object

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

Field Detail

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

openapiFields

public static HashSet<String> openapiFields

openapiRequiredFields

public static HashSet<String> openapiRequiredFields

Constructor Detail

EmissionsForecastBatchParametersDTO

public EmissionsForecastBatchParametersDTO()

Method Detail

requestedAt

public EmissionsForecastBatchParametersDTO requestedAt(@Nullable
                                                       OffsetDateTime requestedAt)

getRequestedAt

@Nullable
public OffsetDateTime getRequestedAt()

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 EmissionsForecastBatchParametersDTO 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 EmissionsForecastBatchParametersDTO dataStartAt(@Nullable
                                                       OffsetDateTime dataStartAt)

getDataStartAt

@Nullable
public OffsetDateTime getDataStartAt()

Start time boundary of forecasted data points.Ignores current 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 EmissionsForecastBatchParametersDTO dataEndAt(@Nullable
                                                     OffsetDateTime dataEndAt)

getDataEndAt

@Nullable
public OffsetDateTime getDataEndAt()

End time boundary of forecasted data points. Ignores current 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 EmissionsForecastBatchParametersDTO 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)

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 EmissionsForecastBatchParametersDTO

fromJson

public static EmissionsForecastBatchParametersDTO fromJson(String jsonString)
                                                    throws IOException

Create an instance of EmissionsForecastBatchParametersDTO given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of EmissionsForecastBatchParametersDTO

Throws:

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

toJson

public String toJson()

Convert an instance of EmissionsForecastBatchParametersDTO to an JSON string

Returns:

JSON string