Package software.amazon.awssdk.services.iottwinmaker.model

Class PropertyDefinitionRequest

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

An object that sets information about a property.

See Also:

  • Method Details

    • dataType

      public final DataType dataType()

      An object that contains information about the data type.

      Returns:
      An object that contains information about the data type.

    • isRequiredInEntity

      public final Boolean isRequiredInEntity()

      A Boolean value that specifies whether the property is required.

      Returns:
      A Boolean value that specifies whether the property is required.

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

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

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

    • configuration

      public final Map<String,String> configuration()

      A mapping that specifies configuration information about the property. Use this field to specify information that you read from and write to an external source.

      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. Use this field to specify information that you read from and write to an external source.

    • displayName

      public final String displayName()

      A friendly name for the property.

      Returns:
      A friendly name for the property.

    • toBuilder

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

    • builder

      public static PropertyDefinitionRequest.Builder builder()

    • serializableBuilderClass

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