ch.rasc.darksky.model

Interface DsTimeMachineRequest

@Value.Immutable
public interface DsTimeMachineRequest

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	DsTimeMachineRequest.Builder

Method Summary

Modifier and Type	Method and Description
static DsTimeMachineRequest.Builder	builder()
Set<DsBlock>	excludeBlocks() Exclude some number of data blocks from the API response.
Set<DsBlock>	includeBlocks() Include some number of data blocks in the API response.
DsLanguage	language() Return summary properties in the desired language.
String	latitude() The latitude of a location (in decimal degrees).
String	longitude() The longitude of a location (in decimal degrees).
long	time() UNIX time (that is, seconds since midnight GMT on 1 Jan 1970).
DsUnit	unit() Return weather conditions in the requested units.

Method Detail

latitude

String latitude()

The latitude of a location (in decimal degrees). Positive is north, negative is south.

longitude

String longitude()

The longitude of a location (in decimal degrees). Positive is east, negative is west.

time

long time()

UNIX time (that is, seconds since midnight GMT on 1 Jan 1970).

language

@Nullable
DsLanguage language()

Return summary properties in the desired language. (Note that units in the summary will be set according to the unit() parameter, so be sure to set both parameters appropriately.)

Default: DsLanguage.EN

unit

@Nullable
DsUnit unit()

Return weather conditions in the requested units.

Default: DsUnit.US

excludeBlocks

Set<DsBlock> excludeBlocks()

Exclude some number of data blocks from the API response. This is useful for reducing latency and saving cache space.

By default (when this method and includeBlocks() are never called) all blocks are included.

includeBlocks

Set<DsBlock> includeBlocks()

Include some number of data blocks in the API response. Blocks that are not specifed are automatically excluded.

By default (when this method and excludeBlocks() are never called) all blocks are included.

builder

static DsTimeMachineRequest.Builder builder()