mv-oci-sdk 2.142.0__py3-none-any.whl → 2.142.0.2__py3-none-any.whl

oci/load_balancer/models/update_listener_details.py

@@ -0,0 +1,344 @@
+# 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: 20170115
+
+
+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 UpdateListenerDetails(object):
+    """
+    The configuration details for updating a listener.
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new UpdateListenerDetails object with values from keyword arguments.
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param default_backend_set_name:
+            The value to assign to the default_backend_set_name property of this UpdateListenerDetails.
+        :type default_backend_set_name: str
+
+        :param port:
+            The value to assign to the port property of this UpdateListenerDetails.
+        :type port: int
+
+        :param protocol:
+            The value to assign to the protocol property of this UpdateListenerDetails.
+        :type protocol: str
+
+        :param hostname_names:
+            The value to assign to the hostname_names property of this UpdateListenerDetails.
+        :type hostname_names: list[str]
+
+        :param path_route_set_name:
+            The value to assign to the path_route_set_name property of this UpdateListenerDetails.
+        :type path_route_set_name: str
+
+        :param routing_policy_name:
+            The value to assign to the routing_policy_name property of this UpdateListenerDetails.
+        :type routing_policy_name: str
+
+        :param ssl_configuration:
+            The value to assign to the ssl_configuration property of this UpdateListenerDetails.
+        :type ssl_configuration: oci.load_balancer.models.SSLConfigurationDetails
+
+        :param connection_configuration:
+            The value to assign to the connection_configuration property of this UpdateListenerDetails.
+        :type connection_configuration: oci.load_balancer.models.ConnectionConfiguration
+
+        :param rule_set_names:
+            The value to assign to the rule_set_names property of this UpdateListenerDetails.
+        :type rule_set_names: list[str]
+
+        """
+        self.swagger_types = {
+            'default_backend_set_name': 'str',
+            'port': 'int',
+            'protocol': 'str',
+            'hostname_names': 'list[str]',
+            'path_route_set_name': 'str',
+            'routing_policy_name': 'str',
+            'ssl_configuration': 'SSLConfigurationDetails',
+            'connection_configuration': 'ConnectionConfiguration',
+            'rule_set_names': 'list[str]'
+        }
+
+        self.attribute_map = {
+            'default_backend_set_name': 'defaultBackendSetName',
+            'port': 'port',
+            'protocol': 'protocol',
+            'hostname_names': 'hostnameNames',
+            'path_route_set_name': 'pathRouteSetName',
+            'routing_policy_name': 'routingPolicyName',
+            'ssl_configuration': 'sslConfiguration',
+            'connection_configuration': 'connectionConfiguration',
+            'rule_set_names': 'ruleSetNames'
+        }
+
+        self._default_backend_set_name = None
+        self._port = None
+        self._protocol = None
+        self._hostname_names = None
+        self._path_route_set_name = None
+        self._routing_policy_name = None
+        self._ssl_configuration = None
+        self._connection_configuration = None
+        self._rule_set_names = None
+
+    @property
+    def default_backend_set_name(self):
+        """
+        **[Required]** Gets the default_backend_set_name of this UpdateListenerDetails.
+        The name of the associated backend set.
+
+        Example: `example_backend_set`
+
+
+        :return: The default_backend_set_name of this UpdateListenerDetails.
+        :rtype: str
+        """
+        return self._default_backend_set_name
+
+    @default_backend_set_name.setter
+    def default_backend_set_name(self, default_backend_set_name):
+        """
+        Sets the default_backend_set_name of this UpdateListenerDetails.
+        The name of the associated backend set.
+
+        Example: `example_backend_set`
+
+
+        :param default_backend_set_name: The default_backend_set_name of this UpdateListenerDetails.
+        :type: str
+        """
+        self._default_backend_set_name = default_backend_set_name
+
+    @property
+    def port(self):
+        """
+        **[Required]** Gets the port of this UpdateListenerDetails.
+        The communication port for the listener.
+
+        Example: `80`
+
+
+        :return: The port of this UpdateListenerDetails.
+        :rtype: int
+        """
+        return self._port
+
+    @port.setter
+    def port(self, port):
+        """
+        Sets the port of this UpdateListenerDetails.
+        The communication port for the listener.
+
+        Example: `80`
+
+
+        :param port: The port of this UpdateListenerDetails.
+        :type: int
+        """
+        self._port = port
+
+    @property
+    def protocol(self):
+        """
+        **[Required]** Gets the protocol of this UpdateListenerDetails.
+        The protocol on which the listener accepts connection requests. The supported protocols are HTTP, HTTP2, TCP, and GRPC.
+        You can also use the :func:`list_protocols` operation to get a list of valid protocols.
+
+        Example: `HTTP`
+
+
+        :return: The protocol of this UpdateListenerDetails.
+        :rtype: str
+        """
+        return self._protocol
+
+    @protocol.setter
+    def protocol(self, protocol):
+        """
+        Sets the protocol of this UpdateListenerDetails.
+        The protocol on which the listener accepts connection requests. The supported protocols are HTTP, HTTP2, TCP, and GRPC.
+        You can also use the :func:`list_protocols` operation to get a list of valid protocols.
+
+        Example: `HTTP`
+
+
+        :param protocol: The protocol of this UpdateListenerDetails.
+        :type: str
+        """
+        self._protocol = protocol
+
+    @property
+    def hostname_names(self):
+        """
+        Gets the hostname_names of this UpdateListenerDetails.
+        An array of hostname resource names.
+
+
+        :return: The hostname_names of this UpdateListenerDetails.
+        :rtype: list[str]
+        """
+        return self._hostname_names
+
+    @hostname_names.setter
+    def hostname_names(self, hostname_names):
+        """
+        Sets the hostname_names of this UpdateListenerDetails.
+        An array of hostname resource names.
+
+
+        :param hostname_names: The hostname_names of this UpdateListenerDetails.
+        :type: list[str]
+        """
+        self._hostname_names = hostname_names
+
+    @property
+    def path_route_set_name(self):
+        """
+        Gets the path_route_set_name of this UpdateListenerDetails.
+        Deprecated. Please use `routingPolicies` instead.
+
+        The name of the set of path-based routing rules, :class:`PathRouteSet`,
+        applied to this listener's traffic.
+
+        Example: `example_path_route_set`
+
+
+        :return: The path_route_set_name of this UpdateListenerDetails.
+        :rtype: str
+        """
+        return self._path_route_set_name
+
+    @path_route_set_name.setter
+    def path_route_set_name(self, path_route_set_name):
+        """
+        Sets the path_route_set_name of this UpdateListenerDetails.
+        Deprecated. Please use `routingPolicies` instead.
+
+        The name of the set of path-based routing rules, :class:`PathRouteSet`,
+        applied to this listener's traffic.
+
+        Example: `example_path_route_set`
+
+
+        :param path_route_set_name: The path_route_set_name of this UpdateListenerDetails.
+        :type: str
+        """
+        self._path_route_set_name = path_route_set_name
+
+    @property
+    def routing_policy_name(self):
+        """
+        Gets the routing_policy_name of this UpdateListenerDetails.
+        The name of the routing policy applied to this listener's traffic.
+
+        Example: `example_routing_policy`
+
+
+        :return: The routing_policy_name of this UpdateListenerDetails.
+        :rtype: str
+        """
+        return self._routing_policy_name
+
+    @routing_policy_name.setter
+    def routing_policy_name(self, routing_policy_name):
+        """
+        Sets the routing_policy_name of this UpdateListenerDetails.
+        The name of the routing policy applied to this listener's traffic.
+
+        Example: `example_routing_policy`
+
+
+        :param routing_policy_name: The routing_policy_name of this UpdateListenerDetails.
+        :type: str
+        """
+        self._routing_policy_name = routing_policy_name
+
+    @property
+    def ssl_configuration(self):
+        """
+        Gets the ssl_configuration of this UpdateListenerDetails.
+
+        :return: The ssl_configuration of this UpdateListenerDetails.
+        :rtype: oci.load_balancer.models.SSLConfigurationDetails
+        """
+        return self._ssl_configuration
+
+    @ssl_configuration.setter
+    def ssl_configuration(self, ssl_configuration):
+        """
+        Sets the ssl_configuration of this UpdateListenerDetails.
+
+        :param ssl_configuration: The ssl_configuration of this UpdateListenerDetails.
+        :type: oci.load_balancer.models.SSLConfigurationDetails
+        """
+        self._ssl_configuration = ssl_configuration
+
+    @property
+    def connection_configuration(self):
+        """
+        Gets the connection_configuration of this UpdateListenerDetails.
+
+        :return: The connection_configuration of this UpdateListenerDetails.
+        :rtype: oci.load_balancer.models.ConnectionConfiguration
+        """
+        return self._connection_configuration
+
+    @connection_configuration.setter
+    def connection_configuration(self, connection_configuration):
+        """
+        Sets the connection_configuration of this UpdateListenerDetails.
+
+        :param connection_configuration: The connection_configuration of this UpdateListenerDetails.
+        :type: oci.load_balancer.models.ConnectionConfiguration
+        """
+        self._connection_configuration = connection_configuration
+
+    @property
+    def rule_set_names(self):
+        """
+        Gets the rule_set_names of this UpdateListenerDetails.
+        The names of the :class:`RuleSet` to apply to the listener.
+
+        Example: [\"example_rule_set\"]
+
+
+        :return: The rule_set_names of this UpdateListenerDetails.
+        :rtype: list[str]
+        """
+        return self._rule_set_names
+
+    @rule_set_names.setter
+    def rule_set_names(self, rule_set_names):
+        """
+        Sets the rule_set_names of this UpdateListenerDetails.
+        The names of the :class:`RuleSet` to apply to the listener.
+
+        Example: [\"example_rule_set\"]
+
+
+        :param rule_set_names: The rule_set_names of this UpdateListenerDetails.
+        :type: list[str]
+        """
+        self._rule_set_names = rule_set_names
+
+    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

oci/load_balancer/models/update_load_balancer_details.py

@@ -0,0 +1,356 @@
+# 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: 20170115
+
+
+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 UpdateLoadBalancerDetails(object):
+    """
+    Configuration details to update a load balancer.
+
+    **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new UpdateLoadBalancerDetails object with values from keyword arguments.
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param display_name:
+            The value to assign to the display_name property of this UpdateLoadBalancerDetails.
+        :type display_name: str
+
+        :param is_delete_protection_enabled:
+            The value to assign to the is_delete_protection_enabled property of this UpdateLoadBalancerDetails.
+        :type is_delete_protection_enabled: bool
+
+        :param is_request_id_enabled:
+            The value to assign to the is_request_id_enabled property of this UpdateLoadBalancerDetails.
+        :type is_request_id_enabled: bool
+
+        :param request_id_header:
+            The value to assign to the request_id_header property of this UpdateLoadBalancerDetails.
+        :type request_id_header: str
+
+        :param freeform_tags:
+            The value to assign to the freeform_tags property of this UpdateLoadBalancerDetails.
+        :type freeform_tags: dict(str, str)
+
+        :param defined_tags:
+            The value to assign to the defined_tags property of this UpdateLoadBalancerDetails.
+        :type defined_tags: dict(str, dict(str, object))
+
+        :param zpr_tags:
+            The value to assign to the zpr_tags property of this UpdateLoadBalancerDetails.
+        :type zpr_tags: dict(str, dict(str, object))
+
+        """
+        self.swagger_types = {
+            'display_name': 'str',
+            'is_delete_protection_enabled': 'bool',
+            'is_request_id_enabled': 'bool',
+            'request_id_header': 'str',
+            'freeform_tags': 'dict(str, str)',
+            'defined_tags': 'dict(str, dict(str, object))',
+            'zpr_tags': 'dict(str, dict(str, object))'
+        }
+
+        self.attribute_map = {
+            'display_name': 'displayName',
+            'is_delete_protection_enabled': 'isDeleteProtectionEnabled',
+            'is_request_id_enabled': 'isRequestIdEnabled',
+            'request_id_header': 'requestIdHeader',
+            'freeform_tags': 'freeformTags',
+            'defined_tags': 'definedTags',
+            'zpr_tags': 'zprTags'
+        }
+
+        self._display_name = None
+        self._is_delete_protection_enabled = None
+        self._is_request_id_enabled = None
+        self._request_id_header = None
+        self._freeform_tags = None
+        self._defined_tags = None
+        self._zpr_tags = None
+
+    @property
+    def display_name(self):
+        """
+        Gets the display_name of this UpdateLoadBalancerDetails.
+        The user-friendly display name for the load balancer. It does not have to be unique, and it is changeable.
+        Avoid entering confidential information.
+
+        Example: `example_load_balancer`
+
+
+        :return: The display_name of this UpdateLoadBalancerDetails.
+        :rtype: str
+        """
+        return self._display_name
+
+    @display_name.setter
+    def display_name(self, display_name):
+        """
+        Sets the display_name of this UpdateLoadBalancerDetails.
+        The user-friendly display name for the load balancer. It does not have to be unique, and it is changeable.
+        Avoid entering confidential information.
+
+        Example: `example_load_balancer`
+
+
+        :param display_name: The display_name of this UpdateLoadBalancerDetails.
+        :type: str
+        """
+        self._display_name = display_name
+
+    @property
+    def is_delete_protection_enabled(self):
+        """
+        Gets the is_delete_protection_enabled of this UpdateLoadBalancerDetails.
+        Whether or not the load balancer has delete protection enabled.
+
+        If \"true\", the loadbalancer will be protected against deletion if configured to accept traffic.
+
+        If \"false\", the loadbalancer will not be protected against deletion.
+
+        If null or unset, the value for delete protection will not be changed.
+
+        Example: `true`
+
+
+        :return: The is_delete_protection_enabled of this UpdateLoadBalancerDetails.
+        :rtype: bool
+        """
+        return self._is_delete_protection_enabled
+
+    @is_delete_protection_enabled.setter
+    def is_delete_protection_enabled(self, is_delete_protection_enabled):
+        """
+        Sets the is_delete_protection_enabled of this UpdateLoadBalancerDetails.
+        Whether or not the load balancer has delete protection enabled.
+
+        If \"true\", the loadbalancer will be protected against deletion if configured to accept traffic.
+
+        If \"false\", the loadbalancer will not be protected against deletion.
+
+        If null or unset, the value for delete protection will not be changed.
+
+        Example: `true`
+
+
+        :param is_delete_protection_enabled: The is_delete_protection_enabled of this UpdateLoadBalancerDetails.
+        :type: bool
+        """
+        self._is_delete_protection_enabled = is_delete_protection_enabled
+
+    @property
+    def is_request_id_enabled(self):
+        """
+        Gets the is_request_id_enabled of this UpdateLoadBalancerDetails.
+        Whether or not the load balancer has the Request Id feature enabled for HTTP listeners.
+
+        If \"true\", the load balancer will attach a unique request id header to every request
+        passed through from the load balancer to load balancer backends. This same request id
+        header also will be added to the response the lb received from the backend handling
+        the request before the load balancer returns the response to the requestor. The name
+        of the unique request id header is set the by value of requestIdHeader.
+
+        If \"false\", the loadbalancer not add this unique request id header to either the request
+        passed through to the load balancer backends nor to the reponse returned to the user.
+
+        New load balancers have the Request Id feature enabled unless isRequestIdEnabled is set to False.
+
+        Example: `true`
+
+
+        :return: The is_request_id_enabled of this UpdateLoadBalancerDetails.
+        :rtype: bool
+        """
+        return self._is_request_id_enabled
+
+    @is_request_id_enabled.setter
+    def is_request_id_enabled(self, is_request_id_enabled):
+        """
+        Sets the is_request_id_enabled of this UpdateLoadBalancerDetails.
+        Whether or not the load balancer has the Request Id feature enabled for HTTP listeners.
+
+        If \"true\", the load balancer will attach a unique request id header to every request
+        passed through from the load balancer to load balancer backends. This same request id
+        header also will be added to the response the lb received from the backend handling
+        the request before the load balancer returns the response to the requestor. The name
+        of the unique request id header is set the by value of requestIdHeader.
+
+        If \"false\", the loadbalancer not add this unique request id header to either the request
+        passed through to the load balancer backends nor to the reponse returned to the user.
+
+        New load balancers have the Request Id feature enabled unless isRequestIdEnabled is set to False.
+
+        Example: `true`
+
+
+        :param is_request_id_enabled: The is_request_id_enabled of this UpdateLoadBalancerDetails.
+        :type: bool
+        """
+        self._is_request_id_enabled = is_request_id_enabled
+
+    @property
+    def request_id_header(self):
+        """
+        Gets the request_id_header of this UpdateLoadBalancerDetails.
+        If isRequestIdEnabled is true then this field contains the name of the header field
+        that contains the unique request id that is attached to every request from
+        the load balancer to the load balancer backends and to every response from the load
+        balancer.
+
+        If a request to the load balancer already contains a header with same name as specified
+        in requestIdHeader then the load balancer will not change the value of that field.
+
+        If isRequestIdEnabled is false then this field is ignored.
+
+        **Notes:**
+        * Unless the header name is \"\" it must start with \"X-\" prefix.
+        * Setting the header name to \"\" will set it to the default: X-Request-Id.
+
+
+        :return: The request_id_header of this UpdateLoadBalancerDetails.
+        :rtype: str
+        """
+        return self._request_id_header
+
+    @request_id_header.setter
+    def request_id_header(self, request_id_header):
+        """
+        Sets the request_id_header of this UpdateLoadBalancerDetails.
+        If isRequestIdEnabled is true then this field contains the name of the header field
+        that contains the unique request id that is attached to every request from
+        the load balancer to the load balancer backends and to every response from the load
+        balancer.
+
+        If a request to the load balancer already contains a header with same name as specified
+        in requestIdHeader then the load balancer will not change the value of that field.
+
+        If isRequestIdEnabled is false then this field is ignored.
+
+        **Notes:**
+        * Unless the header name is \"\" it must start with \"X-\" prefix.
+        * Setting the header name to \"\" will set it to the default: X-Request-Id.
+
+
+        :param request_id_header: The request_id_header of this UpdateLoadBalancerDetails.
+        :type: str
+        """
+        self._request_id_header = request_id_header
+
+    @property
+    def freeform_tags(self):
+        """
+        Gets the freeform_tags of this UpdateLoadBalancerDetails.
+        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 UpdateLoadBalancerDetails.
+        :rtype: dict(str, str)
+        """
+        return self._freeform_tags
+
+    @freeform_tags.setter
+    def freeform_tags(self, freeform_tags):
+        """
+        Sets the freeform_tags of this UpdateLoadBalancerDetails.
+        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 UpdateLoadBalancerDetails.
+        :type: dict(str, str)
+        """
+        self._freeform_tags = freeform_tags
+
+    @property
+    def defined_tags(self):
+        """
+        Gets the defined_tags of this UpdateLoadBalancerDetails.
+        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 UpdateLoadBalancerDetails.
+        :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 UpdateLoadBalancerDetails.
+        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 UpdateLoadBalancerDetails.
+        :type: dict(str, dict(str, object))
+        """
+        self._defined_tags = defined_tags
+
+    @property
+    def zpr_tags(self):
+        """
+        Gets the zpr_tags of this UpdateLoadBalancerDetails.
+        Extended Defined tags for ZPR for this resource. Each key is predefined and scoped to a namespace.
+
+        Example: `{\"Oracle-ZPR\": {\"MaxEgressCount\": {\"value\":\"42\",\"mode\":\"audit\", \"usagetype\" : \"zpr\"}}}`
+
+
+        :return: The zpr_tags of this UpdateLoadBalancerDetails.
+        :rtype: dict(str, dict(str, object))
+        """
+        return self._zpr_tags
+
+    @zpr_tags.setter
+    def zpr_tags(self, zpr_tags):
+        """
+        Sets the zpr_tags of this UpdateLoadBalancerDetails.
+        Extended Defined tags for ZPR for this resource. Each key is predefined and scoped to a namespace.
+
+        Example: `{\"Oracle-ZPR\": {\"MaxEgressCount\": {\"value\":\"42\",\"mode\":\"audit\", \"usagetype\" : \"zpr\"}}}`
+
+
+        :param zpr_tags: The zpr_tags of this UpdateLoadBalancerDetails.
+        :type: dict(str, dict(str, object))
+        """
+        self._zpr_tags = zpr_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