Class TelemetryConfiguration

java.lang.Object
software.amazon.awssdk.services.greengrass.model.TelemetryConfiguration
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<TelemetryConfiguration.Builder,TelemetryConfiguration>
@Generated("software.amazon.awssdk:codegen") public final class TelemetryConfiguration extends Object implements SdkPojo, Serializable, ToCopyableBuilder<TelemetryConfiguration.Builder,TelemetryConfiguration>
Configuration settings for running telemetry.
See Also:

  • Method Details

    • configurationSyncStatus

      public final ConfigurationSyncStatus configurationSyncStatus()
      Synchronization status of the device reported configuration with the desired configuration.

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

      Returns:
      Synchronization status of the device reported configuration with the desired configuration.
      See Also:

    • configurationSyncStatusAsString

      public final String configurationSyncStatusAsString()
      Synchronization status of the device reported configuration with the desired configuration.

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

      Returns:
      Synchronization status of the device reported configuration with the desired configuration.
      See Also:

    • telemetry

      public final Telemetry telemetry()
      Configure telemetry to be on or off.

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

      Returns:
      Configure telemetry to be on or off.
      See Also:

    • telemetryAsString

      public final String telemetryAsString()
      Configure telemetry to be on or off.

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

      Returns:
      Configure telemetry to be on or off.
      See Also:

    • toBuilder

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

    • builder

      public static TelemetryConfiguration.Builder builder()

    • serializableBuilderClass

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