Skip to content

Commit 542939f

Browse files
schloerkeschloerke
committed
Add more missing fields. Copy over docs for all the fields.
1 parent 7c5178e commit 542939f

File tree

1 file changed

+152
-3
lines changed

1 file changed

+152
-3
lines changed

‎src/posit/connect/content.py‎

Lines changed: 152 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,8 @@ class _AttrsBase(TypedDict, total=False):
6565
title: NotRequired[str]
6666
description: NotRequired[str]
6767
access_type: NotRequired[Literal["all", "acl", "logged_in"]]
68+
locked: NotRequired[bool]
69+
locked_message: NotRequired[str]
6870
# Timeout Settings
6971
connection_timeout: NotRequired[int]
7072
read_timeout: NotRequired[int]
@@ -81,13 +83,35 @@ class _AttrsBase(TypedDict, total=False):
8183
memory_limit: NotRequired[int]
8284
amd_gpu_limit: NotRequired[int]
8385
nvidia_gpu_limit: NotRequired[int]
84-
# Execution Settings
85-
run_as: NotRequired[str]
86-
run_as_current_user: NotRequired[bool]
86+
# Bundle info
87+
content_category: NotRequired[str]
88+
parameterized: NotRequired[bool]
89+
cluster_name: NotRequired[str]
90+
image_name: NotRequired[str]
8791
default_image_name: NotRequired[str]
8892
default_r_environment_management: NotRequired[bool]
8993
default_py_environment_management: NotRequired[bool]
9094
service_account_name: NotRequired[str]
95+
r_version: NotRequired[str]
96+
r_environment_management: NotRequired[bool]
97+
py_version: NotRequired[str]
98+
py_environment_management: NotRequired[bool]
99+
quarto_version: NotRequired[str]
100+
# Execution Settings
101+
run_as: NotRequired[str]
102+
run_as_current_user: NotRequired[bool]
103+
created_time: NotRequired[str]
104+
last_deployed_time: NotRequired[str]
105+
bundle_id: NotRequired[str]
106+
app_mode: NotRequired[str]
107+
content_url: NotRequired[str]
108+
dashboard_url: NotRequired[str]
109+
app_role: NotRequired[Literal["owner", "editor", "viewer", "none"]]
110+
vanity_url: NotRequired[str]
111+
tags: NotRequired[List[dict]]
112+
owner: NotRequired[dict]
113+
id: NotRequired[str]
114+
extension: NotRequired[bool]
91115

92116
class _AttrsNotRequired(_AttrsBase):
93117
name: NotRequired[str]
@@ -128,6 +152,131 @@ def __init__(
128152
guid: str,
129153
**kwargs: Unpack[ContentItem._AttrsNotRequired],
130154
) -> None:
155+
"""
156+
Content item.
157+
158+
The content object models all the "things" you may deploy to Posit
159+
Connect. This includes Shiny applications, R Markdown documents, Jupyter notebooks,
160+
Plumber APIs, FastAPI and Flask APIs, Python apps, plots, and pins.
161+
162+
The `app_mode` field specifies the type of content represented by this item
163+
and defines its runtime model.
164+
165+
* Active content, such as apps and APIs, executes on demand as requests arrive.
166+
* Reports render from source to output HTML. This rendering can occur based on a schedule or when
167+
explicitly triggered. It is *not* on each visit. Viewers of this type of
168+
content see a previously rendered result.
169+
* Static content is presented to viewers in its deployed form.
170+
171+
The fields `bundle_id`, `app_mode`, `content_category`, `parameterized`,
172+
`cluster_name`, `image_name`, `r_version`, `r_environment_management`,
173+
`py_version`, `py_environment_management`, and `quarto_version` are
174+
computed as a consequence of a <a href="#post-/v1/content/-guid-/deploy">POST
175+
/v1/content/{guid}/deploy</a> deployment operation.
176+
177+
Parameters
178+
----------
179+
ctx : Context
180+
Context object.
181+
guid : str
182+
The unique identifier of this content item.
183+
name: str, optional
184+
A simple, URL-friendly identifier. Allows alpha-numeric characters, hyphens ("-"), and underscores ("_").
185+
title : str, optional
186+
The title of this content.
187+
description : str, optional
188+
A rich description of this content.
189+
access_type : Literal['all', 'acl', 'logged_in'], optional
190+
Access type describes how this content manages its viewers. The value `all` is the most permissive; any visitor to Posit Connect will be able to view this content. The value `logged_in` indicates that all Posit Connect accounts may view the content. The `acl` value lets specifically enumerated users and groups view the content. Users configured as collaborators may always view content.
191+
locked : bool, optional
192+
Whether or not the content is locked.
193+
locked_message : str, optional
194+
A custom message that is displayed by the content item when locked. It is possible to format this message using Markdown.
195+
connection_timeout : int, optional
196+
Maximum number of seconds allowed without data sent or received across a client connection. A value of `0` means connections will never time-out (not recommended). When `null`, the default `Scheduler.ConnectionTimeout` is used. Applies only to content types that are executed on demand.
197+
read_timeout : int, optional
198+
Maximum number of seconds allowed without data received from a client connection. A value of `0` means a lack of client (browser) interaction never causes the connection to close. When `null`, the default `Scheduler.ReadTimeout` is used. Applies only to content types that are executed on demand.
199+
init_timeout : int, optional
200+
The maximum number of seconds allowed for an interactive application to start. Posit Connect must be able to connect to a newly launched application before this threshold has elapsed. When `null`, the default `Scheduler.InitTimeout` is used. Applies only to content types that are executed on demand.
201+
idle_timeout : int, optional
202+
The maximum number of seconds a worker process for an interactive application to remain alive after it goes idle (no active connections). When `null`, the default `Scheduler.IdleTimeout` is used. Applies only to content types that are executed on demand.
203+
max_processes : int, optional
204+
Specifies the total number of concurrent processes allowed for a single interactive application per Posit Connect node. When `null`, the default `Scheduler.MaxProcesses` is used. Applies only to content types that are executed on demand.
205+
min_processes : int, optional
206+
Specifies the minimum number of concurrent processes allowed for a single interactive application per Posit Connect node. When `null`, the default `Scheduler.MinProcesses` is used. Applies only to content types that are executed on demand.
207+
max_conns_per_process : int, optional
208+
Specifies the maximum number of client connections allowed to an individual process. Incoming connections which will exceed this limit are routed to a new process or rejected. When `null`, the default `Scheduler.MaxConnsPerProcess` is used. Applies only to content types that are executed on demand.
209+
load_factor : float, optional
210+
Controls how aggressively new processes are spawned. When `null`, the default `Scheduler.LoadFactor` is used. Applies only to content types that are executed on demand.
211+
cpu_request : float, optional
212+
The minimum amount of compute power this content needs when executing or rendering, expressed in ["CPU Units"](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#meaning-of-cpu), where 1.0 unit is equivalent to 1 physical or virtual core. Fractional values are allowed. This is used when running in an off-host execution configuration to determine where the content should be run. When `null`, the default `Scheduler.CPURequest` is used.
213+
cpu_limit : float, optional
214+
The maximum amount of compute power this content will be allowed to consume when executing or rendering, expressed in ["CPU Units"](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#meaning-of-cpu), where 1.0 unit is equivalent to 1 physical or virtual core. Fractional values are allowed. This is used when running in an off-host execution configuration. If the process tries to use more CPU than allowed, it will be throttled. When `null`, the default `Scheduler.CPULimit` is used.
215+
memory_request : int, optional
216+
The minimum amount of RAM this content needs when executing or rendering, expressed in bytes. This is used when running in an off-host execution configuration to determine where the content should be run. When `null`, the default `Scheduler.MemoryRequest` is used.
217+
memory_limit : int, optional
218+
The maximum amount of RAM this content will be allowed to consume when executing or rendering, expressed in bytes. If the process tries to use more memory than allowed, it will be terminated. When `null`, the default `Scheduler.MemoryLimit` is used.
219+
amd_gpu_limit : int, optional
220+
The number of AMD GPUs that will be [allocated by Kubernetes](https://kubernetes.io/docs/tasks/manage-gpus/scheduling-gpus/) to run this content. This is used when running in an off-host execution configuration. When `null`, the default `Scheduler.AMDGPULimit` is used. This setting can not exceed `Scheduler.MaxAMDGPULimit`.
221+
nvidia_gpu_limit : int, optional
222+
The number of NVIDIA GPUs that will be [allocated by Kubernetes](https://kubernetes.io/docs/tasks/manage-gpus/scheduling-gpus/) to run this content. This is used when running in an off-host execution configuration. When `null`, the default `Scheduler.NvidiaGPULimit` is used. This setting can not exceed `Scheduler.MaxNvidiaGPULimit`.
223+
created_time : str, optional
224+
The timestamp (RFC3339) indicating when this content was created.
225+
last_deployed_time : str, optional
226+
The timestamp (RFC3339) indicating when this content last had a successful bundle deployment performed.
227+
bundle_id : str, optional
228+
The identifier for the active deployment bundle. Automatically assigned upon the successful deployment of that bundle.
229+
app_mode : Literal['api', 'jupyter-static', 'jupyter-voila', 'python-api', 'python-bokeh', 'python-dash', 'python-fastapi', 'python-shiny', 'python-streamlit', 'quarto-shiny', 'quarto-static', 'rmd-shiny', 'rmd-static', 'shiny', 'static', 'tensorflow-saved-model', 'unknown'], optional
230+
The runtime model for this content. Has a value of `unknown` before data is deployed to this item. Automatically assigned upon the first successful bundle deployment.
231+
content_category : str, optional
232+
Describes the specialization of the content runtime model. Automatically assigned upon the first successful bundle deployment.
233+
parameterized : bool, optional
234+
True when R Markdown rendered content allows parameter configuration. Automatically assigned upon the first successful bundle deployment. Applies only to content with an `app_mode` of `rmd-static`.
235+
cluster_name : str, optional
236+
The location where this content runs. Content running on the same server as Connect will have either a `null` value or the string "Local". Gives the name of the cluster when run external to the Connect host. A `null` value is returned when the client does not have sufficient rights to see this information.
237+
image_name : str, optional
238+
The location where this content runs. Content running on the same server as Connect will have either a `null` value or the string "Local". References the name of the target image when content runs in a clustered environment such as Kubernetes. A `null` value is returned when the client does not have sufficient rights to see this information.
239+
default_image_name : str, optional
240+
The default image that will be used when none is defined by the bundle's manifest. A specific image may be selected by setting the `environment.image` field in the manifest. If no image is selected by the manifest file, then the `default_image_name` is used. If a target image is not defined by the manifest, and no `default_image_name` is configured, then Connect will select an image from the list of configured execution environments. A `null` value is returned when the client does not have sufficient rights to see this information. Use the `/v1/environments` API endpoints to determine which environments are available for content execution.
241+
default_r_environment_management : bool, optional
242+
Indicates whether or not Connect should create and manage an R environment (installing required packages) for this content. When `null`, Connect makes this determination based on the server configuration. A `null` value is also returned when the client does not have sufficient rights to see this information. This value is ignored if the server setting `Applications.DefaultEnvironmentManagementSelection` is disabled.
243+
default_py_environment_management : bool, optional
244+
Indicates whether or not Connect should create and manage a Python environment (installing required packages) for this content. When `null`, Connect makes this determination based on the server configuration. A `null` value is also returned when the client does not have sufficient rights to see this information. This value is ignored if the server setting `Applications.DefaultEnvironmentManagementSelection` is disabled.
245+
service_account_name : str, optional
246+
The name of the Kubernetes service account that is used to run a particular piece of content. It must adhere to valid Kubernetes service account naming rules. Connect must be configured to run with `Launcher.Enabled = true`, `Launcher.Kubernetes = true` and `Launcher.KubernetesContentServiceAccountSelection = true` for this value to be applied. It will have precedence over the `Launcher.KubernetesDefaultServiceAccount` that may be set in the configuration for Connect. If this value is defined and Connect is configured with `Launcher.KubernetesContentServiceAccountSelection = false` an error will be returned. Only administrators and publishers can view this value. Only administrators can set or change this value.
247+
r_version : str, optional
248+
The of R interpreter associated with this content. A `null` value represents that R is not used by this content, that the content has not been prepared for execution, or that the client does not have sufficient rights to see this information. Automatically assigned upon the successful deployment of a bundle.
249+
r_environment_management : bool, optional
250+
Indicates whether or not Connect is managing an R environment and has installed the required packages for this content. A `null` value represents that R is not used by this content, that the content has not been prepared for execution, or that the client does not have sufficient rights to see this information. Automatically assigned upon the successful deployment of a bundle.
251+
py_version : str, optional
252+
The version of Python associated with this content. A `null` value represents that Python is not used by this content, that the content has not been prepared for execution, or that the client does not have sufficient rights to see this information. Automatically assigned upon the successful deployment of a bundle.
253+
py_environment_management : bool, optional
254+
Indicates whether or not Connect is managing a Python environment and has installed the required packages for this content. A `null` value represents that Python is not used by this content, that the content has not been prepared for execution, or that the client does not have sufficient rights to see this information. Automatically assigned upon the successful deployment of a bundle.
255+
quarto_version : str, optional
256+
The version of Quarto associated with this content. A `null` represents that Quarto is not used by this content, that the content has not been prepared for execution, or that the client does not have sufficient rights to see this information. Automatically assigned upon the successful deployment of a bundle.
257+
run_as : str, optional
258+
The UNIX user that executes this content. When `null`, the default `Applications.RunAs` is used. Applies only to executable content types - not `static`.
259+
run_as_current_user : bool, optional
260+
Indicates that Connect should run processes for this content item under the Unix account of the user who visits it. Content accessed anonymously will continue to run as the specified `run_as` user. Connect must be configured to use PAM authentication with the server settings `Applications.RunAsCurrentUser = true` and `PAM.ForwardPassword = true`. This setting has no effect for other authentication types. This setting only applies to application content types (Shiny, Dash, Streamlit, and Bokeh).
261+
owner_guid : str, optional
262+
The unique identifier of the user who owns this content item.
263+
content_url : str, optional
264+
The URL associated with this content. Computed from the associated GUID for this content.
265+
dashboard_url : str, optional
266+
The URL within the Connect dashboard where this content can be configured. Computed from the GUID for this content.
267+
app_role : Literal['owner', 'editor', 'viewer', 'none'], optional
268+
The relationship of the accessing user to this content. A value of `owner` is returned for the content owner. `editor` indicates a collaborator. The `viewer` value is given to users who are permitted to view the content. A `none` role is returned for administrators who cannot view the content but are permitted to view its configuration. Computed at the time of the request.
269+
vanity_url : str, optional
270+
The vanity URL associated with this content item. Included in responses when the vanity URL is set and `include=vanity_url` is provided.
271+
tags : List[Tag], optional
272+
Tags associated with this content item. Included in responses when `include=tags` is provided.
273+
owner : ContentItemOwner, optional
274+
Basic details about the owner of this content item. Included in responses when `include=owner` is provided.
275+
id : str, optional
276+
The internal numeric identifier of this content item.
277+
extension : bool, optional
278+
Whether the content is a Connect Extension.
279+
"""
131280
_assert_guid(guid)
132281

133282
path = f"v1/content/{guid}"

0 commit comments

Comments
 (0)