Class DescribeStorageConfigurationResponse
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<DescribeStorageConfigurationResponse.Builder,
DescribeStorageConfigurationResponse>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final ConfigurationStatus
Returns the value of the ConfigurationStatus property for this object.Contains the storage configuration for time series (data streams) that aren't associated with asset properties.final String
Contains the storage configuration for time series (data streams) that aren't associated with asset properties.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkResponse
.final int
hashCode()
final Instant
The date the storage configuration was last updated, in Unix epoch time.final MultiLayerStorage
Contains information about the storage destination.final RetentionPeriod
The number of days your data is kept in the hot tier.static Class
<? extends DescribeStorageConfigurationResponse.Builder> final StorageType
The storage tier that you specified for your data.final String
The storage tier that you specified for your data.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final WarmTierState
warmTier()
A service managed storage tier optimized for analytical queries.final String
A service managed storage tier optimized for analytical queries.final 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 interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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 returnStorageType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstorageTypeAsString()
.- 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
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 returnStorageType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstorageTypeAsString()
.- 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
Contains information about the storage destination.
- Returns:
- Contains information about the storage destination.
-
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 returnDisassociatedDataStorageState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdisassociatedDataStorageAsString()
.- 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
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 returnDisassociatedDataStorageState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdisassociatedDataStorageAsString()
.- 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
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
Returns the value of the ConfigurationStatus property for this object.- Returns:
- The value of the ConfigurationStatus property for this object.
-
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
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 returnWarmTierState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromwarmTierAsString()
.- 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
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 returnWarmTierState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromwarmTierAsString()
.- 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
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
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 interfaceToCopyableBuilder<DescribeStorageConfigurationResponse.Builder,
DescribeStorageConfigurationResponse> - Specified by:
toBuilder
in classAwsResponse
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
public static Class<? extends DescribeStorageConfigurationResponse.Builder> serializableBuilderClass() -
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsResponse
-
equals
- Overrides:
equals
in classAwsResponse
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkResponse
Used to retrieve the value of a field from any class that extendsSdkResponse
. 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, theSdkResponse.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkResponse
- 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
-