Package org.osgi.service.clusterinfo.dto

Class NodeStatusDTO

java.lang.Object
org.osgi.dto.DTO
org.osgi.service.clusterinfo.dto.NodeStatusDTO
Direct Known Subclasses:
FrameworkNodeStatusDTO
public class NodeStatusDTO extends DTO
Data Transfer Object for a NodeStatus Service.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    String
    cluster
    The name of the cluster this node belongs to.
    String
    country
    ISO 3166-1 alpha-3 location where this node instance is running, if known.
    String[]
    endpoints
    The endpoint(s) at which this node can be accessed from the viewpoint of the consumer of the service.
    String
    id
    The globally unique ID for this node.
    String
    location
    ISO 3166-2 location where this node instance is running, if known.
    String
    parentid
    An optional parentID indicating this node is part of or embedded in another node.
    static final String
    PREFIX_
    Prefix used for the converter
    String[]
    privateEndpoints
    Private endpoint(s) at which this node can be accessed from within the cluster only.
    String
    region
    Something smaller than a country and bigger than a location (e.g.
    String[]
    tags
    Tags associated with this node that can be contributed to by the provider and also by bundles.
    String
    vendor
    The vendor name of the cloud/environment in which the node operates.
    String
    version
    The version of the cloud/environment in which the node operates.
    String
    zone
    Regions are often subdivided in zones that represent different physical locations.

  • Constructor Summary

    Constructors
    Constructor
    Description
    NodeStatusDTO()
    This DTO can be used to provide type safe access to properties of the NodeStatus service.

  • Method Summary

    Methods inherited from class org.osgi.dto.DTO

    toString

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

  • Field Details

    • PREFIX_

      public static final String PREFIX_
      Prefix used for the converter
      See Also:

    • id

      public String id
      The globally unique ID for this node. For example the Docker ID if this node is a Docker container, or the framework UUID if this node is an OSGi framework.

    • cluster

      public String cluster
      The name of the cluster this node belongs to.

    • parentid

      public String parentid
      An optional parentID indicating this node is part of or embedded in another node. For example multiple virtual machines could run on the same physical node.

    • endpoints

      public String[] endpoints
      The endpoint(s) at which this node can be accessed from the viewpoint of the consumer of the service.

    • privateEndpoints

      public String[] privateEndpoints
      Private endpoint(s) at which this node can be accessed from within the cluster only.

    • vendor

      public String vendor
      The vendor name of the cloud/environment in which the node operates.

    • version

      public String version
      The version of the cloud/environment in which the node operates. The value follows the versioning scheme of the cloud provider and may therefore not comply with the OSGi versioning syntax.

    • country

      public String country
      ISO 3166-1 alpha-3 location where this node instance is running, if known.

    • location

      public String location
      ISO 3166-2 location where this node instance is running, if known. This location is more detailed than the country code as it may contain province or territory.

    • region

      public String region
      Something smaller than a country and bigger than a location (e.g. us-east-1 or other cloud-specific location)

    • zone

      public String zone
      Regions are often subdivided in zones that represent different physical locations. The zone can be provided here.

    • tags

      public String[] tags
      Tags associated with this node that can be contributed to by the provider and also by bundles.

  • Constructor Details

    • NodeStatusDTO

      public NodeStatusDTO()
      This DTO can be used to provide type safe access to properties of the NodeStatus service.