Package intrinsic_proto.resources
Message
GetResourceInstanceRequest
Message
ListResourceInstanceRequest
Message
ListResourceInstanceResponse
Message
ResourceConnectionInfo
Services
service ResourceRegistry intrinsic/resources/proto/resource_registry.proto
rpc ListResourceInstances
Request: intrinsic_proto.resources.ListResourceInstanceRequest
Response:
intrinsic_proto.resources.ListResourceInstanceResponse
Lists all resource instances in the currently deployed app.
rpc GetResourceInstance
Request: intrinsic_proto.resources.GetResourceInstanceRequest
Response:
intrinsic_proto.resources.ResourceInstance
Gets specific resource instance from the currently deployed app.
Messages
message GetResourceInstanceRequest intrinsic/resources/proto/resource_registry.proto
| Field | Type | Description | |
|---|---|---|---|
| 1 | name |
string
|
message ListResourceInstanceRequest intrinsic/resources/proto/resource_registry.proto
| Field | Type | Description | |
|---|---|---|---|
| 1 | page_size |
int64
|
The maximum number of resource instances to return. If unspecified, at most 50 resource instances will be returned. The maximum value is 200. |
| 2 | page_token |
string
|
A page token from a previous call used to retrieve subsequent resource instances. |
| 3 | strict_filter |
optional
intrinsic_proto.resources.ListResourceInstanceRequest.StrictFilter
|
Apply a filter to the query to retrieve a filtered set of results. |
message ListResourceInstanceResponse intrinsic/resources/proto/resource_registry.proto
| Field | Type | Description | |
|---|---|---|---|
| 1 | instances |
repeated
intrinsic_proto.resources.ResourceInstance
|
|
| 2 | next_page_token |
string
|
This token can be used to retrieve the next results on a future call. |
message ResourceConnectionInfo intrinsic/resources/proto/resource_handle.proto
Contains info on how to connect to a resource instance.
| Field | Type | Description | |
|---|---|---|---|
|
oneof target
|
|||
| 1 | grpc |
intrinsic_proto.resources.ResourceGrpcConnectionInfo
|
|
message ResourceData (Nested in intrinsic_proto.resources.ResourceHandle ) intrinsic/resources/proto/resource_handle.proto
| Field | Type | Description | |
|---|---|---|---|
| 1 | contents |
google.protobuf.Any
|
Data that can be used to access or interact with the resource instance containing a given resource handle type. |
message ResourceGrpcConnectionInfo intrinsic/resources/proto/resource_handle.proto
| Field | Type | Description | |
|---|---|---|---|
| 1 | address |
string
|
Address of the GRPC service. |
| 2 | server_instance |
string
|
Routing information attached to the http header. |
| 3 | header |
string
|
The header to be used with the instance name in the metadata of requests. |
message ResourceHandle intrinsic/resources/proto/resource_handle.proto
| Field | Type | Description | |
|---|---|---|---|
| 1 | name |
string
|
The name of the resource instance represented by this handle. |
| 2 | resource_data |
map<string, ResourceData>
|
A mapping between the resource's capabilities and their configuration data. |
| 3 | connection_info |
intrinsic_proto.resources.ResourceConnectionInfo
|
Information on how to connect to the resource instance. |
message ResourceHandles intrinsic/resources/proto/resource_handle.proto
| Field | Type | Description | |
|---|---|---|---|
| 1 | handles |
repeated
intrinsic_proto.resources.ResourceHandle
|
message ResourceInstance intrinsic/resources/proto/resource_registry.proto
| Field | Type | Description | |
|---|---|---|---|
| 1 | name |
string
|
The resource instance's unique identifier with the resource set. |
| 2 | type_id |
string
|
Resource type identifier. Type information can be requested through the resource catalog unless this instance was instantiated via sideloading. |
| 3 | configuration |
google.protobuf.Any
|
Service configuration, if the asset has a service component. |
| 6 | resource_family_id |
string
|
Resource family identifier, useful for grouping and filtering. |
| 11 | resource_handle |
intrinsic_proto.resources.ResourceHandle
|
The handle containing connection information and resource capabilitiies. |
| 13 | scene_object_config |
optional
intrinsic_proto.scene_object.v1.SceneObjectConfig
|
Scene object configuration, if the asset has a scene object component. |
message StrictFilter (Nested in intrinsic_proto.resources.ListResourceInstanceRequest ) intrinsic/resources/proto/resource_registry.proto
| Field | Type | Description | |
|---|---|---|---|
| 1 | capability_names |
repeated
string
|
The resource instance must contain all of these capabilities. |
| 2 | resource_family_id |
string
|
If set, the resource instance must share this family id. |