File: //lib/mysqlsh/lib/python3.8/site-packages/oci/vn_monitoring/models/ipv6.py
# coding: utf-8
# Copyright (c) 2016, 2025, Oracle and/or its affiliates. All rights reserved.
# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20160918
from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401
from oci.decorators import init_model_state_from_kwargs
@init_model_state_from_kwargs
class Ipv6(object):
"""
An *IPv6* is a conceptual term that refers to an IPv6 address and related properties.
The `IPv6` object is the API representation of an IPv6.
You can create and assign an IPv6 to any VNIC that is in an IPv6-enabled subnet in an
IPv6-enabled VCN.
**Note:** IPv6 addressing is supported for all commercial and government regions. For important
details about IPv6 addressing in a VCN, see `IPv6 Addresses`__.
__ https://docs.cloud.oracle.com/iaas/Content/Network/Concepts/ipv6.htm
"""
#: A constant which can be used with the lifecycle_state property of a Ipv6.
#: This constant has a value of "PROVISIONING"
LIFECYCLE_STATE_PROVISIONING = "PROVISIONING"
#: A constant which can be used with the lifecycle_state property of a Ipv6.
#: This constant has a value of "AVAILABLE"
LIFECYCLE_STATE_AVAILABLE = "AVAILABLE"
#: A constant which can be used with the lifecycle_state property of a Ipv6.
#: This constant has a value of "TERMINATING"
LIFECYCLE_STATE_TERMINATING = "TERMINATING"
#: A constant which can be used with the lifecycle_state property of a Ipv6.
#: This constant has a value of "TERMINATED"
LIFECYCLE_STATE_TERMINATED = "TERMINATED"
def __init__(self, **kwargs):
"""
Initializes a new Ipv6 object with values from keyword arguments.
The following keyword arguments are supported (corresponding to the getters/setters of this class):
:param compartment_id:
The value to assign to the compartment_id property of this Ipv6.
:type compartment_id: str
:param defined_tags:
The value to assign to the defined_tags property of this Ipv6.
:type defined_tags: dict(str, dict(str, object))
:param display_name:
The value to assign to the display_name property of this Ipv6.
:type display_name: str
:param freeform_tags:
The value to assign to the freeform_tags property of this Ipv6.
:type freeform_tags: dict(str, str)
:param id:
The value to assign to the id property of this Ipv6.
:type id: str
:param ip_address:
The value to assign to the ip_address property of this Ipv6.
:type ip_address: str
:param lifecycle_state:
The value to assign to the lifecycle_state property of this Ipv6.
Allowed values for this property are: "PROVISIONING", "AVAILABLE", "TERMINATING", "TERMINATED"
:type lifecycle_state: str
:param subnet_id:
The value to assign to the subnet_id property of this Ipv6.
:type subnet_id: str
:param time_created:
The value to assign to the time_created property of this Ipv6.
:type time_created: datetime
:param vnic_id:
The value to assign to the vnic_id property of this Ipv6.
:type vnic_id: str
"""
self.swagger_types = {
'compartment_id': 'str',
'defined_tags': 'dict(str, dict(str, object))',
'display_name': 'str',
'freeform_tags': 'dict(str, str)',
'id': 'str',
'ip_address': 'str',
'lifecycle_state': 'str',
'subnet_id': 'str',
'time_created': 'datetime',
'vnic_id': 'str'
}
self.attribute_map = {
'compartment_id': 'compartmentId',
'defined_tags': 'definedTags',
'display_name': 'displayName',
'freeform_tags': 'freeformTags',
'id': 'id',
'ip_address': 'ipAddress',
'lifecycle_state': 'lifecycleState',
'subnet_id': 'subnetId',
'time_created': 'timeCreated',
'vnic_id': 'vnicId'
}
self._compartment_id = None
self._defined_tags = None
self._display_name = None
self._freeform_tags = None
self._id = None
self._ip_address = None
self._lifecycle_state = None
self._subnet_id = None
self._time_created = None
self._vnic_id = None
@property
def compartment_id(self):
"""
**[Required]** Gets the compartment_id of this Ipv6.
The `OCID`__ of the compartment containing the IPv6.
This is the same as the VNIC's compartment.
__ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm
:return: The compartment_id of this Ipv6.
:rtype: str
"""
return self._compartment_id
@compartment_id.setter
def compartment_id(self, compartment_id):
"""
Sets the compartment_id of this Ipv6.
The `OCID`__ of the compartment containing the IPv6.
This is the same as the VNIC's compartment.
__ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm
:param compartment_id: The compartment_id of this Ipv6.
:type: str
"""
self._compartment_id = compartment_id
@property
def defined_tags(self):
"""
Gets the defined_tags of this Ipv6.
Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`
:return: The defined_tags of this Ipv6.
:rtype: dict(str, dict(str, object))
"""
return self._defined_tags
@defined_tags.setter
def defined_tags(self, defined_tags):
"""
Sets the defined_tags of this Ipv6.
Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`
:param defined_tags: The defined_tags of this Ipv6.
:type: dict(str, dict(str, object))
"""
self._defined_tags = defined_tags
@property
def display_name(self):
"""
**[Required]** Gets the display_name of this Ipv6.
A user-friendly name. Does not have to be unique, and it's changeable.
Avoid entering confidential information.
:return: The display_name of this Ipv6.
:rtype: str
"""
return self._display_name
@display_name.setter
def display_name(self, display_name):
"""
Sets the display_name of this Ipv6.
A user-friendly name. Does not have to be unique, and it's changeable.
Avoid entering confidential information.
:param display_name: The display_name of this Ipv6.
:type: str
"""
self._display_name = display_name
@property
def freeform_tags(self):
"""
Gets the freeform_tags of this Ipv6.
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
Example: `{\"bar-key\": \"value\"}`
:return: The freeform_tags of this Ipv6.
:rtype: dict(str, str)
"""
return self._freeform_tags
@freeform_tags.setter
def freeform_tags(self, freeform_tags):
"""
Sets the freeform_tags of this Ipv6.
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
Example: `{\"bar-key\": \"value\"}`
:param freeform_tags: The freeform_tags of this Ipv6.
:type: dict(str, str)
"""
self._freeform_tags = freeform_tags
@property
def id(self):
"""
**[Required]** Gets the id of this Ipv6.
The `OCID`__ of the IPv6.
__ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm
:return: The id of this Ipv6.
:rtype: str
"""
return self._id
@id.setter
def id(self, id):
"""
Sets the id of this Ipv6.
The `OCID`__ of the IPv6.
__ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm
:param id: The id of this Ipv6.
:type: str
"""
self._id = id
@property
def ip_address(self):
"""
**[Required]** Gets the ip_address of this Ipv6.
The IPv6 address of the `IPv6` object. The address is within the IPv6 CIDR block of the VNIC's subnet
(see the `ipv6CidrBlock` attribute for the :class:`Subnet` object.
Example: `2001:0db8:0123:1111:abcd:ef01:2345:6789`
:return: The ip_address of this Ipv6.
:rtype: str
"""
return self._ip_address
@ip_address.setter
def ip_address(self, ip_address):
"""
Sets the ip_address of this Ipv6.
The IPv6 address of the `IPv6` object. The address is within the IPv6 CIDR block of the VNIC's subnet
(see the `ipv6CidrBlock` attribute for the :class:`Subnet` object.
Example: `2001:0db8:0123:1111:abcd:ef01:2345:6789`
:param ip_address: The ip_address of this Ipv6.
:type: str
"""
self._ip_address = ip_address
@property
def lifecycle_state(self):
"""
**[Required]** Gets the lifecycle_state of this Ipv6.
The IPv6's current state.
Allowed values for this property are: "PROVISIONING", "AVAILABLE", "TERMINATING", "TERMINATED"
:return: The lifecycle_state of this Ipv6.
:rtype: str
"""
return self._lifecycle_state
@lifecycle_state.setter
def lifecycle_state(self, lifecycle_state):
"""
Sets the lifecycle_state of this Ipv6.
The IPv6's current state.
:param lifecycle_state: The lifecycle_state of this Ipv6.
:type: str
"""
allowed_values = ["PROVISIONING", "AVAILABLE", "TERMINATING", "TERMINATED"]
if not value_allowed_none_or_none_sentinel(lifecycle_state, allowed_values):
raise ValueError(
f"Invalid value for `lifecycle_state`, must be None or one of {allowed_values}"
)
self._lifecycle_state = lifecycle_state
@property
def subnet_id(self):
"""
**[Required]** Gets the subnet_id of this Ipv6.
The `OCID`__ of the subnet the VNIC is in.
__ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm
:return: The subnet_id of this Ipv6.
:rtype: str
"""
return self._subnet_id
@subnet_id.setter
def subnet_id(self, subnet_id):
"""
Sets the subnet_id of this Ipv6.
The `OCID`__ of the subnet the VNIC is in.
__ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm
:param subnet_id: The subnet_id of this Ipv6.
:type: str
"""
self._subnet_id = subnet_id
@property
def time_created(self):
"""
**[Required]** Gets the time_created of this Ipv6.
The date and time the IPv6 was created, in the format defined by `RFC3339`__.
Example: `2016-08-25T21:10:29.600Z`
__ https://tools.ietf.org/html/rfc3339
:return: The time_created of this Ipv6.
:rtype: datetime
"""
return self._time_created
@time_created.setter
def time_created(self, time_created):
"""
Sets the time_created of this Ipv6.
The date and time the IPv6 was created, in the format defined by `RFC3339`__.
Example: `2016-08-25T21:10:29.600Z`
__ https://tools.ietf.org/html/rfc3339
:param time_created: The time_created of this Ipv6.
:type: datetime
"""
self._time_created = time_created
@property
def vnic_id(self):
"""
**[Required]** Gets the vnic_id of this Ipv6.
The `OCID`__ of the VNIC the IPv6 is assigned to.
The VNIC and IPv6 must be in the same subnet.
__ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm
:return: The vnic_id of this Ipv6.
:rtype: str
"""
return self._vnic_id
@vnic_id.setter
def vnic_id(self, vnic_id):
"""
Sets the vnic_id of this Ipv6.
The `OCID`__ of the VNIC the IPv6 is assigned to.
The VNIC and IPv6 must be in the same subnet.
__ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm
:param vnic_id: The vnic_id of this Ipv6.
:type: str
"""
self._vnic_id = vnic_id
def __repr__(self):
return formatted_flat_dict(self)
def __eq__(self, other):
if other is None:
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
return not self == other