Class CreateDetectorModelRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.iotevents.model.IotEventsRequest
software.amazon.awssdk.services.iotevents.model.CreateDetectorModelRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateDetectorModelRequest.Builder,CreateDetectorModelRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateDetectorModelRequest extends IotEventsRequest implements ToCopyableBuilder<CreateDetectorModelRequest.Builder,CreateDetectorModelRequest>

  • Method Details

    • detectorModelName

      public final String detectorModelName()

      The name of the detector model.

      Returns:
      The name of the detector model.

    • detectorModelDefinition

      public final DetectorModelDefinition detectorModelDefinition()

      Information that defines how the detectors operate.

      Returns:
      Information that defines how the detectors operate.

    • detectorModelDescription

      public final String detectorModelDescription()

      A brief description of the detector model.

      Returns:
      A brief description of the detector model.

    • key

      public final String key()

      The input attribute key used to identify a device or system to create a detector (an instance of the detector model) and then to route each input received to the appropriate detector (instance). This parameter uses a JSON-path expression in the message payload of each input to specify the attribute-value pair that is used to identify the device associated with the input.

      Returns:
      The input attribute key used to identify a device or system to create a detector (an instance of the detector model) and then to route each input received to the appropriate detector (instance). This parameter uses a JSON-path expression in the message payload of each input to specify the attribute-value pair that is used to identify the device associated with the input.

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

    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • tags

      public final List<Tag> tags()

      Metadata that can be used to manage the detector model.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

      Returns:
      Metadata that can be used to manage the detector model.

    • 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 CreateDetectorModelRequest.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<CreateDetectorModelRequest.Builder,CreateDetectorModelRequest>
      Specified by:
      toBuilder in class IotEventsRequest
      Returns:
      a builder for type T

    • builder

      public static CreateDetectorModelRequest.Builder builder()

    • serializableBuilderClass

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

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

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