Package com.inductiveautomation.ignition.common.gateway.script

Record Class UpdateScriptConfig

java.lang.Object
java.lang.Record
com.inductiveautomation.ignition.common.gateway.script.UpdateScriptConfig
public record UpdateScriptConfig(String script, boolean enabled) extends Record
Configuration resource for gateway update scripts.

  • Field Details

    • RESOURCE_TYPE

      public static final ResourceType RESOURCE_TYPE

    • METHOD_NAME

      public static final String METHOD_NAME
      See Also:

    • RESOURCE_KEY

      public static final String RESOURCE_KEY
      See Also:

    • DESCRIPTOR

      public static final com.inductiveautomation.ignition.common.script.typing.ExtensionFunctionDescriptor DESCRIPTOR

  • Constructor Details

    • UpdateScriptConfig

      public UpdateScriptConfig(String script, boolean enabled)
      Creates an instance of a UpdateScriptConfig record class.
      Parameters:
      script - the value for the script record component
      enabled - the value for the enabled record component

  • Method Details

    • ofResource

      public static UpdateScriptConfig ofResource(Resource resource)

    • serialize

      public static Consumer<ResourceBuilder> serialize(String script, boolean enabled)

    • 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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      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.

    • script

      public String script()
      Returns the value of the script record component.
      Returns:
      the value of the script record component

    • enabled

      public boolean enabled()
      Returns the value of the enabled record component.
      Returns:
      the value of the enabled record component