Package software.amazon.awssdk.services.iotevents.model

Class DetectorModelConfiguration

java.lang.Object

software.amazon.awssdk.services.iotevents.model.DetectorModelConfiguration

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<DetectorModelConfiguration.Builder,DetectorModelConfiguration>

@Generated("software.amazon.awssdk:codegen")
public final class DetectorModelConfiguration
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<DetectorModelConfiguration.Builder,DetectorModelConfiguration>

Information about how the detector model is configured.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DetectorModelConfiguration.Builder

Method Summary

Modifier and Type	Method	Description
static DetectorModelConfiguration.Builder	builder()
Instant	creationTime()	The time the detector model was created.
String	detectorModelArn()	The ARN of the detector model.
String	detectorModelDescription()	A brief description of the detector model.
String	detectorModelName()	The name of the detector model.
String	detectorModelVersion()	The version of the detector model.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
EvaluationMethod	evaluationMethod()	Information about the order in which events are evaluated and how actions are executed.
String	evaluationMethodAsString()	Information about the order in which events are evaluated and how actions are executed.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	key()	The value used to identify a detector instance.
Instant	lastUpdateTime()	The time the detector model was last updated.
String	roleArn()	The ARN of the role that grants permission to AWS IoT Events to perform its operations.
List<SdkField<?>>	sdkFields()
static Class<? extends DetectorModelConfiguration.Builder>	serializableBuilderClass()
DetectorModelVersionStatus	status()	The status of the detector model.
String	statusAsString()	The status of the detector model.
DetectorModelConfiguration.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

detectorModelName

public final String detectorModelName()

The name of the detector model.

Returns:

The name of the detector model.

detectorModelVersion

public final String detectorModelVersion()

The version of the detector model.

Returns:

The version of the detector model.

detectorModelDescription

public final String detectorModelDescription()

A brief description of the detector model.

Returns:

A brief description of the detector model.

detectorModelArn

public final String detectorModelArn()

The ARN of the detector model.

Returns:

The ARN of the detector model.

roleArn

public final String roleArn()

The ARN of the role that grants permission to AWS IoT Events to perform its operations.

Returns:

The ARN of the role that grants permission to AWS IoT Events to perform its operations.

creationTime

public final Instant creationTime()

The time the detector model was created.

Returns:

The time the detector model was created.

lastUpdateTime

public final Instant lastUpdateTime()

The time the detector model was last updated.

Returns:

The time the detector model was last updated.

status

public final DetectorModelVersionStatus status()

The status of the detector model.

If the service returns an enum value that is not available in the current SDK version, status will return DetectorModelVersionStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

The status of the detector model.

See Also:

DetectorModelVersionStatus

statusAsString

public final String statusAsString()

The status of the detector model.

If the service returns an enum value that is not available in the current SDK version, status will return DetectorModelVersionStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

The status of the detector model.

See Also:

DetectorModelVersionStatus

key

public final String key()

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:

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.

evaluationMethod

public final EvaluationMethod evaluationMethod()

Information about the order in which events are evaluated and how actions are executed.

If the service returns an enum value that is not available in the current SDK version, evaluationMethod will return EvaluationMethod.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from evaluationMethodAsString().

Returns:

Information about the order in which events are evaluated and how actions are executed.

See Also:

EvaluationMethod

evaluationMethodAsString

public final String evaluationMethodAsString()

Information about the order in which events are evaluated and how actions are executed.

If the service returns an enum value that is not available in the current SDK version, evaluationMethod will return EvaluationMethod.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from evaluationMethodAsString().

Returns:

Information about the order in which events are evaluated and how actions are executed.

See Also:

EvaluationMethod

toBuilder

public DetectorModelConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DetectorModelConfiguration.Builder,DetectorModelConfiguration>

builder

public static DetectorModelConfiguration.Builder builder()

serializableBuilderClass

public static Class<? extends DetectorModelConfiguration.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo