Mesh

class oci.service_mesh.models.Mesh(**kwargs)

Bases: object

The mesh resource is the top-level container that represents the logical boundary of application traffic between the services and deployments that reside within it. A mesh also provides a unit of access control.

Attributes

LIFECYCLE_STATE_ACTIVE A constant which can be used with the lifecycle_state property of a Mesh.
LIFECYCLE_STATE_CREATING A constant which can be used with the lifecycle_state property of a Mesh.
LIFECYCLE_STATE_DELETED A constant which can be used with the lifecycle_state property of a Mesh.
LIFECYCLE_STATE_DELETING A constant which can be used with the lifecycle_state property of a Mesh.
LIFECYCLE_STATE_FAILED A constant which can be used with the lifecycle_state property of a Mesh.
LIFECYCLE_STATE_UPDATING A constant which can be used with the lifecycle_state property of a Mesh.
certificate_authorities Gets the certificate_authorities of this Mesh.
compartment_id [Required] Gets the compartment_id of this Mesh.
defined_tags Gets the defined_tags of this Mesh.
description Gets the description of this Mesh.
display_name [Required] Gets the display_name of this Mesh.
freeform_tags Gets the freeform_tags of this Mesh.
id [Required] Gets the id of this Mesh.
lifecycle_details Gets the lifecycle_details of this Mesh.
lifecycle_state [Required] Gets the lifecycle_state of this Mesh.
mtls Gets the mtls of this Mesh.
system_tags Gets the system_tags of this Mesh.
time_created [Required] Gets the time_created of this Mesh.
time_updated [Required] Gets the time_updated of this Mesh.

Methods

__init__(**kwargs) Initializes a new Mesh object with values from keyword arguments.
LIFECYCLE_STATE_ACTIVE = 'ACTIVE'

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

LIFECYCLE_STATE_CREATING = 'CREATING'

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

LIFECYCLE_STATE_DELETED = 'DELETED'

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

LIFECYCLE_STATE_DELETING = 'DELETING'

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

LIFECYCLE_STATE_FAILED = 'FAILED'

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

LIFECYCLE_STATE_UPDATING = 'UPDATING'

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

__init__(**kwargs)

Initializes a new Mesh 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 Mesh.
  • display_name (str) – The value to assign to the display_name property of this Mesh.
  • description (str) – The value to assign to the description property of this Mesh.
  • certificate_authorities (list[oci.service_mesh.models.CertificateAuthority]) – The value to assign to the certificate_authorities property of this Mesh.
  • mtls (oci.service_mesh.models.MeshMutualTransportLayerSecurity) – The value to assign to the mtls property of this Mesh.
  • compartment_id (str) – The value to assign to the compartment_id property of this Mesh.
  • time_created (datetime) – The value to assign to the time_created property of this Mesh.
  • time_updated (datetime) – The value to assign to the time_updated property of this Mesh.
  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this Mesh. 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 Mesh.
  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this Mesh.
  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this Mesh.
  • system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this Mesh.
certificate_authorities

Gets the certificate_authorities of this Mesh. A list of certificate authority resources to use for creating leaf certificates for mTLS authentication. Currently we only support one certificate authority, but this may expand in future releases. Request with more than one certificate authority will be rejected.

Returns:The certificate_authorities of this Mesh.
Return type:list[oci.service_mesh.models.CertificateAuthority]
compartment_id

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

Returns:The compartment_id of this Mesh.
Return type:str
defined_tags

Gets the defined_tags of this Mesh. 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 Mesh.
Return type:dict(str, dict(str, object))
description

Gets the description of this Mesh. 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 Mesh.
Return type:str
display_name

[Required] Gets the display_name of this Mesh. A user-friendly name. The name does not have to be unique and can be changed after creation. Avoid entering confidential information.

Example: My new resource

Returns:The display_name of this Mesh.
Return type:str
freeform_tags

Gets the freeform_tags of this Mesh. 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 Mesh.
Return type:dict(str, str)
id

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

Returns:The id of this Mesh.
Return type:str
lifecycle_details

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

[Required] Gets the lifecycle_state of this Mesh. 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 Mesh.
Return type:str
mtls

Gets the mtls of this Mesh.

Returns:The mtls of this Mesh.
Return type:oci.service_mesh.models.MeshMutualTransportLayerSecurity
system_tags

Gets the system_tags of this Mesh. 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 Mesh.
Return type:dict(str, dict(str, object))
time_created

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

Returns:The time_created of this Mesh.
Return type:datetime
time_updated

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

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