Class PipeTargetTimestreamParameters

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

The parameters for using a Timestream for LiveAnalytics table as a target.

See Also:

  • Method Details

    • timeValue

      public final String timeValue()

      Dynamic path to the source data field that represents the time value for your data.

      Returns:
      Dynamic path to the source data field that represents the time value for your data.

    • epochTimeUnit

      public final EpochTimeUnit epochTimeUnit()

      The granularity of the time units used. Default is MILLISECONDS.

      Required if TimeFieldType is specified as EPOCH.

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

      Returns:
      The granularity of the time units used. Default is MILLISECONDS.

      Required if TimeFieldType is specified as EPOCH.

      See Also:

    • epochTimeUnitAsString

      public final String epochTimeUnitAsString()

      The granularity of the time units used. Default is MILLISECONDS.

      Required if TimeFieldType is specified as EPOCH.

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

      Returns:
      The granularity of the time units used. Default is MILLISECONDS.

      Required if TimeFieldType is specified as EPOCH.

      See Also:

    • timeFieldType

      public final TimeFieldType timeFieldType()

      The type of time value used.

      The default is EPOCH.

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

      Returns:
      The type of time value used.

      The default is EPOCH.

      See Also:

    • timeFieldTypeAsString

      public final String timeFieldTypeAsString()

      The type of time value used.

      The default is EPOCH.

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

      Returns:
      The type of time value used.

      The default is EPOCH.

      See Also:

    • timestampFormat

      public final String timestampFormat()

      How to format the timestamps. For example, yyyy-MM-dd'T'HH:mm:ss'Z'.

      Required if TimeFieldType is specified as TIMESTAMP_FORMAT.

      Returns:
      How to format the timestamps. For example, yyyy-MM-dd'T'HH:mm:ss'Z'.

      Required if TimeFieldType is specified as TIMESTAMP_FORMAT.

    • versionValue

      public final String versionValue()

      64 bit version value or source data field that represents the version value for your data.

      Write requests with a higher version number will update the existing measure values of the record and version. In cases where the measure value is the same, the version will still be updated.

      Default value is 1.

      Timestream for LiveAnalytics does not support updating partial measure values in a record.

      Write requests for duplicate data with a higher version number will update the existing measure value and version. In cases where the measure value is the same, Version will still be updated. Default value is 1.

      Version must be 1 or greater, or you will receive a ValidationException error.

      Returns:
      64 bit version value or source data field that represents the version value for your data.

      Write requests with a higher version number will update the existing measure values of the record and version. In cases where the measure value is the same, the version will still be updated.

      Default value is 1.

      Timestream for LiveAnalytics does not support updating partial measure values in a record.

      Write requests for duplicate data with a higher version number will update the existing measure value and version. In cases where the measure value is the same, Version will still be updated. Default value is 1.

      Version must be 1 or greater, or you will receive a ValidationException error.

    • hasDimensionMappings

      public final boolean hasDimensionMappings()
      For responses, this returns true if the service returned a value for the DimensionMappings 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.

    • dimensionMappings

      public final List<DimensionMapping> dimensionMappings()

      Map source data to dimensions in the target Timestream for LiveAnalytics table.

      For more information, see Amazon Timestream for LiveAnalytics concepts

      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 hasDimensionMappings() method.

      Returns:
      Map source data to dimensions in the target Timestream for LiveAnalytics table.

      For more information, see Amazon Timestream for LiveAnalytics concepts

    • hasSingleMeasureMappings

      public final boolean hasSingleMeasureMappings()
      For responses, this returns true if the service returned a value for the SingleMeasureMappings 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.

    • singleMeasureMappings

      public final List<SingleMeasureMapping> singleMeasureMappings()

      Mappings of single source data fields to individual records in the specified Timestream for LiveAnalytics table.

      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 hasSingleMeasureMappings() method.

      Returns:
      Mappings of single source data fields to individual records in the specified Timestream for LiveAnalytics table.

    • hasMultiMeasureMappings

      public final boolean hasMultiMeasureMappings()
      For responses, this returns true if the service returned a value for the MultiMeasureMappings 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.

    • multiMeasureMappings

      public final List<MultiMeasureMapping> multiMeasureMappings()

      Maps multiple measures from the source event to the same record in the specified Timestream for LiveAnalytics table.

      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 hasMultiMeasureMappings() method.

      Returns:
      Maps multiple measures from the source event to the same record in the specified Timestream for LiveAnalytics table.

    • toBuilder

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

    • builder

      public static PipeTargetTimestreamParameters.Builder builder()

    • serializableBuilderClass

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