oci 2.137.0__py3-none-any.whl → 2.138.0__py3-none-any.whl

oci/data_flow/data_flow_client_composite_operations.py

@@ -665,6 +665,45 @@ class DataFlowClientCompositeOperations(object):
         except Exception as e:
             raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e)
 
+    def start_sql_endpoint_and_wait_for_state(self, sql_endpoint_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}):
+        """
+        Calls :py:func:`~oci.data_flow.DataFlowClient.start_sql_endpoint` and waits for the :py:class:`~oci.data_flow.models.WorkRequest`
+        to enter the given state(s).
+
+        :param str sql_endpoint_id: (required)
+            The unique id of the SQL Endpoint.
+
+        :param list[str] wait_for_states:
+            An array of states to wait on. These should be valid values for :py:attr:`~oci.data_flow.models.WorkRequest.status`
+
+        :param dict operation_kwargs:
+            A dictionary of keyword arguments to pass to :py:func:`~oci.data_flow.DataFlowClient.start_sql_endpoint`
+
+        :param dict waiter_kwargs:
+            A dictionary of keyword arguments to pass to the :py:func:`oci.wait_until` function. For example, you could pass ``max_interval_seconds`` or ``max_interval_seconds``
+            as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
+        """
+        operation_result = self.client.start_sql_endpoint(sql_endpoint_id, **operation_kwargs)
+        if not wait_for_states:
+            return operation_result
+        lowered_wait_for_states = [w.lower() for w in wait_for_states]
+        if 'opc-work-request-id' not in operation_result.headers:
+            return operation_result
+        wait_for_resource_id = operation_result.headers['opc-work-request-id']
+
+        try:
+            waiter_result = oci.wait_until(
+                self.client,
+                self.client.get_work_request(wait_for_resource_id),
+                evaluate_response=lambda r: getattr(r.data, 'status') and getattr(r.data, 'status').lower() in lowered_wait_for_states,
+                **waiter_kwargs
+            )
+            result_to_return = waiter_result
+
+            return result_to_return
+        except Exception as e:
+            raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e)
+
     def stop_pool_and_wait_for_state(self, pool_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}):
         """
         Calls :py:func:`~oci.data_flow.DataFlowClient.stop_pool` and waits for the :py:class:`~oci.data_flow.models.WorkRequest`
@@ -704,6 +743,45 @@ class DataFlowClientCompositeOperations(object):
         except Exception as e:
             raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e)
 
+    def stop_sql_endpoint_and_wait_for_state(self, sql_endpoint_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}):
+        """
+        Calls :py:func:`~oci.data_flow.DataFlowClient.stop_sql_endpoint` and waits for the :py:class:`~oci.data_flow.models.WorkRequest`
+        to enter the given state(s).
+
+        :param str sql_endpoint_id: (required)
+            The unique id of the SQL Endpoint.
+
+        :param list[str] wait_for_states:
+            An array of states to wait on. These should be valid values for :py:attr:`~oci.data_flow.models.WorkRequest.status`
+
+        :param dict operation_kwargs:
+            A dictionary of keyword arguments to pass to :py:func:`~oci.data_flow.DataFlowClient.stop_sql_endpoint`
+
+        :param dict waiter_kwargs:
+            A dictionary of keyword arguments to pass to the :py:func:`oci.wait_until` function. For example, you could pass ``max_interval_seconds`` or ``max_interval_seconds``
+            as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
+        """
+        operation_result = self.client.stop_sql_endpoint(sql_endpoint_id, **operation_kwargs)
+        if not wait_for_states:
+            return operation_result
+        lowered_wait_for_states = [w.lower() for w in wait_for_states]
+        if 'opc-work-request-id' not in operation_result.headers:
+            return operation_result
+        wait_for_resource_id = operation_result.headers['opc-work-request-id']
+
+        try:
+            waiter_result = oci.wait_until(
+                self.client,
+                self.client.get_work_request(wait_for_resource_id),
+                evaluate_response=lambda r: getattr(r.data, 'status') and getattr(r.data, 'status').lower() in lowered_wait_for_states,
+                **waiter_kwargs
+            )
+            result_to_return = waiter_result
+
+            return result_to_return
+        except Exception as e:
+            raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e)
+
     def update_application_and_wait_for_state(self, update_application_details, application_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}):
         """
         Calls :py:func:`~oci.data_flow.DataFlowClient.update_application` and waits for the :py:class:`~oci.data_flow.models.Application` acted upon

oci/data_flow/models/sql_endpoint.py

@@ -43,6 +43,10 @@ class SqlEndpoint(object):
     #: This constant has a value of "NEEDS_ATTENTION"
     LIFECYCLE_STATE_NEEDS_ATTENTION = "NEEDS_ATTENTION"
 
+    #: A constant which can be used with the lifecycle_state property of a SqlEndpoint.
+    #: This constant has a value of "INACTIVE"
+    LIFECYCLE_STATE_INACTIVE = "INACTIVE"
+
     def __init__(self, **kwargs):
         """
         Initializes a new SqlEndpoint object with values from keyword arguments.
@@ -74,7 +78,7 @@ class SqlEndpoint(object):
 
         :param lifecycle_state:
             The value to assign to the lifecycle_state property of this SqlEndpoint.
-            Allowed values for this property are: "CREATING", "ACTIVE", "DELETING", "DELETED", "FAILED", "UPDATING", "NEEDS_ATTENTION", 'UNKNOWN_ENUM_VALUE'.
+            Allowed values for this property are: "CREATING", "ACTIVE", "DELETING", "DELETED", "FAILED", "UPDATING", "NEEDS_ATTENTION", "INACTIVE", 'UNKNOWN_ENUM_VALUE'.
             Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
         :type lifecycle_state: str
 
@@ -390,7 +394,7 @@ class SqlEndpoint(object):
         Gets the lifecycle_state of this SqlEndpoint.
         The current state of the Sql Endpoint.
 
-        Allowed values for this property are: "CREATING", "ACTIVE", "DELETING", "DELETED", "FAILED", "UPDATING", "NEEDS_ATTENTION", 'UNKNOWN_ENUM_VALUE'.
+        Allowed values for this property are: "CREATING", "ACTIVE", "DELETING", "DELETED", "FAILED", "UPDATING", "NEEDS_ATTENTION", "INACTIVE", 'UNKNOWN_ENUM_VALUE'.
         Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
 
 
@@ -409,7 +413,7 @@ class SqlEndpoint(object):
         :param lifecycle_state: The lifecycle_state of this SqlEndpoint.
         :type: str
         """
-        allowed_values = ["CREATING", "ACTIVE", "DELETING", "DELETED", "FAILED", "UPDATING", "NEEDS_ATTENTION"]
+        allowed_values = ["CREATING", "ACTIVE", "DELETING", "DELETED", "FAILED", "UPDATING", "NEEDS_ATTENTION", "INACTIVE"]
         if not value_allowed_none_or_none_sentinel(lifecycle_state, allowed_values):
             lifecycle_state = 'UNKNOWN_ENUM_VALUE'
         self._lifecycle_state = lifecycle_state

oci/data_flow/models/sql_endpoint_summary.py

@@ -43,6 +43,10 @@ class SqlEndpointSummary(object):
     #: This constant has a value of "NEEDS_ATTENTION"
     LIFECYCLE_STATE_NEEDS_ATTENTION = "NEEDS_ATTENTION"
 
+    #: A constant which can be used with the lifecycle_state property of a SqlEndpointSummary.
+    #: This constant has a value of "INACTIVE"
+    LIFECYCLE_STATE_INACTIVE = "INACTIVE"
+
     def __init__(self, **kwargs):
         """
         Initializes a new SqlEndpointSummary object with values from keyword arguments.
@@ -74,7 +78,7 @@ class SqlEndpointSummary(object):
 
         :param lifecycle_state:
             The value to assign to the lifecycle_state property of this SqlEndpointSummary.
-            Allowed values for this property are: "CREATING", "ACTIVE", "DELETING", "DELETED", "FAILED", "UPDATING", "NEEDS_ATTENTION", 'UNKNOWN_ENUM_VALUE'.
+            Allowed values for this property are: "CREATING", "ACTIVE", "DELETING", "DELETED", "FAILED", "UPDATING", "NEEDS_ATTENTION", "INACTIVE", 'UNKNOWN_ENUM_VALUE'.
             Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
         :type lifecycle_state: str
 
@@ -390,7 +394,7 @@ class SqlEndpointSummary(object):
         Gets the lifecycle_state of this SqlEndpointSummary.
         The current state of the Sql Endpoint.
 
-        Allowed values for this property are: "CREATING", "ACTIVE", "DELETING", "DELETED", "FAILED", "UPDATING", "NEEDS_ATTENTION", 'UNKNOWN_ENUM_VALUE'.
+        Allowed values for this property are: "CREATING", "ACTIVE", "DELETING", "DELETED", "FAILED", "UPDATING", "NEEDS_ATTENTION", "INACTIVE", 'UNKNOWN_ENUM_VALUE'.
         Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
 
 
@@ -409,7 +413,7 @@ class SqlEndpointSummary(object):
         :param lifecycle_state: The lifecycle_state of this SqlEndpointSummary.
         :type: str
         """
-        allowed_values = ["CREATING", "ACTIVE", "DELETING", "DELETED", "FAILED", "UPDATING", "NEEDS_ATTENTION"]
+        allowed_values = ["CREATING", "ACTIVE", "DELETING", "DELETED", "FAILED", "UPDATING", "NEEDS_ATTENTION", "INACTIVE"]
         if not value_allowed_none_or_none_sentinel(lifecycle_state, allowed_values):
             lifecycle_state = 'UNKNOWN_ENUM_VALUE'
         self._lifecycle_state = lifecycle_state

oci/data_flow/models/update_sql_endpoint_details.py

@@ -12,7 +12,7 @@ from oci.decorators import init_model_state_from_kwargs
 @init_model_state_from_kwargs
 class UpdateSqlEndpointDetails(object):
     """
-    Currently only the tags of a SQL Endpoint can be updated.
+    The information about all updatable parameters of a SQL Endpoint.
     """
 
     def __init__(self, **kwargs):
@@ -28,19 +28,96 @@ class UpdateSqlEndpointDetails(object):
             The value to assign to the freeform_tags property of this UpdateSqlEndpointDetails.
         :type freeform_tags: dict(str, str)
 
+        :param display_name:
+            The value to assign to the display_name property of this UpdateSqlEndpointDetails.
+        :type display_name: str
+
+        :param description:
+            The value to assign to the description property of this UpdateSqlEndpointDetails.
+        :type description: str
+
+        :param driver_shape:
+            The value to assign to the driver_shape property of this UpdateSqlEndpointDetails.
+        :type driver_shape: str
+
+        :param driver_shape_config:
+            The value to assign to the driver_shape_config property of this UpdateSqlEndpointDetails.
+        :type driver_shape_config: oci.data_flow.models.ShapeConfig
+
+        :param executor_shape:
+            The value to assign to the executor_shape property of this UpdateSqlEndpointDetails.
+        :type executor_shape: str
+
+        :param executor_shape_config:
+            The value to assign to the executor_shape_config property of this UpdateSqlEndpointDetails.
+        :type executor_shape_config: oci.data_flow.models.ShapeConfig
+
+        :param min_executor_count:
+            The value to assign to the min_executor_count property of this UpdateSqlEndpointDetails.
+        :type min_executor_count: int
+
+        :param max_executor_count:
+            The value to assign to the max_executor_count property of this UpdateSqlEndpointDetails.
+        :type max_executor_count: int
+
+        :param metastore_id:
+            The value to assign to the metastore_id property of this UpdateSqlEndpointDetails.
+        :type metastore_id: str
+
+        :param lake_id:
+            The value to assign to the lake_id property of this UpdateSqlEndpointDetails.
+        :type lake_id: str
+
+        :param spark_advanced_configurations:
+            The value to assign to the spark_advanced_configurations property of this UpdateSqlEndpointDetails.
+        :type spark_advanced_configurations: dict(str, str)
+
         """
         self.swagger_types = {
             'defined_tags': 'dict(str, dict(str, object))',
-            'freeform_tags': 'dict(str, str)'
+            'freeform_tags': 'dict(str, str)',
+            'display_name': 'str',
+            'description': 'str',
+            'driver_shape': 'str',
+            'driver_shape_config': 'ShapeConfig',
+            'executor_shape': 'str',
+            'executor_shape_config': 'ShapeConfig',
+            'min_executor_count': 'int',
+            'max_executor_count': 'int',
+            'metastore_id': 'str',
+            'lake_id': 'str',
+            'spark_advanced_configurations': 'dict(str, str)'
         }
 
         self.attribute_map = {
             'defined_tags': 'definedTags',
-            'freeform_tags': 'freeformTags'
+            'freeform_tags': 'freeformTags',
+            'display_name': 'displayName',
+            'description': 'description',
+            'driver_shape': 'driverShape',
+            'driver_shape_config': 'driverShapeConfig',
+            'executor_shape': 'executorShape',
+            'executor_shape_config': 'executorShapeConfig',
+            'min_executor_count': 'minExecutorCount',
+            'max_executor_count': 'maxExecutorCount',
+            'metastore_id': 'metastoreId',
+            'lake_id': 'lakeId',
+            'spark_advanced_configurations': 'sparkAdvancedConfigurations'
         }
 
         self._defined_tags = None
         self._freeform_tags = None
+        self._display_name = None
+        self._description = None
+        self._driver_shape = None
+        self._driver_shape_config = None
+        self._executor_shape = None
+        self._executor_shape_config = None
+        self._min_executor_count = None
+        self._max_executor_count = None
+        self._metastore_id = None
+        self._lake_id = None
+        self._spark_advanced_configurations = None
 
     @property
     def defined_tags(self):
@@ -104,6 +181,270 @@ class UpdateSqlEndpointDetails(object):
         """
         self._freeform_tags = freeform_tags
 
+    @property
+    def display_name(self):
+        """
+        Gets the display_name of this UpdateSqlEndpointDetails.
+        The SQL Endpoint name, which can be changed.
+
+
+        :return: The display_name of this UpdateSqlEndpointDetails.
+        :rtype: str
+        """
+        return self._display_name
+
+    @display_name.setter
+    def display_name(self, display_name):
+        """
+        Sets the display_name of this UpdateSqlEndpointDetails.
+        The SQL Endpoint name, which can be changed.
+
+
+        :param display_name: The display_name of this UpdateSqlEndpointDetails.
+        :type: str
+        """
+        self._display_name = display_name
+
+    @property
+    def description(self):
+        """
+        Gets the description of this UpdateSqlEndpointDetails.
+        The description of CreateSQLEndpointDetails.
+
+
+        :return: The description of this UpdateSqlEndpointDetails.
+        :rtype: str
+        """
+        return self._description
+
+    @description.setter
+    def description(self, description):
+        """
+        Sets the description of this UpdateSqlEndpointDetails.
+        The description of CreateSQLEndpointDetails.
+
+
+        :param description: The description of this UpdateSqlEndpointDetails.
+        :type: str
+        """
+        self._description = description
+
+    @property
+    def driver_shape(self):
+        """
+        Gets the driver_shape of this UpdateSqlEndpointDetails.
+        The shape of the SQL Endpoint driver instance.
+
+
+        :return: The driver_shape of this UpdateSqlEndpointDetails.
+        :rtype: str
+        """
+        return self._driver_shape
+
+    @driver_shape.setter
+    def driver_shape(self, driver_shape):
+        """
+        Sets the driver_shape of this UpdateSqlEndpointDetails.
+        The shape of the SQL Endpoint driver instance.
+
+
+        :param driver_shape: The driver_shape of this UpdateSqlEndpointDetails.
+        :type: str
+        """
+        self._driver_shape = driver_shape
+
+    @property
+    def driver_shape_config(self):
+        """
+        Gets the driver_shape_config of this UpdateSqlEndpointDetails.
+
+        :return: The driver_shape_config of this UpdateSqlEndpointDetails.
+        :rtype: oci.data_flow.models.ShapeConfig
+        """
+        return self._driver_shape_config
+
+    @driver_shape_config.setter
+    def driver_shape_config(self, driver_shape_config):
+        """
+        Sets the driver_shape_config of this UpdateSqlEndpointDetails.
+
+        :param driver_shape_config: The driver_shape_config of this UpdateSqlEndpointDetails.
+        :type: oci.data_flow.models.ShapeConfig
+        """
+        self._driver_shape_config = driver_shape_config
+
+    @property
+    def executor_shape(self):
+        """
+        Gets the executor_shape of this UpdateSqlEndpointDetails.
+        The shape of the SQL Endpoint worker instance.
+
+
+        :return: The executor_shape of this UpdateSqlEndpointDetails.
+        :rtype: str
+        """
+        return self._executor_shape
+
+    @executor_shape.setter
+    def executor_shape(self, executor_shape):
+        """
+        Sets the executor_shape of this UpdateSqlEndpointDetails.
+        The shape of the SQL Endpoint worker instance.
+
+
+        :param executor_shape: The executor_shape of this UpdateSqlEndpointDetails.
+        :type: str
+        """
+        self._executor_shape = executor_shape
+
+    @property
+    def executor_shape_config(self):
+        """
+        Gets the executor_shape_config of this UpdateSqlEndpointDetails.
+
+        :return: The executor_shape_config of this UpdateSqlEndpointDetails.
+        :rtype: oci.data_flow.models.ShapeConfig
+        """
+        return self._executor_shape_config
+
+    @executor_shape_config.setter
+    def executor_shape_config(self, executor_shape_config):
+        """
+        Sets the executor_shape_config of this UpdateSqlEndpointDetails.
+
+        :param executor_shape_config: The executor_shape_config of this UpdateSqlEndpointDetails.
+        :type: oci.data_flow.models.ShapeConfig
+        """
+        self._executor_shape_config = executor_shape_config
+
+    @property
+    def min_executor_count(self):
+        """
+        Gets the min_executor_count of this UpdateSqlEndpointDetails.
+        The minimum number of executors.
+
+
+        :return: The min_executor_count of this UpdateSqlEndpointDetails.
+        :rtype: int
+        """
+        return self._min_executor_count
+
+    @min_executor_count.setter
+    def min_executor_count(self, min_executor_count):
+        """
+        Sets the min_executor_count of this UpdateSqlEndpointDetails.
+        The minimum number of executors.
+
+
+        :param min_executor_count: The min_executor_count of this UpdateSqlEndpointDetails.
+        :type: int
+        """
+        self._min_executor_count = min_executor_count
+
+    @property
+    def max_executor_count(self):
+        """
+        Gets the max_executor_count of this UpdateSqlEndpointDetails.
+        The maximum number of executors.
+
+
+        :return: The max_executor_count of this UpdateSqlEndpointDetails.
+        :rtype: int
+        """
+        return self._max_executor_count
+
+    @max_executor_count.setter
+    def max_executor_count(self, max_executor_count):
+        """
+        Sets the max_executor_count of this UpdateSqlEndpointDetails.
+        The maximum number of executors.
+
+
+        :param max_executor_count: The max_executor_count of this UpdateSqlEndpointDetails.
+        :type: int
+        """
+        self._max_executor_count = max_executor_count
+
+    @property
+    def metastore_id(self):
+        """
+        Gets the metastore_id of this UpdateSqlEndpointDetails.
+        Metastore OCID
+
+
+        :return: The metastore_id of this UpdateSqlEndpointDetails.
+        :rtype: str
+        """
+        return self._metastore_id
+
+    @metastore_id.setter
+    def metastore_id(self, metastore_id):
+        """
+        Sets the metastore_id of this UpdateSqlEndpointDetails.
+        Metastore OCID
+
+
+        :param metastore_id: The metastore_id of this UpdateSqlEndpointDetails.
+        :type: str
+        """
+        self._metastore_id = metastore_id
+
+    @property
+    def lake_id(self):
+        """
+        Gets the lake_id of this UpdateSqlEndpointDetails.
+        OCI lake OCID
+
+
+        :return: The lake_id of this UpdateSqlEndpointDetails.
+        :rtype: str
+        """
+        return self._lake_id
+
+    @lake_id.setter
+    def lake_id(self, lake_id):
+        """
+        Sets the lake_id of this UpdateSqlEndpointDetails.
+        OCI lake OCID
+
+
+        :param lake_id: The lake_id of this UpdateSqlEndpointDetails.
+        :type: str
+        """
+        self._lake_id = lake_id
+
+    @property
+    def spark_advanced_configurations(self):
+        """
+        Gets the spark_advanced_configurations of this UpdateSqlEndpointDetails.
+        The Spark configuration passed to the running process.
+        See https://spark.apache.org/docs/latest/configuration.html#available-properties.
+        Example: { \"spark.app.name\" : \"My App Name\", \"spark.shuffle.io.maxRetries\" : \"4\" }
+        Note: Not all Spark properties are permitted to be set.  Attempting to set a property that is
+        not allowed to be overwritten will cause a 400 status to be returned.
+
+
+        :return: The spark_advanced_configurations of this UpdateSqlEndpointDetails.
+        :rtype: dict(str, str)
+        """
+        return self._spark_advanced_configurations
+
+    @spark_advanced_configurations.setter
+    def spark_advanced_configurations(self, spark_advanced_configurations):
+        """
+        Sets the spark_advanced_configurations of this UpdateSqlEndpointDetails.
+        The Spark configuration passed to the running process.
+        See https://spark.apache.org/docs/latest/configuration.html#available-properties.
+        Example: { \"spark.app.name\" : \"My App Name\", \"spark.shuffle.io.maxRetries\" : \"4\" }
+        Note: Not all Spark properties are permitted to be set.  Attempting to set a property that is
+        not allowed to be overwritten will cause a 400 status to be returned.
+
+
+        :param spark_advanced_configurations: The spark_advanced_configurations of this UpdateSqlEndpointDetails.
+        :type: dict(str, str)
+        """
+        self._spark_advanced_configurations = spark_advanced_configurations
+
     def __repr__(self):
         return formatted_flat_dict(self)