Package software.amazon.awssdk.services.iotfleetwise.model

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SignalInformation.Builder

Method Summary

Modifier and Type	Method	Description
static SignalInformation.Builder	builder()
String	dataPartitionId()	The ID of the data partition this signal is associated with.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Long	maxSampleCount()	The maximum number of samples to collect.
Long	minimumSamplingIntervalMs()	The minimum duration of time (in milliseconds) between two triggering events to collect data.
String	name()	The name of the signal.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends SignalInformation.Builder>	serializableBuilderClass()
SignalInformation.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

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()

Specified by:

toBuilder in interface ToCopyableBuilder<SignalInformation.Builder,SignalInformation>

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)

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo