SubnetTopology

class oci.vn_monitoring.models.SubnetTopology(**kwargs)

Bases: Topology

Defines the visualization of a subnet in a VCN. See Network Visualizer Documentation for more information, including conventions and pictures of symbols.

Attributes:

TYPE_NETWORKING	A constant which can be used with the type property of a Topology.
TYPE_PATH	A constant which can be used with the type property of a Topology.
TYPE_SUBNET	A constant which can be used with the type property of a Topology.
TYPE_VCN	A constant which can be used with the type property of a Topology.
entities	[Required] Gets the entities of this Topology.
limited_entities	[Required] Gets the limited_entities of this Topology.
relationships	[Required] Gets the relationships of this Topology.
subnet_id	Gets the subnet_id of this SubnetTopology.
time_created	[Required] Gets the time_created of this Topology.
type	[Required] Gets the type of this Topology.

Methods:

__init__(**kwargs)	Initializes a new SubnetTopology object with values from keyword arguments.
get_subtype(object_dictionary)	Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

TYPE_NETWORKING = 'NETWORKING'

A constant which can be used with the type property of a Topology. This constant has a value of “NETWORKING”

TYPE_PATH = 'PATH'

A constant which can be used with the type property of a Topology. This constant has a value of “PATH”

TYPE_SUBNET = 'SUBNET'

A constant which can be used with the type property of a Topology. This constant has a value of “SUBNET”

TYPE_VCN = 'VCN'

A constant which can be used with the type property of a Topology. This constant has a value of “VCN”

__init__(**kwargs)

Initializes a new SubnetTopology object with values from keyword arguments. The default value of the type attribute of this class is SUBNET and it should not be changed. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters

• type (str) – The value to assign to the type property of this SubnetTopology. Allowed values for this property are: “NETWORKING”, “VCN”, “SUBNET”, “PATH”

• entities (list[object]) – The value to assign to the entities property of this SubnetTopology.

• relationships (list[oci.vn_monitoring.models.TopologyEntityRelationship]) – The value to assign to the relationships property of this SubnetTopology.

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

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

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

property entities

[Required] Gets the entities of this Topology. Lists entities comprising the virtual network topology.

Returns

The entities of this Topology.

Return type

list[object]

static get_subtype(object_dictionary)

Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

property limited_entities

[Required] Gets the limited_entities of this Topology. Lists entities that are limited during ingestion. The values for the items in the list are the entity type names of the limitedEntities. Example: vcn

Returns

The limited_entities of this Topology.

Return type

list[str]

property relationships

[Required] Gets the relationships of this Topology. Lists relationships between entities in the virtual network topology.

Returns

The relationships of this Topology.

Return type

list[oci.vn_monitoring.models.TopologyEntityRelationship]

property subnet_id

Gets the subnet_id of this SubnetTopology. The OCID of the subnet for which the visualization is generated.

Returns

The subnet_id of this SubnetTopology.

Return type

str

property time_created

[Required] Gets the time_created of this Topology. Records when the virtual network topology was created, in RFC3339 format for date and time.

Returns

The time_created of this Topology.

Return type

datetime

property type

[Required] Gets the type of this Topology. Type of the topology object.

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

Returns

The type of this Topology.

Return type

str