v1

package
v0.1.146 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 6, 2023 License: Apache-2.0 Imports: 18 Imported by: 3

Documentation

Overview

Package v1 is a reverse proxy.

It translates gRPC into RESTful JSON APIs.

Index

Constants

This section is empty.

Variables

View Source
var CloudSLAMService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "viam.app.cloudslam.v1.CloudSLAMService",
	HandlerType: (*CloudSLAMServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "StartMappingSession",
			Handler:    _CloudSLAMService_StartMappingSession_Handler,
		},
		{
			MethodName: "GetActiveMappingSessionsForRobot",
			Handler:    _CloudSLAMService_GetActiveMappingSessionsForRobot_Handler,
		},
		{
			MethodName: "GetMappingSessionPointCloud",
			Handler:    _CloudSLAMService_GetMappingSessionPointCloud_Handler,
		},
		{
			MethodName: "ListMappingSessions",
			Handler:    _CloudSLAMService_ListMappingSessions_Handler,
		},
		{
			MethodName: "StopMappingSession",
			Handler:    _CloudSLAMService_StopMappingSession_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "app/cloudslam/v1/cloud_slam.proto",
}

CloudSLAMService_ServiceDesc is the grpc.ServiceDesc for CloudSLAMService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

View Source
var File_app_cloudslam_v1_cloud_slam_proto protoreflect.FileDescriptor

Functions

func RegisterCloudSLAMServiceHandler

func RegisterCloudSLAMServiceHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error

RegisterCloudSLAMServiceHandler registers the http handlers for service CloudSLAMService to "mux". The handlers forward requests to the grpc endpoint over "conn".

func RegisterCloudSLAMServiceHandlerClient

func RegisterCloudSLAMServiceHandlerClient(ctx context.Context, mux *runtime.ServeMux, client CloudSLAMServiceClient) error

RegisterCloudSLAMServiceHandlerClient registers the http handlers for service CloudSLAMService to "mux". The handlers forward requests to the grpc endpoint over the given implementation of "CloudSLAMServiceClient". Note: the gRPC framework executes interceptors within the gRPC handler. If the passed in "CloudSLAMServiceClient" doesn't go through the normal gRPC flow (creating a gRPC client etc.) then it will be up to the passed in "CloudSLAMServiceClient" to call the correct interceptors.

func RegisterCloudSLAMServiceHandlerFromEndpoint

func RegisterCloudSLAMServiceHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, opts []grpc.DialOption) (err error)

RegisterCloudSLAMServiceHandlerFromEndpoint is same as RegisterCloudSLAMServiceHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.

func RegisterCloudSLAMServiceHandlerServer

func RegisterCloudSLAMServiceHandlerServer(ctx context.Context, mux *runtime.ServeMux, server CloudSLAMServiceServer) error

RegisterCloudSLAMServiceHandlerServer registers the http handlers for service CloudSLAMService to "mux". UnaryRPC :call CloudSLAMServiceServer directly. StreamingRPC :currently unsupported pending https://github.com/grpc/grpc-go/issues/906. Note that using this registration option will cause many gRPC library features to stop working. Consider using RegisterCloudSLAMServiceHandlerFromEndpoint instead.

func RegisterCloudSLAMServiceServer

func RegisterCloudSLAMServiceServer(s grpc.ServiceRegistrar, srv CloudSLAMServiceServer)

Types

type CloudSLAMServiceClient

CloudSLAMServiceClient is the client API for CloudSLAMService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

type CloudSLAMServiceServer

CloudSLAMServiceServer is the server API for CloudSLAMService service. All implementations must embed UnimplementedCloudSLAMServiceServer for forward compatibility

type GetActiveMappingSessionsForRobotRequest

type GetActiveMappingSessionsForRobotRequest struct {

	// assumes only one active mapping session on a robot
	RobotId string `protobuf:"bytes,1,opt,name=robot_id,json=robotId,proto3" json:"robot_id,omitempty"`
	// contains filtered or unexported fields
}

func (*GetActiveMappingSessionsForRobotRequest) Descriptor deprecated

func (*GetActiveMappingSessionsForRobotRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetActiveMappingSessionsForRobotRequest.ProtoReflect.Descriptor instead.

func (*GetActiveMappingSessionsForRobotRequest) GetRobotId

func (*GetActiveMappingSessionsForRobotRequest) ProtoMessage

func (*GetActiveMappingSessionsForRobotRequest) ProtoReflect

func (*GetActiveMappingSessionsForRobotRequest) Reset

func (*GetActiveMappingSessionsForRobotRequest) String

type GetActiveMappingSessionsForRobotResponse

type GetActiveMappingSessionsForRobotResponse struct {
	SessionId string `protobuf:"bytes,1,opt,name=session_id,json=sessionId,proto3" json:"session_id,omitempty"`
	// contains filtered or unexported fields
}

func (*GetActiveMappingSessionsForRobotResponse) Descriptor deprecated

func (*GetActiveMappingSessionsForRobotResponse) Descriptor() ([]byte, []int)

Deprecated: Use GetActiveMappingSessionsForRobotResponse.ProtoReflect.Descriptor instead.

func (*GetActiveMappingSessionsForRobotResponse) GetSessionId

func (*GetActiveMappingSessionsForRobotResponse) ProtoMessage

func (*GetActiveMappingSessionsForRobotResponse) ProtoReflect

func (*GetActiveMappingSessionsForRobotResponse) Reset

func (*GetActiveMappingSessionsForRobotResponse) String

type GetMappingSessionPointCloudRequest

type GetMappingSessionPointCloudRequest struct {
	SessionId string `protobuf:"bytes,1,opt,name=session_id,json=sessionId,proto3" json:"session_id,omitempty"`
	// contains filtered or unexported fields
}

func (*GetMappingSessionPointCloudRequest) Descriptor deprecated

func (*GetMappingSessionPointCloudRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetMappingSessionPointCloudRequest.ProtoReflect.Descriptor instead.

func (*GetMappingSessionPointCloudRequest) GetSessionId

func (x *GetMappingSessionPointCloudRequest) GetSessionId() string

func (*GetMappingSessionPointCloudRequest) ProtoMessage

func (*GetMappingSessionPointCloudRequest) ProtoMessage()

func (*GetMappingSessionPointCloudRequest) ProtoReflect

func (*GetMappingSessionPointCloudRequest) Reset

func (*GetMappingSessionPointCloudRequest) String

type GetMappingSessionPointCloudResponse

type GetMappingSessionPointCloudResponse struct {

	// url to the pointcloud map
	MapUrl string `protobuf:"bytes,1,opt,name=map_url,json=mapUrl,proto3" json:"map_url,omitempty"`
	// Current position within the SLAM Map
	Pose *v1.Pose `protobuf:"bytes,2,opt,name=pose,proto3" json:"pose,omitempty"`
	// contains filtered or unexported fields
}

func (*GetMappingSessionPointCloudResponse) Descriptor deprecated

func (*GetMappingSessionPointCloudResponse) Descriptor() ([]byte, []int)

Deprecated: Use GetMappingSessionPointCloudResponse.ProtoReflect.Descriptor instead.

func (*GetMappingSessionPointCloudResponse) GetMapUrl

func (*GetMappingSessionPointCloudResponse) GetPose

func (*GetMappingSessionPointCloudResponse) ProtoMessage

func (*GetMappingSessionPointCloudResponse) ProtoMessage()

func (*GetMappingSessionPointCloudResponse) ProtoReflect

func (*GetMappingSessionPointCloudResponse) Reset

func (*GetMappingSessionPointCloudResponse) String

type ListMappingSessionsRequest

type ListMappingSessionsRequest struct {
	OrgId      string `protobuf:"bytes,1,opt,name=org_id,json=orgId,proto3" json:"org_id,omitempty"`
	LocationId string `protobuf:"bytes,2,opt,name=location_id,json=locationId,proto3" json:"location_id,omitempty"`
	// contains filtered or unexported fields
}

func (*ListMappingSessionsRequest) Descriptor deprecated

func (*ListMappingSessionsRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListMappingSessionsRequest.ProtoReflect.Descriptor instead.

func (*ListMappingSessionsRequest) GetLocationId

func (x *ListMappingSessionsRequest) GetLocationId() string

func (*ListMappingSessionsRequest) GetOrgId

func (x *ListMappingSessionsRequest) GetOrgId() string

func (*ListMappingSessionsRequest) ProtoMessage

func (*ListMappingSessionsRequest) ProtoMessage()

func (*ListMappingSessionsRequest) ProtoReflect

func (*ListMappingSessionsRequest) Reset

func (x *ListMappingSessionsRequest) Reset()

func (*ListMappingSessionsRequest) String

func (x *ListMappingSessionsRequest) String() string

type ListMappingSessionsResponse

type ListMappingSessionsResponse struct {
	Session []*MappingMetadata `protobuf:"bytes,1,rep,name=session,proto3" json:"session,omitempty"`
	// contains filtered or unexported fields
}

func (*ListMappingSessionsResponse) Descriptor deprecated

func (*ListMappingSessionsResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListMappingSessionsResponse.ProtoReflect.Descriptor instead.

func (*ListMappingSessionsResponse) GetSession

func (x *ListMappingSessionsResponse) GetSession() []*MappingMetadata

func (*ListMappingSessionsResponse) ProtoMessage

func (*ListMappingSessionsResponse) ProtoMessage()

func (*ListMappingSessionsResponse) ProtoReflect

func (*ListMappingSessionsResponse) Reset

func (x *ListMappingSessionsResponse) Reset()

func (*ListMappingSessionsResponse) String

func (x *ListMappingSessionsResponse) String() string

type MappingMetadata

type MappingMetadata struct {
	OrgId                  string                 `protobuf:"bytes,1,opt,name=org_id,json=orgId,proto3" json:"org_id,omitempty"`                                          // org associated with the slam session
	LocationId             string                 `protobuf:"bytes,2,opt,name=location_id,json=locationId,proto3" json:"location_id,omitempty"`                           // location associated with the slam session
	RobotId                string                 `protobuf:"bytes,3,opt,name=robot_id,json=robotId,proto3" json:"robot_id,omitempty"`                                    // robot associated with slam session
	TimeStartSubmitted     *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=time_start_submitted,json=timeStartSubmitted,proto3" json:"time_start_submitted,omitempty"` // time this document was created
	TimeCloudRunJobStarted *timestamppb.Timestamp ``                                                                                                                      // time the cloud run job started
	/* 133-byte string literal not displayed */
	TimeEndSubmitted     *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=time_end_submitted,json=timeEndSubmitted,proto3" json:"time_end_submitted,omitempty"` // time StopSlamSession was called
	TimeCloudRunJobEnded *timestamppb.Timestamp ``                                                                                                                // time the cloud run job ended
	/* 127-byte string literal not displayed */
	EndStatus         string `protobuf:"bytes,8,opt,name=end_status,json=endStatus,proto3" json:"end_status,omitempty"`                            // “success”, “failed to start”, etc
	CloudRunJobId     string `protobuf:"bytes,9,opt,name=cloud_run_job_id,json=cloudRunJobId,proto3" json:"cloud_run_job_id,omitempty"`            // initially unset
	ViamServerVersion string `protobuf:"bytes,10,opt,name=viam_server_version,json=viamServerVersion,proto3" json:"viam_server_version,omitempty"` // version tag from request, defaults to stable
	MapName           string `protobuf:"bytes,11,opt,name=map_name,json=mapName,proto3" json:"map_name,omitempty"`                                 // name of the map package
	SlamVersion       string `protobuf:"bytes,12,opt,name=slam_version,json=slamVersion,proto3" json:"slam_version,omitempty"`                     // version tag from request, defaults to stable
	Config            string `protobuf:"bytes,13,opt,name=config,proto3" json:"config,omitempty"`                                                  // a robot config for a slam session
	// contains filtered or unexported fields
}

func (*MappingMetadata) Descriptor deprecated

func (*MappingMetadata) Descriptor() ([]byte, []int)

Deprecated: Use MappingMetadata.ProtoReflect.Descriptor instead.

func (*MappingMetadata) GetCloudRunJobId

func (x *MappingMetadata) GetCloudRunJobId() string

func (*MappingMetadata) GetConfig

func (x *MappingMetadata) GetConfig() string

func (*MappingMetadata) GetEndStatus

func (x *MappingMetadata) GetEndStatus() string

func (*MappingMetadata) GetLocationId

func (x *MappingMetadata) GetLocationId() string

func (*MappingMetadata) GetMapName

func (x *MappingMetadata) GetMapName() string

func (*MappingMetadata) GetOrgId

func (x *MappingMetadata) GetOrgId() string

func (*MappingMetadata) GetRobotId

func (x *MappingMetadata) GetRobotId() string

func (*MappingMetadata) GetSlamVersion

func (x *MappingMetadata) GetSlamVersion() string

func (*MappingMetadata) GetTimeCloudRunJobEnded

func (x *MappingMetadata) GetTimeCloudRunJobEnded() *timestamppb.Timestamp

func (*MappingMetadata) GetTimeCloudRunJobStarted

func (x *MappingMetadata) GetTimeCloudRunJobStarted() *timestamppb.Timestamp

func (*MappingMetadata) GetTimeEndSubmitted

func (x *MappingMetadata) GetTimeEndSubmitted() *timestamppb.Timestamp

func (*MappingMetadata) GetTimeStartSubmitted

func (x *MappingMetadata) GetTimeStartSubmitted() *timestamppb.Timestamp

func (*MappingMetadata) GetViamServerVersion

func (x *MappingMetadata) GetViamServerVersion() string

func (*MappingMetadata) ProtoMessage

func (*MappingMetadata) ProtoMessage()

func (*MappingMetadata) ProtoReflect

func (x *MappingMetadata) ProtoReflect() protoreflect.Message

func (*MappingMetadata) Reset

func (x *MappingMetadata) Reset()

func (*MappingMetadata) String

func (x *MappingMetadata) String() string

type StartMappingSessionRequest

type StartMappingSessionRequest struct {

	// The given config contains details such as sensor, map package and algorithm-specific fields required to run slam.
	SlamConfig *structpb.Struct `protobuf:"bytes,1,opt,name=slam_config,json=slamConfig,proto3" json:"slam_config,omitempty"`
	// Version to use for slam, defaults stable
	SlamVersion string `protobuf:"bytes,2,opt,name=slam_version,json=slamVersion,proto3" json:"slam_version,omitempty"`
	MapName     string `protobuf:"bytes,3,opt,name=map_name,json=mapName,proto3" json:"map_name,omitempty"`
	OrgId       string `protobuf:"bytes,4,opt,name=org_id,json=orgId,proto3" json:"org_id,omitempty"`
	LocationId  string `protobuf:"bytes,5,opt,name=location_id,json=locationId,proto3" json:"location_id,omitempty"`
	RobotId     string `protobuf:"bytes,6,opt,name=robot_id,json=robotId,proto3" json:"robot_id,omitempty"`
	// contains filtered or unexported fields
}

func (*StartMappingSessionRequest) Descriptor deprecated

func (*StartMappingSessionRequest) Descriptor() ([]byte, []int)

Deprecated: Use StartMappingSessionRequest.ProtoReflect.Descriptor instead.

func (*StartMappingSessionRequest) GetLocationId added in v0.1.144

func (x *StartMappingSessionRequest) GetLocationId() string

func (*StartMappingSessionRequest) GetMapName

func (x *StartMappingSessionRequest) GetMapName() string

func (*StartMappingSessionRequest) GetOrgId added in v0.1.144

func (x *StartMappingSessionRequest) GetOrgId() string

func (*StartMappingSessionRequest) GetRobotId added in v0.1.144

func (x *StartMappingSessionRequest) GetRobotId() string

func (*StartMappingSessionRequest) GetSlamConfig

func (x *StartMappingSessionRequest) GetSlamConfig() *structpb.Struct

func (*StartMappingSessionRequest) GetSlamVersion

func (x *StartMappingSessionRequest) GetSlamVersion() string

func (*StartMappingSessionRequest) ProtoMessage

func (*StartMappingSessionRequest) ProtoMessage()

func (*StartMappingSessionRequest) ProtoReflect

func (*StartMappingSessionRequest) Reset

func (x *StartMappingSessionRequest) Reset()

func (*StartMappingSessionRequest) String

func (x *StartMappingSessionRequest) String() string

type StartMappingSessionResponse

type StartMappingSessionResponse struct {
	SessionId string `protobuf:"bytes,1,opt,name=session_id,json=sessionId,proto3" json:"session_id,omitempty"`
	// contains filtered or unexported fields
}

func (*StartMappingSessionResponse) Descriptor deprecated

func (*StartMappingSessionResponse) Descriptor() ([]byte, []int)

Deprecated: Use StartMappingSessionResponse.ProtoReflect.Descriptor instead.

func (*StartMappingSessionResponse) GetSessionId

func (x *StartMappingSessionResponse) GetSessionId() string

func (*StartMappingSessionResponse) ProtoMessage

func (*StartMappingSessionResponse) ProtoMessage()

func (*StartMappingSessionResponse) ProtoReflect

func (*StartMappingSessionResponse) Reset

func (x *StartMappingSessionResponse) Reset()

func (*StartMappingSessionResponse) String

func (x *StartMappingSessionResponse) String() string

type StopMappingSessionRequest

type StopMappingSessionRequest struct {
	SessionId string `protobuf:"bytes,1,opt,name=session_id,json=sessionId,proto3" json:"session_id,omitempty"`
	SaveMap   bool   `protobuf:"varint,2,opt,name=save_map,json=saveMap,proto3" json:"save_map,omitempty"`
	// contains filtered or unexported fields
}

func (*StopMappingSessionRequest) Descriptor deprecated

func (*StopMappingSessionRequest) Descriptor() ([]byte, []int)

Deprecated: Use StopMappingSessionRequest.ProtoReflect.Descriptor instead.

func (*StopMappingSessionRequest) GetSaveMap

func (x *StopMappingSessionRequest) GetSaveMap() bool

func (*StopMappingSessionRequest) GetSessionId

func (x *StopMappingSessionRequest) GetSessionId() string

func (*StopMappingSessionRequest) ProtoMessage

func (*StopMappingSessionRequest) ProtoMessage()

func (*StopMappingSessionRequest) ProtoReflect

func (*StopMappingSessionRequest) Reset

func (x *StopMappingSessionRequest) Reset()

func (*StopMappingSessionRequest) String

func (x *StopMappingSessionRequest) String() string

type StopMappingSessionResponse

type StopMappingSessionResponse struct {
	PackageId string `protobuf:"bytes,1,opt,name=package_id,json=packageId,proto3" json:"package_id,omitempty"`
	Version   string `protobuf:"bytes,2,opt,name=version,proto3" json:"version,omitempty"`
	// contains filtered or unexported fields
}

func (*StopMappingSessionResponse) Descriptor deprecated

func (*StopMappingSessionResponse) Descriptor() ([]byte, []int)

Deprecated: Use StopMappingSessionResponse.ProtoReflect.Descriptor instead.

func (*StopMappingSessionResponse) GetPackageId

func (x *StopMappingSessionResponse) GetPackageId() string

func (*StopMappingSessionResponse) GetVersion

func (x *StopMappingSessionResponse) GetVersion() string

func (*StopMappingSessionResponse) ProtoMessage

func (*StopMappingSessionResponse) ProtoMessage()

func (*StopMappingSessionResponse) ProtoReflect

func (*StopMappingSessionResponse) Reset

func (x *StopMappingSessionResponse) Reset()

func (*StopMappingSessionResponse) String

func (x *StopMappingSessionResponse) String() string

type UnimplementedCloudSLAMServiceServer

type UnimplementedCloudSLAMServiceServer struct {
}

UnimplementedCloudSLAMServiceServer must be embedded to have forward compatible implementations.

func (UnimplementedCloudSLAMServiceServer) ListMappingSessions

func (UnimplementedCloudSLAMServiceServer) StartMappingSession

func (UnimplementedCloudSLAMServiceServer) StopMappingSession

type UnsafeCloudSLAMServiceServer

type UnsafeCloudSLAMServiceServer interface {
	// contains filtered or unexported methods
}

UnsafeCloudSLAMServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to CloudSLAMServiceServer will result in compilation errors.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL