VirtualService¶

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

Bases: object

This resource represents a customer-managed service in the Service Mesh. Each virtual service declares multiple running versions of the service and maps to a group of instances/pods running a specific version of the actual service.

Attributes

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

Methods

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

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

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

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

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

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

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

__init__(**kwargs)¶

Initializes a new VirtualService 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 VirtualService.
compartment_id (str) – The value to assign to the compartment_id property of this VirtualService.
mesh_id (str) – The value to assign to the mesh_id property of this VirtualService.
name (str) – The value to assign to the name property of this VirtualService.
description (str) – The value to assign to the description property of this VirtualService.
default_routing_policy (oci.service_mesh.models.DefaultVirtualServiceRoutingPolicy) – The value to assign to the default_routing_policy property of this VirtualService.
hosts (list[str]) – The value to assign to the hosts property of this VirtualService.
mtls (oci.service_mesh.models.MutualTransportLayerSecurity) – The value to assign to the mtls property of this VirtualService.
time_created (datetime) – The value to assign to the time_created property of this VirtualService.
time_updated (datetime) – The value to assign to the time_updated property of this VirtualService.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this VirtualService. 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 VirtualService.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this VirtualService.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this VirtualService.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this VirtualService.

compartment_id¶

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

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

default_routing_policy¶

Gets the default_routing_policy of this VirtualService.

Returns:	The default_routing_policy of this VirtualService.
Return type:	oci.service_mesh.models.DefaultVirtualServiceRoutingPolicy

defined_tags¶

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

description¶

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

freeform_tags¶

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

hosts¶

Gets the hosts of this VirtualService. The DNS hostnames of the virtual service that is used by its callers. Wildcard hostnames are supported in the prefix form. Examples of valid hostnames are “www.example.com”, “.example.com”, “.com”. Can be omitted if the virtual service will only have TCP virtual deployments.

Returns:	The hosts of this VirtualService.
Return type:	list[str]

id¶

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

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

lifecycle_details¶

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

lifecycle_state¶

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

mesh_id¶

[Required] Gets the mesh_id of this VirtualService. The OCID of the service mesh in which this virtual service is created.

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

mtls¶

Gets the mtls of this VirtualService.

Returns:	The mtls of this VirtualService.
Return type:	oci.service_mesh.models.MutualTransportLayerSecurity

name¶

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

system_tags¶

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

time_created¶

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

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

time_updated¶

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

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