The python-domino library

project_name: The name of the project.

owner_username: (Optional) The owner username for the project. This parameter is useful when you need to create a project under an organization.

username_or_email: Name or email of the Domino user to add as collaborator to the current project.

message: Optional - Message related to the user’s role or purpose to the project.

project_id: The project identifier.

tag_id: The tag identifier.

tags (list): One or more tag names.

project_id: (Defaults to current project ID) The project identifier.

tag_name (string): The tag name.

project_id: (Defaults to current project id) The project ID.

tag_name (string): The tag name.

project_id: (Defaults to current project id) The project ID.

command: The command to execution as an array of strings where members of the array represent arguments of the command. For example: ["main.py", "hi mom"]

isDirect: (Optional) Whether this command should be passed directly to a shell.

commitId: (Optional) The commitId to launch from. If not provided, the project launches from the latest commit.

title: (Optional) A title for the execution.

tier: (Optional) The hardware tier to use for the execution. This is the human-readable name of the hardware tier, such as "Free", "Small", or "Medium". If not provided, the project’s default tier is used.

publishApiEndpoint: (Optional) Whether to publish an API endpoint from the resulting output.

command: The command to execution as an array of strings where members of the array represent arguments of the command. For example: ["main.py", "hi mom"]

isDirect: (Optional) Whether this command should be passed directly to a shell.

commitId: (Optional) The commitId to launch from. If not provided, the project launches from the latest commit.

title: (Optional) A title for the execution.

tier: (Optional) The hardware tier to use for the execution. Will use project’s default tier if not provided. If not provided, the project’s default tier is used.

publishApiEndpoint: (Optional) Whether to publish an API endpoint from the resulting output.

poll_freq: (Optional) Number of seconds between polling of the Domino server for status of the task that is running.

max_poll_time: (Optional) Maximum number of seconds to wait for a task to complete. If this threshold is exceeded, an exception is raised.

retry_count: (Optional) Maximum number of polling retries (in case of transient HTTP errors). If this threshold is exceeded, an exception is raised.

runId: String that identifies the execution.

saveChanges: (Defaults to True) If false, execution results are discarded.

runId: string that identifies the execution

commitId: The commitId to list files from.

path: (Defaults to "/") The path to list from.

path: The path to save the file to. For example, /README.md writes to the root directory of the project while /data/numbers.csv saves the file to a sub folder named data. If the specified folder does not yet exist, it is created.

file: A Python file object. For example: f = open("authors.txt","rb")

key: The key of the file to fetch from the blob server.

unpublishRunningApps: (Defaults to True) Check for active app instances in the current project and unpublish them before publishing.

hardwareTierId: (Optional) Launch the app on the specified hardware tier.

command (string): Command to execute in Job. For example: domino.job_start(command="main.py arg1 arg2")

commit_id (string): (Optional) The commitId to launch from. If not provided, the job launches from the latest commit.

hardware_tier_name (string): (Optional) The hardware tier NAME to launch job in. If not provided, the project’s default tier is used.

environment_id (string): (Optional) The environment ID with which to launch the job. If not provided, the project’s default environment is used.

on_demand_spark_cluster_properties (dict): (Optional) On demand spark cluster properties. The following properties can be provided in the Spark cluster:

{
    "computeEnvironmentId": "<Environment ID configured with spark>"
    "executorCount": "<Number of Executors in cluster>"
     (optional defaults to 1)
    "executorHardwareTierId": "<Hardware tier ID for Spark Executors>"
     (optional defaults to last used historically if available)
    "masterHardwareTierId":  "<Hardware tier ID for Spark master"
     (optional defaults to last used historically if available)
    "executorStorageMB": "<Executor's storage in MB>"
     (optional defaults to 0; 1GB is 1000MB Here)
}

param compute_cluster_properties (dict): (Optional) The compute-cluster properties definition contains parameters for launching any Domino supported compute cluster for a job. Use this to launch a job that uses a compute-cluster instead of the deprecated on_demand_spark_cluster_properties field. If on_demand_spark_cluster_properties and compute_cluster_properties are both present, on_demand_spark_cluster_properties is ignored. compute_cluster_properties contains the following fields:

{
    "clusterType": <string, one of "Ray", "Spark", "Dask", "MPI">,
    "computeEnvironmentId": <string, The environment ID for the cluster's nodes>,
    "computeEnvironmentRevisionSpec": <one of "ActiveRevision", "LatestRevision",
    {"revisionId":"<environment_revision_id>"} (optional)>,
    "masterHardwareTierId": <string, the Hardware tier ID for the cluster's master node (required unless clusterType is MPI)>,
    "workerCount": <number, the total workers to spawn for the cluster>,
    "workerHardwareTierId": <string, The Hardware tier ID for the cluster workers>,
    "workerStorage": <{ "value": <number>, "unit": <one of "GiB", "MB"> },
    The disk storage size for the cluster's worker nodes (optional)>
    "maxWorkerCount": <number, The max number of workers allowed. When
    this configuration exists, autoscaling is enabled for the cluster and
    "workerCount" is interpreted as the min number of workers allowed in the cluster
    (optional)>
}

external_volume_mounts (List[string]): (Optional) External volume mount IDs to mount to execution. If not provided, the job launches with no external volumes mounted.

job_id (string): Job identifier.

commit_results (boolean): (Defaults to true) If false, the job results are not committed.

job_id (string): Job identifier.

poll_freq: Poll frequency interval in seconds.

max_poll_time: Max poll time in seconds.

project_id (string): (Defaults to None) The project identifier. Each project can hold up to 5 datasets.

project_id: The project identifier.

project_id: The project identifier.

dataset_id: The dataset identifier.

dataset_name: Name of the new dataset. NOTE: The name must be unique.

dataset_description: Description of the dataset.

dataset_id: The dataset identifier.

dataset_name: (Optional) New name of the dataset.

dataset_description: (Optional) New description of the dataset.

dataset_ids (list[string]): List of IDs of the datasets to delete. NOTE: Datasets are first marked for deletion, then deleted after a grace period (15 minutes, configurable). A Domino admin may also need to complete this process before the name can be reused.