software.amazon.awscdk.core

Class Duration

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.core.Duration

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/0.12.1 (build 3ce4842)",
           date="2019-06-25T13:54:15.891Z")
 @Stability(value=Experimental)
public class Duration
extends software.amazon.jsii.JsiiObject

Represents a length of time. The amount can be specified either as a literal value (e.g: `10`) which cannot be negative, or as an unresolved number token. Whent he amount is passed as an token, unit conversion is not possible. EXPERIMENTAL

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Duration(software.amazon.jsii.JsiiObject.InitializationMode mode)

Method Summary

Modifier and Type	Method and Description
static Duration	days(Number amount) EXPERIMENTAL
static Duration	hours(Number amount) EXPERIMENTAL
static Duration	minutes(Number amount) EXPERIMENTAL
static Duration	parse(String duration) Parse a period formatted according to the ISO 8601 standard (see https://www.iso.org/fr/standard/70907.html).
static Duration	seconds(Number amount) EXPERIMENTAL
Number	toDays() EXPERIMENTAL
Number	toDays(TimeConversionOptions opts) EXPERIMENTAL
Number	toHours() EXPERIMENTAL
Number	toHours(TimeConversionOptions opts) EXPERIMENTAL
String	toISOString() EXPERIMENTAL
Number	toMinutes() EXPERIMENTAL
Number	toMinutes(TimeConversionOptions opts) EXPERIMENTAL
Number	toSeconds() EXPERIMENTAL
Number	toSeconds(TimeConversionOptions opts) EXPERIMENTAL
String	toString() Returns a string representation of this `Duration` that is also a Token that cannot be successfully resolved.

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiCall, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticGet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

Duration

protected Duration(software.amazon.jsii.JsiiObject.InitializationMode mode)

Method Detail

days

@Stability(value=Experimental)
public static Duration days(Number amount)

EXPERIMENTAL

Parameters:

amount - the amount of Days the `Duration` will represent.

Returns:

a new `Duration` representing `amount` Days.

hours

@Stability(value=Experimental)
public static Duration hours(Number amount)

EXPERIMENTAL

Parameters:

amount - the amount of Hours the `Duration` will represent.

Returns:

a new `Duration` representing `amount` Hours.

minutes

@Stability(value=Experimental)
public static Duration minutes(Number amount)

EXPERIMENTAL

Parameters:

amount - the amount of Minutes the `Duration` will represent.

Returns:

a new `Duration` representing `amount` Minutes.

parse

@Stability(value=Experimental)
public static Duration parse(String duration)

Parse a period formatted according to the ISO 8601 standard (see https://www.iso.org/fr/standard/70907.html). EXPERIMENTAL

Parameters:

duration - an ISO-formtted duration to be parsed.

Returns:

the parsed `Duration`.

seconds

@Stability(value=Experimental)
public static Duration seconds(Number amount)

EXPERIMENTAL

Parameters:

amount - the amount of Seconds the `Duration` will represent.

Returns:

a new `Duration` representing `amount` Seconds.

toDays

@Stability(value=Experimental)
public Number toDays(@Nullable
                                                    TimeConversionOptions opts)

EXPERIMENTAL

Returns:

the value of this `Duration` expressed in Days.

toDays

@Stability(value=Experimental)
public Number toDays()

EXPERIMENTAL

Returns:

the value of this `Duration` expressed in Days.

toHours

@Stability(value=Experimental)
public Number toHours(@Nullable
                                                     TimeConversionOptions opts)

EXPERIMENTAL

Returns:

the value of this `Duration` expressed in Hours.

toHours

@Stability(value=Experimental)
public Number toHours()

EXPERIMENTAL

Returns:

the value of this `Duration` expressed in Hours.

toISOString

@Stability(value=Experimental)
public String toISOString()

EXPERIMENTAL

Returns:

an ISO 8601 representation of this period (see https://www.iso.org/fr/standard/70907.html).

toMinutes

@Stability(value=Experimental)
public Number toMinutes(@Nullable
                                                       TimeConversionOptions opts)

EXPERIMENTAL

Returns:

the value of this `Duration` expressed in Minutes.

toMinutes

@Stability(value=Experimental)
public Number toMinutes()

EXPERIMENTAL

Returns:

the value of this `Duration` expressed in Minutes.

toSeconds

@Stability(value=Experimental)
public Number toSeconds(@Nullable
                                                       TimeConversionOptions opts)

EXPERIMENTAL

Returns:

the value of this `Duration` expressed in Seconds.

toSeconds

@Stability(value=Experimental)
public Number toSeconds()

EXPERIMENTAL

Returns:

the value of this `Duration` expressed in Seconds.

toString

@Stability(value=Experimental)
public String toString()

Returns a string representation of this `Duration` that is also a Token that cannot be successfully resolved. This protects users against inadvertently stringifying a `Duration` object, when they should have called one of the `to*` methods instead. EXPERIMENTAL

Overrides:

toString in class Object