software.amazon.awscdk.services.iotevents

Class State

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.iotevents.State

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:41.323Z")
public class State
extends software.amazon.jsii.JsiiObject

(experimental) Defines a state of a detector.

Example:

 // Example automatically generated from non-compiling source. May contain errors.
 import software.amazon.awscdk.services.iotevents.*;
 import software.amazon.awscdk.services.iotevents.actions.*;
 IInput input;
 State state = State.Builder.create()
         .stateName("MyState")
         .onEnter(List.of(Event.builder()
                 .eventName("test-event")
                 .condition(Expression.currentInput(input))
                 .actions(List.of(actions, List.of(
                     new SetVariableAction("MyVariable", Expression.inputAttribute(input, "payload.temperature")))))
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	State.Builder (experimental) A fluent builder for State.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	State(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	State(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getStateName() (experimental) The name of the state.
void	transitionTo(State targetState, TransitionOptions options) (experimental) Add a transition event to the state.

Methods inherited from class java.lang.Object

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

Constructor Detail

State

protected State(software.amazon.jsii.JsiiObjectRef objRef)

State

protected State(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

Method Detail

transitionTo

public void transitionTo(State targetState,
                         TransitionOptions options)

(experimental) Add a transition event to the state.

The transition event will be triggered if condition is evaluated to true.

Parameters:

targetState - the state that will be transit to when the event triggered. This parameter is required.

options - transition options including the condition that causes the state transition. This parameter is required.

getStateName

public java.lang.String getStateName()

(experimental) The name of the state.