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:

  • Method Details

    • 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:

    • 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:

    • 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:

    • 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:

    • toBuilder

      public DetectorModelConfiguration.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<DetectorModelConfiguration.Builder,DetectorModelConfiguration>
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.