Skip to main content

artifacts

Creates, updates, deletes, gets or lists an artifacts resource.

Overview​

Nameartifacts
TypeResource
Idnvidia.private_registry.artifacts

Fields​

The following fields are returned by SELECT queries:

NameDatatypeDescription
namestringUnique name of the helm chart
encryption_key_idstringID of the customer managed encryption key associated with this artifact (wire: encryptionKeyId)
latest_version_idstringID of the latest version (wire: latestVersionId)
display_namestringDisplay name (wire: displayName)
org_namestringName of the org that the helm chart belongs to (wire: orgName)
owner_namestringName of the user who owns this version (wire: ownerName)
team_namestringName of the team that the helm chart belongs to (wire: teamName)
access_typestring (LISTED, EXCLUSIVE, NOT_LISTED) (wire: accessType)
artifact_typestringArtifact type (MODEL, MODEL_SCRIPT, HELM_CHART, REPOSITORY, COLLECTION, ENDPOINT, BLUEPRINT, PLAYBOOK, AGENT, API, SKILL) (wire: artifactType)
attributesarray
biasstringText describing bias in the artifact
built_bystringOrganization that built the helm chart (wire: builtBy)
can_guest_downloadbooleanIndicates if a guest user can download (wire: canGuestDownload)
created_datestringCreation 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)
descriptionstringDescription of the helm chart
explainabilitystringText describing the explainability for this artifact
has_signed_versionbooleanIndicates if the artifact has any signed versions (wire: hasSignedVersion)
is_favouritebooleanFlag indicating if helm chart is user's favorite (wire: isFavourite)
is_publicbooleanDetermines if this helm chart is publicly accessible (wire: isPublic)
is_read_onlybooleanindicate if current user has read only permissions (deprecated) (wire: isReadOnly)
labelsarray
latest_version_size_in_bytesinteger (int64)Size of the latest version in bytes (wire: latestVersionSizeInBytes)
license_termsarray (wire: licenseTerms)
logostringURL for the logo image
policy_labelsarray (wire: policyLabels)
privacystringText describing the privacy for this artifact
product_namesarray (wire: productNames)
publisherstringOrganization that published this helm chart
safety_and_securitystringText for describing the safety and security in the artifact (wire: safetyAndSecurity)
short_descriptionstringShort description of the helm chart (wire: shortDescription)
updated_datestringUpdated 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:

NameAccessible byRequired ParamsOptional ParamsDescription
get_by_teamselectteam_name, artifact_type, artifact_nameresolve_labels, remove_unresolved_labelsGet artifact details in team
list_by_teamselectteam_name, artifact_typepage_size, page_number, resolve_labels, remove_unresolved_labelsList artifacts the user can access in the specified org and team
getselectartifact_type, artifact_nameresolve_labels, remove_unresolved_labelsGet artifact details in org
listselectartifact_typepage_size, page_number, resolve_labels, remove_unresolved_labelsList artifacts the user can access in the specified org
create_by_teaminsertteam_name, artifact_type, name, short_descriptionCreate artifact in team
createinsertartifact_type, name, short_descriptionCreate artifact in org
update_by_teamupdateteam_name, artifact_type, artifact_nameUpdate artifact details in team
updateupdateartifact_type, artifact_nameUpdate artifact details in org
replace_by_teamreplaceteam_name, artifact_type, artifact_nameReplace artifact details in team
replacereplaceartifact_type, artifact_nameReplace artifact details in org
delete_by_teamdeleteteam_name, artifact_type, artifact_nameDelete artifact in team
deletedeleteartifact_type, artifact_nameDelete artifact in org
sync_release_type_labels_by_teamexecteam_name, artifact_type, artifact_nameSync release type labels for all collections containing this artifact. Internal API for service-to-service communication.
set_release_type_by_teamexecteam_name, artifact_type, artifact_name, versionUpdates the release type (for example GA, EA, beta) of an artifact version within the specified organization and optional team.
set_terms_of_service_by_teamexecteam_name, artifact_type, artifact_nameUpdate artifact terms of service
sync_release_type_labelsexecartifact_type, artifact_nameSync release type labels for all collections containing this artifact. Internal API for service-to-service communication.
set_release_typeexecartifact_type, artifact_name, versionUpdates the release type (for example GA, EA, beta) of an artifact version within the specified organization and optional team.
set_terms_of_serviceexecartifact_type, artifact_nameUpdate artifact terms of service
malware_scan_by_teamexecteam_name, artifact_type, artifact_name, version_idcontact_email, nspect_idInitiates malwares can for the artifact
purge_by_teamexecteam_name, artifact_type, artifact_namePurge Search DB for deleted artifacts
malware_scanexecartifact_type, artifact_name, version_idcontact_email, nspect_idInitiates malwares can for the artifact
purgeexecartifact_type, artifact_namePurge Search DB for deleted artifacts

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.

NameDatatypeDescription
artifact_namestring (UTF-8)Artifact name
artifact_typestring (UTF-8)Artifact type
team_namestring (UTF-8)Team name
version_idstring (UTF-8)Version ID
contact_emailstring (UTF-8)Contact email
nspect_idstring (UTF-8)Nspect identifier
page_numberstring (UTF-8)Page number - zero based index
page_sizestring (UTF-8)Page size
remove_unresolved_labelsbooleanRemove unresolved labels
resolve_labelsbooleanResolve labels

SELECT examples​

Get artifact details in 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.artifacts
WHERE team_name = '{{ team_name }}' -- required
AND artifact_type = '{{ artifact_type }}' -- required
AND artifact_name = '{{ artifact_name }}' -- required
AND resolve_labels = '{{ resolve_labels }}'
AND remove_unresolved_labels = '{{ remove_unresolved_labels }}'
;

INSERT examples​

Create artifact in team

INSERT INTO nvidia.private_registry.artifacts (
attributes,
bias,
built_by,
description,
display_name,
explainability,
labels,
labels_v2,
license_terms,
logo,
name,
privacy,
publisher,
safety_and_security,
short_description,
team_name,
artifact_type
)
SELECT
'{{ attributes }}',
'{{ bias }}',
'{{ built_by }}',
'{{ description }}',
'{{ display_name }}',
'{{ explainability }}',
'{{ labels }}',
'{{ labels_v2 }}',
'{{ license_terms }}',
'{{ logo }}',
'{{ name }}' /* required */,
'{{ privacy }}',
'{{ publisher }}',
'{{ safety_and_security }}',
'{{ short_description }}' /* required */,
'{{ team_name }}',
'{{ artifact_type }}'
RETURNING
artifact,
request_status
;

UPDATE examples​

Update artifact details in team

UPDATE nvidia.private_registry.artifacts
SET
attributes = '{{ attributes }}',
bias = '{{ bias }}',
built_by = '{{ built_by }}',
description = '{{ description }}',
display_name = '{{ display_name }}',
explainability = '{{ explainability }}',
labels = '{{ labels }}',
labels_v2 = '{{ labels_v2 }}',
license_terms = '{{ license_terms }}',
logo = '{{ logo }}',
privacy = '{{ privacy }}',
publisher = '{{ publisher }}',
safety_and_security = '{{ safety_and_security }}',
short_description = '{{ short_description }}'
WHERE
team_name = '{{ team_name }}' --required
AND artifact_type = '{{ artifact_type }}' --required
AND artifact_name = '{{ artifact_name }}' --required
RETURNING
artifact,
request_status;

REPLACE examples​

Replace artifact details in team

REPLACE nvidia.private_registry.artifacts
SET
attributes = '{{ attributes }}',
bias = '{{ bias }}',
built_by = '{{ built_by }}',
description = '{{ description }}',
display_name = '{{ display_name }}',
explainability = '{{ explainability }}',
labels = '{{ labels }}',
labels_v2 = '{{ labels_v2 }}',
license_terms = '{{ license_terms }}',
logo = '{{ logo }}',
privacy = '{{ privacy }}',
publisher = '{{ publisher }}',
safety_and_security = '{{ safety_and_security }}',
short_description = '{{ short_description }}'
WHERE
team_name = '{{ team_name }}' --required
AND artifact_type = '{{ artifact_type }}' --required
AND artifact_name = '{{ artifact_name }}' --required
RETURNING
artifact,
request_status;

DELETE examples​

Delete artifact in team

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

Lifecycle Methods​

EXEC variables use wire (API) names.

Sync release type labels for all collections containing this artifact. Internal API for service-to-service communication.

EXEC nvidia.private_registry.artifacts.sync_release_type_labels_by_team
@team_name='{{ team_name }}' --required,
@artifact_type='{{ artifact_type }}' --required,
@artifact_name='{{ artifact_name }}' --required
;