IngressGateway¶

class oci.service_mesh.models.IngressGateway(**kwargs)¶

Bases: object

An ingress gateway allows resources that are outside of a mesh to communicate to resources that are inside the mesh. It sits on the edge of a service mesh receiving incoming HTTP/TCP connections to the mesh.

Attributes

`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a IngressGateway.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a IngressGateway.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a IngressGateway.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a IngressGateway.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a IngressGateway.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a IngressGateway.
`access_logging`	Gets the access_logging of this IngressGateway.
`compartment_id`	[Required] Gets the compartment_id of this IngressGateway.
`defined_tags`	Gets the defined_tags of this IngressGateway.
`description`	Gets the description of this IngressGateway.
`freeform_tags`	Gets the freeform_tags of this IngressGateway.
`hosts`	Gets the hosts of this IngressGateway.
`id`	[Required] Gets the id of this IngressGateway.
`lifecycle_details`	Gets the lifecycle_details of this IngressGateway.
`lifecycle_state`	[Required] Gets the lifecycle_state of this IngressGateway.
`mesh_id`	[Required] Gets the mesh_id of this IngressGateway.
`mtls`	Gets the mtls of this IngressGateway.
`name`	[Required] Gets the name of this IngressGateway.
`system_tags`	Gets the system_tags of this IngressGateway.
`time_created`	[Required] Gets the time_created of this IngressGateway.
`time_updated`	[Required] Gets the time_updated of this IngressGateway.

Methods

__init__(**kwargs) Initializes a new IngressGateway object with values from keyword arguments.

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶: A constant which can be used with the lifecycle_state property of a IngressGateway. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'¶: A constant which can be used with the lifecycle_state property of a IngressGateway. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'¶: A constant which can be used with the lifecycle_state property of a IngressGateway. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'¶: A constant which can be used with the lifecycle_state property of a IngressGateway. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'¶: A constant which can be used with the lifecycle_state property of a IngressGateway. This constant has a value of “FAILED”

LIFECYCLE_STATE_UPDATING = 'UPDATING'¶: A constant which can be used with the lifecycle_state property of a IngressGateway. This constant has a value of “UPDATING”

__init__(**kwargs)¶

Initializes a new IngressGateway 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 IngressGateway.
name (str) – The value to assign to the name property of this IngressGateway.
description (str) – The value to assign to the description property of this IngressGateway.
mesh_id (str) – The value to assign to the mesh_id property of this IngressGateway.
compartment_id (str) – The value to assign to the compartment_id property of this IngressGateway.
time_created (datetime) – The value to assign to the time_created property of this IngressGateway.
time_updated (datetime) – The value to assign to the time_updated property of this IngressGateway.
hosts (list[oci.service_mesh.models.IngressGatewayHost]) – The value to assign to the hosts property of this IngressGateway.
mtls (oci.service_mesh.models.IngressGatewayMutualTransportLayerSecurity) – The value to assign to the mtls property of this IngressGateway.
access_logging (oci.service_mesh.models.AccessLoggingConfiguration) – The value to assign to the access_logging property of this IngressGateway.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this IngressGateway. Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “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 IngressGateway.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this IngressGateway.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this IngressGateway.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this IngressGateway.

access_logging¶

Gets the access_logging of this IngressGateway.

Returns:	The access_logging of this IngressGateway.
Return type:	oci.service_mesh.models.AccessLoggingConfiguration

compartment_id¶

[Required] Gets the compartment_id of this IngressGateway. The OCID of the compartment.

Returns:	The compartment_id of this IngressGateway.
Return type:	str

defined_tags¶

Gets the defined_tags of this IngressGateway. Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {“foo-namespace”: {“bar-key”: “value”}}

Returns:	The defined_tags of this IngressGateway.
Return type:	dict(str, dict(str, object))

description¶

Gets the description of this IngressGateway. Description of the resource. It can be changed after creation. Avoid entering confidential information.

Example: This is my new resource

Returns:	The description of this IngressGateway.
Return type:	str

freeform_tags¶

Gets the freeform_tags of this IngressGateway. Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {“bar-key”: “value”}

Returns:	The freeform_tags of this IngressGateway.
Return type:	dict(str, str)

hosts¶

Gets the hosts of this IngressGateway. Array of hostnames and their listener configuration that this gateway will bind to.

Returns:	The hosts of this IngressGateway.
Return type:	list[oci.service_mesh.models.IngressGatewayHost]

id¶

[Required] Gets the id of this IngressGateway. Unique identifier that is immutable on creation.

Returns:	The id of this IngressGateway.
Return type:	str

lifecycle_details¶

Gets the lifecycle_details of this IngressGateway. 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 IngressGateway.
Return type:	str

lifecycle_state¶

[Required] Gets the lifecycle_state of this IngressGateway. The current state of the Resource.

Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “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 IngressGateway.
Return type:	str

mesh_id¶

[Required] Gets the mesh_id of this IngressGateway. The OCID of the service mesh in which this ingress gateway is created.

Returns:	The mesh_id of this IngressGateway.
Return type:	str

mtls¶

Gets the mtls of this IngressGateway.

Returns:	The mtls of this IngressGateway.
Return type:	oci.service_mesh.models.IngressGatewayMutualTransportLayerSecurity

name¶

[Required] Gets the name of this IngressGateway. A user-friendly name. The name has to be unique within the same service mesh and cannot be changed after creation. Avoid entering confidential information.

Example: My unique resource name

Returns:	The name of this IngressGateway.
Return type:	str

system_tags¶

Gets the system_tags of this IngressGateway. Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}

Returns:	The system_tags of this IngressGateway.
Return type:	dict(str, dict(str, object))

time_created¶

[Required] Gets the time_created of this IngressGateway. The time when this resource was created in an RFC3339 formatted datetime string.

Returns:	The time_created of this IngressGateway.
Return type:	datetime

time_updated¶

[Required] Gets the time_updated of this IngressGateway. The time when this resource was updated in an RFC3339 formatted datetime string.

Returns:	The time_updated of this IngressGateway.
Return type:	datetime