# Uses of Class
com.ngrok.definitions.Ref

Packages that use Ref
Package
Description
com.ngrok.definitions

- ## Uses of Ref in com.ngrok.definitions

  Methods in com.ngrok.definitions that return Ref
  Modifier and Type
  Method
  Description
  `Ref`
  EndpointBackend.`getBackend()`
  backend to be used to back this endpoint
  `Ref`
  TunnelSession.`getCredential()`
  reference to the tunnel credential or ssh credential used by the ngrok agent to start this tunnel session
  `Ref`
  IpPolicyRule.`getIpPolicy()`
  object describing the IP policy this IP Policy Rule belongs to
  `Ref`
  Tunnel.`getTunnelSession()`
  reference object pointing to the tunnel session on which this tunnel was started
  Methods in com.ngrok.definitions that return types with arguments of type Ref
  Modifier and Type
  Method
  Description
  `Optional<List<Ref>>`
  Tunnel.`getBackends()`
  tunnel group backends served by this backend tunnel
  `Optional<Ref>`
  ReservedDomain.`getCertificate()`
  object referencing the TLS certificate used for connections to this domain.
  `List<Ref>`
  EndpointMutualTls.`getCertificateAuthorities()`
  PEM-encoded CA certificates that will be used to validate.
  `List<Ref>`
  EventSubscription.`getDestinations()`
  Destinations to which these events will be sent
  `Optional<Ref>`
  Endpoint.`getDomain()`
  the domain reserved for this endpoint
  `Optional<Ref>`
  Endpoint.`getEdge()`
  the edge serving requests to this endpoint, if this is an edge endpoint
  `Optional<Ref>`
  Tunnel.`getEndpoint()`
  the ephemeral endpoint this tunnel is associated with, if this is an agent-initiated tunnel
  `List<Ref>`
  EndpointIpPolicy.`getIpPolicies()`
  Fetches the value of the `ipPolicies` property.
  `List<Ref>`
  IpRestriction.`getIpPolicies()`
  the set of IP policies that are used to enforce the restriction
  `Optional<Ref>`
  Endpoint.`getTcpAddr()`
  the address reserved for this endpoint
  `Optional<Ref>`
  Endpoint.`getTunnel()`
  the tunnel serving requests to this endpoint, if this is an ephemeral endpoint
  `List<Ref>`
  TunnelGroupBackend.`getTunnels()`
  tunnels matching this backend
  Constructors in com.ngrok.definitions with parameters of type Ref
  Modifier
  Constructor
  Description
  ``
  `EndpointBackend(Optional<Boolean> enabled, Ref backend)`
  Creates a new instance of `EndpointBackend`.
  ``
  `IpPolicyRule(String id, URI uri, OffsetDateTime createdAt, String description, String metadata, String cidr, Ref ipPolicy, String action)`
  Creates a new instance of `IpPolicyRule`.
  ``
  `Tunnel(String id, URI publicUrl, OffsetDateTime startedAt, String metadata, String proto, String region, Ref tunnelSession, Optional<Ref> endpoint, Map<String,String> labels, Optional<List<Ref>> backends, String forwardsTo)`
  Creates a new instance of `Tunnel`.
  ``
  `TunnelSession(String agentVersion, Ref credential, String id, String ip, String metadata, String os, String region, OffsetDateTime startedAt, String transport, URI uri)`
  Creates a new instance of `TunnelSession`.
  Constructor parameters in com.ngrok.definitions with type arguments of type Ref
  Modifier
  Constructor
  Description
  ``
  `Endpoint(String id, String region, OffsetDateTime createdAt, OffsetDateTime updatedAt, URI publicUrl, String proto, String hostport, String type, String metadata, Optional<Ref> domain, Optional<Ref> tcpAddr, Optional<Ref> tunnel, Optional<Ref> edge)`
  Creates a new instance of `Endpoint`.
  ``
  `EndpointIpPolicy(Optional<Boolean> enabled, List<Ref> ipPolicies)`
  Creates a new instance of `EndpointIpPolicy`.
  ``
  `EndpointMutualTls(Optional<Boolean> enabled, List<Ref> certificateAuthorities)`
  Creates a new instance of `EndpointMutualTls`.
  ``
  `IpRestriction(String id, URI uri, OffsetDateTime createdAt, String description, String metadata, Boolean enforced, String type, List<Ref> ipPolicies)`
  Creates a new instance of `IpRestriction`.
  ``
  `Tunnel(String id, URI publicUrl, OffsetDateTime startedAt, String metadata, String proto, String region, Ref tunnelSession, Optional<Ref> endpoint, Map<String,String> labels, Optional<List<Ref>> backends, String forwardsTo)`
  Creates a new instance of `Tunnel`.
  ``
  `TunnelGroupBackend(String id, URI uri, OffsetDateTime createdAt, String description, String metadata, Map<String,String> labels, List<Ref> tunnels)`
  Creates a new instance of `TunnelGroupBackend`.