collection_artifacts

Creates, updates, deletes, gets or lists a collection_artifacts resource.

Overview

Name	collection_artifacts
Type	Resource
Id	nvidia.private_registry.collection_artifacts

Fields

The following fields are returned by SELECT queries:

list_by_team

Name	Datatype	Description
name	string	Unique name of the helm chart
encryption_key_id	string	ID of the customer managed encryption key associated with this artifact (wire: encryptionKeyId)
latest_version_id	string	ID of the latest version (wire: latestVersionId)
display_name	string	Display name (wire: displayName)
org_name	string	Name of the org that the helm chart belongs to (wire: orgName)
owner_name	string	Name of the user who owns this version (wire: ownerName)
team_name	string	Name of the team that the helm chart belongs to (wire: teamName)
access_type	string	(LISTED, EXCLUSIVE, NOT_LISTED) (wire: accessType)
artifact_type	string	Artifact type (MODEL, MODEL_SCRIPT, HELM_CHART, REPOSITORY, COLLECTION, ENDPOINT, BLUEPRINT, PLAYBOOK, AGENT, API, SKILL) (wire: artifactType)
attributes	array
bias	string	Text describing bias in the artifact
built_by	string	Organization that built the helm chart (wire: builtBy)
can_guest_download	boolean	Indicates if a guest user can download (wire: canGuestDownload)
created_date	string	Creation date in ISO-8601 format (pattern: <code>\d{4}-[01]\d-[0-3]\dT[0-2]\d:[0-5]\d:[0-5]\d.\d+Z</code>) (wire: createdDate)
description	string	Description of the helm chart
explainability	string	Text describing the explainability for this artifact
has_signed_version	boolean	Indicates if the artifact has any signed versions (wire: hasSignedVersion)
is_favourite	boolean	Flag indicating if helm chart is user's favorite (wire: isFavourite)
is_public	boolean	Determines if this helm chart is publicly accessible (wire: isPublic)
is_read_only	boolean	indicate if current user has read only permissions (deprecated) (wire: isReadOnly)
labels	array
latest_version_size_in_bytes	integer (int64)	Size of the latest version in bytes (wire: latestVersionSizeInBytes)
license_terms	array	(wire: licenseTerms)
logo	string	URL for the logo image
policy_labels	array	(wire: policyLabels)
privacy	string	Text describing the privacy for this artifact
product_names	array	(wire: productNames)
publisher	string	Organization that published this helm chart
safety_and_security	string	Text for describing the safety and security in the artifact (wire: safetyAndSecurity)
short_description	string	Short description of the helm chart (wire: shortDescription)
updated_date	string	Updated date in ISO-8601 format (pattern: <code>\d{4}-[01]\d-[0-3]\dT[0-2]\d:[0-5]\d:[0-5]\d.\d+Z</code>) (wire: updatedDate)

list

Name	Datatype	Description
name	string	Unique name of the helm chart
encryption_key_id	string	ID of the customer managed encryption key associated with this artifact (wire: encryptionKeyId)
latest_version_id	string	ID of the latest version (wire: latestVersionId)
display_name	string	Display name (wire: displayName)
org_name	string	Name of the org that the helm chart belongs to (wire: orgName)
owner_name	string	Name of the user who owns this version (wire: ownerName)
team_name	string	Name of the team that the helm chart belongs to (wire: teamName)
access_type	string	(LISTED, EXCLUSIVE, NOT_LISTED) (wire: accessType)
artifact_type	string	Artifact type (MODEL, MODEL_SCRIPT, HELM_CHART, REPOSITORY, COLLECTION, ENDPOINT, BLUEPRINT, PLAYBOOK, AGENT, API, SKILL) (wire: artifactType)
attributes	array
bias	string	Text describing bias in the artifact
built_by	string	Organization that built the helm chart (wire: builtBy)
can_guest_download	boolean	Indicates if a guest user can download (wire: canGuestDownload)
created_date	string	Creation date in ISO-8601 format (pattern: <code>\d{4}-[01]\d-[0-3]\dT[0-2]\d:[0-5]\d:[0-5]\d.\d+Z</code>) (wire: createdDate)
description	string	Description of the helm chart
explainability	string	Text describing the explainability for this artifact
has_signed_version	boolean	Indicates if the artifact has any signed versions (wire: hasSignedVersion)
is_favourite	boolean	Flag indicating if helm chart is user's favorite (wire: isFavourite)
is_public	boolean	Determines if this helm chart is publicly accessible (wire: isPublic)
is_read_only	boolean	indicate if current user has read only permissions (deprecated) (wire: isReadOnly)
labels	array
latest_version_size_in_bytes	integer (int64)	Size of the latest version in bytes (wire: latestVersionSizeInBytes)
license_terms	array	(wire: licenseTerms)
logo	string	URL for the logo image
policy_labels	array	(wire: policyLabels)
privacy	string	Text describing the privacy for this artifact
product_names	array	(wire: productNames)
publisher	string	Organization that published this helm chart
safety_and_security	string	Text for describing the safety and security in the artifact (wire: safetyAndSecurity)
short_description	string	Short description of the helm chart (wire: shortDescription)
updated_date	string	Updated date in ISO-8601 format (pattern: <code>\d{4}-[01]\d-[0-3]\dT[0-2]\d:[0-5]\d:[0-5]\d.\d+Z</code>) (wire: updatedDate)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_by_team	select	team_name, collection_name, artifact_type	page_size, page_number, order_by, resolve_labels, remove_unresolved_labels	List collection artifacts the user can access in the specified org and team
list	select	collection_name, artifact_type	page_size, page_number, order_by, resolve_labels, remove_unresolved_labels	List collection artifacts the user can access in the specified org
add_cross_org_team_by_team	insert	team_name, collection_name, artifact_org_name, artifact_team_name, artifact_type, artifact_name		Add artifact to the specified collection in the specified org and team from another org and team
add_cross_org_team	insert	collection_name, artifact_org_name, artifact_team_name, artifact_type, artifact_name		Add artifact to the specified collection in the specified org from another org and team
add_cross_org_by_team	insert	team_name, collection_name, artifact_org_name, artifact_type, artifact_name		Add artifact to the specified collection in the specified org and team from another org
add_cross_org	insert	collection_name, artifact_org_name, artifact_type, artifact_name		Add artifact to the specified collection in the specified org from another org
add_by_team	insert	team_name, collection_name, artifact_type, artifact_name		Add artifact to the specified collection in the specified org and team
add	insert	collection_name, artifact_type, artifact_name		Add artifact to the specified collection in the specified org
update_bulk_by_team	update	team_name, collection_name		Patch collection in the specified org and team
update_bulk	update	collection_name		Patch collection in the specified org
remove_cross_org_team_by_team	delete	team_name, collection_name, artifact_org_name, artifact_team_name, artifact_type, artifact_name		Remove artifact from the specified collection in the specified org and team from another org and team
remove_cross_org_team	delete	collection_name, artifact_org_name, artifact_team_name, artifact_type, artifact_name		Remove artifact from the specified collection in the specified org from another org
remove_cross_org_by_team	delete	team_name, collection_name, artifact_org_name, artifact_type, artifact_name		Remove artifact from the specified collection in the specified org and team from another org
remove_cross_org	delete	collection_name, artifact_org_name, artifact_type, artifact_name		Remove artifact from the specified collection in the specified org from another org
remove_by_team	delete	team_name, collection_name, artifact_type, artifact_name		Remove artifact from the specified collection in the specified org and team
remove	delete	collection_name, artifact_type, artifact_name		Remove artifact from the specified collection in the specified org

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
artifact_name	string (UTF-8)	Artifact name
artifact_org_name	string (UTF-8)	Artifact organization name
artifact_team_name	string (UTF-8)	Artifact team name
artifact_type	string (UTF-8)	Artifact type
collection_name	string (UTF-8)	Collection name
team_name	string (UTF-8)	Team name
order_by	string (UTF-8)	Order by
page_number	string (UTF-8)	Page number - zero based index
page_size	string (UTF-8)	Page size
remove_unresolved_labels	boolean	Remove unresolved labels
resolve_labels	boolean	Resolve labels

SELECT examples

list_by_team

List collection artifacts the user can access in the specified org and team

SELECT
name,
encryption_key_id,
latest_version_id,
display_name,
org_name,
owner_name,
team_name,
access_type,
artifact_type,
attributes,
bias,
built_by,
can_guest_download,
created_date,
description,
explainability,
has_signed_version,
is_favourite,
is_public,
is_read_only,
labels,
latest_version_size_in_bytes,
license_terms,
logo,
policy_labels,
privacy,
product_names,
publisher,
safety_and_security,
short_description,
updated_date
FROM nvidia.private_registry.collection_artifacts
WHERE team_name = '{{ team_name }}' -- required
AND collection_name = '{{ collection_name }}' -- required
AND artifact_type = '{{ artifact_type }}' -- required
AND page_size = '{{ page_size }}'
AND page_number = '{{ page_number }}'
AND order_by = '{{ order_by }}'
AND resolve_labels = '{{ resolve_labels }}'
AND remove_unresolved_labels = '{{ remove_unresolved_labels }}'
;

list

List collection artifacts the user can access in the specified org

SELECT
name,
encryption_key_id,
latest_version_id,
display_name,
org_name,
owner_name,
team_name,
access_type,
artifact_type,
attributes,
bias,
built_by,
can_guest_download,
created_date,
description,
explainability,
has_signed_version,
is_favourite,
is_public,
is_read_only,
labels,
latest_version_size_in_bytes,
license_terms,
logo,
policy_labels,
privacy,
product_names,
publisher,
safety_and_security,
short_description,
updated_date
FROM nvidia.private_registry.collection_artifacts
WHERE collection_name = '{{ collection_name }}' -- required
AND artifact_type = '{{ artifact_type }}' -- required
AND page_size = '{{ page_size }}'
AND page_number = '{{ page_number }}'
AND order_by = '{{ order_by }}'
AND resolve_labels = '{{ resolve_labels }}'
AND remove_unresolved_labels = '{{ remove_unresolved_labels }}'
;

INSERT examples

add_cross_org_team_by_team

Add artifact to the specified collection in the specified org and team from another org and team

INSERT INTO nvidia.private_registry.collection_artifacts (
team_name,
collection_name,
artifact_org_name,
artifact_team_name,
artifact_type,
artifact_name
)
SELECT 
'{{ team_name }}',
'{{ collection_name }}',
'{{ artifact_org_name }}',
'{{ artifact_team_name }}',
'{{ artifact_type }}',
'{{ artifact_name }}'
RETURNING
request_status
;

add_cross_org_team

Add artifact to the specified collection in the specified org from another org and team

INSERT INTO nvidia.private_registry.collection_artifacts (
collection_name,
artifact_org_name,
artifact_team_name,
artifact_type,
artifact_name
)
SELECT 
'{{ collection_name }}',
'{{ artifact_org_name }}',
'{{ artifact_team_name }}',
'{{ artifact_type }}',
'{{ artifact_name }}'
RETURNING
request_status
;

add_cross_org_by_team

Add artifact to the specified collection in the specified org and team from another org

INSERT INTO nvidia.private_registry.collection_artifacts (
team_name,
collection_name,
artifact_org_name,
artifact_type,
artifact_name
)
SELECT 
'{{ team_name }}',
'{{ collection_name }}',
'{{ artifact_org_name }}',
'{{ artifact_type }}',
'{{ artifact_name }}'
RETURNING
request_status
;

add_cross_org

Add artifact to the specified collection in the specified org from another org

INSERT INTO nvidia.private_registry.collection_artifacts (
collection_name,
artifact_org_name,
artifact_type,
artifact_name
)
SELECT 
'{{ collection_name }}',
'{{ artifact_org_name }}',
'{{ artifact_type }}',
'{{ artifact_name }}'
RETURNING
request_status
;

add_by_team

Add artifact to the specified collection in the specified org and team

INSERT INTO nvidia.private_registry.collection_artifacts (
team_name,
collection_name,
artifact_type,
artifact_name
)
SELECT 
'{{ team_name }}',
'{{ collection_name }}',
'{{ artifact_type }}',
'{{ artifact_name }}'
RETURNING
request_status
;

add

Add artifact to the specified collection in the specified org

INSERT INTO nvidia.private_registry.collection_artifacts (
collection_name,
artifact_type,
artifact_name
)
SELECT 
'{{ collection_name }}',
'{{ artifact_type }}',
'{{ artifact_name }}'
RETURNING
request_status
;

Manifest

# Description fields are for documentation purposes
- name: collection_artifacts
props:
  - name: team_name
    value: "{{ team_name }}"
    description: Required parameter for the collection_artifacts resource.
  - name: collection_name
    value: "{{ collection_name }}"
    description: Required parameter for the collection_artifacts resource.
  - name: artifact_org_name
    value: "{{ artifact_org_name }}"
    description: Required parameter for the collection_artifacts resource.
  - name: artifact_team_name
    value: "{{ artifact_team_name }}"
    description: Required parameter for the collection_artifacts resource.
  - name: artifact_type
    value: "{{ artifact_type }}"
    description: Required parameter for the collection_artifacts resource.
  - name: artifact_name
    value: "{{ artifact_name }}"
    description: Required parameter for the collection_artifacts resource.

UPDATE examples

update_bulk_by_team

Patch collection in the specified org and team

UPDATE nvidia.private_registry.collection_artifacts
SET 
operations = '{{ operations }}'
WHERE 
team_name = '{{ team_name }}' --required
AND collection_name = '{{ collection_name }}' --required
RETURNING
request_status;

update_bulk

Patch collection in the specified org

UPDATE nvidia.private_registry.collection_artifacts
SET 
operations = '{{ operations }}'
WHERE 
collection_name = '{{ collection_name }}' --required
RETURNING
request_status;

DELETE examples

remove_cross_org_team_by_team

Remove artifact from the specified collection in the specified org and team from another org and team

DELETE FROM nvidia.private_registry.collection_artifacts
WHERE team_name = '{{ team_name }}' --required
AND collection_name = '{{ collection_name }}' --required
AND artifact_org_name = '{{ artifact_org_name }}' --required
AND artifact_team_name = '{{ artifact_team_name }}' --required
AND artifact_type = '{{ artifact_type }}' --required
AND artifact_name = '{{ artifact_name }}' --required
;

remove_cross_org_team

Remove artifact from the specified collection in the specified org from another org

DELETE FROM nvidia.private_registry.collection_artifacts
WHERE collection_name = '{{ collection_name }}' --required
AND artifact_org_name = '{{ artifact_org_name }}' --required
AND artifact_team_name = '{{ artifact_team_name }}' --required
AND artifact_type = '{{ artifact_type }}' --required
AND artifact_name = '{{ artifact_name }}' --required
;

remove_cross_org_by_team

Remove artifact from the specified collection in the specified org and team from another org

DELETE FROM nvidia.private_registry.collection_artifacts
WHERE team_name = '{{ team_name }}' --required
AND collection_name = '{{ collection_name }}' --required
AND artifact_org_name = '{{ artifact_org_name }}' --required
AND artifact_type = '{{ artifact_type }}' --required
AND artifact_name = '{{ artifact_name }}' --required
;

remove_cross_org

Remove artifact from the specified collection in the specified org from another org

DELETE FROM nvidia.private_registry.collection_artifacts
WHERE collection_name = '{{ collection_name }}' --required
AND artifact_org_name = '{{ artifact_org_name }}' --required
AND artifact_type = '{{ artifact_type }}' --required
AND artifact_name = '{{ artifact_name }}' --required
;

remove_by_team

Remove artifact from the specified collection in the specified org and team

DELETE FROM nvidia.private_registry.collection_artifacts
WHERE team_name = '{{ team_name }}' --required
AND collection_name = '{{ collection_name }}' --required
AND artifact_type = '{{ artifact_type }}' --required
AND artifact_name = '{{ artifact_name }}' --required
;

remove

Remove artifact from the specified collection in the specified org

DELETE FROM nvidia.private_registry.collection_artifacts
WHERE collection_name = '{{ collection_name }}' --required
AND artifact_type = '{{ artifact_type }}' --required
AND artifact_name = '{{ artifact_name }}' --required
;