Class ScaDevice


  • public class ScaDevice
    extends Object
    A resource that contains information about a device, including its unique ID, name, and type.
    • Constructor Detail

      • ScaDevice

        public ScaDevice()
    • Method Detail

      • id

        public ScaDevice id​(String id)
        The unique identifier of the SCA device you are registering.
        Parameters:
        id - The unique identifier of the SCA device you are registering.
        Returns:
        the current ScaDevice instance, allowing for method chaining
      • getId

        public String getId()
        The unique identifier of the SCA device you are registering.
        Returns:
        id The unique identifier of the SCA device you are registering.
      • setId

        public void setId​(String id)
        The unique identifier of the SCA device you are registering.
        Parameters:
        id - The unique identifier of the SCA device you are registering.
      • name

        public ScaDevice name​(String name)
        The name of the SCA device that you are registering. You can use it to help your users identify the device.
        Parameters:
        name - The name of the SCA device that you are registering. You can use it to help your users identify the device.
        Returns:
        the current ScaDevice instance, allowing for method chaining
      • getName

        public String getName()
        The name of the SCA device that you are registering. You can use it to help your users identify the device.
        Returns:
        name The name of the SCA device that you are registering. You can use it to help your users identify the device.
      • setName

        public void setName​(String name)
        The name of the SCA device that you are registering. You can use it to help your users identify the device.
        Parameters:
        name - The name of the SCA device that you are registering. You can use it to help your users identify the device.
      • type

        public ScaDevice type​(ScaDeviceType type)
        type
        Parameters:
        type -
        Returns:
        the current ScaDevice instance, allowing for method chaining
      • getType

        public ScaDeviceType getType()
        Get type
        Returns:
        type
      • setType

        public void setType​(ScaDeviceType type)
        type
        Parameters:
        type -
      • includeNullValues

        public ScaDevice includeNullValues​(boolean includeNullValues)
        Configures whether null values are explicitly serialized in the JSON payload. Default is false.
      • isIncludeNullValues

        public boolean isIncludeNullValues()
        Returns whether null values are explicitly serialized in the JSON payload.
      • setIncludeNullValues

        public void setIncludeNullValues​(boolean includeNullValues)
        Sets whether null values should be explicitly serialized in the JSON payload. Default is false.
      • equals

        public boolean equals​(Object o)
        Return true if this ScaDevice object is equal to o.
        Overrides:
        equals in class Object
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object
      • getExplicitNulls

        public Map<String,​Object> getExplicitNulls()
        Returns a map of properties to be merged into the JSON payload as explicit null values.
      • fromJson

        public static ScaDevice fromJson​(String jsonString)
                                  throws com.fasterxml.jackson.core.JsonProcessingException
        Create an instance of ScaDevice given an JSON string
        Parameters:
        jsonString - JSON string
        Returns:
        An instance of ScaDevice
        Throws:
        com.fasterxml.jackson.core.JsonProcessingException - if the JSON string is invalid with respect to ScaDevice
      • toJson

        public String toJson()
                      throws com.fasterxml.jackson.core.JsonProcessingException
        Convert an instance of ScaDevice to an JSON string
        Returns:
        JSON string
        Throws:
        com.fasterxml.jackson.core.JsonProcessingException