oci 2.131.0__py3-none-any.whl → 2.132.0__py3-none-any.whl

oci/redis/models/node_summary.py

@@ -0,0 +1,196 @@
+# coding: utf-8
+# Copyright (c) 2016, 2024, 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: 20220315
+
+
+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 NodeSummary(object):
+    """
+    The details of each node in the cluster.
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new NodeSummary object with values from keyword arguments.
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param private_endpoint_fqdn:
+            The value to assign to the private_endpoint_fqdn property of this NodeSummary.
+        :type private_endpoint_fqdn: str
+
+        :param private_endpoint_ip_address:
+            The value to assign to the private_endpoint_ip_address property of this NodeSummary.
+        :type private_endpoint_ip_address: str
+
+        :param display_name:
+            The value to assign to the display_name property of this NodeSummary.
+        :type display_name: str
+
+        :param redis_cluster_id:
+            The value to assign to the redis_cluster_id property of this NodeSummary.
+        :type redis_cluster_id: str
+
+        :param shard_number:
+            The value to assign to the shard_number property of this NodeSummary.
+        :type shard_number: int
+
+        """
+        self.swagger_types = {
+            'private_endpoint_fqdn': 'str',
+            'private_endpoint_ip_address': 'str',
+            'display_name': 'str',
+            'redis_cluster_id': 'str',
+            'shard_number': 'int'
+        }
+
+        self.attribute_map = {
+            'private_endpoint_fqdn': 'privateEndpointFqdn',
+            'private_endpoint_ip_address': 'privateEndpointIpAddress',
+            'display_name': 'displayName',
+            'redis_cluster_id': 'redisClusterId',
+            'shard_number': 'shardNumber'
+        }
+
+        self._private_endpoint_fqdn = None
+        self._private_endpoint_ip_address = None
+        self._display_name = None
+        self._redis_cluster_id = None
+        self._shard_number = None
+
+    @property
+    def private_endpoint_fqdn(self):
+        """
+        **[Required]** Gets the private_endpoint_fqdn of this NodeSummary.
+        The fully qualified domain name (FQDN) of the API endpoint to access a specific node.
+
+
+        :return: The private_endpoint_fqdn of this NodeSummary.
+        :rtype: str
+        """
+        return self._private_endpoint_fqdn
+
+    @private_endpoint_fqdn.setter
+    def private_endpoint_fqdn(self, private_endpoint_fqdn):
+        """
+        Sets the private_endpoint_fqdn of this NodeSummary.
+        The fully qualified domain name (FQDN) of the API endpoint to access a specific node.
+
+
+        :param private_endpoint_fqdn: The private_endpoint_fqdn of this NodeSummary.
+        :type: str
+        """
+        self._private_endpoint_fqdn = private_endpoint_fqdn
+
+    @property
+    def private_endpoint_ip_address(self):
+        """
+        **[Required]** Gets the private_endpoint_ip_address of this NodeSummary.
+        The private IP address of the API endpoint to access a specific node.
+
+
+        :return: The private_endpoint_ip_address of this NodeSummary.
+        :rtype: str
+        """
+        return self._private_endpoint_ip_address
+
+    @private_endpoint_ip_address.setter
+    def private_endpoint_ip_address(self, private_endpoint_ip_address):
+        """
+        Sets the private_endpoint_ip_address of this NodeSummary.
+        The private IP address of the API endpoint to access a specific node.
+
+
+        :param private_endpoint_ip_address: The private_endpoint_ip_address of this NodeSummary.
+        :type: str
+        """
+        self._private_endpoint_ip_address = private_endpoint_ip_address
+
+    @property
+    def display_name(self):
+        """
+        **[Required]** Gets the display_name of this NodeSummary.
+        A user-friendly name of a cluster node.
+
+
+        :return: The display_name of this NodeSummary.
+        :rtype: str
+        """
+        return self._display_name
+
+    @display_name.setter
+    def display_name(self, display_name):
+        """
+        Sets the display_name of this NodeSummary.
+        A user-friendly name of a cluster node.
+
+
+        :param display_name: The display_name of this NodeSummary.
+        :type: str
+        """
+        self._display_name = display_name
+
+    @property
+    def redis_cluster_id(self):
+        """
+        **[Required]** Gets the redis_cluster_id of this NodeSummary.
+        The OCID of the cluster
+
+
+        :return: The redis_cluster_id of this NodeSummary.
+        :rtype: str
+        """
+        return self._redis_cluster_id
+
+    @redis_cluster_id.setter
+    def redis_cluster_id(self, redis_cluster_id):
+        """
+        Sets the redis_cluster_id of this NodeSummary.
+        The OCID of the cluster
+
+
+        :param redis_cluster_id: The redis_cluster_id of this NodeSummary.
+        :type: str
+        """
+        self._redis_cluster_id = redis_cluster_id
+
+    @property
+    def shard_number(self):
+        """
+        Gets the shard_number of this NodeSummary.
+        The shard number to which the node belongs to.
+
+
+        :return: The shard_number of this NodeSummary.
+        :rtype: int
+        """
+        return self._shard_number
+
+    @shard_number.setter
+    def shard_number(self, shard_number):
+        """
+        Sets the shard_number of this NodeSummary.
+        The shard number to which the node belongs to.
+
+
+        :param shard_number: The shard_number of this NodeSummary.
+        :type: int
+        """
+        self._shard_number = shard_number
+
+    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/redis/models/redis_cluster.py

@@ -12,9 +12,9 @@ from oci.decorators import init_model_state_from_kwargs
 @init_model_state_from_kwargs
 class RedisCluster(object):
     """
-    A Redis cluster is a memory-based storage solution. For more information, see `OCI Caching Service with Redis`__.
+    An OCI Cache cluster is a memory-based storage solution. For more information, see `OCI Cache`__.
 
-    __ https://docs.cloud.oracle.com/iaas/Content/redis/home.htm
+    __ https://docs.cloud.oracle.com/iaas/Content/ocicache/home.htm
     """
 
     #: A constant which can be used with the lifecycle_state property of a RedisCluster.
@@ -49,6 +49,14 @@ class RedisCluster(object):
     #: This constant has a value of "REDIS_7_0"
     SOFTWARE_VERSION_REDIS_7_0 = "REDIS_7_0"
 
+    #: A constant which can be used with the cluster_mode property of a RedisCluster.
+    #: This constant has a value of "SHARDED"
+    CLUSTER_MODE_SHARDED = "SHARDED"
+
+    #: A constant which can be used with the cluster_mode property of a RedisCluster.
+    #: This constant has a value of "NONSHARDED"
+    CLUSTER_MODE_NONSHARDED = "NONSHARDED"
+
     def __init__(self, **kwargs):
         """
         Initializes a new RedisCluster object with values from keyword arguments.
@@ -122,6 +130,16 @@ class RedisCluster(object):
             The value to assign to the node_collection property of this RedisCluster.
         :type node_collection: oci.redis.models.NodeCollection
 
+        :param cluster_mode:
+            The value to assign to the cluster_mode property of this RedisCluster.
+            Allowed values for this property are: "SHARDED", "NONSHARDED", 'UNKNOWN_ENUM_VALUE'.
+            Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
+        :type cluster_mode: str
+
+        :param shard_count:
+            The value to assign to the shard_count property of this RedisCluster.
+        :type shard_count: int
+
         :param nsg_ids:
             The value to assign to the nsg_ids property of this RedisCluster.
         :type nsg_ids: list[str]
@@ -156,6 +174,8 @@ class RedisCluster(object):
             'time_created': 'datetime',
             'time_updated': 'datetime',
             'node_collection': 'NodeCollection',
+            'cluster_mode': 'str',
+            'shard_count': 'int',
             'nsg_ids': 'list[str]',
             'freeform_tags': 'dict(str, str)',
             'defined_tags': 'dict(str, dict(str, object))',
@@ -179,6 +199,8 @@ class RedisCluster(object):
             'time_created': 'timeCreated',
             'time_updated': 'timeUpdated',
             'node_collection': 'nodeCollection',
+            'cluster_mode': 'clusterMode',
+            'shard_count': 'shardCount',
             'nsg_ids': 'nsgIds',
             'freeform_tags': 'freeformTags',
             'defined_tags': 'definedTags',
@@ -201,6 +223,8 @@ class RedisCluster(object):
         self._time_created = None
         self._time_updated = None
         self._node_collection = None
+        self._cluster_mode = None
+        self._shard_count = None
         self._nsg_ids = None
         self._freeform_tags = None
         self._defined_tags = None
@@ -210,7 +234,7 @@ class RedisCluster(object):
     def id(self):
         """
         **[Required]** Gets the id of this RedisCluster.
-        The `OCID`__ of the Redis cluster.
+        The `OCID`__ of the cluster.
 
         __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm#Oracle
 
@@ -224,7 +248,7 @@ class RedisCluster(object):
     def id(self, id):
         """
         Sets the id of this RedisCluster.
-        The `OCID`__ of the Redis cluster.
+        The `OCID`__ of the cluster.
 
         __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm#Oracle
 
@@ -262,7 +286,7 @@ class RedisCluster(object):
     def compartment_id(self):
         """
         **[Required]** Gets the compartment_id of this RedisCluster.
-        The `OCID`__ of the compartment that contains the Redis cluster.
+        The `OCID`__ of the compartment that contains the cluster.
 
         __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm#Oracle
 
@@ -276,7 +300,7 @@ class RedisCluster(object):
     def compartment_id(self, compartment_id):
         """
         Sets the compartment_id of this RedisCluster.
-        The `OCID`__ of the compartment that contains the Redis cluster.
+        The `OCID`__ of the compartment that contains the cluster.
 
         __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm#Oracle
 
@@ -290,7 +314,7 @@ class RedisCluster(object):
     def lifecycle_state(self):
         """
         Gets the lifecycle_state of this RedisCluster.
-        The current state of the Redis cluster.
+        The current state of the cluster.
 
         Allowed values for this property are: "CREATING", "UPDATING", "ACTIVE", "DELETING", "DELETED", "FAILED", 'UNKNOWN_ENUM_VALUE'.
         Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
@@ -305,7 +329,7 @@ class RedisCluster(object):
     def lifecycle_state(self, lifecycle_state):
         """
         Sets the lifecycle_state of this RedisCluster.
-        The current state of the Redis cluster.
+        The current state of the cluster.
 
 
         :param lifecycle_state: The lifecycle_state of this RedisCluster.
@@ -344,7 +368,7 @@ class RedisCluster(object):
     def node_count(self):
         """
         **[Required]** Gets the node_count of this RedisCluster.
-        The number of nodes in the Redis cluster.
+        The number of nodes per shard in the cluster when clusterMode is SHARDED. This is the total number of nodes when clusterMode is NONSHARDED.
 
 
         :return: The node_count of this RedisCluster.
@@ -356,7 +380,7 @@ class RedisCluster(object):
     def node_count(self, node_count):
         """
         Sets the node_count of this RedisCluster.
-        The number of nodes in the Redis cluster.
+        The number of nodes per shard in the cluster when clusterMode is SHARDED. This is the total number of nodes when clusterMode is NONSHARDED.
 
 
         :param node_count: The node_count of this RedisCluster.
@@ -368,7 +392,7 @@ class RedisCluster(object):
     def node_memory_in_gbs(self):
         """
         **[Required]** Gets the node_memory_in_gbs of this RedisCluster.
-        The amount of memory allocated to the Redis cluster's nodes, in gigabytes.
+        The amount of memory allocated to the cluster's nodes, in gigabytes.
 
 
         :return: The node_memory_in_gbs of this RedisCluster.
@@ -380,7 +404,7 @@ class RedisCluster(object):
     def node_memory_in_gbs(self, node_memory_in_gbs):
         """
         Sets the node_memory_in_gbs of this RedisCluster.
-        The amount of memory allocated to the Redis cluster's nodes, in gigabytes.
+        The amount of memory allocated to the cluster's nodes, in gigabytes.
 
 
         :param node_memory_in_gbs: The node_memory_in_gbs of this RedisCluster.
@@ -392,7 +416,7 @@ class RedisCluster(object):
     def primary_fqdn(self):
         """
         **[Required]** Gets the primary_fqdn of this RedisCluster.
-        The fully qualified domain name (FQDN) of the API endpoint for the Redis cluster's primary node.
+        The fully qualified domain name (FQDN) of the API endpoint for the cluster's primary node.
 
 
         :return: The primary_fqdn of this RedisCluster.
@@ -404,7 +428,7 @@ class RedisCluster(object):
     def primary_fqdn(self, primary_fqdn):
         """
         Sets the primary_fqdn of this RedisCluster.
-        The fully qualified domain name (FQDN) of the API endpoint for the Redis cluster's primary node.
+        The fully qualified domain name (FQDN) of the API endpoint for the cluster's primary node.
 
 
         :param primary_fqdn: The primary_fqdn of this RedisCluster.
@@ -416,7 +440,7 @@ class RedisCluster(object):
     def primary_endpoint_ip_address(self):
         """
         **[Required]** Gets the primary_endpoint_ip_address of this RedisCluster.
-        The private IP address of the API endpoint for the Redis cluster's primary node.
+        The private IP address of the API endpoint for the cluster's primary node.
 
 
         :return: The primary_endpoint_ip_address of this RedisCluster.
@@ -428,7 +452,7 @@ class RedisCluster(object):
     def primary_endpoint_ip_address(self, primary_endpoint_ip_address):
         """
         Sets the primary_endpoint_ip_address of this RedisCluster.
-        The private IP address of the API endpoint for the Redis cluster's primary node.
+        The private IP address of the API endpoint for the cluster's primary node.
 
 
         :param primary_endpoint_ip_address: The primary_endpoint_ip_address of this RedisCluster.
@@ -440,7 +464,7 @@ class RedisCluster(object):
     def replicas_fqdn(self):
         """
         **[Required]** Gets the replicas_fqdn of this RedisCluster.
-        The fully qualified domain name (FQDN) of the API endpoint for the Redis cluster's replica nodes.
+        The fully qualified domain name (FQDN) of the API endpoint for the cluster's replica nodes.
 
 
         :return: The replicas_fqdn of this RedisCluster.
@@ -452,7 +476,7 @@ class RedisCluster(object):
     def replicas_fqdn(self, replicas_fqdn):
         """
         Sets the replicas_fqdn of this RedisCluster.
-        The fully qualified domain name (FQDN) of the API endpoint for the Redis cluster's replica nodes.
+        The fully qualified domain name (FQDN) of the API endpoint for the cluster's replica nodes.
 
 
         :param replicas_fqdn: The replicas_fqdn of this RedisCluster.
@@ -464,7 +488,7 @@ class RedisCluster(object):
     def replicas_endpoint_ip_address(self):
         """
         **[Required]** Gets the replicas_endpoint_ip_address of this RedisCluster.
-        The private IP address of the API endpoint for the Redis cluster's replica nodes.
+        The private IP address of the API endpoint for the cluster's replica nodes.
 
 
         :return: The replicas_endpoint_ip_address of this RedisCluster.
@@ -476,7 +500,7 @@ class RedisCluster(object):
     def replicas_endpoint_ip_address(self, replicas_endpoint_ip_address):
         """
         Sets the replicas_endpoint_ip_address of this RedisCluster.
-        The private IP address of the API endpoint for the Redis cluster's replica nodes.
+        The private IP address of the API endpoint for the cluster's replica nodes.
 
 
         :param replicas_endpoint_ip_address: The replicas_endpoint_ip_address of this RedisCluster.
@@ -488,7 +512,7 @@ class RedisCluster(object):
     def software_version(self):
         """
         **[Required]** Gets the software_version of this RedisCluster.
-        The Redis version that the cluster is running.
+        The OCI Cache engine version that the cluster is running.
 
         Allowed values for this property are: "V7_0_5", "REDIS_7_0", 'UNKNOWN_ENUM_VALUE'.
         Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
@@ -503,7 +527,7 @@ class RedisCluster(object):
     def software_version(self, software_version):
         """
         Sets the software_version of this RedisCluster.
-        The Redis version that the cluster is running.
+        The OCI Cache engine version that the cluster is running.
 
 
         :param software_version: The software_version of this RedisCluster.
@@ -518,7 +542,7 @@ class RedisCluster(object):
     def subnet_id(self):
         """
         **[Required]** Gets the subnet_id of this RedisCluster.
-        The `OCID`__ of the Redis cluster's subnet.
+        The `OCID`__ of the cluster's subnet.
 
         __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm#Oracle
 
@@ -532,7 +556,7 @@ class RedisCluster(object):
     def subnet_id(self, subnet_id):
         """
         Sets the subnet_id of this RedisCluster.
-        The `OCID`__ of the Redis cluster's subnet.
+        The `OCID`__ of the cluster's subnet.
 
         __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm#Oracle
 
@@ -546,7 +570,7 @@ class RedisCluster(object):
     def time_created(self):
         """
         Gets the time_created of this RedisCluster.
-        The date and time the Redis cluster was created. An `RFC3339`__ formatted datetime string.
+        The date and time the cluster was created. An `RFC3339`__ formatted datetime string.
 
         __ https://datatracker.ietf.org/doc/html/rfc3339
 
@@ -560,7 +584,7 @@ class RedisCluster(object):
     def time_created(self, time_created):
         """
         Sets the time_created of this RedisCluster.
-        The date and time the Redis cluster was created. An `RFC3339`__ formatted datetime string.
+        The date and time the cluster was created. An `RFC3339`__ formatted datetime string.
 
         __ https://datatracker.ietf.org/doc/html/rfc3339
 
@@ -574,7 +598,7 @@ class RedisCluster(object):
     def time_updated(self):
         """
         Gets the time_updated of this RedisCluster.
-        The date and time the Redis cluster was updated. An `RFC3339`__ formatted datetime string.
+        The date and time the cluster was updated. An `RFC3339`__ formatted datetime string.
 
         __ https://datatracker.ietf.org/doc/html/rfc3339
 
@@ -588,7 +612,7 @@ class RedisCluster(object):
     def time_updated(self, time_updated):
         """
         Sets the time_updated of this RedisCluster.
-        The date and time the Redis cluster was updated. An `RFC3339`__ formatted datetime string.
+        The date and time the cluster was updated. An `RFC3339`__ formatted datetime string.
 
         __ https://datatracker.ietf.org/doc/html/rfc3339
 
@@ -618,16 +642,70 @@ class RedisCluster(object):
         """
         self._node_collection = node_collection
 
+    @property
+    def cluster_mode(self):
+        """
+        Gets the cluster_mode of this RedisCluster.
+        Specifies whether the cluster is sharded or non-sharded.
+
+        Allowed values for this property are: "SHARDED", "NONSHARDED", 'UNKNOWN_ENUM_VALUE'.
+        Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
+
+
+        :return: The cluster_mode of this RedisCluster.
+        :rtype: str
+        """
+        return self._cluster_mode
+
+    @cluster_mode.setter
+    def cluster_mode(self, cluster_mode):
+        """
+        Sets the cluster_mode of this RedisCluster.
+        Specifies whether the cluster is sharded or non-sharded.
+
+
+        :param cluster_mode: The cluster_mode of this RedisCluster.
+        :type: str
+        """
+        allowed_values = ["SHARDED", "NONSHARDED"]
+        if not value_allowed_none_or_none_sentinel(cluster_mode, allowed_values):
+            cluster_mode = 'UNKNOWN_ENUM_VALUE'
+        self._cluster_mode = cluster_mode
+
+    @property
+    def shard_count(self):
+        """
+        Gets the shard_count of this RedisCluster.
+        The number of shards in a sharded cluster. Only applicable when clusterMode is SHARDED.
+
+
+        :return: The shard_count of this RedisCluster.
+        :rtype: int
+        """
+        return self._shard_count
+
+    @shard_count.setter
+    def shard_count(self, shard_count):
+        """
+        Sets the shard_count of this RedisCluster.
+        The number of shards in a sharded cluster. Only applicable when clusterMode is SHARDED.
+
+
+        :param shard_count: The shard_count of this RedisCluster.
+        :type: int
+        """
+        self._shard_count = shard_count
+
     @property
     def nsg_ids(self):
         """
         Gets the nsg_ids of this RedisCluster.
         A list of Network Security Group (NSG) `OCIDs`__
         associated with this cluster. For more information,
-        see `Using an NSG for Redis Clusters`__.
+        see `Using an NSG for Clusters`__.
 
         __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm
-        __ https://docs.cloud.oracle.com/iaas/Content/redis/connecttorediscluster.htm#connecttorediscluster__networksecuritygroup
+        __ https://docs.cloud.oracle.com/iaas/Content/ocicache/connecttocluster.htm#connecttocluster__networksecuritygroup
 
 
         :return: The nsg_ids of this RedisCluster.
@@ -641,10 +719,10 @@ class RedisCluster(object):
         Sets the nsg_ids of this RedisCluster.
         A list of Network Security Group (NSG) `OCIDs`__
         associated with this cluster. For more information,
-        see `Using an NSG for Redis Clusters`__.
+        see `Using an NSG for Clusters`__.
 
         __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm
-        __ https://docs.cloud.oracle.com/iaas/Content/redis/connecttorediscluster.htm#connecttorediscluster__networksecuritygroup
+        __ https://docs.cloud.oracle.com/iaas/Content/ocicache/connecttocluster.htm#connecttocluster__networksecuritygroup
 
 
         :param nsg_ids: The nsg_ids of this RedisCluster.

oci/redis/models/redis_cluster_collection.py

@@ -12,9 +12,9 @@ from oci.decorators import init_model_state_from_kwargs
 @init_model_state_from_kwargs
 class RedisClusterCollection(object):
     """
-    A list of Redis clusters that match filter criteria, if any. A Redis cluster is a memory-based storage solution. For more information, see `OCI Caching Service with Redis`__.
+    A list of clusters that match filter criteria, if any. A cluster is a memory-based storage solution. For more information, see `OCI Cache`__.
 
-    __ https://docs.cloud.oracle.com/iaas/Content/redis/home.htm
+    __ https://docs.cloud.oracle.com/iaas/Content/ocicache/home.htm
     """
 
     def __init__(self, **kwargs):
@@ -41,7 +41,7 @@ class RedisClusterCollection(object):
     def items(self):
         """
         **[Required]** Gets the items of this RedisClusterCollection.
-        The list of Redis clusters.
+        The list of clusters.
 
 
         :return: The items of this RedisClusterCollection.
@@ -53,7 +53,7 @@ class RedisClusterCollection(object):
     def items(self, items):
         """
         Sets the items of this RedisClusterCollection.
-        The list of Redis clusters.
+        The list of clusters.
 
 
         :param items: The items of this RedisClusterCollection.