Class CustomProperty

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

Represents a member of the complex data structure. The data type of the property can be either primitive or another struct.

See Also:

  • Method Details

    • fullyQualifiedName

      public final String fullyQualifiedName()

      The fully qualified name of the custom property. For example, the fully qualified name of a custom property might be ComplexDataTypes.VehicleDataTypes.SVMCamera.FPS.

      Returns:
      The fully qualified name of the custom property. For example, the fully qualified name of a custom property might be ComplexDataTypes.VehicleDataTypes.SVMCamera.FPS.

    • dataType

      public final NodeDataType dataType()

      The data type for the custom property.

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

      Returns:
      The data type for the custom property.
      See Also:

    • dataTypeAsString

      public final String dataTypeAsString()

      The data type for the custom property.

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

      Returns:
      The data type for the custom property.
      See Also:

    • dataEncoding

      public final NodeDataEncoding dataEncoding()

      Indicates whether the property is binary data.

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

      Returns:
      Indicates whether the property is binary data.
      See Also:

    • dataEncodingAsString

      public final String dataEncodingAsString()

      Indicates whether the property is binary data.

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

      Returns:
      Indicates whether the property is binary data.
      See Also:

    • description

      public final String description()

      A brief description of the custom property.

      Returns:
      A brief description of the custom property.

    • deprecationMessage

      public final String deprecationMessage()

      The deprecation message for the node or the branch that was moved or deleted.

      Returns:
      The deprecation message for the node or the branch that was moved or deleted.

    • comment

      public final String comment()

      A comment in addition to the description.

      Returns:
      A comment in addition to the description.

    • structFullyQualifiedName

      public final String structFullyQualifiedName()

      The fully qualified name of the struct node for the custom property if the data type of the custom property is Struct or StructArray.

      Returns:
      The fully qualified name of the struct node for the custom property if the data type of the custom property is Struct or StructArray.

    • toBuilder

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

    • builder

      public static CustomProperty.Builder builder()

    • serializableBuilderClass

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