DefaultResourceEntityDelegate.ResourceEntity

java.lang.Object

com.inductiveautomation.ignition.gateway.config.DefaultResourceEntityDelegate.ResourceEntity

All Implemented Interfaces:: Entity

Enclosing class:: DefaultResourceEntityDelegate

protected static class DefaultResourceEntityDelegate.ResourceEntity extends Object implements Entity

Implementation that turns a named Resource into an Entity.

Method Summary

Modifier and Type

Method

Description

Optional<AuditComponent>

getAudit()

Optional<DescriptionComponent>

getDescription()

Optional<DiagnosticComponent>

getDiagnostics()

Optional<EnablementComponent>

getEnablement()

@NotNull String

getName()

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.inductiveautomation.ignition.gateway.model.entity.Entity
getChildren, getNavigation

Method Details
- getName
  
  @NotNull public @NotNull String getName()
  
  Specified by:
  
  getName in interface Entity
  
  Returns:
  
  The name of the entity. This is a unique identifier for the entity within it's sibling set.
- getDescription
  
  public Optional<DescriptionComponent> getDescription()
  
  Specified by:
  
  getDescription in interface Entity
  
  Returns:
  
  Description information about the entity, this can contain a descriptive doc string as well as a map of additional properties.
- getAudit
  
  public Optional<AuditComponent> getAudit()
  
  Specified by:
  
  getAudit in interface Entity
  
  Returns:
  
  Information about when this entity was last changed, and who changed it (if applicable).
- getEnablement
  
  public Optional<EnablementComponent> getEnablement()
  
  Specified by:
  
  getEnablement in interface Entity
  
  Returns:
  
  Information about whether this entity is enabled or disabled, and how to change that state (if allowed)
- getDiagnostics
  
  public Optional<DiagnosticComponent> getDiagnostics()
  
  Specified by:
  
  getDiagnostics in interface Entity
  
  Returns:
  
  Diagnostic information (metrics and healthchecks) about this entity, if any.