Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface GatewayProperties

Package version

interface

An interface representing GatewayProperties. Describes properties of a gateway resource.

Hierarchy

  • GatewayProperties

Index

Properties

Optional description

description: undefined | string
member

{string} [description] User readable description of the gateway.

destinationNetwork

destinationNetwork: NetworkRef
member

{NetworkRef} destinationNetwork Network that the Application is using.

Optional http

http: HttpConfig[]
member

{HttpConfig[]} [http] Configuration for http connectivity for this gateway.

Optional ipAddress

ipAddress: undefined | string
member

{string} [ipAddress] IP address of the gateway. This is populated in the response and is ignored for incoming requests. NOTE: This property will not be serialized. It can only be populated by the server.

sourceNetwork

sourceNetwork: NetworkRef
member

{NetworkRef} sourceNetwork Network the gateway should listen on for requests.

Optional status

member

{ResourceStatus} [status] Status of the resource. Possible values include: 'Unknown', 'Ready', 'Upgrading', 'Creating', 'Deleting', 'Failed' NOTE: This property will not be serialized. It can only be populated by the server.

Optional statusDetails

statusDetails: undefined | string
member

{string} [statusDetails] Gives additional information about the current status of the gateway. NOTE: This property will not be serialized. It can only be populated by the server.

Optional tcp

tcp: TcpConfig[]
member

{TcpConfig[]} [tcp] Configuration for tcp connectivity for this gateway.

Generated using TypeDoc