aidp-python-client 1.0.0__py3-none-any.whl

aidp_python_client/aidataplatform_dp/models/spark_cluster.py

@@ -0,0 +1,497 @@
+# coding: utf-8
+# Copyright (c) 2026, Oracle and/or its affiliates.  All rights reserved.
+
+
+from .cluster import Cluster
+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 SparkCluster(Cluster):
+    """
+    User-created cluster.
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new SparkCluster object with values from keyword arguments. The default value of the :py:attr:`~oci.aidataplatform_dp.models.SparkCluster.source_api` attribute
+        of this class is ``CLUSTER_API`` and it should not be changed.
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param key:
+            The value to assign to the key property of this SparkCluster.
+        :type key: str
+
+        :param display_name:
+            The value to assign to the display_name property of this SparkCluster.
+        :type display_name: str
+
+        :param description:
+            The value to assign to the description property of this SparkCluster.
+        :type description: str
+
+        :param source_api:
+            The value to assign to the source_api property of this SparkCluster.
+            Allowed values for this property are: "CLUSTER_API", "DEFAULT_CLUSTER_API", "AGENT_FLOW_COMPUTE"
+        :type source_api: str
+
+        :param type:
+            The value to assign to the type property of this SparkCluster.
+            Allowed values for this property are: "USER", "AGENT_FLOW_COMPUTE"
+        :type type: str
+
+        :param time_created:
+            The value to assign to the time_created property of this SparkCluster.
+        :type time_created: datetime
+
+        :param time_updated:
+            The value to assign to the time_updated property of this SparkCluster.
+        :type time_updated: datetime
+
+        :param state:
+            The value to assign to the state property of this SparkCluster.
+            Allowed values for this property are: "ACCEPTED", "CREATING", "ACTIVE", "DELETING", "DELETED", "FAILED", "STOPPING", "STOPPED", "UPDATING", "RESTARTING", "STARTING", "NETWORK_CONFIGURATION_ATTACH_IN_PROGRESS", "NETWORK_CONFIGURATION_ATTACH_SUCCESSFUL", "NETWORK_CONFIGURATION_ATTACH_FAILED", "NETWORK_CONFIGURATION_DETACH_IN_PROGRESS", "NETWORK_CONFIGURATION_DETACH_SUCCESSFUL", "NETWORK_CONFIGURATION_DETACH_FAILED"
+        :type state: str
+
+        :param state_details:
+            The value to assign to the state_details property of this SparkCluster.
+        :type state_details: str
+
+        :param node_type:
+            The value to assign to the node_type property of this SparkCluster.
+        :type node_type: str
+
+        :param driver_config:
+            The value to assign to the driver_config property of this SparkCluster.
+        :type driver_config: oci.aidataplatform_dp.models.DriverConfig
+
+        :param active_cluster_resources:
+            The value to assign to the active_cluster_resources property of this SparkCluster.
+        :type active_cluster_resources: oci.aidataplatform_dp.models.ActiveClusterResources
+
+        :param created_by:
+            The value to assign to the created_by property of this SparkCluster.
+        :type created_by: str
+
+        :param created_by_name:
+            The value to assign to the created_by_name property of this SparkCluster.
+        :type created_by_name: str
+
+        :param updated_by:
+            The value to assign to the updated_by property of this SparkCluster.
+        :type updated_by: str
+
+        :param updated_by_name:
+            The value to assign to the updated_by_name property of this SparkCluster.
+        :type updated_by_name: str
+
+        :param stopped_by:
+            The value to assign to the stopped_by property of this SparkCluster.
+        :type stopped_by: str
+
+        :param stopped_by_name:
+            The value to assign to the stopped_by_name property of this SparkCluster.
+        :type stopped_by_name: str
+
+        :param worker_config:
+            The value to assign to the worker_config property of this SparkCluster.
+        :type worker_config: oci.aidataplatform_dp.models.WorkerConfig
+
+        :param cluster_runtime_config:
+            The value to assign to the cluster_runtime_config property of this SparkCluster.
+        :type cluster_runtime_config: oci.aidataplatform_dp.models.ClusterRuntimeConfig
+
+        :param logging_config:
+            The value to assign to the logging_config property of this SparkCluster.
+        :type logging_config: oci.aidataplatform_dp.models.LoggingConfig
+
+        :param auto_termination_minutes:
+            The value to assign to the auto_termination_minutes property of this SparkCluster.
+        :type auto_termination_minutes: int
+
+        :param attached_notebooks:
+            The value to assign to the attached_notebooks property of this SparkCluster.
+        :type attached_notebooks: list[str]
+
+        :param attached_sessions:
+            The value to assign to the attached_sessions property of this SparkCluster.
+        :type attached_sessions: list[oci.aidataplatform_dp.models.AttachedSession]
+
+        :param attached_agent_flow_count:
+            The value to assign to the attached_agent_flow_count property of this SparkCluster.
+        :type attached_agent_flow_count: int
+
+        :param jdbc_endpoint_url:
+            The value to assign to the jdbc_endpoint_url property of this SparkCluster.
+        :type jdbc_endpoint_url: str
+
+        :param log_id:
+            The value to assign to the log_id property of this SparkCluster.
+        :type log_id: str
+
+        :param log_group_id:
+            The value to assign to the log_group_id property of this SparkCluster.
+        :type log_group_id: str
+
+        :param subscription:
+            The value to assign to the subscription property of this SparkCluster.
+        :type subscription: oci.aidataplatform_dp.models.SubscriptionDetails
+
+        """
+        self.swagger_types = {
+            'key': 'str',
+            'display_name': 'str',
+            'description': 'str',
+            'source_api': 'str',
+            'type': 'str',
+            'time_created': 'datetime',
+            'time_updated': 'datetime',
+            'state': 'str',
+            'state_details': 'str',
+            'node_type': 'str',
+            'driver_config': 'DriverConfig',
+            'active_cluster_resources': 'ActiveClusterResources',
+            'created_by': 'str',
+            'created_by_name': 'str',
+            'updated_by': 'str',
+            'updated_by_name': 'str',
+            'stopped_by': 'str',
+            'stopped_by_name': 'str',
+            'worker_config': 'WorkerConfig',
+            'cluster_runtime_config': 'ClusterRuntimeConfig',
+            'logging_config': 'LoggingConfig',
+            'auto_termination_minutes': 'int',
+            'attached_notebooks': 'list[str]',
+            'attached_sessions': 'list[AttachedSession]',
+            'attached_agent_flow_count': 'int',
+            'jdbc_endpoint_url': 'str',
+            'log_id': 'str',
+            'log_group_id': 'str',
+            'subscription': 'SubscriptionDetails'
+        }
+
+        self.attribute_map = {
+            'key': 'key',
+            'display_name': 'displayName',
+            'description': 'description',
+            'source_api': 'sourceApi',
+            'type': 'type',
+            'time_created': 'timeCreated',
+            'time_updated': 'timeUpdated',
+            'state': 'state',
+            'state_details': 'stateDetails',
+            'node_type': 'nodeType',
+            'driver_config': 'driverConfig',
+            'active_cluster_resources': 'activeClusterResources',
+            'created_by': 'createdBy',
+            'created_by_name': 'createdByName',
+            'updated_by': 'updatedBy',
+            'updated_by_name': 'updatedByName',
+            'stopped_by': 'stoppedBy',
+            'stopped_by_name': 'stoppedByName',
+            'worker_config': 'workerConfig',
+            'cluster_runtime_config': 'clusterRuntimeConfig',
+            'logging_config': 'loggingConfig',
+            'auto_termination_minutes': 'autoTerminationMinutes',
+            'attached_notebooks': 'attachedNotebooks',
+            'attached_sessions': 'attachedSessions',
+            'attached_agent_flow_count': 'attachedAgentFlowCount',
+            'jdbc_endpoint_url': 'jdbcEndpointUrl',
+            'log_id': 'logId',
+            'log_group_id': 'logGroupId',
+            'subscription': 'subscription'
+        }
+
+        self._key = None
+        self._display_name = None
+        self._description = None
+        self._source_api = None
+        self._type = None
+        self._time_created = None
+        self._time_updated = None
+        self._state = None
+        self._state_details = None
+        self._node_type = None
+        self._driver_config = None
+        self._active_cluster_resources = None
+        self._created_by = None
+        self._created_by_name = None
+        self._updated_by = None
+        self._updated_by_name = None
+        self._stopped_by = None
+        self._stopped_by_name = None
+        self._worker_config = None
+        self._cluster_runtime_config = None
+        self._logging_config = None
+        self._auto_termination_minutes = None
+        self._attached_notebooks = None
+        self._attached_sessions = None
+        self._attached_agent_flow_count = None
+        self._jdbc_endpoint_url = None
+        self._log_id = None
+        self._log_group_id = None
+        self._subscription = None
+        self._source_api = 'CLUSTER_API'
+
+    @property
+    def worker_config(self):
+        """
+        Gets the worker_config of this SparkCluster.
+
+        :return: The worker_config of this SparkCluster.
+        :rtype: oci.aidataplatform_dp.models.WorkerConfig
+        """
+        return self._worker_config
+
+    @worker_config.setter
+    def worker_config(self, worker_config):
+        """
+        Sets the worker_config of this SparkCluster.
+
+        :param worker_config: The worker_config of this SparkCluster.
+        :type: oci.aidataplatform_dp.models.WorkerConfig
+        """
+        self._worker_config = worker_config
+
+    @property
+    def cluster_runtime_config(self):
+        """
+        Gets the cluster_runtime_config of this SparkCluster.
+
+        :return: The cluster_runtime_config of this SparkCluster.
+        :rtype: oci.aidataplatform_dp.models.ClusterRuntimeConfig
+        """
+        return self._cluster_runtime_config
+
+    @cluster_runtime_config.setter
+    def cluster_runtime_config(self, cluster_runtime_config):
+        """
+        Sets the cluster_runtime_config of this SparkCluster.
+
+        :param cluster_runtime_config: The cluster_runtime_config of this SparkCluster.
+        :type: oci.aidataplatform_dp.models.ClusterRuntimeConfig
+        """
+        self._cluster_runtime_config = cluster_runtime_config
+
+    @property
+    def logging_config(self):
+        """
+        Gets the logging_config of this SparkCluster.
+
+        :return: The logging_config of this SparkCluster.
+        :rtype: oci.aidataplatform_dp.models.LoggingConfig
+        """
+        return self._logging_config
+
+    @logging_config.setter
+    def logging_config(self, logging_config):
+        """
+        Sets the logging_config of this SparkCluster.
+
+        :param logging_config: The logging_config of this SparkCluster.
+        :type: oci.aidataplatform_dp.models.LoggingConfig
+        """
+        self._logging_config = logging_config
+
+    @property
+    def auto_termination_minutes(self):
+        """
+        Gets the auto_termination_minutes of this SparkCluster.
+        Optional timeout value in minutes used to automatically stop idle compute clusters.
+
+
+        :return: The auto_termination_minutes of this SparkCluster.
+        :rtype: int
+        """
+        return self._auto_termination_minutes
+
+    @auto_termination_minutes.setter
+    def auto_termination_minutes(self, auto_termination_minutes):
+        """
+        Sets the auto_termination_minutes of this SparkCluster.
+        Optional timeout value in minutes used to automatically stop idle compute clusters.
+
+
+        :param auto_termination_minutes: The auto_termination_minutes of this SparkCluster.
+        :type: int
+        """
+        self._auto_termination_minutes = auto_termination_minutes
+
+    @property
+    def attached_notebooks(self):
+        """
+        Gets the attached_notebooks of this SparkCluster.
+        List of notebooks attached to a specific cluster.
+
+
+        :return: The attached_notebooks of this SparkCluster.
+        :rtype: list[str]
+        """
+        return self._attached_notebooks
+
+    @attached_notebooks.setter
+    def attached_notebooks(self, attached_notebooks):
+        """
+        Sets the attached_notebooks of this SparkCluster.
+        List of notebooks attached to a specific cluster.
+
+
+        :param attached_notebooks: The attached_notebooks of this SparkCluster.
+        :type: list[str]
+        """
+        self._attached_notebooks = attached_notebooks
+
+    @property
+    def attached_sessions(self):
+        """
+        Gets the attached_sessions of this SparkCluster.
+        List of sessions attached to a specific cluster.
+
+
+        :return: The attached_sessions of this SparkCluster.
+        :rtype: list[oci.aidataplatform_dp.models.AttachedSession]
+        """
+        return self._attached_sessions
+
+    @attached_sessions.setter
+    def attached_sessions(self, attached_sessions):
+        """
+        Sets the attached_sessions of this SparkCluster.
+        List of sessions attached to a specific cluster.
+
+
+        :param attached_sessions: The attached_sessions of this SparkCluster.
+        :type: list[oci.aidataplatform_dp.models.AttachedSession]
+        """
+        self._attached_sessions = attached_sessions
+
+    @property
+    def attached_agent_flow_count(self):
+        """
+        Gets the attached_agent_flow_count of this SparkCluster.
+        Count of agent flow attached to a specific cluster.
+
+
+        :return: The attached_agent_flow_count of this SparkCluster.
+        :rtype: int
+        """
+        return self._attached_agent_flow_count
+
+    @attached_agent_flow_count.setter
+    def attached_agent_flow_count(self, attached_agent_flow_count):
+        """
+        Sets the attached_agent_flow_count of this SparkCluster.
+        Count of agent flow attached to a specific cluster.
+
+
+        :param attached_agent_flow_count: The attached_agent_flow_count of this SparkCluster.
+        :type: int
+        """
+        self._attached_agent_flow_count = attached_agent_flow_count
+
+    @property
+    def jdbc_endpoint_url(self):
+        """
+        Gets the jdbc_endpoint_url of this SparkCluster.
+        Spark JDBC URL.
+
+
+        :return: The jdbc_endpoint_url of this SparkCluster.
+        :rtype: str
+        """
+        return self._jdbc_endpoint_url
+
+    @jdbc_endpoint_url.setter
+    def jdbc_endpoint_url(self, jdbc_endpoint_url):
+        """
+        Sets the jdbc_endpoint_url of this SparkCluster.
+        Spark JDBC URL.
+
+
+        :param jdbc_endpoint_url: The jdbc_endpoint_url of this SparkCluster.
+        :type: str
+        """
+        self._jdbc_endpoint_url = jdbc_endpoint_url
+
+    @property
+    def log_id(self):
+        """
+        Gets the log_id of this SparkCluster.
+        The OCID of the log where cluster logs are published and retrieved. This logId is always created within the logGroupId returned in the response payload.
+
+
+        :return: The log_id of this SparkCluster.
+        :rtype: str
+        """
+        return self._log_id
+
+    @log_id.setter
+    def log_id(self, log_id):
+        """
+        Sets the log_id of this SparkCluster.
+        The OCID of the log where cluster logs are published and retrieved. This logId is always created within the logGroupId returned in the response payload.
+
+
+        :param log_id: The log_id of this SparkCluster.
+        :type: str
+        """
+        self._log_id = log_id
+
+    @property
+    def log_group_id(self):
+        """
+        Gets the log_group_id of this SparkCluster.
+        The unique OCID that identifies a specific log group within OCI Logging.
+        This log group is exclusively associated with the AI Data Platform Workbench instance and is created in the same compartment within the customer\u2019s tenancy as the AI Data Platform Workbench instance.
+
+
+        :return: The log_group_id of this SparkCluster.
+        :rtype: str
+        """
+        return self._log_group_id
+
+    @log_group_id.setter
+    def log_group_id(self, log_group_id):
+        """
+        Sets the log_group_id of this SparkCluster.
+        The unique OCID that identifies a specific log group within OCI Logging.
+        This log group is exclusively associated with the AI Data Platform Workbench instance and is created in the same compartment within the customer\u2019s tenancy as the AI Data Platform Workbench instance.
+
+
+        :param log_group_id: The log_group_id of this SparkCluster.
+        :type: str
+        """
+        self._log_group_id = log_group_id
+
+    @property
+    def subscription(self):
+        """
+        Gets the subscription of this SparkCluster.
+
+        :return: The subscription of this SparkCluster.
+        :rtype: oci.aidataplatform_dp.models.SubscriptionDetails
+        """
+        return self._subscription
+
+    @subscription.setter
+    def subscription(self, subscription):
+        """
+        Sets the subscription of this SparkCluster.
+
+        :param subscription: The subscription of this SparkCluster.
+        :type: oci.aidataplatform_dp.models.SubscriptionDetails
+        """
+        self._subscription = subscription
+
+    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

aidp_python_client/aidataplatform_dp/models/spark_runtime_config.py

@@ -0,0 +1,155 @@
+# coding: utf-8
+# Copyright (c) 2026, Oracle and/or its affiliates.  All rights reserved.
+
+
+from .cluster_runtime_config import ClusterRuntimeConfig
+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 SparkRuntimeConfig(ClusterRuntimeConfig):
+    """
+    Spark runtime information.
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new SparkRuntimeConfig object with values from keyword arguments. The default value of the :py:attr:`~oci.aidataplatform_dp.models.SparkRuntimeConfig.type` attribute
+        of this class is ``SPARK`` and it should not be changed.
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param type:
+            The value to assign to the type property of this SparkRuntimeConfig.
+            Allowed values for this property are: "SPARK"
+        :type type: str
+
+        :param init_scripts:
+            The value to assign to the init_scripts property of this SparkRuntimeConfig.
+        :type init_scripts: list[oci.aidataplatform_dp.models.InitScriptPath]
+
+        :param spark_version:
+            The value to assign to the spark_version property of this SparkRuntimeConfig.
+        :type spark_version: str
+
+        :param spark_advanced_configurations:
+            The value to assign to the spark_advanced_configurations property of this SparkRuntimeConfig.
+        :type spark_advanced_configurations: dict(str, str)
+
+        :param spark_env_variables:
+            The value to assign to the spark_env_variables property of this SparkRuntimeConfig.
+        :type spark_env_variables: dict(str, str)
+
+        """
+        self.swagger_types = {
+            'type': 'str',
+            'init_scripts': 'list[InitScriptPath]',
+            'spark_version': 'str',
+            'spark_advanced_configurations': 'dict(str, str)',
+            'spark_env_variables': 'dict(str, str)'
+        }
+
+        self.attribute_map = {
+            'type': 'type',
+            'init_scripts': 'initScripts',
+            'spark_version': 'sparkVersion',
+            'spark_advanced_configurations': 'sparkAdvancedConfigurations',
+            'spark_env_variables': 'sparkEnvVariables'
+        }
+
+        self._type = None
+        self._init_scripts = None
+        self._spark_version = None
+        self._spark_advanced_configurations = None
+        self._spark_env_variables = None
+        self._type = 'SPARK'
+
+    @property
+    def spark_version(self):
+        """
+        Gets the spark_version of this SparkRuntimeConfig.
+        Spark version used to run the application.
+
+
+        :return: The spark_version of this SparkRuntimeConfig.
+        :rtype: str
+        """
+        return self._spark_version
+
+    @spark_version.setter
+    def spark_version(self, spark_version):
+        """
+        Sets the spark_version of this SparkRuntimeConfig.
+        Spark version used to run the application.
+
+
+        :param spark_version: The spark_version of this SparkRuntimeConfig.
+        :type: str
+        """
+        self._spark_version = spark_version
+
+    @property
+    def spark_advanced_configurations(self):
+        """
+        Gets the spark_advanced_configurations of this SparkRuntimeConfig.
+        Spark configuration passed to the running process.
+
+
+        :return: The spark_advanced_configurations of this SparkRuntimeConfig.
+        :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 SparkRuntimeConfig.
+        Spark configuration passed to the running process.
+
+
+        :param spark_advanced_configurations: The spark_advanced_configurations of this SparkRuntimeConfig.
+        :type: dict(str, str)
+        """
+        self._spark_advanced_configurations = spark_advanced_configurations
+
+    @property
+    def spark_env_variables(self):
+        """
+        Gets the spark_env_variables of this SparkRuntimeConfig.
+        Environment variables passed to the running process. See <a href=\"https://spark.apache.org/docs/latest/configuration.html#available-properties\" target=\"_blank\" rel=\"noopener noreferrer\">Available Properties</a>.
+        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_env_variables of this SparkRuntimeConfig.
+        :rtype: dict(str, str)
+        """
+        return self._spark_env_variables
+
+    @spark_env_variables.setter
+    def spark_env_variables(self, spark_env_variables):
+        """
+        Sets the spark_env_variables of this SparkRuntimeConfig.
+        Environment variables passed to the running process. See <a href=\"https://spark.apache.org/docs/latest/configuration.html#available-properties\" target=\"_blank\" rel=\"noopener noreferrer\">Available Properties</a>.
+        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_env_variables: The spark_env_variables of this SparkRuntimeConfig.
+        :type: dict(str, str)
+        """
+        self._spark_env_variables = spark_env_variables
+
+    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