software.amazon.awscdk.services.iotevents

Class State.Builder

java.lang.Object

software.amazon.awscdk.services.iotevents.State.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<State>

Enclosing class:

State

@Stability(value=Experimental)
public static final class State.Builder
extends Object
implements software.amazon.jsii.Builder<State>

(experimental) A fluent builder for State.

Method Summary

Modifier and Type	Method and Description
State	build()
static State.Builder	create()
State.Builder	onEnter(List<? extends Event> onEnter) (experimental) Specifies the events on enter.
State.Builder	onExit(List<? extends Event> onExit) (experimental) Specifies the events on exit.
State.Builder	onInput(List<? extends Event> onInput) (experimental) Specifies the events on input.
State.Builder	stateName(String stateName) (experimental) The name of the state.

Methods inherited from class java.lang.Object

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

Method Detail

create

@Stability(value=Experimental)
public static State.Builder create()

Returns:

a new instance of State.Builder.

stateName

@Stability(value=Experimental)
public State.Builder stateName(String stateName)

(experimental) The name of the state.

Parameters:

stateName - The name of the state. This parameter is required.

Returns:

this

onEnter

@Stability(value=Experimental)
public State.Builder onEnter(List<? extends Event> onEnter)

(experimental) Specifies the events on enter.

The conditions of the events will be evaluated when entering this state. If the condition of the event evaluates to true, the actions of the event will be executed.

Default: - no events will trigger on entering this state

Parameters:

onEnter - Specifies the events on enter. This parameter is required.

Returns:

this

onExit

@Stability(value=Experimental)
public State.Builder onExit(List<? extends Event> onExit)

(experimental) Specifies the events on exit.

The conditions of the events are evaluated when an exiting this state. If the condition evaluates to true, the actions of the event will be executed.

Default: - no events will trigger on exiting this state

Parameters:

onExit - Specifies the events on exit. This parameter is required.

Returns:

this

onInput

@Stability(value=Experimental)
public State.Builder onInput(List<? extends Event> onInput)

(experimental) Specifies the events on input.

The conditions of the events will be evaluated when any input is received. If the condition of the event evaluates to true, the actions of the event will be executed.

Default: - no events will trigger on input in this state

Parameters:

onInput - Specifies the events on input. This parameter is required.

Returns:

this

build

@Stability(value=Experimental)
public State build()

Specified by:

build in interface software.amazon.jsii.Builder<State>