oci 2.146.0__py3-none-any.whl → 2.148.0__py3-none-any.whl

oci/opensearch/models/opensearch_cluster_pipeline.py

@@ -42,6 +42,14 @@ class OpensearchClusterPipeline(object):
     #: This constant has a value of "FAILED"
     LIFECYCLE_STATE_FAILED = "FAILED"
 
+    #: A constant which can be used with the pipeline_mode property of a OpensearchClusterPipeline.
+    #: This constant has a value of "RUNNING"
+    PIPELINE_MODE_RUNNING = "RUNNING"
+
+    #: A constant which can be used with the pipeline_mode property of a OpensearchClusterPipeline.
+    #: This constant has a value of "STOPPED"
+    PIPELINE_MODE_STOPPED = "STOPPED"
+
     def __init__(self, **kwargs):
         """
         Initializes a new OpensearchClusterPipeline object with values from keyword arguments.
@@ -75,26 +83,26 @@ class OpensearchClusterPipeline(object):
             The value to assign to the subnet_compartment_id property of this OpensearchClusterPipeline.
         :type subnet_compartment_id: str
 
-        :param max_ocpu_count:
-            The value to assign to the max_ocpu_count property of this OpensearchClusterPipeline.
-        :type max_ocpu_count: int
-
-        :param min_ocpu_count:
-            The value to assign to the min_ocpu_count property of this OpensearchClusterPipeline.
-        :type min_ocpu_count: int
+        :param ocpu_count:
+            The value to assign to the ocpu_count property of this OpensearchClusterPipeline.
+        :type ocpu_count: int
 
-        :param max_memory_gb:
-            The value to assign to the max_memory_gb property of this OpensearchClusterPipeline.
-        :type max_memory_gb: int
+        :param memory_gb:
+            The value to assign to the memory_gb property of this OpensearchClusterPipeline.
+        :type memory_gb: int
 
-        :param min_memory_gb:
-            The value to assign to the min_memory_gb property of this OpensearchClusterPipeline.
-        :type min_memory_gb: int
+        :param node_count:
+            The value to assign to the node_count property of this OpensearchClusterPipeline.
+        :type node_count: int
 
         :param pipeline_configuration_body:
             The value to assign to the pipeline_configuration_body property of this OpensearchClusterPipeline.
         :type pipeline_configuration_body: str
 
+        :param data_prepper_configuration_body:
+            The value to assign to the data_prepper_configuration_body property of this OpensearchClusterPipeline.
+        :type data_prepper_configuration_body: str
+
         :param opensearch_pipeline_fqdn:
             The value to assign to the opensearch_pipeline_fqdn property of this OpensearchClusterPipeline.
         :type opensearch_pipeline_fqdn: str
@@ -105,9 +113,16 @@ class OpensearchClusterPipeline(object):
 
         :param lifecycle_state:
             The value to assign to the lifecycle_state property of this OpensearchClusterPipeline.
-            Allowed values for this property are: "CREATING", "UPDATING", "ACTIVE", "DELETING", "DELETED", "FAILED"
+            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'.
         :type lifecycle_state: str
 
+        :param pipeline_mode:
+            The value to assign to the pipeline_mode property of this OpensearchClusterPipeline.
+            Allowed values for this property are: "RUNNING", "STOPPED", 'UNKNOWN_ENUM_VALUE'.
+            Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
+        :type pipeline_mode: str
+
         :param time_created:
             The value to assign to the time_created property of this OpensearchClusterPipeline.
         :type time_created: datetime
@@ -116,6 +131,14 @@ class OpensearchClusterPipeline(object):
             The value to assign to the time_updated property of this OpensearchClusterPipeline.
         :type time_updated: datetime
 
+        :param reverse_connection_endpoints:
+            The value to assign to the reverse_connection_endpoints property of this OpensearchClusterPipeline.
+        :type reverse_connection_endpoints: list[oci.opensearch.models.OpensearchPipelineReverseConnectionEndpoint]
+
+        :param nsg_id:
+            The value to assign to the nsg_id property of this OpensearchClusterPipeline.
+        :type nsg_id: str
+
         :param freeform_tags:
             The value to assign to the freeform_tags property of this OpensearchClusterPipeline.
         :type freeform_tags: dict(str, str)
@@ -137,16 +160,19 @@ class OpensearchClusterPipeline(object):
             'subnet_id': 'str',
             'vcn_compartment_id': 'str',
             'subnet_compartment_id': 'str',
-            'max_ocpu_count': 'int',
-            'min_ocpu_count': 'int',
-            'max_memory_gb': 'int',
-            'min_memory_gb': 'int',
+            'ocpu_count': 'int',
+            'memory_gb': 'int',
+            'node_count': 'int',
             'pipeline_configuration_body': 'str',
+            'data_prepper_configuration_body': 'str',
             'opensearch_pipeline_fqdn': 'str',
             'opensearch_pipeline_private_ip': 'str',
             'lifecycle_state': 'str',
+            'pipeline_mode': 'str',
             'time_created': 'datetime',
             'time_updated': 'datetime',
+            'reverse_connection_endpoints': 'list[OpensearchPipelineReverseConnectionEndpoint]',
+            'nsg_id': 'str',
             'freeform_tags': 'dict(str, str)',
             'defined_tags': 'dict(str, dict(str, object))',
             'system_tags': 'dict(str, dict(str, object))'
@@ -160,16 +186,19 @@ class OpensearchClusterPipeline(object):
             'subnet_id': 'subnetId',
             'vcn_compartment_id': 'vcnCompartmentId',
             'subnet_compartment_id': 'subnetCompartmentId',
-            'max_ocpu_count': 'maxOcpuCount',
-            'min_ocpu_count': 'minOcpuCount',
-            'max_memory_gb': 'maxMemoryGB',
-            'min_memory_gb': 'minMemoryGB',
+            'ocpu_count': 'ocpuCount',
+            'memory_gb': 'memoryGB',
+            'node_count': 'nodeCount',
             'pipeline_configuration_body': 'pipelineConfigurationBody',
+            'data_prepper_configuration_body': 'dataPrepperConfigurationBody',
             'opensearch_pipeline_fqdn': 'opensearchPipelineFqdn',
             'opensearch_pipeline_private_ip': 'opensearchPipelinePrivateIp',
             'lifecycle_state': 'lifecycleState',
+            'pipeline_mode': 'pipelineMode',
             'time_created': 'timeCreated',
             'time_updated': 'timeUpdated',
+            'reverse_connection_endpoints': 'reverseConnectionEndpoints',
+            'nsg_id': 'nsgId',
             'freeform_tags': 'freeformTags',
             'defined_tags': 'definedTags',
             'system_tags': 'systemTags'
@@ -182,16 +211,19 @@ class OpensearchClusterPipeline(object):
         self._subnet_id = None
         self._vcn_compartment_id = None
         self._subnet_compartment_id = None
-        self._max_ocpu_count = None
-        self._min_ocpu_count = None
-        self._max_memory_gb = None
-        self._min_memory_gb = None
+        self._ocpu_count = None
+        self._memory_gb = None
+        self._node_count = None
         self._pipeline_configuration_body = None
+        self._data_prepper_configuration_body = None
         self._opensearch_pipeline_fqdn = None
         self._opensearch_pipeline_private_ip = None
         self._lifecycle_state = None
+        self._pipeline_mode = None
         self._time_created = None
         self._time_updated = None
+        self._reverse_connection_endpoints = None
+        self._nsg_id = None
         self._freeform_tags = None
         self._defined_tags = None
         self._system_tags = None
@@ -344,7 +376,7 @@ class OpensearchClusterPipeline(object):
     def subnet_compartment_id(self):
         """
         **[Required]** Gets the subnet_compartment_id of this OpensearchClusterPipeline.
-        The OCID for the compartment where the pipwline's subnet is located.
+        The OCID for the compartment where the pipeline's subnet is located.
 
 
         :return: The subnet_compartment_id of this OpensearchClusterPipeline.
@@ -356,7 +388,7 @@ class OpensearchClusterPipeline(object):
     def subnet_compartment_id(self, subnet_compartment_id):
         """
         Sets the subnet_compartment_id of this OpensearchClusterPipeline.
-        The OCID for the compartment where the pipwline's subnet is located.
+        The OCID for the compartment where the pipeline's subnet is located.
 
 
         :param subnet_compartment_id: The subnet_compartment_id of this OpensearchClusterPipeline.
@@ -365,100 +397,76 @@ class OpensearchClusterPipeline(object):
         self._subnet_compartment_id = subnet_compartment_id
 
     @property
-    def max_ocpu_count(self):
-        """
-        **[Required]** Gets the max_ocpu_count of this OpensearchClusterPipeline.
-        The maximum pipeline capacity, in OCPUs.
-
-
-        :return: The max_ocpu_count of this OpensearchClusterPipeline.
-        :rtype: int
-        """
-        return self._max_ocpu_count
-
-    @max_ocpu_count.setter
-    def max_ocpu_count(self, max_ocpu_count):
-        """
-        Sets the max_ocpu_count of this OpensearchClusterPipeline.
-        The maximum pipeline capacity, in OCPUs.
-
-
-        :param max_ocpu_count: The max_ocpu_count of this OpensearchClusterPipeline.
-        :type: int
-        """
-        self._max_ocpu_count = max_ocpu_count
-
-    @property
-    def min_ocpu_count(self):
+    def ocpu_count(self):
         """
-        **[Required]** Gets the min_ocpu_count of this OpensearchClusterPipeline.
-        The maximum pipeline capacity, in OCPUs.
+        **[Required]** Gets the ocpu_count of this OpensearchClusterPipeline.
+        The number of OCPUs configured for each pipeline node.
 
 
-        :return: The min_ocpu_count of this OpensearchClusterPipeline.
+        :return: The ocpu_count of this OpensearchClusterPipeline.
         :rtype: int
         """
-        return self._min_ocpu_count
+        return self._ocpu_count
 
-    @min_ocpu_count.setter
-    def min_ocpu_count(self, min_ocpu_count):
+    @ocpu_count.setter
+    def ocpu_count(self, ocpu_count):
         """
-        Sets the min_ocpu_count of this OpensearchClusterPipeline.
-        The maximum pipeline capacity, in OCPUs.
+        Sets the ocpu_count of this OpensearchClusterPipeline.
+        The number of OCPUs configured for each pipeline node.
 
 
-        :param min_ocpu_count: The min_ocpu_count of this OpensearchClusterPipeline.
+        :param ocpu_count: The ocpu_count of this OpensearchClusterPipeline.
         :type: int
         """
-        self._min_ocpu_count = min_ocpu_count
+        self._ocpu_count = ocpu_count
 
     @property
-    def max_memory_gb(self):
+    def memory_gb(self):
         """
-        **[Required]** Gets the max_memory_gb of this OpensearchClusterPipeline.
-        The maximum amount of memory in GB, for the pipeline.
+        **[Required]** Gets the memory_gb of this OpensearchClusterPipeline.
+        The amount of memory in GB, for each pipeline node.
 
 
-        :return: The max_memory_gb of this OpensearchClusterPipeline.
+        :return: The memory_gb of this OpensearchClusterPipeline.
         :rtype: int
         """
-        return self._max_memory_gb
+        return self._memory_gb
 
-    @max_memory_gb.setter
-    def max_memory_gb(self, max_memory_gb):
+    @memory_gb.setter
+    def memory_gb(self, memory_gb):
         """
-        Sets the max_memory_gb of this OpensearchClusterPipeline.
-        The maximum amount of memory in GB, for the pipeline.
+        Sets the memory_gb of this OpensearchClusterPipeline.
+        The amount of memory in GB, for each pipeline node.
 
 
-        :param max_memory_gb: The max_memory_gb of this OpensearchClusterPipeline.
+        :param memory_gb: The memory_gb of this OpensearchClusterPipeline.
         :type: int
         """
-        self._max_memory_gb = max_memory_gb
+        self._memory_gb = memory_gb
 
     @property
-    def min_memory_gb(self):
+    def node_count(self):
         """
-        **[Required]** Gets the min_memory_gb of this OpensearchClusterPipeline.
-        The minimum amount of memory in GB, for the pipeline.
+        **[Required]** Gets the node_count of this OpensearchClusterPipeline.
+        The number of nodes configured for the pipeline.
 
 
-        :return: The min_memory_gb of this OpensearchClusterPipeline.
+        :return: The node_count of this OpensearchClusterPipeline.
         :rtype: int
         """
-        return self._min_memory_gb
+        return self._node_count
 
-    @min_memory_gb.setter
-    def min_memory_gb(self, min_memory_gb):
+    @node_count.setter
+    def node_count(self, node_count):
         """
-        Sets the min_memory_gb of this OpensearchClusterPipeline.
-        The minimum amount of memory in GB, for the pipeline.
+        Sets the node_count of this OpensearchClusterPipeline.
+        The number of nodes configured for the pipeline.
 
 
-        :param min_memory_gb: The min_memory_gb of this OpensearchClusterPipeline.
+        :param node_count: The node_count of this OpensearchClusterPipeline.
         :type: int
         """
-        self._min_memory_gb = min_memory_gb
+        self._node_count = node_count
 
     @property
     def pipeline_configuration_body(self):
@@ -484,6 +492,30 @@ class OpensearchClusterPipeline(object):
         """
         self._pipeline_configuration_body = pipeline_configuration_body
 
+    @property
+    def data_prepper_configuration_body(self):
+        """
+        **[Required]** Gets the data_prepper_configuration_body of this OpensearchClusterPipeline.
+        The data prepper config in YAML format. The command accepts the data prepper config as a string or within a .yaml file. If you provide the configuration as a string, each new line must be escaped with \\.
+
+
+        :return: The data_prepper_configuration_body of this OpensearchClusterPipeline.
+        :rtype: str
+        """
+        return self._data_prepper_configuration_body
+
+    @data_prepper_configuration_body.setter
+    def data_prepper_configuration_body(self, data_prepper_configuration_body):
+        """
+        Sets the data_prepper_configuration_body of this OpensearchClusterPipeline.
+        The data prepper config in YAML format. The command accepts the data prepper config as a string or within a .yaml file. If you provide the configuration as a string, each new line must be escaped with \\.
+
+
+        :param data_prepper_configuration_body: The data_prepper_configuration_body of this OpensearchClusterPipeline.
+        :type: str
+        """
+        self._data_prepper_configuration_body = data_prepper_configuration_body
+
     @property
     def opensearch_pipeline_fqdn(self):
         """
@@ -538,7 +570,8 @@ class OpensearchClusterPipeline(object):
         **[Required]** Gets the lifecycle_state of this OpensearchClusterPipeline.
         The current state of the cluster backup.
 
-        Allowed values for this property are: "CREATING", "UPDATING", "ACTIVE", "DELETING", "DELETED", "FAILED"
+        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'.
 
 
         :return: The lifecycle_state of this OpensearchClusterPipeline.
@@ -558,11 +591,39 @@ class OpensearchClusterPipeline(object):
         """
         allowed_values = ["CREATING", "UPDATING", "ACTIVE", "DELETING", "DELETED", "FAILED"]
         if not value_allowed_none_or_none_sentinel(lifecycle_state, allowed_values):
-            raise ValueError(
-                f"Invalid value for `lifecycle_state`, must be None or one of {allowed_values}"
-            )
+            lifecycle_state = 'UNKNOWN_ENUM_VALUE'
         self._lifecycle_state = lifecycle_state
 
+    @property
+    def pipeline_mode(self):
+        """
+        **[Required]** Gets the pipeline_mode of this OpensearchClusterPipeline.
+        The current state of the pipeline.
+
+        Allowed values for this property are: "RUNNING", "STOPPED", 'UNKNOWN_ENUM_VALUE'.
+        Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
+
+
+        :return: The pipeline_mode of this OpensearchClusterPipeline.
+        :rtype: str
+        """
+        return self._pipeline_mode
+
+    @pipeline_mode.setter
+    def pipeline_mode(self, pipeline_mode):
+        """
+        Sets the pipeline_mode of this OpensearchClusterPipeline.
+        The current state of the pipeline.
+
+
+        :param pipeline_mode: The pipeline_mode of this OpensearchClusterPipeline.
+        :type: str
+        """
+        allowed_values = ["RUNNING", "STOPPED"]
+        if not value_allowed_none_or_none_sentinel(pipeline_mode, allowed_values):
+            pipeline_mode = 'UNKNOWN_ENUM_VALUE'
+        self._pipeline_mode = pipeline_mode
+
     @property
     def time_created(self):
         """
@@ -615,6 +676,54 @@ class OpensearchClusterPipeline(object):
         """
         self._time_updated = time_updated
 
+    @property
+    def reverse_connection_endpoints(self):
+        """
+        Gets the reverse_connection_endpoints of this OpensearchClusterPipeline.
+        The customer IP and the corresponding fully qualified domain name that the pipeline will connect to.
+
+
+        :return: The reverse_connection_endpoints of this OpensearchClusterPipeline.
+        :rtype: list[oci.opensearch.models.OpensearchPipelineReverseConnectionEndpoint]
+        """
+        return self._reverse_connection_endpoints
+
+    @reverse_connection_endpoints.setter
+    def reverse_connection_endpoints(self, reverse_connection_endpoints):
+        """
+        Sets the reverse_connection_endpoints of this OpensearchClusterPipeline.
+        The customer IP and the corresponding fully qualified domain name that the pipeline will connect to.
+
+
+        :param reverse_connection_endpoints: The reverse_connection_endpoints of this OpensearchClusterPipeline.
+        :type: list[oci.opensearch.models.OpensearchPipelineReverseConnectionEndpoint]
+        """
+        self._reverse_connection_endpoints = reverse_connection_endpoints
+
+    @property
+    def nsg_id(self):
+        """
+        Gets the nsg_id of this OpensearchClusterPipeline.
+        The OCID of the NSG where the pipeline private endpoint vnic will be attached.
+
+
+        :return: The nsg_id of this OpensearchClusterPipeline.
+        :rtype: str
+        """
+        return self._nsg_id
+
+    @nsg_id.setter
+    def nsg_id(self, nsg_id):
+        """
+        Sets the nsg_id of this OpensearchClusterPipeline.
+        The OCID of the NSG where the pipeline private endpoint vnic will be attached.
+
+
+        :param nsg_id: The nsg_id of this OpensearchClusterPipeline.
+        :type: str
+        """
+        self._nsg_id = nsg_id
+
     @property
     def freeform_tags(self):
         """

oci/opensearch/models/opensearch_cluster_pipeline_collection.py

@@ -12,7 +12,7 @@ from oci.decorators import init_model_state_from_kwargs
 @init_model_state_from_kwargs
 class OpensearchClusterPipelineCollection(object):
     """
-    The list of cluster pieplines returned in a cluster pipeline search.
+    The list of cluster pipelines returned in a cluster pipeline search.
     """
 
     def __init__(self, **kwargs):