Package intrinsic_proto.assets
Service
AssetDeploymentService
Message
CreateResourceFromCatalogRequest
Message
CreateResourceFromCatalogResponse
Services
service AssetDeploymentService intrinsic/assets/proto/asset_deployment.proto
Service to manage the deployment of assets, specifically, resource instances and skills.
rpc CreateResourceFromCatalog
Request: intrinsic_proto.assets.CreateResourceFromCatalogRequest
Response:
google.longrunning.Operation
Creates a new resource instance from a resource type present in the
resource catalog.
On success the response field of Operation is set to
CreateResourceFromCatalogResponse.
On failure, any changes applied to the workcell are reverted.
rpc DeleteResource
Request: intrinsic_proto.assets.DeleteResourceRequest
Response:
google.longrunning.Operation
Deletes a previously added resource. The world object corresponding to the resource instance is also deleted including any attached frames.
rpc UpdateResource
Request: intrinsic_proto.assets.UpdateResourceRequest
Response:
google.longrunning.Operation
Update an existing resource instance with a different resource
configuration or the resource type version.
On success, response field of Operation is set to
Resource.
Messages
message AssetTagMetadata intrinsic/assets/proto/asset_tag.proto
Metadata about a particular asset tag value.
| Field | Type | Description | |
|---|---|---|---|
| 1 | asset_tag |
intrinsic_proto.assets.AssetTag
|
The asset tag to which these metadata apply. |
| 2 | display_name |
string
|
The display name of the asset tag. |
| 3 | applicable_asset_types |
repeated
intrinsic_proto.assets.AssetType
|
The asset types to which the asset tag applies. An asset tag may only be associated with an asset if the asset is of a type listed here. |
message AssetTagMetadataSet intrinsic/assets/proto/asset_tag.proto
Describes the metadata of a set of asset tags.
Each AssetTag value must have a corresponding entry in tags, ordered by enum
value.
A value of this proto is defined in asset_tags.textproto; it describes the canonical set of built-in tags that can be associated with assets.
| Field | Type | Description | |
|---|---|---|---|
| 1 | tags |
repeated
intrinsic_proto.assets.AssetTagMetadata
|
message CreateResourceFromCatalogRequest intrinsic/assets/proto/asset_deployment.proto
| Field | Type | Description | |
|---|---|---|---|
| 1 | type_id_version |
string
|
Versioned type identifier for the resource type that would be used to create the resource instance. The resource type should be present in the catalog. |
| 2 | configuration |
intrinsic_proto.assets.ResourceInstanceConfiguration
|
Configuration for the resource instance. |
| 3 | asset_type |
intrinsic_proto.assets.AssetType
|
Asset type of the resource instance to be created. |
| 4 | world_id |
string
|
World ID for which we will instantiate this asset. If left unset, no world operations will be performed. |
message CreateResourceFromCatalogResponse intrinsic/assets/proto/asset_deployment.proto
| Field | Type | Description | |
|---|---|---|---|
| 1 | name |
string
|
Name of the resource instance that was installed. |
message DeleteResourceRequest intrinsic/assets/proto/asset_deployment.proto
| Field | Type | Description | |
|---|---|---|---|
| 1 | name |
string
|
Name of the resource instance to delete. |
| 2 | deletion_strategy |
intrinsic_proto.assets.DeleteResourceRequest.DeletionStrategy
|
Deletion strategy to use. |
| 3 | world_id |
string
|
World ID from where we will delete this asset. If left unset, no world operations will be performed. |
message Documentation intrinsic/assets/proto/documentation.proto
| Field | Type | Description | |
|---|---|---|---|
| 1 | description |
string
|
message FieldMetadata intrinsic/assets/proto/field_metadata.proto
Metadata that further describes a field in a proto. This metadata can be added using a proto option. Field metadata is optional and may be omitted in parts or entirely.
Example:
message MyAsset {
string distance_to_edge_m = 1
[(intrinsic_proto.assets.asset_parameter_metadata).unit = "m"];
}
Tools (e.g., the frontend) may use the information provided in field metadata to show additional guidance or expose targeted functionality during parameterization.
| Field | Type | Description | |
|---|---|---|---|
| 1 | unit |
string
|
Unit of the field. This should be the symbol for the unit rather than the full name (e.g., "m" for meters or "rad" for radian). If empty, the field is treated as unitless. When possible, field names should contain their unit as a suffix. This ensures that people working with generated code for the field proto always have access to unit information. |
| 2 | is_icon2_position_part |
bool
|
Designator for a field that holds an Icon2PositionPart reference. This can be used to designate a particular field in the UI that should be used to select a part name. |
| 3 | is_installed_scene_object_asset |
bool
|
Designator for a intrinsic_proto.assets.Id field that holds an installed scene object asset. This can be used to designate a particular field in the UI that should be used to select a scene object asset. |
message Id intrinsic/assets/proto/id.proto
Id uniquely identifies an asset (e.g., skill, resource) in its respective catalog. If you change an Id's package or name field, the catalog will treat any new releases as a completely different asset.
An ID string is formatted as: "
| Field | Type | Description | |
|---|---|---|---|
| 1 | package |
string
|
A dot-separated string describing the name of the asset's parent package. We recommend that companies use their reverse Internet domain name to start the package name. A valid package: - consists only of lower case alphanumeric characters, underscores, and periods; - begins with an alphabetic character; - ends with an alphanumeric character; - contains at least one period; - precedes each period with an alphanumeric character; - follows each period with an alphabetic character; - does not contain multiple underscores in a row. NOTE: Disallowing multiple underscores in a row enables underscores to be replaced with a hyphen (-) and periods to be replaced with two hyphens (--) in order to convert asset ids to kubernetes labels without possibility of collisions. |
| 2 | name |
string
|
The name of the asset within the package. A valid name: - consists only of lower case alphanumeric characters and underscores; - begins with an alphabetic character; - ends with an alphanumeric character; - does not contain multiple underscores in a row. NOTE: Disallowing multiple underscores in a row enables underscores to be replaced with a hyphen (-) and periods to be replaced with two hyphens (--) in order to convert asset ids to kubernetes labels without possibility of collisions. |
message IdVersion intrinsic/assets/proto/id.proto
IdVersion uniquely identifies a particular version of an asset in its respective catalog. Each release of an asset to a catalog must have a new version.
An IDVersion string is formatted as: "
| Field | Type | Description | |
|---|---|---|---|
| 1 | id |
intrinsic_proto.assets.Id
|
The asset's ID. |
| 2 | version |
string
|
The asset's version, formatted as described by semver.org. |
message Metadata intrinsic/assets/proto/metadata.proto
General metadata for a specific version of an asset.
| Field | Type | Description | |
|---|---|---|---|
| 1 | id_version |
intrinsic_proto.assets.IdVersion
|
The asset's id and version. Required when creating assets. |
| 2 | display_name |
string
|
The display name of the asset to be shown in UIs. Required when creating assets. |
| 3 | vendor |
intrinsic_proto.assets.Vendor
|
The asset's vendor. Required when creating assets. |
| 4 | documentation |
intrinsic_proto.assets.Documentation
|
Documentation for the asset. |
| 5 | release_notes |
string
|
Release notes for this version of the asset. |
| 6 | release_tag |
intrinsic_proto.assets.ReleaseTag
|
Use Asset.release_metadata.default instead. |
| 7 | update_time |
google.protobuf.Timestamp
|
The time at which this version of the asset became available. |
| 8 | asset_type |
intrinsic_proto.assets.AssetType
|
The type of the asset. |
| 9 | asset_tag |
intrinsic_proto.assets.AssetTag
|
A tag to help users search for assets by keyword. |
| 10 | file_descriptor_set |
google.protobuf.FileDescriptorSet
|
A descriptor set for the asset's protos. |
message Resource intrinsic/assets/proto/asset_deployment.proto
| Field | Type | Description | |
|---|---|---|---|
| 1 | name |
string
|
Name of the resource. |
| 2 | id_version |
intrinsic_proto.assets.IdVersion
|
Versioned identifier for the backing asset. |
| 3 | configuration |
intrinsic_proto.assets.ResourceConfiguration
|
Configuration for the resource. |
message ResourceConfiguration intrinsic/assets/proto/asset_deployment.proto
| Field | Type | Description | |
|---|---|---|---|
| 1 | configuration |
optional
google.protobuf.Any
|
Optional resource-specific runtime configuration. |
| 3 | scheduled_node_hostname |
optional
string
|
Hostname on which the service should be run. |
| 6 | scene_object_config |
optional
intrinsic_proto.scene_object.v1.SceneObjectConfig
|
Optional scene object configuration. |
message ResourceInstanceConfiguration intrinsic/assets/proto/asset_deployment.proto
Configuration for the resource instance.
| Field | Type | Description | |
|---|---|---|---|
| 1 | name |
string
|
User provided name for the resource instance. This should be unique within the resource set. |
| 2 | configuration |
optional
google.protobuf.Any
|
Service configuration, if the asset has a service component. |
| 4 | parent |
optional
intrinsic_proto.world.ObjectReferenceWithEntityFilter
|
Optional parent where to attach the new resource instance to.
This may only be specified if the resource type associated with this
resource instance specifies a |
| 5 | parent_t_this |
optional
intrinsic_proto.Pose
|
Optional pose relative to the attached parent.
This may only be specified if the resource type associated with this
resource instance specifies a |
| 6 | scene_object_config |
optional
intrinsic_proto.scene_object.v1.SceneObjectConfig
|
Scene object configuration, if the asset has a scene object component. |
message StatusSpec intrinsic/assets/proto/status_spec.proto
Message to describe expected status codes of assets. Assets define a namespace through their ID, e.g., skill ID. Within this codes above 10000 are up to be defined by the author of the respective components. Other components can use this information to react specifically to errors.
| Field | Type | Description | |
|---|---|---|---|
| 1 | code |
uint32
|
The code to declare. |
| 2 | title |
string
|
Short one-line description of the error that can be shown, e.g., when selecting an error to match from a list. Frameworks, such as the skills framework, may use this information to fill in missing information if not otherwise provided. |
| 3 | recovery_instructions |
string
|
Guidance for the user on actions to take when this failure occurs (e.g., useful error recovery strategies). |
message StatusSpecs intrinsic/assets/proto/status_spec.proto
A collection of status specs. This message is used for standalone files that contain status specs.
| Field | Type | Description | |
|---|---|---|---|
| 1 | status_info |
repeated
intrinsic_proto.assets.StatusSpec
|
message UpdateResourceRequest intrinsic/assets/proto/asset_deployment.proto
| Field | Type | Description | |
|---|---|---|---|
| 1 | resource |
intrinsic_proto.assets.Resource
|
Resource to update. |
| 2 | world_id |
string
|
World ID for which we will update this asset. If left unset, no world operations will be performed. |
message Vendor intrinsic/assets/proto/vendor.proto
| Field | Type | Description | |
|---|---|---|---|
| 1 | display_name |
string
|
The name of the vendor that is to be displayed in the UI. |
Enums
enum AssetTag intrinsic/assets/proto/asset_tag.proto
A tag to help users search for assets by keyword.
Not all tags are applicable to every asset type (see AssetTagMetadata).
| Name | Number | Description |
|---|---|---|
ASSET_TAG_UNSPECIFIED |
0 | |
ASSET_TAG_CAMERA |
1 | |
ASSET_TAG_GRIPPER |
2 | |
ASSET_TAG_SUBPROCESS |
3 |
enum AssetType intrinsic/assets/proto/asset_type.proto
Identifies the type of an asset.
| Name | Number | Description |
|---|---|---|
ASSET_TYPE_UNSPECIFIED |
0 | |
ASSET_TYPE_SCENE_OBJECT |
1 | |
ASSET_TYPE_SERVICE |
2 | |
ASSET_TYPE_SKILL |
3 | |
ASSET_TYPE_HARDWARE_DEVICE |
4 | |
ASSET_TYPE_DATA |
5 | |
ASSET_TYPE_PROCESS |
6 |
enum DeletionStrategy intrinsic/assets/proto/asset_deployment.proto
| Name | Number | Description |
|---|---|---|
UNKNOWN |
0 | Unknown strategy. This is considered an error and the resource instance would not be deleted. |
DELETE_INSTANCE_ONLY |
1 | Only delete the resource instance specified in the request. |
RECURSIVE_DELETE |
2 | Delete the resource instance specified in the request and recursively delete all the sub-children in the kinematics chain. |
enum ReleaseTag intrinsic/assets/proto/release_tag.proto
Use Asset.release_metadata.default instead.
| Name | Number | Description |
|---|---|---|
RELEASE_TAG_UNSPECIFIED |
0 | |
RELEASE_TAG_DEFAULT |
2 |