Gateway

class oci.apigateway.models.Gateway(**kwargs)

Bases: object

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.

Attributes:

ENDPOINT_TYPE_PRIVATE

A constant which can be used with the endpoint_type property of a Gateway.

ENDPOINT_TYPE_PUBLIC

A constant which can be used with the endpoint_type property of a Gateway.

IP_MODE_DUAL_STACK

A constant which can be used with the ip_mode property of a Gateway.

IP_MODE_IPV4

A constant which can be used with the ip_mode property of a Gateway.

IP_MODE_IPV6

A constant which can be used with the ip_mode property of a Gateway.

LIFECYCLE_STATE_ACTIVE

A constant which can be used with the lifecycle_state property of a Gateway.

LIFECYCLE_STATE_CREATING

A constant which can be used with the lifecycle_state property of a Gateway.

LIFECYCLE_STATE_DELETED

A constant which can be used with the lifecycle_state property of a Gateway.

LIFECYCLE_STATE_DELETING

A constant which can be used with the lifecycle_state property of a Gateway.

LIFECYCLE_STATE_FAILED

A constant which can be used with the lifecycle_state property of a Gateway.

LIFECYCLE_STATE_UPDATING

A constant which can be used with the lifecycle_state property of a Gateway.

ca_bundles

Gets the ca_bundles of this Gateway.

certificate_id

Gets the certificate_id of this Gateway.

compartment_id

[Required] Gets the compartment_id of this Gateway.

defined_tags

Gets the defined_tags of this Gateway.

display_name

Gets the display_name of this Gateway.

endpoint_type

[Required] Gets the endpoint_type of this Gateway.

freeform_tags

Gets the freeform_tags of this Gateway.

hostname

Gets the hostname of this Gateway.

id

[Required] Gets the id of this Gateway.

ip_addresses

Gets the ip_addresses of this Gateway.

ip_mode

Gets the ip_mode of this Gateway.

ipv4_address_configuration

Gets the ipv4_address_configuration of this Gateway.

ipv6_address_configuration

Gets the ipv6_address_configuration of this Gateway.

lifecycle_details

Gets the lifecycle_details of this Gateway.

lifecycle_state

Gets the lifecycle_state of this Gateway.

locks

Gets the locks of this Gateway.

network_security_group_ids

Gets the network_security_group_ids of this Gateway.

response_cache_details

Gets the response_cache_details of this Gateway.

subnet_id

Gets the subnet_id of this Gateway.

system_tags

Gets the system_tags of this Gateway.

time_created

Gets the time_created of this Gateway.

time_updated

Gets the time_updated of this Gateway.

Methods:

__init__(**kwargs)

Initializes a new Gateway object with values from keyword arguments.

ENDPOINT_TYPE_PRIVATE = 'PRIVATE'

A constant which can be used with the endpoint_type property of a Gateway. This constant has a value of “PRIVATE”

ENDPOINT_TYPE_PUBLIC = 'PUBLIC'

A constant which can be used with the endpoint_type property of a Gateway. This constant has a value of “PUBLIC”

IP_MODE_DUAL_STACK = 'DUAL_STACK'

A constant which can be used with the ip_mode property of a Gateway. This constant has a value of “DUAL_STACK”

IP_MODE_IPV4 = 'IPV4'

A constant which can be used with the ip_mode property of a Gateway. This constant has a value of “IPV4”

IP_MODE_IPV6 = 'IPV6'

A constant which can be used with the ip_mode property of a Gateway. This constant has a value of “IPV6”

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'

A constant which can be used with the lifecycle_state property of a Gateway. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'

A constant which can be used with the lifecycle_state property of a Gateway. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'

A constant which can be used with the lifecycle_state property of a Gateway. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'

A constant which can be used with the lifecycle_state property of a Gateway. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'

A constant which can be used with the lifecycle_state property of a Gateway. This constant has a value of “FAILED”

LIFECYCLE_STATE_UPDATING = 'UPDATING'

A constant which can be used with the lifecycle_state property of a Gateway. This constant has a value of “UPDATING”

__init__(**kwargs)

Initializes a new Gateway object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters
  • id (str) – The value to assign to the id property of this Gateway.

  • display_name (str) – The value to assign to the display_name property of this Gateway.

  • compartment_id (str) – The value to assign to the compartment_id property of this Gateway.

  • endpoint_type (str) – The value to assign to the endpoint_type property of this Gateway. Allowed values for this property are: “PUBLIC”, “PRIVATE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • subnet_id (str) – The value to assign to the subnet_id property of this Gateway.

  • network_security_group_ids (list[str]) – The value to assign to the network_security_group_ids property of this Gateway.

  • time_created (datetime) – The value to assign to the time_created property of this Gateway.

  • time_updated (datetime) – The value to assign to the time_updated property of this Gateway.

  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this Gateway. Allowed values for this property are: “CREATING”, “ACTIVE”, “UPDATING”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • lifecycle_details (str) – The value to assign to the lifecycle_details property of this Gateway.

  • locks (list[oci.apigateway.models.ResourceLock]) – The value to assign to the locks property of this Gateway.

  • hostname (str) – The value to assign to the hostname property of this Gateway.

  • certificate_id (str) – The value to assign to the certificate_id property of this Gateway.

  • ip_addresses (list[oci.apigateway.models.IpAddress]) – The value to assign to the ip_addresses property of this Gateway.

  • response_cache_details (oci.apigateway.models.ResponseCacheDetails) – The value to assign to the response_cache_details property of this Gateway.

  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this Gateway.

  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this Gateway.

  • system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this Gateway.

  • ca_bundles (list[oci.apigateway.models.CaBundle]) – The value to assign to the ca_bundles property of this Gateway.

  • ip_mode (str) – The value to assign to the ip_mode property of this Gateway. Allowed values for this property are: “IPV4”, “IPV6”, “DUAL_STACK”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • ipv6_address_configuration (oci.apigateway.models.Ipv6AddressConfiguration) – The value to assign to the ipv6_address_configuration property of this Gateway.

  • ipv4_address_configuration (oci.apigateway.models.Ipv4AddressConfiguration) – The value to assign to the ipv4_address_configuration property of this Gateway.

property ca_bundles

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

Returns

The ca_bundles of this Gateway.

Return type

list[oci.apigateway.models.CaBundle]

property certificate_id

Gets the certificate_id of this Gateway. The OCID of the resource.

Returns

The certificate_id of this Gateway.

Return type

str

property compartment_id

[Required] Gets the compartment_id of this Gateway. The OCID of the compartment in which the resource is created.

Returns

The compartment_id of this Gateway.

Return type

str

property defined_tags

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

Example: {“Operations”: {“CostCenter”: “42”}}

Returns

The defined_tags of this Gateway.

Return type

dict(str, dict(str, object))

property display_name

Gets the display_name of this Gateway. A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.

Example: My new resource

Returns

The display_name of this Gateway.

Return type

str

property endpoint_type

[Required] Gets the endpoint_type of this Gateway. Gateway endpoint type. PUBLIC will have a public ip address assigned to it, while PRIVATE will only be accessible on a private IP address on the subnet.

Example: PUBLIC or PRIVATE

Allowed values for this property are: “PUBLIC”, “PRIVATE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The endpoint_type of this Gateway.

Return type

str

property freeform_tags

Gets the freeform_tags of this Gateway. 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: {“Department”: “Finance”}

Returns

The freeform_tags of this Gateway.

Return type

dict(str, str)

property hostname

Gets the hostname of this Gateway. The hostname for APIs deployed on the gateway.

Returns

The hostname of this Gateway.

Return type

str

property id

[Required] Gets the id of this Gateway. The OCID of the resource.

Returns

The id of this Gateway.

Return type

str

property ip_addresses

Gets the ip_addresses of this Gateway. An array of IP addresses associated with the gateway.

Returns

The ip_addresses of this Gateway.

Return type

list[oci.apigateway.models.IpAddress]

property ip_mode

Gets the ip_mode of this Gateway. Determines whether the gateway has an IPv4 or IPv6 address assigned to it, or both. IPV4 means the gateway will only have an IPv4 address assigned to it, and IPV6 means the gateway will only have an IPv6 address assigned to it. DUAL_STACK means the gateway will have both an IPv4 and IPv6 address assigned to it. Example: IPV4 or IPV6 or DUAL_STACK

Allowed values for this property are: “IPV4”, “IPV6”, “DUAL_STACK”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The ip_mode of this Gateway.

Return type

str

property ipv4_address_configuration

Gets the ipv4_address_configuration of this Gateway.

Returns

The ipv4_address_configuration of this Gateway.

Return type

oci.apigateway.models.Ipv4AddressConfiguration

property ipv6_address_configuration

Gets the ipv6_address_configuration of this Gateway.

Returns

The ipv6_address_configuration of this Gateway.

Return type

oci.apigateway.models.Ipv6AddressConfiguration

property lifecycle_details

Gets the lifecycle_details of this Gateway. 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.

Returns

The lifecycle_details of this Gateway.

Return type

str

property lifecycle_state

Gets the lifecycle_state of this Gateway. The current state of the gateway.

Allowed values for this property are: “CREATING”, “ACTIVE”, “UPDATING”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The lifecycle_state of this Gateway.

Return type

str

property locks

Gets the locks of this Gateway. Locks associated with this resource.

Returns

The locks of this Gateway.

Return type

list[oci.apigateway.models.ResourceLock]

property network_security_group_ids

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

Returns

The network_security_group_ids of this Gateway.

Return type

list[str]

property response_cache_details

Gets the response_cache_details of this Gateway.

Returns

The response_cache_details of this Gateway.

Return type

oci.apigateway.models.ResponseCacheDetails

property subnet_id

Gets the subnet_id of this Gateway. The OCID of the subnet in which related resources are created.

Returns

The subnet_id of this Gateway.

Return type

str

property system_tags

Gets the system_tags of this Gateway. System tags for this resource. Each key is predefined and scoped to a namespace. Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}

Returns

The system_tags of this Gateway.

Return type

dict(str, dict(str, object))

property time_created

Gets the time_created of this Gateway. The time this resource was created. An RFC3339 formatted datetime string.

Returns

The time_created of this Gateway.

Return type

datetime

property time_updated

Gets the time_updated of this Gateway. The time this resource was last updated. An RFC3339 formatted datetime string.

Returns

The time_updated of this Gateway.

Return type

datetime