Class SignalInformation

java.lang.Object
software.amazon.awssdk.services.iotfleetwise.model.SignalInformation
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<SignalInformation.Builder,SignalInformation>
@Generated("software.amazon.awssdk:codegen") public final class SignalInformation extends Object implements SdkPojo, Serializable, ToCopyableBuilder<SignalInformation.Builder,SignalInformation>

Information about a signal.

See Also:

  • Method Details

    • name

      public final String name()

      The name of the signal.

      Returns:
      The name of the signal.

    • maxSampleCount

      public final Long maxSampleCount()

      The maximum number of samples to collect.

      Returns:
      The maximum number of samples to collect.

    • minimumSamplingIntervalMs

      public final Long minimumSamplingIntervalMs()

      The minimum duration of time (in milliseconds) between two triggering events to collect data.

      If a signal changes often, you might want to collect data at a slower rate.

      Returns:
      The minimum duration of time (in milliseconds) between two triggering events to collect data.

      If a signal changes often, you might want to collect data at a slower rate.

    • dataPartitionId

      public final String dataPartitionId()

      The ID of the data partition this signal is associated with.

      The ID must match one of the IDs provided in dataPartitions. This is accomplished either by specifying a particular data partition ID or by using default for an established default partition. You can establish a default partition in the DataPartition data type.

      If you upload a signal as a condition for a campaign's data partition, the same signal must be included in signalsToCollect.

      Access to certain Amazon Web Services IoT FleetWise features is currently gated. For more information, see Amazon Web Services Region and feature availability in the Amazon Web Services IoT FleetWise Developer Guide.

      Returns:
      The ID of the data partition this signal is associated with.

      The ID must match one of the IDs provided in dataPartitions. This is accomplished either by specifying a particular data partition ID or by using default for an established default partition. You can establish a default partition in the DataPartition data type.

      If you upload a signal as a condition for a campaign's data partition, the same signal must be included in signalsToCollect.

      Access to certain Amazon Web Services IoT FleetWise features is currently gated. For more information, see Amazon Web Services Region and feature availability in the Amazon Web Services IoT FleetWise Developer Guide.

    • toBuilder

      public SignalInformation.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<SignalInformation.Builder,SignalInformation>
      Returns:
      a builder for type T

    • builder

      public static SignalInformation.Builder builder()

    • serializableBuilderClass

      public static Class<? extends SignalInformation.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.