Package com.inductiveautomation.ignition.gateway.opcua.server.api

Record Class DeviceProfileConfig

java.lang.Object
java.lang.Record
com.inductiveautomation.ignition.gateway.opcua.server.api.DeviceProfileConfig
Record Components:
type - an identifier unique to the type of Device, i.e., the typeId of the DeviceExtensionPoint.
browsePath - an optional String that defines an additional folder hierarchy underneath the "Devices" folder that this Device should be placed in.
rolePermissionMappings - a List of RolePermissionMappings that define the permissions granted to a role for the Device represented by this profile.
All Implemented Interfaces:
ExtensionPointProfileConfig
public record DeviceProfileConfig(String type, @Nullable String browsePath, @Nullable List<com.inductiveautomation.ignition.gateway.opcua.server.api.RolePermissionMapping> rolePermissionMappings) extends Record implements ExtensionPointProfileConfig
Profile configuration object common to all Devices and DeviceExtensionPoints.

  • Constructor Summary

    Constructors
    Constructor
    Description
    DeviceProfileConfig(String type, @Nullable String browsePath, @Nullable List<com.inductiveautomation.ignition.gateway.opcua.server.api.RolePermissionMapping> rolePermissionMappings)
    Creates an instance of a DeviceProfileConfig record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    @Nullable String
    browsePath()
    Returns the value of the browsePath record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    @Nullable List<com.inductiveautomation.ignition.gateway.opcua.server.api.RolePermissionMapping>
    rolePermissionMappings()
    Returns the value of the rolePermissionMappings record component.
    final String
    toString()
    Returns a string representation of this record class.
    String
    type()
    Returns the value of the type record component.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • DeviceProfileConfig

      public DeviceProfileConfig(String type, @Nullable @Nullable String browsePath, @Nullable @Nullable List<com.inductiveautomation.ignition.gateway.opcua.server.api.RolePermissionMapping> rolePermissionMappings)
      Creates an instance of a DeviceProfileConfig record class.
      Parameters:
      type - the value for the type record component
      browsePath - the value for the browsePath record component
      rolePermissionMappings - the value for the rolePermissionMappings record component

  • Method Details

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • type

      public String type()
      Returns the value of the type record component.
      Specified by:
      type in interface ExtensionPointProfileConfig
      Returns:
      the value of the type record component

    • browsePath

      @Nullable public @Nullable String browsePath()
      Returns the value of the browsePath record component.
      Returns:
      the value of the browsePath record component

    • rolePermissionMappings

      @Nullable public @Nullable List<com.inductiveautomation.ignition.gateway.opcua.server.api.RolePermissionMapping> rolePermissionMappings()
      Returns the value of the rolePermissionMappings record component.
      Returns:
      the value of the rolePermissionMappings record component