Package software.amazon.awssdk.services.iotsitewise.model

Class DescribeStorageConfigurationResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.iotsitewise.model.IoTSiteWiseResponse

software.amazon.awssdk.services.iotsitewise.model.DescribeStorageConfigurationResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeStorageConfigurationResponse.Builder,DescribeStorageConfigurationResponse>

@Generated("software.amazon.awssdk:codegen")
public final class DescribeStorageConfigurationResponse
extends IoTSiteWiseResponse
implements ToCopyableBuilder<DescribeStorageConfigurationResponse.Builder,DescribeStorageConfigurationResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeStorageConfigurationResponse.Builder

Method Summary

Modifier and Type	Method	Description
static DescribeStorageConfigurationResponse.Builder	builder()
ConfigurationStatus	configurationStatus()	Returns the value of the ConfigurationStatus property for this object.
DisassociatedDataStorageState	disassociatedDataStorage()	Contains the storage configuration for time series (data streams) that aren't associated with asset properties.
String	disassociatedDataStorageAsString()	Contains the storage configuration for time series (data streams) that aren't associated with asset properties.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Instant	lastUpdateDate()	The date the storage configuration was last updated, in Unix epoch time.
MultiLayerStorage	multiLayerStorage()	Contains information about the storage destination.
RetentionPeriod	retentionPeriod()	The number of days your data is kept in the hot tier.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeStorageConfigurationResponse.Builder>	serializableBuilderClass()
StorageType	storageType()	The storage tier that you specified for your data.
String	storageTypeAsString()	The storage tier that you specified for your data.
DescribeStorageConfigurationResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
WarmTierState	warmTier()	A service managed storage tier optimized for analytical queries.
String	warmTierAsString()	A service managed storage tier optimized for analytical queries.
WarmTierRetentionPeriod	warmTierRetentionPeriod()	Set this period to specify how long your data is stored in the warm tier before it is deleted.

Methods inherited from class software.amazon.awssdk.services.iotsitewise.model.IoTSiteWiseResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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

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:

StorageType

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:

StorageType

multiLayerStorage

public final MultiLayerStorage multiLayerStorage()

Contains information about the storage destination.

Returns:

Contains information about the storage destination.

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:

DisassociatedDataStorageState

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:

DisassociatedDataStorageState

retentionPeriod

public final RetentionPeriod retentionPeriod()

The number of days your data is kept in the hot tier. By default, your data is kept indefinitely in the hot tier.

Returns:

The number of days your data is kept in the hot tier. By default, your data is kept indefinitely in the hot tier.

configurationStatus

public final ConfigurationStatus configurationStatus()

Returns the value of the ConfigurationStatus property for this object.

Returns:

The value of the ConfigurationStatus property for this object.

lastUpdateDate

public final Instant lastUpdateDate()

The date the storage configuration was last updated, in Unix epoch time.

Returns:

The date the storage configuration was last updated, in Unix epoch time.

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:

WarmTierState

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:

WarmTierState

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 DescribeStorageConfigurationResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeStorageConfigurationResponse.Builder,DescribeStorageConfigurationResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static DescribeStorageConfigurationResponse.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

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)

Overrides:

getValueForField in class SdkResponse

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo