← Back to packages

Package intrinsic_proto.frontend.v1

Service ClusterDiscoveryService

Service SolutionDiscoveryService

Message ClusterDescription

Message GetSolutionDescriptionRequest

Message GetSolutionDescriptionResponse

Message ListClusterDescriptionsRequest

Message ListClusterDescriptionsResponse

Message ListSolutionDescriptionsRequest

Message ListSolutionDescriptionsResponse

Message SolutionDescription

Enum SolutionState

Services

service ClusterDiscoveryService intrinsic/frontend/cloud/api/v1/clusterdiscovery_api.proto

Provides information about the available clusters in a project.

rpc ListClusterDescriptions
Request: intrinsic_proto.frontend.v1.ListClusterDescriptionsRequest
Response: intrinsic_proto.frontend.v1.ListClusterDescriptionsResponse

Returns a list of clusters registered to the org which is provided via the gRPC context (as the value of an HTTP cookie with name "org-id").

service SolutionDiscoveryService intrinsic/frontend/cloud/api/v1/solutiondiscovery_api.proto

Provides information about a user's solutions in a project.

rpc ListSolutionDescriptions
Request: intrinsic_proto.frontend.v1.ListSolutionDescriptionsRequest
Response: intrinsic_proto.frontend.v1.ListSolutionDescriptionsResponse

Returns a list of the user's solutions which satisfy the given filter criteria.

rpc GetSolutionDescription
Request: intrinsic_proto.frontend.v1.GetSolutionDescriptionRequest
Response: intrinsic_proto.frontend.v1.GetSolutionDescriptionResponse

Returns information about a specific solution.

Messages

message ClusterDescription intrinsic/frontend/cloud/api/v1/clusterdiscovery_api.proto

Details about a cluster.

Field Type Description
1 cluster_name string

The unique name/ID of the cluster within its project.
2 k8s_context string

K8s context of the cluster. Usually the same as 'cluster_name'.
3 region string

The region the cluster is located in. Can be used, e.g., for grouping clusters for display purposes.
4 can_do_sim bool

True if cluster is powerful enough to run a simulated workcell.
5 can_do_real bool

True if cluster can access real hardware.
6 has_gpu bool

True if cluster has a GPU.
7 solution_name string

Name/ID of the currently running solution. Empty if no solution is running.
8 solution_display_name string

Display name of the currently running solution. Empty if no solution is running.
9 solution_state intrinsic_proto.frontend.v1.SolutionState

State of the running solution. If a solution is currently running, equal to one of the running states (e.g., SOLUTION_STATE_RUNNING_IN_SIM). Equal to SOLUTION_STATE_UNSPECIFIED if no solution is running.
10 display_name string

The Display Name of the cluster used by the frontend.

message GetSolutionDescriptionRequest intrinsic/frontend/cloud/api/v1/solutiondiscovery_api.proto

Field Type Description
1 name string

The name/ID of the solution to return.

message GetSolutionDescriptionResponse intrinsic/frontend/cloud/api/v1/solutiondiscovery_api.proto

Field Type Description
1 solution intrinsic_proto.frontend.v1.SolutionDescription

Details about the solution matching the request.

message ListClusterDescriptionsRequest intrinsic/frontend/cloud/api/v1/clusterdiscovery_api.proto

Room for filtering options which are currently not provided.

Field Type Description

message ListClusterDescriptionsResponse intrinsic/frontend/cloud/api/v1/clusterdiscovery_api.proto

Field Type Description
1 clusters repeated intrinsic_proto.frontend.v1.ClusterDescription

Details about the clusters matching the filter criteria of the request, sorted lexicographically by cluster region and 'cluster_name'.

message ListSolutionDescriptionsRequest intrinsic/frontend/cloud/api/v1/solutiondiscovery_api.proto

Field Type Description
1 filters repeated intrinsic_proto.frontend.v1.SolutionState

Only return solutions which have any of the given states. If empty, return all solutions.
2 page_size int64

The maximum number of versioned solutions to return. The service may return fewer than this value. If unspecified, at most 20 versioned solutions will be returned. The maximum value is 200; values above 200 will be coerced to 200.
3 next_page_token string

A page token, received from a previous ListSolutionDescriptions call. Provide this to retrieve the subsequent page.

message ListSolutionDescriptionsResponse intrinsic/frontend/cloud/api/v1/solutiondiscovery_api.proto

Field Type Description
1 solutions repeated intrinsic_proto.frontend.v1.SolutionDescription

Details about the solutions matching the filter criteria of the request, sorted by 'update_time' in descending order.
2 next_page_token string

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

message SolutionDescription intrinsic/frontend/cloud/api/v1/solutiondiscovery_api.proto

Details about a solution.

Field Type Description
1 name string

The unique name/ID of the solution. For a human readable name, see 'display_name'.
2 display_name string

The name of the solution under which it should be displayed.
3 state intrinsic_proto.frontend.v1.SolutionState

The current state of the solution.
4 cluster_name string

Name of the cluster this solution is deployed to. Only filled if solution is running (see 'state').

Enums

enum SolutionState intrinsic/frontend/cloud/api/v1/clusterdiscovery_api.proto

State of a solution.

Name Number Description
SOLUTION_STATE_UNSPECIFIED 0
SOLUTION_STATE_NOT_RUNNING 1
SOLUTION_STATE_RUNNING_ON_HW 2
SOLUTION_STATE_RUNNING_IN_SIM 3