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.14.3 (build 1b1062d)",
           date="2019-08-14T08:10:20.278Z")
 @Stability(value=Stable)
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.

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)
static Duration	hours(Number amount)
static Duration	minutes(Number amount)
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)
Number	toDays()
Number	toDays(TimeConversionOptions opts)
Number	toHours()
Number	toHours(TimeConversionOptions opts)
String	toISOString()
Number	toMinutes()
Number	toMinutes(TimeConversionOptions opts)
Number	toSeconds()
Number	toSeconds(TimeConversionOptions opts)
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=Stable)
public static Duration days(Number amount)

Parameters:

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

Returns:

a new `Duration` representing `amount` Days.

hours

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

Parameters:

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

Returns:

a new `Duration` representing `amount` Hours.

minutes

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

Parameters:

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

Returns:

a new `Duration` representing `amount` Minutes.

parse

@Stability(value=Stable)
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).

Parameters:

duration - an ISO-formtted duration to be parsed.

Returns:

the parsed `Duration`.

seconds

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

Parameters:

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

Returns:

a new `Duration` representing `amount` Seconds.

toDays

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

Returns:

the value of this `Duration` expressed in Days.

toDays

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

Returns:

the value of this `Duration` expressed in Days.

toHours

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

Returns:

the value of this `Duration` expressed in Hours.

toHours

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

Returns:

the value of this `Duration` expressed in Hours.

toISOString

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

Returns:

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

toMinutes

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

Returns:

the value of this `Duration` expressed in Minutes.

toMinutes

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

Returns:

the value of this `Duration` expressed in Minutes.

toSeconds

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

Returns:

the value of this `Duration` expressed in Seconds.

toSeconds

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

Returns:

the value of this `Duration` expressed in Seconds.

toString

@Stability(value=Stable)
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.

Overrides:

toString in class Object