Package com.strongdm.api

Class Relay

java.lang.Object
com.strongdm.api.Relay
All Implemented Interfaces:
Node
public class Relay extends Object implements Node
Relay represents a StrongDM CLI installation running in relay mode.

  • Constructor Details

    • Relay

      public Relay()

  • Method Details

    • getDevice

      public String getDevice()
      Device is a read only device name uploaded by the gateway process when it comes online.

    • setDevice

      public void setDevice(String in)
      Device is a read only device name uploaded by the gateway process when it comes online.

    • getGatewayFilter

      public String getGatewayFilter()
      GatewayFilter can be used to restrict the peering between relays and gateways. Deprecated.

    • setGatewayFilter

      public void setGatewayFilter(String in)
      GatewayFilter can be used to restrict the peering between relays and gateways. Deprecated.

    • getId

      public String getId()
      Unique identifier of the Relay.
      Specified by:
      getId in interface Node

    • setId

      public void setId(String in)
      Unique identifier of the Relay.

    • getLocation

      public String getLocation()
      Location is a read only network location uploaded by the gateway process when it comes online.

    • setLocation

      public void setLocation(String in)
      Location is a read only network location uploaded by the gateway process when it comes online.

    • getMaintenanceWindows

      public List<NodeMaintenanceWindow> getMaintenanceWindows()
      Maintenance Windows define when this node is allowed to restart. If a node is requested to restart, it will check each window to determine if any of them permit it to restart, and if any do, it will. This check is repeated per window until the restart is successfully completed. If not set here, may be set on the command line or via an environment variable on the process itself; any server setting will take precedence over local settings. This setting is ineffective for nodes below version 38.44.0. If this setting is not applied via this remote configuration or via local configuration, the default setting is used: always allow restarts if serving no connections, and allow a restart even if serving connections between 7-8 UTC, any day.

    • setMaintenanceWindows

      public void setMaintenanceWindows(List<NodeMaintenanceWindow> in)
      Maintenance Windows define when this node is allowed to restart. If a node is requested to restart, it will check each window to determine if any of them permit it to restart, and if any do, it will. This check is repeated per window until the restart is successfully completed. If not set here, may be set on the command line or via an environment variable on the process itself; any server setting will take precedence over local settings. This setting is ineffective for nodes below version 38.44.0. If this setting is not applied via this remote configuration or via local configuration, the default setting is used: always allow restarts if serving no connections, and allow a restart even if serving connections between 7-8 UTC, any day.

    • getName

      public String getName()
      Unique human-readable name of the Relay. Node names must include only letters, numbers, and hyphens (no spaces, underscores, or other special characters). Generated if not provided on create.
      Specified by:
      getName in interface Node

    • setName

      public void setName(String in)
      Unique human-readable name of the Relay. Node names must include only letters, numbers, and hyphens (no spaces, underscores, or other special characters). Generated if not provided on create.
      Specified by:
      setName in interface Node

    • getState

      public String getState()
      The current state of the relay. One of: "new", "verifying_restart", "awaiting_restart", "restarting", "started", "stopped", "dead", "unknown".

    • setState

      public void setState(String in)
      The current state of the relay. One of: "new", "verifying_restart", "awaiting_restart", "restarting", "started", "stopped", "dead", "unknown".

    • getTags

      public Map<String,String> getTags()
      Tags is a map of key, value pairs.
      Specified by:
      getTags in interface Node

    • setTags

      public void setTags(Map<String,String> in)
      Tags is a map of key, value pairs.
      Specified by:
      setTags in interface Node

    • getVersion

      public String getVersion()
      Version is a read only sdm binary version uploaded by the gateway process when it comes online.

    • setVersion

      public void setVersion(String in)
      Version is a read only sdm binary version uploaded by the gateway process when it comes online.