Class PutStorageConfigurationRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.iotsitewise.model.IoTSiteWiseRequest
software.amazon.awssdk.services.iotsitewise.model.PutStorageConfigurationRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<PutStorageConfigurationRequest.Builder,PutStorageConfigurationRequest>
@Generated("software.amazon.awssdk:codegen") public final class PutStorageConfigurationRequest extends IoTSiteWiseRequest implements ToCopyableBuilder<PutStorageConfigurationRequest.Builder,PutStorageConfigurationRequest>

  • Method Details

    • storageType

      public final StorageType storageType()

      The storage tier that you specified for your data. The storageType parameter can be one of the following values:

      • SITEWISE_DEFAULT_STORAGE – IoT SiteWise saves your data into the hot tier. The hot tier is a service-managed database.

      • MULTI_LAYER_STORAGE – IoT SiteWise saves your data in both the cold tier and the hot tier. The cold tier is a customer-managed Amazon S3 bucket.

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

      Returns:
      The storage tier that you specified for your data. The storageType parameter can be one of the following values:

      • SITEWISE_DEFAULT_STORAGE – IoT SiteWise saves your data into the hot tier. The hot tier is a service-managed database.

      • MULTI_LAYER_STORAGE – IoT SiteWise saves your data in both the cold tier and the hot tier. The cold tier is a customer-managed Amazon S3 bucket.

      See Also:

    • storageTypeAsString

      public final String storageTypeAsString()

      The storage tier that you specified for your data. The storageType parameter can be one of the following values:

      • SITEWISE_DEFAULT_STORAGE – IoT SiteWise saves your data into the hot tier. The hot tier is a service-managed database.

      • MULTI_LAYER_STORAGE – IoT SiteWise saves your data in both the cold tier and the hot tier. The cold tier is a customer-managed Amazon S3 bucket.

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

      Returns:
      The storage tier that you specified for your data. The storageType parameter can be one of the following values:

      • SITEWISE_DEFAULT_STORAGE – IoT SiteWise saves your data into the hot tier. The hot tier is a service-managed database.

      • MULTI_LAYER_STORAGE – IoT SiteWise saves your data in both the cold tier and the hot tier. The cold tier is a customer-managed Amazon S3 bucket.

      See Also:

    • multiLayerStorage

      public final MultiLayerStorage multiLayerStorage()

      Identifies a storage destination. If you specified MULTI_LAYER_STORAGE for the storage type, you must specify a MultiLayerStorage object.

      Returns:
      Identifies a storage destination. If you specified MULTI_LAYER_STORAGE for the storage type, you must specify a MultiLayerStorage object.

    • disassociatedDataStorage

      public final DisassociatedDataStorageState disassociatedDataStorage()

      Contains the storage configuration for time series (data streams) that aren't associated with asset properties. The disassociatedDataStorage can be one of the following values:

      • ENABLED – IoT SiteWise accepts time series that aren't associated with asset properties.

        After the disassociatedDataStorage is enabled, you can't disable it.

      • DISABLED – IoT SiteWise doesn't accept time series (data streams) that aren't associated with asset properties.

      For more information, see Data streams in the IoT SiteWise User Guide.

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

      Returns:
      Contains the storage configuration for time series (data streams) that aren't associated with asset properties. The disassociatedDataStorage can be one of the following values:

      • ENABLED – IoT SiteWise accepts time series that aren't associated with asset properties.

        After the disassociatedDataStorage is enabled, you can't disable it.

      • DISABLED – IoT SiteWise doesn't accept time series (data streams) that aren't associated with asset properties.

      For more information, see Data streams in the IoT SiteWise User Guide.

      See Also:

    • disassociatedDataStorageAsString

      public final String disassociatedDataStorageAsString()

      Contains the storage configuration for time series (data streams) that aren't associated with asset properties. The disassociatedDataStorage can be one of the following values:

      • ENABLED – IoT SiteWise accepts time series that aren't associated with asset properties.

        After the disassociatedDataStorage is enabled, you can't disable it.

      • DISABLED – IoT SiteWise doesn't accept time series (data streams) that aren't associated with asset properties.

      For more information, see Data streams in the IoT SiteWise User Guide.

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

      Returns:
      Contains the storage configuration for time series (data streams) that aren't associated with asset properties. The disassociatedDataStorage can be one of the following values:

      • ENABLED – IoT SiteWise accepts time series that aren't associated with asset properties.

        After the disassociatedDataStorage is enabled, you can't disable it.

      • DISABLED – IoT SiteWise doesn't accept time series (data streams) that aren't associated with asset properties.

      For more information, see Data streams in the IoT SiteWise User Guide.

      See Also:

    • retentionPeriod

      public final RetentionPeriod retentionPeriod()
      Returns the value of the RetentionPeriod property for this object.
      Returns:
      The value of the RetentionPeriod property for this object.

    • warmTier

      public final WarmTierState warmTier()

      A service managed storage tier optimized for analytical queries. It stores periodically uploaded, buffered and historical data ingested with the CreaeBulkImportJob API.

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

      Returns:
      A service managed storage tier optimized for analytical queries. It stores periodically uploaded, buffered and historical data ingested with the CreaeBulkImportJob API.
      See Also:

    • warmTierAsString

      public final String warmTierAsString()

      A service managed storage tier optimized for analytical queries. It stores periodically uploaded, buffered and historical data ingested with the CreaeBulkImportJob API.

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

      Returns:
      A service managed storage tier optimized for analytical queries. It stores periodically uploaded, buffered and historical data ingested with the CreaeBulkImportJob API.
      See Also:

    • warmTierRetentionPeriod

      public final WarmTierRetentionPeriod warmTierRetentionPeriod()

      Set this period to specify how long your data is stored in the warm tier before it is deleted. You can set this only if cold tier is enabled.

      Returns:
      Set this period to specify how long your data is stored in the warm tier before it is deleted. You can set this only if cold tier is enabled.

    • toBuilder

      public PutStorageConfigurationRequest.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<PutStorageConfigurationRequest.Builder,PutStorageConfigurationRequest>
      Specified by:
      toBuilder in class IoTSiteWiseRequest
      Returns:
      a builder for type T

    • builder

      public static PutStorageConfigurationRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends PutStorageConfigurationRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • 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.