Class PropertyDefinitionResponse
- java.lang.Object
-
- software.amazon.awssdk.services.iottwinmaker.model.PropertyDefinitionResponse
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<PropertyDefinitionResponse.Builder,PropertyDefinitionResponse>
@Generated("software.amazon.awssdk:codegen") public final class PropertyDefinitionResponse extends Object implements SdkPojo, Serializable, ToCopyableBuilder<PropertyDefinitionResponse.Builder,PropertyDefinitionResponse>
An object that contains response data from a property definition request.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfacePropertyDefinitionResponse.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static PropertyDefinitionResponse.Builderbuilder()Map<String,String>configuration()A mapping that specifies configuration information about the property.DataTypedataType()An object that contains information about the data type.DataValuedefaultValue()An object that contains the default value.StringdisplayName()A friendly name for the property.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasConfiguration()For responses, this returns true if the service returned a value for the Configuration property.inthashCode()BooleanisExternalId()A Boolean value that specifies whether the property ID comes from an external data store.BooleanisFinal()A Boolean value that specifies whether the property definition can be updated.BooleanisImported()A Boolean value that specifies whether the property definition is imported from an external data store.BooleanisInherited()A Boolean value that specifies whether the property definition is inherited from a parent entity.BooleanisRequiredInEntity()A Boolean value that specifies whether the property is required in an entity.BooleanisStoredExternally()A Boolean value that specifies whether the property is stored externally.BooleanisTimeSeries()A Boolean value that specifies whether the property consists of time series data.List<SdkField<?>>sdkFields()static Class<? extends PropertyDefinitionResponse.Builder>serializableBuilderClass()PropertyDefinitionResponse.BuildertoBuilder()StringtoString()Returns a string representation of this object.-
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
-
dataType
public final DataType dataType()
An object that contains information about the data type.
- Returns:
- An object that contains information about the data type.
-
isTimeSeries
public final Boolean isTimeSeries()
A Boolean value that specifies whether the property consists of time series data.
- Returns:
- A Boolean value that specifies whether the property consists of time series data.
-
isRequiredInEntity
public final Boolean isRequiredInEntity()
A Boolean value that specifies whether the property is required in an entity.
- Returns:
- A Boolean value that specifies whether the property is required in an entity.
-
isExternalId
public final Boolean isExternalId()
A Boolean value that specifies whether the property ID comes from an external data store.
- Returns:
- A Boolean value that specifies whether the property ID comes from an external data store.
-
isStoredExternally
public final Boolean isStoredExternally()
A Boolean value that specifies whether the property is stored externally.
- Returns:
- A Boolean value that specifies whether the property is stored externally.
-
isImported
public final Boolean isImported()
A Boolean value that specifies whether the property definition is imported from an external data store.
- Returns:
- A Boolean value that specifies whether the property definition is imported from an external data store.
-
isFinal
public final Boolean isFinal()
A Boolean value that specifies whether the property definition can be updated.
- Returns:
- A Boolean value that specifies whether the property definition can be updated.
-
isInherited
public final Boolean isInherited()
A Boolean value that specifies whether the property definition is inherited from a parent entity.
- Returns:
- A Boolean value that specifies whether the property definition is inherited from a parent entity.
-
defaultValue
public final DataValue defaultValue()
An object that contains the default value.
- Returns:
- An object that contains the default value.
-
hasConfiguration
public final boolean hasConfiguration()
For responses, this returns true if the service returned a value for the Configuration property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()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.
-
configuration
public final Map<String,String> configuration()
A mapping that specifies configuration information about the property.
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
hasConfiguration()method.- Returns:
- A mapping that specifies configuration information about the property.
-
displayName
public final String displayName()
A friendly name for the property.
- Returns:
- A friendly name for the property.
-
toBuilder
public PropertyDefinitionResponse.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<PropertyDefinitionResponse.Builder,PropertyDefinitionResponse>
-
builder
public static PropertyDefinitionResponse.Builder builder()
-
serializableBuilderClass
public static Class<? extends PropertyDefinitionResponse.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
-