connect.environments
connect.environments
Environment resources.
Attributes
| Name | Description |
|---|---|
| MatchingType | Directions for how environments are considered for selection. |
Classes
| Name | Description |
|---|---|
| Environment | |
| Environments | |
| Installation | Interpreter installation in an execution environment. |
| Installations | Interpreter installations in an execution environment. |
Environment
connect.environments.Environment()Methods
| Name | Description |
|---|---|
| destroy | Destroy the environment. |
| update | Update the environment. |
destroy
connect.environments.Environment.destroy()Destroy the environment.
Warnings
This operation is irreversible.
Note
This action requires administrator privileges.
update
connect.environments.Environment.update(
title
description=...
matching=...
supervisor=...
python=...
quarto=...
r=...
tensorflow=...
)Update the environment.
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| title | str | A human-readable title. | required |
| description | (str | None, optional, not required) |
A human-readable description. | ... |
| matching | (MatchingType, optional, not required) |
Directions for how the environment is considered for selection | ... |
| supervisor | (str | None, optional, not required) |
Path to the supervisor script. | ... |
| python | (Installations, optional, not required) |
The Python installations available in this environment | ... |
| quarto | (Installations, optional, not required) |
The Quarto installations available in this environment | ... |
| r | (Installations, optional, not required) |
The R installations available in this environment | ... |
| tensorflow | (Installations, optional, not required) |
The Tensorflow installations available in this environment | ... |
Note
This action requires administrator privileges.
Environments
connect.environments.Environments()Methods
| Name | Description |
|---|---|
| create | Create an environment. |
| find | |
| find_by | Find the first record matching the specified conditions. |
create
connect.environments.Environments.create(
title
name
cluster_name
matching='any'
description=...
supervisor=...
python=...
quarto=...
r=...
tensorflow=...
)Create an environment.
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| title | str | A human-readable title. | required |
| name | str | The container image name used for execution in this environment. | required |
| cluster_name | str | Literal['Kubernetes'] |
The cluster identifier for this environment. Defaults to “Kubernetes” when Off-Host-Execution is enabled. | required |
| description | str | A human-readable description. | ... |
| matching | MatchingType | Directions for how the environment is considered for selection, by default is “any”. | 'any' |
| supervisor | str | Path to the supervisor script | ... |
| python | Installations | The Python installations available in this environment | ... |
| quarto | Installations | The Quarto installations available in this environment | ... |
| r | Installations | The R installations available in this environment | ... |
| tensorflow | Installations | The Tensorflow installations available in this environment | ... |
Returns
| Name | Type | Description |
|---|---|---|
| Environment |
Note
This action requires administrator privileges.
find
connect.environments.Environments.find(guid, /)find_by
connect.environments.Environments.find_by(
id=...
guid=...
created_time=...
updated_time=...
title=...
name=...
description=...
cluster_name=...
environment_type=...
matching=...
supervisor=...
python=...
quarto=...
r=...
tensorflow=...
)Find the first record matching the specified conditions.
There is no implied ordering, so if order matters, you should specify it yourself.
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| id | str | The numerical identifier. | ... |
| guid | str | The unique identifier. | ... |
| created_time | str | The timestamp (RFC3339) when the environment was created. | ... |
| updated_time | str | The timestamp (RFC3339) when the environment was updated. | ... |
| title | str | A human-readable title. | ... |
| name | str | The container image name used for execution in this environment. | ... |
| description | str | A human-readable description. | ... |
| cluster_name | str | Literal['Kubernetes'] |
The cluster identifier for this environment. Defaults to “Kubernetes” when Off-Host-Execution is enabled. | ... |
| environment_type | str | Literal['Kubernetes'] |
The cluster environment type. Defaults to “Kubernetes” when Off-Host-Execution is enabled. | ... |
| matching | MatchingType | Directions for how the environment is considered for selection. | ... |
| supervisor | str | Path to the supervisor script | ... |
| python | Installations | The Python installations available in this environment | ... |
| quarto | Installations | The Quarto installations available in this environment | ... |
| r | Installations | The R installations available in this environment | ... |
| tensorflow | Installations | The Tensorflow installations available in this environment | ... |
Returns
| Name | Type | Description |
|---|---|---|
| Environment | None |
Note
This action requires administrator or publisher privileges.
Installation
connect.environments.Installation()Interpreter installation in an execution environment.
Attributes
| Name | Description |
|---|---|
| path | The absolute path to the interpreter’s executable. |
| version | The semantic version of the interpreter. |
Installations
connect.environments.Installations()Interpreter installations in an execution environment.
Attributes
| Name | Description |
|---|---|
| installations | Interpreter installations in an execution environment. |