Class InfluxDBDestinationConfiguration

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

The configuration of an InfluxDB topic rule destination.

See Also:

  • Method Details

    • endpoint

      public final String endpoint()

      The URL of the InfluxDB instance to write to.

      Returns:
      The URL of the InfluxDB instance to write to.

    • influxDBVersion

      public final InfluxDBVersion influxDBVersion()

      The major version of the InfluxDB instance. Valid values are V2 and V3.

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

      Returns:
      The major version of the InfluxDB instance. Valid values are V2 and V3.
      See Also:

    • influxDBVersionAsString

      public final String influxDBVersionAsString()

      The major version of the InfluxDB instance. Valid values are V2 and V3.

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

      Returns:
      The major version of the InfluxDB instance. Valid values are V2 and V3.
      See Also:

    • secretId

      public final String secretId()

      The ARN or name of the Amazon Web Services Secrets Manager secret that contains the InfluxDB API token.

      Returns:
      The ARN or name of the Amazon Web Services Secrets Manager secret that contains the InfluxDB API token.

    • secretType

      public final InfluxDBSecretType secretType()

      The type of the secret that contains the InfluxDB API token. Valid values are SecretString and SecretBinary.

      If omitted, IoT reads the secret as a string.

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

      Returns:
      The type of the secret that contains the InfluxDB API token. Valid values are SecretString and SecretBinary.

      If omitted, IoT reads the secret as a string.

      See Also:

    • secretTypeAsString

      public final String secretTypeAsString()

      The type of the secret that contains the InfluxDB API token. Valid values are SecretString and SecretBinary.

      If omitted, IoT reads the secret as a string.

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

      Returns:
      The type of the secret that contains the InfluxDB API token. Valid values are SecretString and SecretBinary.

      If omitted, IoT reads the secret as a string.

      See Also:

    • secretKey

      public final String secretKey()

      The key to read from the secret value when the secret contains a JSON object. If omitted, IoT uses the entire secret value as the InfluxDB API token.

      Returns:
      The key to read from the secret value when the secret contains a JSON object. If omitted, IoT uses the entire secret value as the InfluxDB API token.

    • toBuilder

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

    • builder

      public static InfluxDBDestinationConfiguration.Builder builder()

    • serializableBuilderClass

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