Package com.ngrok.definitions

Class TcpEdge

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

  • Constructor Details

    • TcpEdge

      public TcpEdge(String id, String description, String metadata, OffsetDateTime createdAt, URI uri, Optional<List<String>> hostports, Optional<EndpointBackend> backend, Optional<EndpointIpPolicy> ipRestriction)
      Creates a new instance of TcpEdge.
      Parameters:
      id - unique identifier of this edge
      description - human-readable description of what this edge will be used for; optional, max 255 bytes.
      metadata - arbitrary user-defined machine-readable data of this edge. Optional, max 4096 bytes.
      createdAt - timestamp when the edge was created, RFC 3339 format
      uri - URI of the edge API resource
      hostports - hostports served by this edge
      backend - edge modules
      ipRestriction - the value of the ip_restriction parameter as a EndpointIpPolicy

  • Method Details

    • getId

      public String getId()
      unique identifier of this edge
      Returns:
      the value of the property as a String

    • getDescription

      public String getDescription()
      human-readable description of what this edge will be used for; 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 edge. Optional, max 4096 bytes.
      Returns:
      the value of the property as a String

    • getCreatedAt

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

    • getUri

      public URI getUri()
      URI of the edge API resource
      Returns:
      the value of the property as a URI

    • getHostports

      public Optional<List<String>> getHostports()
      hostports served by this edge
      Returns:
      the value of the property as a List of String wrapped in an Optional

    • getBackend

      public Optional<EndpointBackend> getBackend()
      edge modules
      Returns:
      the value of the property as a EndpointBackend wrapped in an Optional

    • getIpRestriction

      public Optional<EndpointIpPolicy> getIpRestriction()
      Fetches the value of the ipRestriction property.
      Returns:
      the value of the property as a EndpointIpPolicy wrapped in an Optional

    • 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