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

oci/redis/models/redis_cluster_summary.py

@@ -12,9 +12,9 @@ from oci.decorators import init_model_state_from_kwargs
 @init_model_state_from_kwargs
 class RedisClusterSummary(object):
     """
-    Summary of information about a Redis cluster. A Redis cluster is a memory-based storage solution. For more information, see `OCI Caching Service with Redis`__.
+    Summary of information about a cluster. 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):
@@ -82,6 +82,14 @@ class RedisClusterSummary(object):
             The value to assign to the time_updated property of this RedisClusterSummary.
         :type time_updated: datetime
 
+        :param cluster_mode:
+            The value to assign to the cluster_mode property of this RedisClusterSummary.
+        :type cluster_mode: str
+
+        :param shard_count:
+            The value to assign to the shard_count property of this RedisClusterSummary.
+        :type shard_count: int
+
         :param nsg_ids:
             The value to assign to the nsg_ids property of this RedisClusterSummary.
         :type nsg_ids: list[str]
@@ -115,6 +123,8 @@ class RedisClusterSummary(object):
             'subnet_id': 'str',
             'time_created': 'datetime',
             'time_updated': 'datetime',
+            'cluster_mode': 'str',
+            'shard_count': 'int',
             'nsg_ids': 'list[str]',
             'freeform_tags': 'dict(str, str)',
             'defined_tags': 'dict(str, dict(str, object))',
@@ -137,6 +147,8 @@ class RedisClusterSummary(object):
             'subnet_id': 'subnetId',
             'time_created': 'timeCreated',
             'time_updated': 'timeUpdated',
+            'cluster_mode': 'clusterMode',
+            'shard_count': 'shardCount',
             'nsg_ids': 'nsgIds',
             'freeform_tags': 'freeformTags',
             'defined_tags': 'definedTags',
@@ -158,6 +170,8 @@ class RedisClusterSummary(object):
         self._subnet_id = None
         self._time_created = None
         self._time_updated = None
+        self._cluster_mode = None
+        self._shard_count = None
         self._nsg_ids = None
         self._freeform_tags = None
         self._defined_tags = None
@@ -167,7 +181,7 @@ class RedisClusterSummary(object):
     def id(self):
         """
         **[Required]** Gets the id of this RedisClusterSummary.
-        The `OCID`__ of the Redis cluster.
+        The `OCID`__ of the cluster.
 
         __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm#Oracle
 
@@ -181,7 +195,7 @@ class RedisClusterSummary(object):
     def id(self, id):
         """
         Sets the id of this RedisClusterSummary.
-        The `OCID`__ of the Redis cluster.
+        The `OCID`__ of the cluster.
 
         __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm#Oracle
 
@@ -219,7 +233,7 @@ class RedisClusterSummary(object):
     def compartment_id(self):
         """
         **[Required]** Gets the compartment_id of this RedisClusterSummary.
-        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
 
@@ -233,7 +247,7 @@ class RedisClusterSummary(object):
     def compartment_id(self, compartment_id):
         """
         Sets the compartment_id of this RedisClusterSummary.
-        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
 
@@ -247,7 +261,7 @@ class RedisClusterSummary(object):
     def lifecycle_state(self):
         """
         Gets the lifecycle_state of this RedisClusterSummary.
-        The current state of the Redis cluster.
+        The current state of the cluster.
 
 
         :return: The lifecycle_state of this RedisClusterSummary.
@@ -259,7 +273,7 @@ class RedisClusterSummary(object):
     def lifecycle_state(self, lifecycle_state):
         """
         Sets the lifecycle_state of this RedisClusterSummary.
-        The current state of the Redis cluster.
+        The current state of the cluster.
 
 
         :param lifecycle_state: The lifecycle_state of this RedisClusterSummary.
@@ -295,7 +309,7 @@ class RedisClusterSummary(object):
     def node_count(self):
         """
         **[Required]** Gets the node_count of this RedisClusterSummary.
-        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 RedisClusterSummary.
@@ -307,7 +321,7 @@ class RedisClusterSummary(object):
     def node_count(self, node_count):
         """
         Sets the node_count of this RedisClusterSummary.
-        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 RedisClusterSummary.
@@ -319,7 +333,7 @@ class RedisClusterSummary(object):
     def node_memory_in_gbs(self):
         """
         **[Required]** Gets the node_memory_in_gbs of this RedisClusterSummary.
-        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 RedisClusterSummary.
@@ -331,7 +345,7 @@ class RedisClusterSummary(object):
     def node_memory_in_gbs(self, node_memory_in_gbs):
         """
         Sets the node_memory_in_gbs of this RedisClusterSummary.
-        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 RedisClusterSummary.
@@ -343,7 +357,7 @@ class RedisClusterSummary(object):
     def primary_fqdn(self):
         """
         **[Required]** Gets the primary_fqdn of this RedisClusterSummary.
-        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 RedisClusterSummary.
@@ -355,7 +369,7 @@ class RedisClusterSummary(object):
     def primary_fqdn(self, primary_fqdn):
         """
         Sets the primary_fqdn of this RedisClusterSummary.
-        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 RedisClusterSummary.
@@ -367,7 +381,7 @@ class RedisClusterSummary(object):
     def primary_endpoint_ip_address(self):
         """
         **[Required]** Gets the primary_endpoint_ip_address of this RedisClusterSummary.
-        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 RedisClusterSummary.
@@ -379,7 +393,7 @@ class RedisClusterSummary(object):
     def primary_endpoint_ip_address(self, primary_endpoint_ip_address):
         """
         Sets the primary_endpoint_ip_address of this RedisClusterSummary.
-        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 RedisClusterSummary.
@@ -391,7 +405,7 @@ class RedisClusterSummary(object):
     def replicas_fqdn(self):
         """
         **[Required]** Gets the replicas_fqdn of this RedisClusterSummary.
-        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 RedisClusterSummary.
@@ -403,7 +417,7 @@ class RedisClusterSummary(object):
     def replicas_fqdn(self, replicas_fqdn):
         """
         Sets the replicas_fqdn of this RedisClusterSummary.
-        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 RedisClusterSummary.
@@ -415,7 +429,7 @@ class RedisClusterSummary(object):
     def replicas_endpoint_ip_address(self):
         """
         **[Required]** Gets the replicas_endpoint_ip_address of this RedisClusterSummary.
-        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 RedisClusterSummary.
@@ -427,7 +441,7 @@ class RedisClusterSummary(object):
     def replicas_endpoint_ip_address(self, replicas_endpoint_ip_address):
         """
         Sets the replicas_endpoint_ip_address of this RedisClusterSummary.
-        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 RedisClusterSummary.
@@ -439,7 +453,7 @@ class RedisClusterSummary(object):
     def software_version(self):
         """
         **[Required]** Gets the software_version of this RedisClusterSummary.
-        The Redis version that the cluster is running.
+        The OCI Cache engine version that the cluster is running.
 
 
         :return: The software_version of this RedisClusterSummary.
@@ -451,7 +465,7 @@ class RedisClusterSummary(object):
     def software_version(self, software_version):
         """
         Sets the software_version of this RedisClusterSummary.
-        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 RedisClusterSummary.
@@ -463,7 +477,7 @@ class RedisClusterSummary(object):
     def subnet_id(self):
         """
         **[Required]** Gets the subnet_id of this RedisClusterSummary.
-        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
 
@@ -477,7 +491,7 @@ class RedisClusterSummary(object):
     def subnet_id(self, subnet_id):
         """
         Sets the subnet_id of this RedisClusterSummary.
-        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
 
@@ -491,7 +505,7 @@ class RedisClusterSummary(object):
     def time_created(self):
         """
         Gets the time_created of this RedisClusterSummary.
-        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
 
@@ -505,7 +519,7 @@ class RedisClusterSummary(object):
     def time_created(self, time_created):
         """
         Sets the time_created of this RedisClusterSummary.
-        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
 
@@ -519,7 +533,7 @@ class RedisClusterSummary(object):
     def time_updated(self):
         """
         Gets the time_updated of this RedisClusterSummary.
-        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
 
@@ -533,7 +547,7 @@ class RedisClusterSummary(object):
     def time_updated(self, time_updated):
         """
         Sets the time_updated of this RedisClusterSummary.
-        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
 
@@ -543,16 +557,64 @@ class RedisClusterSummary(object):
         """
         self._time_updated = time_updated
 
+    @property
+    def cluster_mode(self):
+        """
+        Gets the cluster_mode of this RedisClusterSummary.
+        Specifies whether the cluster is sharded or non-sharded.
+
+
+        :return: The cluster_mode of this RedisClusterSummary.
+        :rtype: str
+        """
+        return self._cluster_mode
+
+    @cluster_mode.setter
+    def cluster_mode(self, cluster_mode):
+        """
+        Sets the cluster_mode of this RedisClusterSummary.
+        Specifies whether the cluster is sharded or non-sharded.
+
+
+        :param cluster_mode: The cluster_mode of this RedisClusterSummary.
+        :type: str
+        """
+        self._cluster_mode = cluster_mode
+
+    @property
+    def shard_count(self):
+        """
+        Gets the shard_count of this RedisClusterSummary.
+        The number of shards in a sharded cluster. Only applicable when clusterMode is SHARDED.
+
+
+        :return: The shard_count of this RedisClusterSummary.
+        :rtype: int
+        """
+        return self._shard_count
+
+    @shard_count.setter
+    def shard_count(self, shard_count):
+        """
+        Sets the shard_count of this RedisClusterSummary.
+        The number of shards in a sharded cluster. Only applicable when clusterMode is SHARDED.
+
+
+        :param shard_count: The shard_count of this RedisClusterSummary.
+        :type: int
+        """
+        self._shard_count = shard_count
+
     @property
     def nsg_ids(self):
         """
         Gets the nsg_ids of this RedisClusterSummary.
         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 RedisClusterSummary.
@@ -566,10 +628,10 @@ class RedisClusterSummary(object):
         Sets the nsg_ids of this RedisClusterSummary.
         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 RedisClusterSummary.

oci/redis/models/redis_node_collection.py

@@ -0,0 +1,72 @@
+# 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 RedisNodeCollection(object):
+    """
+    A list of nodes in a cluster that match filter criteria, if any.
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new RedisNodeCollection object with values from keyword arguments.
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param items:
+            The value to assign to the items property of this RedisNodeCollection.
+        :type items: list[oci.redis.models.NodeSummary]
+
+        """
+        self.swagger_types = {
+            'items': 'list[NodeSummary]'
+        }
+
+        self.attribute_map = {
+            'items': 'items'
+        }
+
+        self._items = None
+
+    @property
+    def items(self):
+        """
+        **[Required]** Gets the items of this RedisNodeCollection.
+        The list of nodes in a cluster.
+
+
+        :return: The items of this RedisNodeCollection.
+        :rtype: list[oci.redis.models.NodeSummary]
+        """
+        return self._items
+
+    @items.setter
+    def items(self, items):
+        """
+        Sets the items of this RedisNodeCollection.
+        The list of nodes in a cluster.
+
+
+        :param items: The items of this RedisNodeCollection.
+        :type: list[oci.redis.models.NodeSummary]
+        """
+        self._items = items
+
+    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/update_redis_cluster_details.py

@@ -12,7 +12,7 @@ from oci.decorators import init_model_state_from_kwargs
 @init_model_state_from_kwargs
 class UpdateRedisClusterDetails(object):
     """
-    The configuration to update for an existing Redis cluster.
+    The configuration to update for an existing cluster.
     """
 
     def __init__(self, **kwargs):
@@ -20,6 +20,10 @@ class UpdateRedisClusterDetails(object):
         Initializes a new UpdateRedisClusterDetails object with values from keyword arguments.
         The following keyword arguments are supported (corresponding to the getters/setters of this class):
 
+        :param shard_count:
+            The value to assign to the shard_count property of this UpdateRedisClusterDetails.
+        :type shard_count: int
+
         :param display_name:
             The value to assign to the display_name property of this UpdateRedisClusterDetails.
         :type display_name: str
@@ -46,6 +50,7 @@ class UpdateRedisClusterDetails(object):
 
         """
         self.swagger_types = {
+            'shard_count': 'int',
             'display_name': 'str',
             'node_count': 'int',
             'node_memory_in_gbs': 'float',
@@ -55,6 +60,7 @@ class UpdateRedisClusterDetails(object):
         }
 
         self.attribute_map = {
+            'shard_count': 'shardCount',
             'display_name': 'displayName',
             'node_count': 'nodeCount',
             'node_memory_in_gbs': 'nodeMemoryInGBs',
@@ -63,6 +69,7 @@ class UpdateRedisClusterDetails(object):
             'defined_tags': 'definedTags'
         }
 
+        self._shard_count = None
         self._display_name = None
         self._node_count = None
         self._node_memory_in_gbs = None
@@ -70,6 +77,30 @@ class UpdateRedisClusterDetails(object):
         self._freeform_tags = None
         self._defined_tags = None
 
+    @property
+    def shard_count(self):
+        """
+        Gets the shard_count of this UpdateRedisClusterDetails.
+        The number of shards in sharded cluster. Only applicable when clusterMode is SHARDED.
+
+
+        :return: The shard_count of this UpdateRedisClusterDetails.
+        :rtype: int
+        """
+        return self._shard_count
+
+    @shard_count.setter
+    def shard_count(self, shard_count):
+        """
+        Sets the shard_count of this UpdateRedisClusterDetails.
+        The number of shards in sharded cluster. Only applicable when clusterMode is SHARDED.
+
+
+        :param shard_count: The shard_count of this UpdateRedisClusterDetails.
+        :type: int
+        """
+        self._shard_count = shard_count
+
     @property
     def display_name(self):
         """
@@ -98,7 +129,7 @@ class UpdateRedisClusterDetails(object):
     def node_count(self):
         """
         Gets the node_count of this UpdateRedisClusterDetails.
-        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 UpdateRedisClusterDetails.
@@ -110,7 +141,7 @@ class UpdateRedisClusterDetails(object):
     def node_count(self, node_count):
         """
         Sets the node_count of this UpdateRedisClusterDetails.
-        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 UpdateRedisClusterDetails.
@@ -122,7 +153,7 @@ class UpdateRedisClusterDetails(object):
     def node_memory_in_gbs(self):
         """
         Gets the node_memory_in_gbs of this UpdateRedisClusterDetails.
-        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 UpdateRedisClusterDetails.
@@ -134,7 +165,7 @@ class UpdateRedisClusterDetails(object):
     def node_memory_in_gbs(self, node_memory_in_gbs):
         """
         Sets the node_memory_in_gbs of this UpdateRedisClusterDetails.
-        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 UpdateRedisClusterDetails.
@@ -148,10 +179,10 @@ class UpdateRedisClusterDetails(object):
         Gets the nsg_ids of this UpdateRedisClusterDetails.
         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 UpdateRedisClusterDetails.
@@ -165,10 +196,10 @@ class UpdateRedisClusterDetails(object):
         Sets the nsg_ids of this UpdateRedisClusterDetails.
         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 UpdateRedisClusterDetails.