← Back to packages

Package intrinsic_proto.solution.v1

Service SolutionService

Message CreateBehaviorTreeRequest

Message DeleteBehaviorTreeRequest

Message GetBehaviorTreeRequest

Message GetStatusRequest

Message ListBehaviorTreesRequest

Message ListBehaviorTreesResponse

Message Status

Message UpdateBehaviorTreeRequest

Enum BehaviorTreeView

Enum State

Services

service SolutionService intrinsic/frontend/solution_service/proto/solution_service.proto

Manages the running solution.

Gets a single behavior tree from the running solution.

Updates an existing behavior tree in the running solution.

Deletes a behavior tree in the running solution.

Messages

message CreateBehaviorTreeRequest intrinsic/frontend/solution_service/proto/solution_service.proto

Field Type Description
1 behavior_tree_id string

The ID (name) to use for the behavior tree. Must always be specified. This is also sometimes called the "process name". The name must be unique within the running solution and should ideally be meaningful to the user.

2 behavior_tree intrinsic_proto.executive.BehaviorTree

The behavior tree to create. The name field will be ignored.

message DeleteBehaviorTreeRequest intrinsic/frontend/solution_service/proto/solution_service.proto

Field Type Description
1 name string

The name of the behavior tree to delete.

message GetBehaviorTreeRequest intrinsic/frontend/solution_service/proto/solution_service.proto

Field Type Description
1 name string

The name of the behavior tree to retrieve.

2 view intrinsic_proto.solution.v1.BehaviorTreeView

The view of the behavior tree to return. Defaults to the FULL view.

message GetStatusRequest intrinsic/frontend/solution_service/proto/solution_service.proto

For future extensions.

Field Type Description

message ListBehaviorTreesRequest intrinsic/frontend/solution_service/proto/solution_service.proto

Field Type Description
1 page_size int32

The maximum number of behavior trees to return. The service may return fewer than this value. If unspecified, at most 20 behavior trees will be returned. The maximum value is 50; values above 50 will be coerced to 50.

2 page_token string

Page token received from a previous call. Provide this to retrieve the subsequent page.

3 view intrinsic_proto.solution.v1.BehaviorTreeView

The view of the behavior tree to return. Defaults to the BASIC view.

message ListBehaviorTreesResponse intrinsic/frontend/solution_service/proto/solution_service.proto

Field Type Description
1 behavior_trees repeated intrinsic_proto.executive.BehaviorTree

The behavior trees from the running solution. Behavior trees are returned in alphabetical order (a-z) by name.

2 next_page_token string

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

message Status intrinsic/frontend/solution_service/proto/status.proto

Field Type Description
1 state intrinsic_proto.solution.v1.Status.State

Current state of the solution as a single value. It is recommended not to make assumptions about the sequence of states the solution will transition through as individual states may be skipped. - Starting a solution is safe when state is PLATFORM_READY - Editing the solution is safe when the state is DEPLOYING or READY - Executing processes is only safe when the state is READY

2 state_reason string

Human-readable reason for the solution being in the current state. Never populated when the state is PLATFORM_READY or READY.

3 name string

Unique ID of the running solution. Empty if no solution is running or the solution is not deployed from the catalog.

4 display_name string

Human readable name of the running solution. Empty if no solution is running.

5 simulated bool

Whether the solution is running in simulation. The solution is running on real hardware or there is no solution running if this is false.

6 cluster_name string

Name of the cluster.

7 platform_version string

Version of the platform.

message UpdateBehaviorTreeRequest intrinsic/frontend/solution_service/proto/solution_service.proto

Field Type Description
1 behavior_tree intrinsic_proto.executive.BehaviorTree

The updated behavior tree. The name field is used to identify the behavior tree to update.

2 allow_missing bool

If set to true, a new behavior tree will be created if it does not exist.

Enums

enum BehaviorTreeView intrinsic/frontend/solution_service/proto/solution_service.proto

Name Number Description
BEHAVIOR_TREE_VIEW_UNSPECIFIED 0

The default/unset value. The default depends on the RPC and is documented individually where relevant.

BEHAVIOR_TREE_VIEW_BASIC 1

Include basic metadata about the behavior tree (name and tree_id). This is the default view for ListBehaviorTrees.

BEHAVIOR_TREE_VIEW_FULL 2

Include the full contents of the behavior tree.

enum State intrinsic/frontend/solution_service/proto/status.proto

Name Number Description
STATE_UNSPECIFIED 0

The state of the solution is not specified. The solution should not be interacted with in this state.

PLATFORM_DEPLOYING 1

Core platform services are being deployed and are not available yet. It is strongly recommended to wait for the state to transition to either PLATFORM_READY, DEPLOYING or READY before any further action.

PLATFORM_READY 2

All core platform services are ready and no solution is running. It is safe to start a solution in this state.

DEPLOYING 3

Solution specific services or assets (e.g. skills, services) are being deployed. The solution can be safely edited while in this state. Executing processes is not recommended until the solution transitions to the READY state.

READY 4

The solution and all of its services and assets are ready. All functionality, including process execution, is available.

STOPPING 5

Solution specific services or assets (e.g. skills, services) are being stopped. The solution should not be edited when in this state.

ERROR 6

Something went wrong during deployment of the platform or solution. The state_reason field may contain more detailed information.