Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace Gateway

A gateway is a virtual network appliance in a regional subnet. A gateway routes inbound traffic to back-end services including public, private, and partner HTTP APIs, as well as Oracle Functions. Avoid entering confidential information. For more information, see API Gateway Concepts.

Properties

Optional caBundles

caBundles: Array<CaBundle>

An array of CA bundles that should be used on the Gateway for TLS validation.

Optional certificateId

certificateId: undefined | string

The OCID of the resource.

compartmentId

compartmentId: string

The OCID of the compartment in which the resource is created.

Optional definedTags

definedTags: undefined | object

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: {@code {\"Operations\": {\"CostCenter\": \"42\"}}}

Optional displayName

displayName: undefined | string

A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

Example: {@code My new resource}

endpointType

endpointType: EndpointType

Gateway endpoint type. {@code PUBLIC} will have a public ip address assigned to it, while {@code PRIVATE} will only be accessible on a private IP address on the subnet.

Example: {@code PUBLIC} or {@code PRIVATE}

Optional freeformTags

freeformTags: undefined | object

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.

Example: {@code {\"Department\": \"Finance\"}}

Optional hostname

hostname: undefined | string

The hostname for APIs deployed on the gateway.

id

id: string

The OCID of the resource.

Optional ipAddresses

ipAddresses: Array<IpAddress>

An array of IP addresses associated with the gateway.

Optional lifecycleDetails

lifecycleDetails: undefined | string

A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in a Failed state.

Optional lifecycleState

lifecycleState: LifecycleState

The current state of the gateway.

Optional networkSecurityGroupIds

networkSecurityGroupIds: Array<string>

An array of Network Security Groups OCIDs associated with this API Gateway.

Optional responseCacheDetails

responseCacheDetails: ExternalRespCache | NoCache

Optional subnetId

subnetId: undefined | string

The OCID of the subnet in which related resources are created.

Optional timeCreated

timeCreated: Date

The time this resource was created. An RFC3339 formatted datetime string.

Optional timeUpdated

timeUpdated: Date

The time this resource was last updated. An RFC3339 formatted datetime string.

Functions

getDeserializedJsonObj

  • getDeserializedJsonObj(obj: Gateway): object

getJsonObj