OBJECT

Package

A Package is an object that groups dependent aiWARE resources together.

link GraphQL Schema definition

1type Package {
2
3# The UUID of the Package.
4id: ID!
5
6# Details for the organization that owns the package.
7organization: OrganizationInfo
8
9# The unique name of the package.
10name: String!
11
12description: String
13
14# The path for an icon image.
15icon: String
16
17# This determines how the package is distributed.
18distributionType: EngineDistributionType
19
20# The semantic version of the package.
21version: String!
22
23# This UUID is used to track a package's lineage and versions. This UUID is NOT
24# guaranteed to be a package ID and should not be used as such.
25sourceOriginId: ID
26
27# The source package ID of a package refers to the package it immediately derives
28# from, if any.
29#
30# For example, if there are two packages in the same lineage with versions 1.0 and
31# 2.0,
32# the 2.0 package derives from the 1.0 package. Therefore, the source package ID
33# of the 2.0
34# package would be the ID of the 1.0 package.
35sourcePackageId: ID
36
37# This specifies an aiWARE version that this package is dependent on, if
38# applicable.
39aiwareVersion: String
40
41deleted: Boolean
42
43deprecated: Boolean
44
45status: PackageStatus
46
47# The date the package was installed onto the instance.
48installDate: DateTime
49
50# The date the package was available for distribution. This depends on the
51# package's status and distribution type.
52distributionDate: DateTime
53
54# A flag that indicates whether the package was generated as a result of an
55# automated process or not.
56autoGenerated: Boolean
57
58primaryResourceId: ID @deprecated( reason: "duplicate" )
59
60# This is the resource that the package was specifically made for. This is
61# typically set during automatic package
62# creation and is usually an engine or application.
63#
64# For example, if an application was created and a package was created for it, the
65# application would be the package’s
66# primary resource. This is especially useful because different packages might
67# share many resources, but one package
68# might have an application as a primary resource while another might have an
69# engine as a primary resource.
70primaryResource: PackageResource
71
72# Arguments
73# type: Filter results by Resource Type.
74resources(type: PackageResourceType, alias: String, offset: Int, limit: Int): PackageResourceList
75
76# nestedResources will return resources that are directly or indirectly nested to
77# this package.
78#
79# Arguments
80# type: Filter results by Resource Type.
81nestedResources(type: PackageResourceType, offset: Int, limit: Int): PackageResourceList
82
83# This is the date of when the package was originally created.
84createdAt: DateTime!
85
86modifiedAt: DateTime!
87
88createdBy: BasicUserInfo!
89
90modifiedBy: BasicUserInfo!
91
92}