RouteTable

class oci.core.models.RouteTable(**kwargs)

Bases: object

A collection of RouteRule objects, which are used to route packets based on destination IP to a particular network entity. For more information, see Overview of the Networking Service.

To use any of the API operations, you must be authorized in an IAM policy. If you’re not authorized, talk to an administrator. If you’re an administrator who needs to write policies to give users access, see Getting Started with Policies.

Attributes:

LIFECYCLE_STATE_AVAILABLE

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

LIFECYCLE_STATE_PROVISIONING

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

LIFECYCLE_STATE_TERMINATED

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

LIFECYCLE_STATE_TERMINATING

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

compartment_id

[Required] Gets the compartment_id of this RouteTable.

defined_tags

Gets the defined_tags of this RouteTable.

display_name

Gets the display_name of this RouteTable.

freeform_tags

Gets the freeform_tags of this RouteTable.

id

[Required] Gets the id of this RouteTable.

lifecycle_state

[Required] Gets the lifecycle_state of this RouteTable.

route_rules

[Required] Gets the route_rules of this RouteTable.

system_tags

Gets the system_tags of this RouteTable.

time_created

Gets the time_created of this RouteTable.

vcn_id

[Required] Gets the vcn_id of this RouteTable.

Methods:

__init__(**kwargs)

Initializes a new RouteTable object with values from keyword arguments.

LIFECYCLE_STATE_AVAILABLE = 'AVAILABLE'

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

LIFECYCLE_STATE_PROVISIONING = 'PROVISIONING'

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

LIFECYCLE_STATE_TERMINATED = 'TERMINATED'

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

LIFECYCLE_STATE_TERMINATING = 'TERMINATING'

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

__init__(**kwargs)

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

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

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

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

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

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

  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this RouteTable. Allowed values for this property are: “PROVISIONING”, “AVAILABLE”, “TERMINATING”, “TERMINATED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • route_rules (list[oci.core.models.RouteRule]) – The value to assign to the route_rules property of this RouteTable.

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

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

  • vcn_id (str) – The value to assign to the vcn_id property of this RouteTable.

property compartment_id

[Required] Gets the compartment_id of this RouteTable. The OCID of the compartment containing the route table.

Returns

The compartment_id of this RouteTable.

Return type

str

property defined_tags

Gets the defined_tags of this RouteTable. 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 RouteTable.

Return type

dict(str, dict(str, object))

property display_name

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

Returns

The display_name of this RouteTable.

Return type

str

property freeform_tags

Gets the freeform_tags of this RouteTable. 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 RouteTable.

Return type

dict(str, str)

property id

[Required] Gets the id of this RouteTable. The route table’s Oracle ID (OCID).

Returns

The id of this RouteTable.

Return type

str

property lifecycle_state

[Required] Gets the lifecycle_state of this RouteTable. The route table’s current state.

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

Returns

The lifecycle_state of this RouteTable.

Return type

str

property route_rules

[Required] Gets the route_rules of this RouteTable. The collection of rules for routing destination IPs to network devices.

Returns

The route_rules of this RouteTable.

Return type

list[oci.core.models.RouteRule]

property system_tags

Gets the system_tags of this RouteTable. 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 RouteTable.

Return type

dict(str, dict(str, object))

property time_created

Gets the time_created of this RouteTable. The date and time the route table was created, in the format defined by RFC3339.

Example: 2016-08-25T21:10:29.600Z

Returns

The time_created of this RouteTable.

Return type

datetime

property vcn_id

[Required] Gets the vcn_id of this RouteTable. The OCID of the VCN the route table list belongs to.

Returns

The vcn_id of this RouteTable.

Return type

str