Server : Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/7.4.20 System : Linux st2.domain.com 3.10.0-1127.10.1.el7.x86_64 #1 SMP Wed Jun 3 14:28:03 UTC 2020 x86_64 User : apache ( 48) PHP Version : 7.4.20 Disable Function : NONE Directory : /proc/self/root/usr/share/mysqlsh/oci_sdk/oci/apigateway/models/ |
# coding: utf-8
# Copyright (c) 2016, 2020, Oracle and/or its affiliates. All rights reserved.
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 Gateway(object):
"""
A gateway is a virtual network appliance in a regional subnet. A gateway routes inbound traffic to back-end services including public, private, and partner HTTP APIs, as well as Oracle Functions. Avoid entering confidential information. For more information, see
`API Gateway Concepts`__.
__ https://docs.cloud.oracle.com/iaas/Content/APIGateway/Concepts/apigatewayconcepts.htm
"""
#: A constant which can be used with the endpoint_type property of a Gateway.
#: This constant has a value of "PUBLIC"
ENDPOINT_TYPE_PUBLIC = "PUBLIC"
#: A constant which can be used with the endpoint_type property of a Gateway.
#: This constant has a value of "PRIVATE"
ENDPOINT_TYPE_PRIVATE = "PRIVATE"
#: A constant which can be used with the lifecycle_state property of a Gateway.
#: This constant has a value of "CREATING"
LIFECYCLE_STATE_CREATING = "CREATING"
#: A constant which can be used with the lifecycle_state property of a Gateway.
#: This constant has a value of "ACTIVE"
LIFECYCLE_STATE_ACTIVE = "ACTIVE"
#: A constant which can be used with the lifecycle_state property of a Gateway.
#: This constant has a value of "UPDATING"
LIFECYCLE_STATE_UPDATING = "UPDATING"
#: A constant which can be used with the lifecycle_state property of a Gateway.
#: This constant has a value of "DELETING"
LIFECYCLE_STATE_DELETING = "DELETING"
#: A constant which can be used with the lifecycle_state property of a Gateway.
#: This constant has a value of "DELETED"
LIFECYCLE_STATE_DELETED = "DELETED"
#: A constant which can be used with the lifecycle_state property of a Gateway.
#: This constant has a value of "FAILED"
LIFECYCLE_STATE_FAILED = "FAILED"
def __init__(self, **kwargs):
"""
Initializes a new Gateway object with values from keyword arguments.
The following keyword arguments are supported (corresponding to the getters/setters of this class):
:param id:
The value to assign to the id property of this Gateway.
:type id: str
:param display_name:
The value to assign to the display_name property of this Gateway.
:type display_name: str
:param compartment_id:
The value to assign to the compartment_id property of this Gateway.
:type compartment_id: str
:param endpoint_type:
The value to assign to the endpoint_type property of this Gateway.
Allowed values for this property are: "PUBLIC", "PRIVATE", 'UNKNOWN_ENUM_VALUE'.
Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
:type endpoint_type: str
:param subnet_id:
The value to assign to the subnet_id property of this Gateway.
:type subnet_id: str
:param time_created:
The value to assign to the time_created property of this Gateway.
:type time_created: datetime
:param time_updated:
The value to assign to the time_updated property of this Gateway.
:type time_updated: datetime
:param lifecycle_state:
The value to assign to the lifecycle_state property of this Gateway.
Allowed values for this property are: "CREATING", "ACTIVE", "UPDATING", "DELETING", "DELETED", "FAILED", 'UNKNOWN_ENUM_VALUE'.
Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
:type lifecycle_state: str
:param lifecycle_details:
The value to assign to the lifecycle_details property of this Gateway.
:type lifecycle_details: str
:param hostname:
The value to assign to the hostname property of this Gateway.
:type hostname: str
:param freeform_tags:
The value to assign to the freeform_tags property of this Gateway.
:type freeform_tags: dict(str, str)
:param defined_tags:
The value to assign to the defined_tags property of this Gateway.
:type defined_tags: dict(str, dict(str, object))
"""
self.swagger_types = {
'id': 'str',
'display_name': 'str',
'compartment_id': 'str',
'endpoint_type': 'str',
'subnet_id': 'str',
'time_created': 'datetime',
'time_updated': 'datetime',
'lifecycle_state': 'str',
'lifecycle_details': 'str',
'hostname': 'str',
'freeform_tags': 'dict(str, str)',
'defined_tags': 'dict(str, dict(str, object))'
}
self.attribute_map = {
'id': 'id',
'display_name': 'displayName',
'compartment_id': 'compartmentId',
'endpoint_type': 'endpointType',
'subnet_id': 'subnetId',
'time_created': 'timeCreated',
'time_updated': 'timeUpdated',
'lifecycle_state': 'lifecycleState',
'lifecycle_details': 'lifecycleDetails',
'hostname': 'hostname',
'freeform_tags': 'freeformTags',
'defined_tags': 'definedTags'
}
self._id = None
self._display_name = None
self._compartment_id = None
self._endpoint_type = None
self._subnet_id = None
self._time_created = None
self._time_updated = None
self._lifecycle_state = None
self._lifecycle_details = None
self._hostname = None
self._freeform_tags = None
self._defined_tags = None
@property
def id(self):
"""
**[Required]** Gets the id of this Gateway.
The `OCID`__ of the resource.
__ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm
:return: The id of this Gateway.
:rtype: str
"""
return self._id
@id.setter
def id(self, id):
"""
Sets the id of this Gateway.
The `OCID`__ of the resource.
__ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm
:param id: The id of this Gateway.
:type: str
"""
self._id = id
@property
def display_name(self):
"""
Gets the display_name of this Gateway.
A user-friendly name. Does not have to be unique, and it's changeable.
Avoid entering confidential information.
Example: `My new resource`
:return: The display_name of this Gateway.
:rtype: str
"""
return self._display_name
@display_name.setter
def display_name(self, display_name):
"""
Sets the display_name of this Gateway.
A user-friendly name. Does not have to be unique, and it's changeable.
Avoid entering confidential information.
Example: `My new resource`
:param display_name: The display_name of this Gateway.
:type: str
"""
self._display_name = display_name
@property
def compartment_id(self):
"""
**[Required]** Gets the compartment_id of this Gateway.
The `OCID`__ of the compartment in which the
resource is created.
__ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm
:return: The compartment_id of this Gateway.
:rtype: str
"""
return self._compartment_id
@compartment_id.setter
def compartment_id(self, compartment_id):
"""
Sets the compartment_id of this Gateway.
The `OCID`__ of the compartment in which the
resource is created.
__ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm
:param compartment_id: The compartment_id of this Gateway.
:type: str
"""
self._compartment_id = compartment_id
@property
def endpoint_type(self):
"""
**[Required]** Gets the endpoint_type of this Gateway.
Gateway endpoint type.
Allowed values for this property are: "PUBLIC", "PRIVATE", 'UNKNOWN_ENUM_VALUE'.
Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
:return: The endpoint_type of this Gateway.
:rtype: str
"""
return self._endpoint_type
@endpoint_type.setter
def endpoint_type(self, endpoint_type):
"""
Sets the endpoint_type of this Gateway.
Gateway endpoint type.
:param endpoint_type: The endpoint_type of this Gateway.
:type: str
"""
allowed_values = ["PUBLIC", "PRIVATE"]
if not value_allowed_none_or_none_sentinel(endpoint_type, allowed_values):
endpoint_type = 'UNKNOWN_ENUM_VALUE'
self._endpoint_type = endpoint_type
@property
def subnet_id(self):
"""
Gets the subnet_id of this Gateway.
The `OCID`__ of the subnet in which
related resources are created.
__ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm
:return: The subnet_id of this Gateway.
:rtype: str
"""
return self._subnet_id
@subnet_id.setter
def subnet_id(self, subnet_id):
"""
Sets the subnet_id of this Gateway.
The `OCID`__ of the subnet in which
related resources are created.
__ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm
:param subnet_id: The subnet_id of this Gateway.
:type: str
"""
self._subnet_id = subnet_id
@property
def time_created(self):
"""
Gets the time_created of this Gateway.
The time this resource was created. An RFC3339 formatted datetime string.
:return: The time_created of this Gateway.
:rtype: datetime
"""
return self._time_created
@time_created.setter
def time_created(self, time_created):
"""
Sets the time_created of this Gateway.
The time this resource was created. An RFC3339 formatted datetime string.
:param time_created: The time_created of this Gateway.
:type: datetime
"""
self._time_created = time_created
@property
def time_updated(self):
"""
Gets the time_updated of this Gateway.
The time this resource was last updated. An RFC3339 formatted datetime string.
:return: The time_updated of this Gateway.
:rtype: datetime
"""
return self._time_updated
@time_updated.setter
def time_updated(self, time_updated):
"""
Sets the time_updated of this Gateway.
The time this resource was last updated. An RFC3339 formatted datetime string.
:param time_updated: The time_updated of this Gateway.
:type: datetime
"""
self._time_updated = time_updated
@property
def lifecycle_state(self):
"""
Gets the lifecycle_state of this Gateway.
The current state of the gateway.
Allowed values for this property are: "CREATING", "ACTIVE", "UPDATING", "DELETING", "DELETED", "FAILED", 'UNKNOWN_ENUM_VALUE'.
Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
:return: The lifecycle_state of this Gateway.
:rtype: str
"""
return self._lifecycle_state
@lifecycle_state.setter
def lifecycle_state(self, lifecycle_state):
"""
Sets the lifecycle_state of this Gateway.
The current state of the gateway.
:param lifecycle_state: The lifecycle_state of this Gateway.
:type: str
"""
allowed_values = ["CREATING", "ACTIVE", "UPDATING", "DELETING", "DELETED", "FAILED"]
if not value_allowed_none_or_none_sentinel(lifecycle_state, allowed_values):
lifecycle_state = 'UNKNOWN_ENUM_VALUE'
self._lifecycle_state = lifecycle_state
@property
def lifecycle_details(self):
"""
Gets the lifecycle_details of this Gateway.
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.
:return: The lifecycle_details of this Gateway.
:rtype: str
"""
return self._lifecycle_details
@lifecycle_details.setter
def lifecycle_details(self, lifecycle_details):
"""
Sets the lifecycle_details of this Gateway.
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.
:param lifecycle_details: The lifecycle_details of this Gateway.
:type: str
"""
self._lifecycle_details = lifecycle_details
@property
def hostname(self):
"""
Gets the hostname of this Gateway.
The hostname for APIs deployed on the gateway.
:return: The hostname of this Gateway.
:rtype: str
"""
return self._hostname
@hostname.setter
def hostname(self, hostname):
"""
Sets the hostname of this Gateway.
The hostname for APIs deployed on the gateway.
:param hostname: The hostname of this Gateway.
:type: str
"""
self._hostname = hostname
@property
def freeform_tags(self):
"""
Gets the freeform_tags of this Gateway.
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\"}`
__ https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm
:return: The freeform_tags of this Gateway.
:rtype: dict(str, str)
"""
return self._freeform_tags
@freeform_tags.setter
def freeform_tags(self, freeform_tags):
"""
Sets the freeform_tags of this Gateway.
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\"}`
__ https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm
:param freeform_tags: The freeform_tags of this Gateway.
:type: dict(str, str)
"""
self._freeform_tags = freeform_tags
@property
def defined_tags(self):
"""
Gets the defined_tags of this Gateway.
Defined tags for this resource. Each key is predefined and scoped to a
namespace. For more information, see
`Resource Tags`__.
Example: `{\"Operations\": {\"CostCenter\": \"42\"}}`
__ https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm
:return: The defined_tags of this Gateway.
: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 Gateway.
Defined tags for this resource. Each key is predefined and scoped to a
namespace. For more information, see
`Resource Tags`__.
Example: `{\"Operations\": {\"CostCenter\": \"42\"}}`
__ https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm
:param defined_tags: The defined_tags of this Gateway.
:type: dict(str, dict(str, object))
"""
self._defined_tags = defined_tags
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