File manager

File manager - Edit - /usr/lib/mysqlsh/lib/python3.9/site-packages/oci/apigateway/models/gateway.py

Back
# coding: utf-8 # Copyright (c) 2016, 2026, 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: 20190501 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.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" #: A constant which can be used with the ip_mode property of a Gateway. #: This constant has a value of "IPV4" IP_MODE_IPV4 = "IPV4" #: A constant which can be used with the ip_mode property of a Gateway. #: This constant has a value of "IPV6" IP_MODE_IPV6 = "IPV6" #: A constant which can be used with the ip_mode property of a Gateway. #: This constant has a value of "DUAL_STACK" IP_MODE_DUAL_STACK = "DUAL_STACK" 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 network_security_group_ids: The value to assign to the network_security_group_ids property of this Gateway. :type network_security_group_ids: list[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 locks: The value to assign to the locks property of this Gateway. :type locks: list[oci.apigateway.models.ResourceLock] :param hostname: The value to assign to the hostname property of this Gateway. :type hostname: str :param certificate_id: The value to assign to the certificate_id property of this Gateway. :type certificate_id: str :param ip_addresses: The value to assign to the ip_addresses property of this Gateway. :type ip_addresses: list[oci.apigateway.models.IpAddress] :param response_cache_details: The value to assign to the response_cache_details property of this Gateway. :type response_cache_details: oci.apigateway.models.ResponseCacheDetails :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)) :param system_tags: The value to assign to the system_tags property of this Gateway. :type system_tags: dict(str, dict(str, object)) :param ca_bundles: The value to assign to the ca_bundles property of this Gateway. :type ca_bundles: list[oci.apigateway.models.CaBundle] :param ip_mode: The value to assign to the ip_mode property of this Gateway. Allowed values for this property are: "IPV4", "IPV6", "DUAL_STACK", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type ip_mode: str :param ipv6_address_configuration: The value to assign to the ipv6_address_configuration property of this Gateway. :type ipv6_address_configuration: oci.apigateway.models.Ipv6AddressConfiguration :param ipv4_address_configuration: The value to assign to the ipv4_address_configuration property of this Gateway. :type ipv4_address_configuration: oci.apigateway.models.Ipv4AddressConfiguration """ self.swagger_types = { 'id': 'str', 'display_name': 'str', 'compartment_id': 'str', 'endpoint_type': 'str', 'subnet_id': 'str', 'network_security_group_ids': 'list[str]', 'time_created': 'datetime', 'time_updated': 'datetime', 'lifecycle_state': 'str', 'lifecycle_details': 'str', 'locks': 'list[ResourceLock]', 'hostname': 'str', 'certificate_id': 'str', 'ip_addresses': 'list[IpAddress]', 'response_cache_details': 'ResponseCacheDetails', 'freeform_tags': 'dict(str, str)', 'defined_tags': 'dict(str, dict(str, object))', 'system_tags': 'dict(str, dict(str, object))', 'ca_bundles': 'list[CaBundle]', 'ip_mode': 'str', 'ipv6_address_configuration': 'Ipv6AddressConfiguration', 'ipv4_address_configuration': 'Ipv4AddressConfiguration' } self.attribute_map = { 'id': 'id', 'display_name': 'displayName', 'compartment_id': 'compartmentId', 'endpoint_type': 'endpointType', 'subnet_id': 'subnetId', 'network_security_group_ids': 'networkSecurityGroupIds', 'time_created': 'timeCreated', 'time_updated': 'timeUpdated', 'lifecycle_state': 'lifecycleState', 'lifecycle_details': 'lifecycleDetails', 'locks': 'locks', 'hostname': 'hostname', 'certificate_id': 'certificateId', 'ip_addresses': 'ipAddresses', 'response_cache_details': 'responseCacheDetails', 'freeform_tags': 'freeformTags', 'defined_tags': 'definedTags', 'system_tags': 'systemTags', 'ca_bundles': 'caBundles', 'ip_mode': 'ipMode', 'ipv6_address_configuration': 'ipv6AddressConfiguration', 'ipv4_address_configuration': 'ipv4AddressConfiguration' } self._id = None self._display_name = None self._compartment_id = None self._endpoint_type = None self._subnet_id = None self._network_security_group_ids = None self._time_created = None self._time_updated = None self._lifecycle_state = None self._lifecycle_details = None self._locks = None self._hostname = None self._certificate_id = None self._ip_addresses = None self._response_cache_details = None self._freeform_tags = None self._defined_tags = None self._system_tags = None self._ca_bundles = None self._ip_mode = None self._ipv6_address_configuration = None self._ipv4_address_configuration = None @property def id(self): """ [Required] Gets the id of this Gateway. The `OCID`__ of the resource. __ https://docs.oracle.com/iaas/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.oracle.com/iaas/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.oracle.com/iaas/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.oracle.com/iaas/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. `PUBLIC` will have a public ip address assigned to it, while `PRIVATE` will only be accessible on a private IP address on the subnet. Example: `PUBLIC` or `PRIVATE` 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. `PUBLIC` will have a public ip address assigned to it, while `PRIVATE` will only be accessible on a private IP address on the subnet. Example: `PUBLIC` or `PRIVATE` :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.oracle.com/iaas/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.oracle.com/iaas/Content/General/Concepts/identifiers.htm :param subnet_id: The subnet_id of this Gateway. :type: str """ self._subnet_id = subnet_id @property def network_security_group_ids(self): """ Gets the network_security_group_ids of this Gateway. An array of Network Security Groups OCIDs associated with this API Gateway. :return: The network_security_group_ids of this Gateway. :rtype: list[str] """ return self._network_security_group_ids @network_security_group_ids.setter def network_security_group_ids(self, network_security_group_ids): """ Sets the network_security_group_ids of this Gateway. An array of Network Security Groups OCIDs associated with this API Gateway. :param network_security_group_ids: The network_security_group_ids of this Gateway. :type: list[str] """ self._network_security_group_ids = network_security_group_ids @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 locks(self): """ Gets the locks of this Gateway. Locks associated with this resource. :return: The locks of this Gateway. :rtype: list[oci.apigateway.models.ResourceLock] """ return self._locks @locks.setter def locks(self, locks): """ Sets the locks of this Gateway. Locks associated with this resource. :param locks: The locks of this Gateway. :type: list[oci.apigateway.models.ResourceLock] """ self._locks = locks @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 certificate_id(self): """ Gets the certificate_id of this Gateway. The `OCID`__ of the resource. __ https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm :return: The certificate_id of this Gateway. :rtype: str """ return self._certificate_id @certificate_id.setter def certificate_id(self, certificate_id): """ Sets the certificate_id of this Gateway. The `OCID`__ of the resource. __ https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm :param certificate_id: The certificate_id of this Gateway. :type: str """ self._certificate_id = certificate_id @property def ip_addresses(self): """ Gets the ip_addresses of this Gateway. An array of IP addresses associated with the gateway. :return: The ip_addresses of this Gateway. :rtype: list[oci.apigateway.models.IpAddress] """ return self._ip_addresses @ip_addresses.setter def ip_addresses(self, ip_addresses): """ Sets the ip_addresses of this Gateway. An array of IP addresses associated with the gateway. :param ip_addresses: The ip_addresses of this Gateway. :type: list[oci.apigateway.models.IpAddress] """ self._ip_addresses = ip_addresses @property def response_cache_details(self): """ Gets the response_cache_details of this Gateway. :return: The response_cache_details of this Gateway. :rtype: oci.apigateway.models.ResponseCacheDetails """ return self._response_cache_details @response_cache_details.setter def response_cache_details(self, response_cache_details): """ Sets the response_cache_details of this Gateway. :param response_cache_details: The response_cache_details of this Gateway. :type: oci.apigateway.models.ResponseCacheDetails """ self._response_cache_details = response_cache_details @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.oracle.com/iaas/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.oracle.com/iaas/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.oracle.com/iaas/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.oracle.com/iaas/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 @property def system_tags(self): """ Gets the system_tags of this Gateway. System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}` :return: The system_tags of this Gateway. :rtype: dict(str, dict(str, object)) """ return self._system_tags @system_tags.setter def system_tags(self, system_tags): """ Sets the system_tags of this Gateway. System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}` :param system_tags: The system_tags of this Gateway. :type: dict(str, dict(str, object)) """ self._system_tags = system_tags @property def ca_bundles(self): """ Gets the ca_bundles of this Gateway. An array of CA bundles that should be used on the Gateway for TLS validation. :return: The ca_bundles of this Gateway. :rtype: list[oci.apigateway.models.CaBundle] """ return self._ca_bundles @ca_bundles.setter def ca_bundles(self, ca_bundles): """ Sets the ca_bundles of this Gateway. An array of CA bundles that should be used on the Gateway for TLS validation. :param ca_bundles: The ca_bundles of this Gateway. :type: list[oci.apigateway.models.CaBundle] """ self._ca_bundles = ca_bundles @property def ip_mode(self): """ Gets the ip_mode of this Gateway. Determines whether the gateway has an IPv4 or IPv6 address assigned to it, or both. `IPV4` means the gateway will only have an IPv4 address assigned to it, and `IPV6` means the gateway will only have an `IPv6` address assigned to it. `DUAL_STACK` means the gateway will have both an IPv4 and IPv6 address assigned to it. Example: `IPV4` or `IPV6` or `DUAL_STACK` Allowed values for this property are: "IPV4", "IPV6", "DUAL_STACK", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :return: The ip_mode of this Gateway. :rtype: str """ return self._ip_mode @ip_mode.setter def ip_mode(self, ip_mode): """ Sets the ip_mode of this Gateway. Determines whether the gateway has an IPv4 or IPv6 address assigned to it, or both. `IPV4` means the gateway will only have an IPv4 address assigned to it, and `IPV6` means the gateway will only have an `IPv6` address assigned to it. `DUAL_STACK` means the gateway will have both an IPv4 and IPv6 address assigned to it. Example: `IPV4` or `IPV6` or `DUAL_STACK` :param ip_mode: The ip_mode of this Gateway. :type: str """ allowed_values = ["IPV4", "IPV6", "DUAL_STACK"] if not value_allowed_none_or_none_sentinel(ip_mode, allowed_values): ip_mode = 'UNKNOWN_ENUM_VALUE' self._ip_mode = ip_mode @property def ipv6_address_configuration(self): """ Gets the ipv6_address_configuration of this Gateway. :return: The ipv6_address_configuration of this Gateway. :rtype: oci.apigateway.models.Ipv6AddressConfiguration """ return self._ipv6_address_configuration @ipv6_address_configuration.setter def ipv6_address_configuration(self, ipv6_address_configuration): """ Sets the ipv6_address_configuration of this Gateway. :param ipv6_address_configuration: The ipv6_address_configuration of this Gateway. :type: oci.apigateway.models.Ipv6AddressConfiguration """ self._ipv6_address_configuration = ipv6_address_configuration @property def ipv4_address_configuration(self): """ Gets the ipv4_address_configuration of this Gateway. :return: The ipv4_address_configuration of this Gateway. :rtype: oci.apigateway.models.Ipv4AddressConfiguration """ return self._ipv4_address_configuration @ipv4_address_configuration.setter def ipv4_address_configuration(self, ipv4_address_configuration): """ Sets the ipv4_address_configuration of this Gateway. :param ipv4_address_configuration: The ipv4_address_configuration of this Gateway. :type: oci.apigateway.models.Ipv4AddressConfiguration """ self._ipv4_address_configuration = ipv4_address_configuration 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

| ver. 1.4 | Github | . | PHP 8.2.32 | Generation time: 0.06 | proxy | phpinfo | Settings