Package com.ngrok.definitions

Class IpWhitelistEntry

java.lang.Object
com.ngrok.definitions.IpWhitelistEntry
public class IpWhitelistEntry extends Object
A class encapsulating the IpWhitelistEntry resource.

  • Constructor Details

    • IpWhitelistEntry

      public IpWhitelistEntry​(String id, URI uri, OffsetDateTime createdAt, String description, String metadata, String ipNet)
      Creates a new instance of IpWhitelistEntry.
      Parameters:
      id - unique identifier for this IP whitelist entry
      uri - URI of the IP whitelist entry API resource
      createdAt - timestamp when the IP whitelist entry was created, RFC 3339 format
      description - human-readable description of the source IPs for this IP whitelist entry. optional, max 255 bytes.
      metadata - arbitrary user-defined machine-readable data of this IP whitelist entry. optional, max 4096 bytes.
      ipNet - an IP address or IP network range in CIDR notation (e.g. 10.1.1.1 or 10.1.0.0/16) of addresses that will be whitelisted to communicate with your tunnel endpoints

  • Method Details

    • getId

      public String getId()
      unique identifier for this IP whitelist entry
      Returns:
      the value of the property as a String

    • getUri

      public URI getUri()
      URI of the IP whitelist entry API resource
      Returns:
      the value of the property as a URI

    • getCreatedAt

      public OffsetDateTime getCreatedAt()
      timestamp when the IP whitelist entry was created, RFC 3339 format
      Returns:
      the value of the property as a OffsetDateTime

    • getDescription

      public String getDescription()
      human-readable description of the source IPs for this IP whitelist entry. optional, max 255 bytes.
      Returns:
      the value of the property as a String

    • getMetadata

      public String getMetadata()
      arbitrary user-defined machine-readable data of this IP whitelist entry. optional, max 4096 bytes.
      Returns:
      the value of the property as a String

    • getIpNet

      public String getIpNet()
      an IP address or IP network range in CIDR notation (e.g. 10.1.1.1 or 10.1.0.0/16) of addresses that will be whitelisted to communicate with your tunnel endpoints
      Returns:
      the value of the property as a String

    • equals

      public boolean equals​(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object