software.amazon.awscdk.services.iotevents

Class DetectorModelProps.Builder

java.lang.Object

software.amazon.awscdk.services.iotevents.DetectorModelProps.Builder

Enclosing interface:

DetectorModelProps

public static final class DetectorModelProps.Builder
extends java.lang.Object

A builder for DetectorModelProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
DetectorModelProps	build() Builds the configured instance.
DetectorModelProps.Builder	description(java.lang.String description) Sets the value of DetectorModelProps.getDescription()
DetectorModelProps.Builder	detectorKey(java.lang.String detectorKey) Sets the value of DetectorModelProps.getDetectorKey()
DetectorModelProps.Builder	detectorModelName(java.lang.String detectorModelName) Sets the value of DetectorModelProps.getDetectorModelName()
DetectorModelProps.Builder	evaluationMethod(EventEvaluation evaluationMethod) Sets the value of DetectorModelProps.getEvaluationMethod()
DetectorModelProps.Builder	initialState(State initialState) Sets the value of DetectorModelProps.getInitialState()
DetectorModelProps.Builder	role(IRole role) Sets the value of DetectorModelProps.getRole()

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

initialState

public DetectorModelProps.Builder initialState(State initialState)

Sets the value of DetectorModelProps.getInitialState()

Parameters:

initialState - The state that is entered at the creation of each detector. This parameter is required.

Returns:

this

description

public DetectorModelProps.Builder description(java.lang.String description)

Sets the value of DetectorModelProps.getDescription()

Parameters:

description - A brief description of the detector model.

Returns:

this

detectorKey

public DetectorModelProps.Builder detectorKey(java.lang.String detectorKey)

Sets the value of DetectorModelProps.getDetectorKey()

Parameters:

detectorKey - The value used to identify a detector instance. When a device or system sends input, a new detector instance with a unique key value is created. AWS IoT Events can continue to route input to its corresponding detector instance based on this identifying information.

This parameter uses a JSON-path expression to select the attribute-value pair in the message payload that is used for identification. To route the message to the correct detector instance, the device must send a message payload that contains the same attribute-value.

Returns:

this

detectorModelName

public DetectorModelProps.Builder detectorModelName(java.lang.String detectorModelName)

Sets the value of DetectorModelProps.getDetectorModelName()

Parameters:

detectorModelName - The name of the detector model.

Returns:

this

evaluationMethod

public DetectorModelProps.Builder evaluationMethod(EventEvaluation evaluationMethod)

Sets the value of DetectorModelProps.getEvaluationMethod()

Parameters:

evaluationMethod - Information about the order in which events are evaluated and how actions are executed. When setting to SERIAL, variables are updated and event conditions are evaluated in the order that the events are defined. When setting to BATCH, variables within a state are updated and events within a state are performed only after all event conditions are evaluated.

Returns:

this

role

public DetectorModelProps.Builder role(IRole role)

Sets the value of DetectorModelProps.getRole()

Parameters:

role - The role that grants permission to AWS IoT Events to perform its operations.

Returns:

this

build

public DetectorModelProps build()

Builds the configured instance.

Returns:

a new instance of DetectorModelProps

Throws:

java.lang.NullPointerException - if any required attribute was not provided