Documentation ¶
Overview ¶
Package v1 is a reverse proxy.
It translates gRPC into RESTful JSON APIs.
Index ¶
- Variables
- func RegisterDataSyncServiceHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error
- func RegisterDataSyncServiceHandlerClient(ctx context.Context, mux *runtime.ServeMux, client DataSyncServiceClient) error
- func RegisterDataSyncServiceHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, ...) (err error)
- func RegisterDataSyncServiceHandlerServer(ctx context.Context, mux *runtime.ServeMux, server DataSyncServiceServer) error
- func RegisterDataSyncServiceServer(s grpc.ServiceRegistrar, srv DataSyncServiceServer)
- type CaptureInterval
- func (*CaptureInterval) Descriptor() ([]byte, []int)deprecated
- func (x *CaptureInterval) GetEnd() *timestamppb.Timestamp
- func (x *CaptureInterval) GetStart() *timestamppb.Timestamp
- func (*CaptureInterval) ProtoMessage()
- func (x *CaptureInterval) ProtoReflect() protoreflect.Message
- func (x *CaptureInterval) Reset()
- func (x *CaptureInterval) String() string
- type DataCaptureMetadata
- func (*DataCaptureMetadata) Descriptor() ([]byte, []int)deprecated
- func (x *DataCaptureMetadata) GetComponentName() string
- func (x *DataCaptureMetadata) GetComponentType() string
- func (x *DataCaptureMetadata) GetFileExtension() string
- func (x *DataCaptureMetadata) GetMethodName() string
- func (x *DataCaptureMetadata) GetMethodParameters() map[string]*anypb.Any
- func (x *DataCaptureMetadata) GetTags() []string
- func (x *DataCaptureMetadata) GetType() DataType
- func (*DataCaptureMetadata) ProtoMessage()
- func (x *DataCaptureMetadata) ProtoReflect() protoreflect.Message
- func (x *DataCaptureMetadata) Reset()
- func (x *DataCaptureMetadata) String() string
- type DataCaptureUploadMetadata
- func (*DataCaptureUploadMetadata) Descriptor() ([]byte, []int)deprecated
- func (x *DataCaptureUploadMetadata) GetSensorMetadata() *SensorMetadata
- func (x *DataCaptureUploadMetadata) GetUploadMetadata() *UploadMetadata
- func (*DataCaptureUploadMetadata) ProtoMessage()
- func (x *DataCaptureUploadMetadata) ProtoReflect() protoreflect.Message
- func (x *DataCaptureUploadMetadata) Reset()
- func (x *DataCaptureUploadMetadata) String() string
- type DataCaptureUploadRequest
- func (*DataCaptureUploadRequest) Descriptor() ([]byte, []int)deprecated
- func (x *DataCaptureUploadRequest) GetMetadata() *UploadMetadata
- func (x *DataCaptureUploadRequest) GetSensorContents() []*SensorData
- func (*DataCaptureUploadRequest) ProtoMessage()
- func (x *DataCaptureUploadRequest) ProtoReflect() protoreflect.Message
- func (x *DataCaptureUploadRequest) Reset()
- func (x *DataCaptureUploadRequest) String() string
- type DataCaptureUploadResponse
- func (*DataCaptureUploadResponse) Descriptor() ([]byte, []int)deprecated
- func (x *DataCaptureUploadResponse) GetFileId() string
- func (*DataCaptureUploadResponse) ProtoMessage()
- func (x *DataCaptureUploadResponse) ProtoReflect() protoreflect.Message
- func (x *DataCaptureUploadResponse) Reset()
- func (x *DataCaptureUploadResponse) String() string
- type DataSyncServiceClient
- type DataSyncServiceServer
- type DataSyncService_FileUploadClient
- type DataSyncService_FileUploadServer
- type DataSyncService_StreamingDataCaptureUploadClient
- type DataSyncService_StreamingDataCaptureUploadServer
- type DataType
- type FileData
- type FileUploadRequest
- func (*FileUploadRequest) Descriptor() ([]byte, []int)deprecated
- func (x *FileUploadRequest) GetFileContents() *FileData
- func (x *FileUploadRequest) GetMetadata() *UploadMetadata
- func (m *FileUploadRequest) GetUploadPacket() isFileUploadRequest_UploadPacket
- func (*FileUploadRequest) ProtoMessage()
- func (x *FileUploadRequest) ProtoReflect() protoreflect.Message
- func (x *FileUploadRequest) Reset()
- func (x *FileUploadRequest) String() string
- type FileUploadRequest_FileContents
- type FileUploadRequest_Metadata
- type FileUploadResponse
- func (*FileUploadResponse) Descriptor() ([]byte, []int)deprecated
- func (x *FileUploadResponse) GetFileId() string
- func (*FileUploadResponse) ProtoMessage()
- func (x *FileUploadResponse) ProtoReflect() protoreflect.Message
- func (x *FileUploadResponse) Reset()
- func (x *FileUploadResponse) String() string
- type SensorData
- func (*SensorData) Descriptor() ([]byte, []int)deprecated
- func (x *SensorData) GetBinary() []byte
- func (m *SensorData) GetData() isSensorData_Data
- func (x *SensorData) GetMetadata() *SensorMetadata
- func (x *SensorData) GetStruct() *structpb.Struct
- func (*SensorData) ProtoMessage()
- func (x *SensorData) ProtoReflect() protoreflect.Message
- func (x *SensorData) Reset()
- func (x *SensorData) String() string
- type SensorData_Binary
- type SensorData_Struct
- type SensorMetadata
- func (*SensorMetadata) Descriptor() ([]byte, []int)deprecated
- func (x *SensorMetadata) GetTimeReceived() *timestamppb.Timestamp
- func (x *SensorMetadata) GetTimeRequested() *timestamppb.Timestamp
- func (*SensorMetadata) ProtoMessage()
- func (x *SensorMetadata) ProtoReflect() protoreflect.Message
- func (x *SensorMetadata) Reset()
- func (x *SensorMetadata) String() string
- type StreamingDataCaptureUploadRequest
- func (*StreamingDataCaptureUploadRequest) Descriptor() ([]byte, []int)deprecated
- func (x *StreamingDataCaptureUploadRequest) GetData() []byte
- func (x *StreamingDataCaptureUploadRequest) GetMetadata() *DataCaptureUploadMetadata
- func (m *StreamingDataCaptureUploadRequest) GetUploadPacket() isStreamingDataCaptureUploadRequest_UploadPacket
- func (*StreamingDataCaptureUploadRequest) ProtoMessage()
- func (x *StreamingDataCaptureUploadRequest) ProtoReflect() protoreflect.Message
- func (x *StreamingDataCaptureUploadRequest) Reset()
- func (x *StreamingDataCaptureUploadRequest) String() string
- type StreamingDataCaptureUploadRequest_Data
- type StreamingDataCaptureUploadRequest_Metadata
- type StreamingDataCaptureUploadResponse
- func (*StreamingDataCaptureUploadResponse) Descriptor() ([]byte, []int)deprecated
- func (x *StreamingDataCaptureUploadResponse) GetFileId() string
- func (*StreamingDataCaptureUploadResponse) ProtoMessage()
- func (x *StreamingDataCaptureUploadResponse) ProtoReflect() protoreflect.Message
- func (x *StreamingDataCaptureUploadResponse) Reset()
- func (x *StreamingDataCaptureUploadResponse) String() string
- type UnimplementedDataSyncServiceServer
- func (UnimplementedDataSyncServiceServer) DataCaptureUpload(context.Context, *DataCaptureUploadRequest) (*DataCaptureUploadResponse, error)
- func (UnimplementedDataSyncServiceServer) FileUpload(DataSyncService_FileUploadServer) error
- func (UnimplementedDataSyncServiceServer) StreamingDataCaptureUpload(DataSyncService_StreamingDataCaptureUploadServer) error
- type UnsafeDataSyncServiceServer
- type UploadMetadata
- func (*UploadMetadata) Descriptor() ([]byte, []int)deprecated
- func (x *UploadMetadata) GetComponentName() string
- func (x *UploadMetadata) GetComponentType() string
- func (x *UploadMetadata) GetFileExtension() string
- func (x *UploadMetadata) GetFileName() string
- func (x *UploadMetadata) GetMethodName() string
- func (x *UploadMetadata) GetMethodParameters() map[string]*anypb.Any
- func (x *UploadMetadata) GetPartId() string
- func (x *UploadMetadata) GetTags() []string
- func (x *UploadMetadata) GetType() DataType
- func (*UploadMetadata) ProtoMessage()
- func (x *UploadMetadata) ProtoReflect() protoreflect.Message
- func (x *UploadMetadata) Reset()
- func (x *UploadMetadata) String() string
Constants ¶
This section is empty.
Variables ¶
var ( DataType_name = map[int32]string{ 0: "DATA_TYPE_UNSPECIFIED", 1: "DATA_TYPE_BINARY_SENSOR", 2: "DATA_TYPE_TABULAR_SENSOR", 3: "DATA_TYPE_FILE", } DataType_value = map[string]int32{ "DATA_TYPE_UNSPECIFIED": 0, "DATA_TYPE_BINARY_SENSOR": 1, "DATA_TYPE_TABULAR_SENSOR": 2, "DATA_TYPE_FILE": 3, } )
Enum value maps for DataType.
var DataSyncService_ServiceDesc = grpc.ServiceDesc{ ServiceName: "viam.app.datasync.v1.DataSyncService", HandlerType: (*DataSyncServiceServer)(nil), Methods: []grpc.MethodDesc{ { MethodName: "DataCaptureUpload", Handler: _DataSyncService_DataCaptureUpload_Handler, }, }, Streams: []grpc.StreamDesc{ { StreamName: "FileUpload", Handler: _DataSyncService_FileUpload_Handler, ClientStreams: true, }, { StreamName: "StreamingDataCaptureUpload", Handler: _DataSyncService_StreamingDataCaptureUpload_Handler, ClientStreams: true, }, }, Metadata: "app/datasync/v1/data_sync.proto", }
DataSyncService_ServiceDesc is the grpc.ServiceDesc for DataSyncService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
var File_app_datasync_v1_data_sync_proto protoreflect.FileDescriptor
Functions ¶
func RegisterDataSyncServiceHandler ¶
func RegisterDataSyncServiceHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error
RegisterDataSyncServiceHandler registers the http handlers for service DataSyncService to "mux". The handlers forward requests to the grpc endpoint over "conn".
func RegisterDataSyncServiceHandlerClient ¶
func RegisterDataSyncServiceHandlerClient(ctx context.Context, mux *runtime.ServeMux, client DataSyncServiceClient) error
RegisterDataSyncServiceHandlerClient registers the http handlers for service DataSyncService to "mux". The handlers forward requests to the grpc endpoint over the given implementation of "DataSyncServiceClient". Note: the gRPC framework executes interceptors within the gRPC handler. If the passed in "DataSyncServiceClient" doesn't go through the normal gRPC flow (creating a gRPC client etc.) then it will be up to the passed in "DataSyncServiceClient" to call the correct interceptors.
func RegisterDataSyncServiceHandlerFromEndpoint ¶
func RegisterDataSyncServiceHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, opts []grpc.DialOption) (err error)
RegisterDataSyncServiceHandlerFromEndpoint is same as RegisterDataSyncServiceHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.
func RegisterDataSyncServiceHandlerServer ¶
func RegisterDataSyncServiceHandlerServer(ctx context.Context, mux *runtime.ServeMux, server DataSyncServiceServer) error
RegisterDataSyncServiceHandlerServer registers the http handlers for service DataSyncService to "mux". UnaryRPC :call DataSyncServiceServer 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 RegisterDataSyncServiceHandlerFromEndpoint instead.
func RegisterDataSyncServiceServer ¶
func RegisterDataSyncServiceServer(s grpc.ServiceRegistrar, srv DataSyncServiceServer)
Types ¶
type CaptureInterval ¶
type CaptureInterval struct { Start *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=start,proto3" json:"start,omitempty"` End *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=end,proto3" json:"end,omitempty"` // contains filtered or unexported fields }
CaptureInterval specifies the start and end times of the data capture.
func (*CaptureInterval) Descriptor
deprecated
func (*CaptureInterval) Descriptor() ([]byte, []int)
Deprecated: Use CaptureInterval.ProtoReflect.Descriptor instead.
func (*CaptureInterval) GetEnd ¶
func (x *CaptureInterval) GetEnd() *timestamppb.Timestamp
func (*CaptureInterval) GetStart ¶
func (x *CaptureInterval) GetStart() *timestamppb.Timestamp
func (*CaptureInterval) ProtoMessage ¶
func (*CaptureInterval) ProtoMessage()
func (*CaptureInterval) ProtoReflect ¶
func (x *CaptureInterval) ProtoReflect() protoreflect.Message
func (*CaptureInterval) Reset ¶
func (x *CaptureInterval) Reset()
func (*CaptureInterval) String ¶
func (x *CaptureInterval) String() string
type DataCaptureMetadata ¶
type DataCaptureMetadata struct { ComponentType string `protobuf:"bytes,1,opt,name=component_type,json=componentType,proto3" json:"component_type,omitempty"` ComponentName string `protobuf:"bytes,2,opt,name=component_name,json=componentName,proto3" json:"component_name,omitempty"` MethodName string `protobuf:"bytes,4,opt,name=method_name,json=methodName,proto3" json:"method_name,omitempty"` Type DataType `protobuf:"varint,5,opt,name=type,proto3,enum=viam.app.datasync.v1.DataType" json:"type,omitempty"` MethodParameters map[string]*anypb.Any `` /* 197-byte string literal not displayed */ FileExtension string `protobuf:"bytes,7,opt,name=file_extension,json=fileExtension,proto3" json:"file_extension,omitempty"` Tags []string `protobuf:"bytes,8,rep,name=tags,proto3" json:"tags,omitempty"` // contains filtered or unexported fields }
DataCaptureMetadata contains the metadata for data captured by collectors.
func (*DataCaptureMetadata) Descriptor
deprecated
func (*DataCaptureMetadata) Descriptor() ([]byte, []int)
Deprecated: Use DataCaptureMetadata.ProtoReflect.Descriptor instead.
func (*DataCaptureMetadata) GetComponentName ¶
func (x *DataCaptureMetadata) GetComponentName() string
func (*DataCaptureMetadata) GetComponentType ¶
func (x *DataCaptureMetadata) GetComponentType() string
func (*DataCaptureMetadata) GetFileExtension ¶
func (x *DataCaptureMetadata) GetFileExtension() string
func (*DataCaptureMetadata) GetMethodName ¶
func (x *DataCaptureMetadata) GetMethodName() string
func (*DataCaptureMetadata) GetMethodParameters ¶
func (x *DataCaptureMetadata) GetMethodParameters() map[string]*anypb.Any
func (*DataCaptureMetadata) GetTags ¶
func (x *DataCaptureMetadata) GetTags() []string
func (*DataCaptureMetadata) GetType ¶
func (x *DataCaptureMetadata) GetType() DataType
func (*DataCaptureMetadata) ProtoMessage ¶
func (*DataCaptureMetadata) ProtoMessage()
func (*DataCaptureMetadata) ProtoReflect ¶
func (x *DataCaptureMetadata) ProtoReflect() protoreflect.Message
func (*DataCaptureMetadata) Reset ¶
func (x *DataCaptureMetadata) Reset()
func (*DataCaptureMetadata) String ¶
func (x *DataCaptureMetadata) String() string
type DataCaptureUploadMetadata ¶ added in v0.1.164
type DataCaptureUploadMetadata struct { UploadMetadata *UploadMetadata `protobuf:"bytes,1,opt,name=upload_metadata,json=uploadMetadata,proto3" json:"upload_metadata,omitempty"` SensorMetadata *SensorMetadata `protobuf:"bytes,2,opt,name=sensor_metadata,json=sensorMetadata,proto3" json:"sensor_metadata,omitempty"` // contains filtered or unexported fields }
DataCaptureUploadMetadata contains the metadata for streaming binary (image + file) data.
func (*DataCaptureUploadMetadata) Descriptor
deprecated
added in
v0.1.164
func (*DataCaptureUploadMetadata) Descriptor() ([]byte, []int)
Deprecated: Use DataCaptureUploadMetadata.ProtoReflect.Descriptor instead.
func (*DataCaptureUploadMetadata) GetSensorMetadata ¶ added in v0.1.164
func (x *DataCaptureUploadMetadata) GetSensorMetadata() *SensorMetadata
func (*DataCaptureUploadMetadata) GetUploadMetadata ¶ added in v0.1.164
func (x *DataCaptureUploadMetadata) GetUploadMetadata() *UploadMetadata
func (*DataCaptureUploadMetadata) ProtoMessage ¶ added in v0.1.164
func (*DataCaptureUploadMetadata) ProtoMessage()
func (*DataCaptureUploadMetadata) ProtoReflect ¶ added in v0.1.164
func (x *DataCaptureUploadMetadata) ProtoReflect() protoreflect.Message
func (*DataCaptureUploadMetadata) Reset ¶ added in v0.1.164
func (x *DataCaptureUploadMetadata) Reset()
func (*DataCaptureUploadMetadata) String ¶ added in v0.1.164
func (x *DataCaptureUploadMetadata) String() string
type DataCaptureUploadRequest ¶ added in v0.1.29
type DataCaptureUploadRequest struct { Metadata *UploadMetadata `protobuf:"bytes,1,opt,name=metadata,proto3" json:"metadata,omitempty"` SensorContents []*SensorData `protobuf:"bytes,2,rep,name=sensor_contents,json=sensorContents,proto3" json:"sensor_contents,omitempty"` // contains filtered or unexported fields }
DataCaptureUploadRequest requests to upload the contents and metadata for tabular data.
func (*DataCaptureUploadRequest) Descriptor
deprecated
added in
v0.1.29
func (*DataCaptureUploadRequest) Descriptor() ([]byte, []int)
Deprecated: Use DataCaptureUploadRequest.ProtoReflect.Descriptor instead.
func (*DataCaptureUploadRequest) GetMetadata ¶ added in v0.1.29
func (x *DataCaptureUploadRequest) GetMetadata() *UploadMetadata
func (*DataCaptureUploadRequest) GetSensorContents ¶ added in v0.1.29
func (x *DataCaptureUploadRequest) GetSensorContents() []*SensorData
func (*DataCaptureUploadRequest) ProtoMessage ¶ added in v0.1.29
func (*DataCaptureUploadRequest) ProtoMessage()
func (*DataCaptureUploadRequest) ProtoReflect ¶ added in v0.1.29
func (x *DataCaptureUploadRequest) ProtoReflect() protoreflect.Message
func (*DataCaptureUploadRequest) Reset ¶ added in v0.1.29
func (x *DataCaptureUploadRequest) Reset()
func (*DataCaptureUploadRequest) String ¶ added in v0.1.29
func (x *DataCaptureUploadRequest) String() string
type DataCaptureUploadResponse ¶ added in v0.1.29
type DataCaptureUploadResponse struct { FileId string `protobuf:"bytes,1,opt,name=file_id,json=fileId,proto3" json:"file_id,omitempty"` // contains filtered or unexported fields }
DataCaptureUploadResponse returns the file id of the uploaded contents and metadata for tabular data.
func (*DataCaptureUploadResponse) Descriptor
deprecated
added in
v0.1.29
func (*DataCaptureUploadResponse) Descriptor() ([]byte, []int)
Deprecated: Use DataCaptureUploadResponse.ProtoReflect.Descriptor instead.
func (*DataCaptureUploadResponse) GetFileId ¶ added in v0.1.141
func (x *DataCaptureUploadResponse) GetFileId() string
func (*DataCaptureUploadResponse) ProtoMessage ¶ added in v0.1.29
func (*DataCaptureUploadResponse) ProtoMessage()
func (*DataCaptureUploadResponse) ProtoReflect ¶ added in v0.1.29
func (x *DataCaptureUploadResponse) ProtoReflect() protoreflect.Message
func (*DataCaptureUploadResponse) Reset ¶ added in v0.1.29
func (x *DataCaptureUploadResponse) Reset()
func (*DataCaptureUploadResponse) String ¶ added in v0.1.29
func (x *DataCaptureUploadResponse) String() string
type DataSyncServiceClient ¶
type DataSyncServiceClient interface { // DataCaptureUpload uploads the contents and metadata for tabular data. DataCaptureUpload(ctx context.Context, in *DataCaptureUploadRequest, opts ...grpc.CallOption) (*DataCaptureUploadResponse, error) // FileUpload uploads the contents and metadata for binary (image + file) data, // where the first packet must be the UploadMetadata. FileUpload(ctx context.Context, opts ...grpc.CallOption) (DataSyncService_FileUploadClient, error) // StreamingDataCaptureUpload uploads the streaming contents and metadata for streaming binary (image + file) data, // where the first packet must be the UploadMetadata. StreamingDataCaptureUpload(ctx context.Context, opts ...grpc.CallOption) (DataSyncService_StreamingDataCaptureUploadClient, error) }
DataSyncServiceClient is the client API for DataSyncService 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.
func NewDataSyncServiceClient ¶
func NewDataSyncServiceClient(cc grpc.ClientConnInterface) DataSyncServiceClient
type DataSyncServiceServer ¶
type DataSyncServiceServer interface { // DataCaptureUpload uploads the contents and metadata for tabular data. DataCaptureUpload(context.Context, *DataCaptureUploadRequest) (*DataCaptureUploadResponse, error) // FileUpload uploads the contents and metadata for binary (image + file) data, // where the first packet must be the UploadMetadata. FileUpload(DataSyncService_FileUploadServer) error // StreamingDataCaptureUpload uploads the streaming contents and metadata for streaming binary (image + file) data, // where the first packet must be the UploadMetadata. StreamingDataCaptureUpload(DataSyncService_StreamingDataCaptureUploadServer) error // contains filtered or unexported methods }
DataSyncServiceServer is the server API for DataSyncService service. All implementations must embed UnimplementedDataSyncServiceServer for forward compatibility
type DataSyncService_FileUploadClient ¶ added in v0.1.29
type DataSyncService_FileUploadClient interface { Send(*FileUploadRequest) error CloseAndRecv() (*FileUploadResponse, error) grpc.ClientStream }
type DataSyncService_FileUploadServer ¶ added in v0.1.29
type DataSyncService_FileUploadServer interface { SendAndClose(*FileUploadResponse) error Recv() (*FileUploadRequest, error) grpc.ServerStream }
type DataSyncService_StreamingDataCaptureUploadClient ¶ added in v0.1.164
type DataSyncService_StreamingDataCaptureUploadClient interface { Send(*StreamingDataCaptureUploadRequest) error CloseAndRecv() (*StreamingDataCaptureUploadResponse, error) grpc.ClientStream }
type DataSyncService_StreamingDataCaptureUploadServer ¶ added in v0.1.164
type DataSyncService_StreamingDataCaptureUploadServer interface { SendAndClose(*StreamingDataCaptureUploadResponse) error Recv() (*StreamingDataCaptureUploadRequest, error) grpc.ServerStream }
type DataType ¶
type DataType int32
DataType specifies the type of data uploaded.
func (DataType) Descriptor ¶
func (DataType) Descriptor() protoreflect.EnumDescriptor
func (DataType) EnumDescriptor
deprecated
func (DataType) Number ¶
func (x DataType) Number() protoreflect.EnumNumber
func (DataType) Type ¶
func (DataType) Type() protoreflect.EnumType
type FileData ¶
type FileData struct { Data []byte `protobuf:"bytes,1,opt,name=data,proto3" json:"data,omitempty"` // contains filtered or unexported fields }
FileData contains the contents of binary (image + file) data.
func (*FileData) Descriptor
deprecated
func (*FileData) ProtoMessage ¶
func (*FileData) ProtoMessage()
func (*FileData) ProtoReflect ¶
func (x *FileData) ProtoReflect() protoreflect.Message
type FileUploadRequest ¶ added in v0.1.29
type FileUploadRequest struct { // Types that are assignable to UploadPacket: // // *FileUploadRequest_Metadata // *FileUploadRequest_FileContents UploadPacket isFileUploadRequest_UploadPacket `protobuf_oneof:"upload_packet"` // contains filtered or unexported fields }
FileUploadRequest requests to upload the contents and metadata for binary (image + file) data. The first packet must be the UploadMetadata associated with the binary data.
func (*FileUploadRequest) Descriptor
deprecated
added in
v0.1.29
func (*FileUploadRequest) Descriptor() ([]byte, []int)
Deprecated: Use FileUploadRequest.ProtoReflect.Descriptor instead.
func (*FileUploadRequest) GetFileContents ¶ added in v0.1.29
func (x *FileUploadRequest) GetFileContents() *FileData
func (*FileUploadRequest) GetMetadata ¶ added in v0.1.29
func (x *FileUploadRequest) GetMetadata() *UploadMetadata
func (*FileUploadRequest) GetUploadPacket ¶ added in v0.1.29
func (m *FileUploadRequest) GetUploadPacket() isFileUploadRequest_UploadPacket
func (*FileUploadRequest) ProtoMessage ¶ added in v0.1.29
func (*FileUploadRequest) ProtoMessage()
func (*FileUploadRequest) ProtoReflect ¶ added in v0.1.29
func (x *FileUploadRequest) ProtoReflect() protoreflect.Message
func (*FileUploadRequest) Reset ¶ added in v0.1.29
func (x *FileUploadRequest) Reset()
func (*FileUploadRequest) String ¶ added in v0.1.29
func (x *FileUploadRequest) String() string
type FileUploadRequest_FileContents ¶ added in v0.1.29
type FileUploadRequest_FileContents struct {
FileContents *FileData `protobuf:"bytes,2,opt,name=file_contents,json=fileContents,proto3,oneof"`
}
type FileUploadRequest_Metadata ¶ added in v0.1.29
type FileUploadRequest_Metadata struct {
Metadata *UploadMetadata `protobuf:"bytes,1,opt,name=metadata,proto3,oneof"`
}
type FileUploadResponse ¶ added in v0.1.29
type FileUploadResponse struct { FileId string `protobuf:"bytes,1,opt,name=file_id,json=fileId,proto3" json:"file_id,omitempty"` // contains filtered or unexported fields }
FileUploadResponse returns the file id of the uploaded contents and metadata for binary (image + file) data.
func (*FileUploadResponse) Descriptor
deprecated
added in
v0.1.29
func (*FileUploadResponse) Descriptor() ([]byte, []int)
Deprecated: Use FileUploadResponse.ProtoReflect.Descriptor instead.
func (*FileUploadResponse) GetFileId ¶ added in v0.1.141
func (x *FileUploadResponse) GetFileId() string
func (*FileUploadResponse) ProtoMessage ¶ added in v0.1.29
func (*FileUploadResponse) ProtoMessage()
func (*FileUploadResponse) ProtoReflect ¶ added in v0.1.29
func (x *FileUploadResponse) ProtoReflect() protoreflect.Message
func (*FileUploadResponse) Reset ¶ added in v0.1.29
func (x *FileUploadResponse) Reset()
func (*FileUploadResponse) String ¶ added in v0.1.29
func (x *FileUploadResponse) String() string
type SensorData ¶
type SensorData struct { Metadata *SensorMetadata `protobuf:"bytes,1,opt,name=metadata,proto3" json:"metadata,omitempty"` // Types that are assignable to Data: // // *SensorData_Struct // *SensorData_Binary Data isSensorData_Data `protobuf_oneof:"data"` // contains filtered or unexported fields }
SensorData contains the contents and metadata for tabular data.
func (*SensorData) Descriptor
deprecated
func (*SensorData) Descriptor() ([]byte, []int)
Deprecated: Use SensorData.ProtoReflect.Descriptor instead.
func (*SensorData) GetBinary ¶
func (x *SensorData) GetBinary() []byte
func (*SensorData) GetData ¶
func (m *SensorData) GetData() isSensorData_Data
func (*SensorData) GetMetadata ¶
func (x *SensorData) GetMetadata() *SensorMetadata
func (*SensorData) GetStruct ¶
func (x *SensorData) GetStruct() *structpb.Struct
func (*SensorData) ProtoMessage ¶
func (*SensorData) ProtoMessage()
func (*SensorData) ProtoReflect ¶
func (x *SensorData) ProtoReflect() protoreflect.Message
func (*SensorData) Reset ¶
func (x *SensorData) Reset()
func (*SensorData) String ¶
func (x *SensorData) String() string
type SensorData_Binary ¶
type SensorData_Binary struct {
Binary []byte `protobuf:"bytes,3,opt,name=binary,proto3,oneof"`
}
type SensorData_Struct ¶
type SensorMetadata ¶
type SensorMetadata struct { TimeRequested *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=time_requested,json=timeRequested,proto3" json:"time_requested,omitempty"` TimeReceived *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=time_received,json=timeReceived,proto3" json:"time_received,omitempty"` // contains filtered or unexported fields }
SensorMetadata contains the time the sensor data was requested and was received.
func (*SensorMetadata) Descriptor
deprecated
func (*SensorMetadata) Descriptor() ([]byte, []int)
Deprecated: Use SensorMetadata.ProtoReflect.Descriptor instead.
func (*SensorMetadata) GetTimeReceived ¶
func (x *SensorMetadata) GetTimeReceived() *timestamppb.Timestamp
func (*SensorMetadata) GetTimeRequested ¶
func (x *SensorMetadata) GetTimeRequested() *timestamppb.Timestamp
func (*SensorMetadata) ProtoMessage ¶
func (*SensorMetadata) ProtoMessage()
func (*SensorMetadata) ProtoReflect ¶
func (x *SensorMetadata) ProtoReflect() protoreflect.Message
func (*SensorMetadata) Reset ¶
func (x *SensorMetadata) Reset()
func (*SensorMetadata) String ¶
func (x *SensorMetadata) String() string
type StreamingDataCaptureUploadRequest ¶ added in v0.1.164
type StreamingDataCaptureUploadRequest struct { // Types that are assignable to UploadPacket: // // *StreamingDataCaptureUploadRequest_Metadata // *StreamingDataCaptureUploadRequest_Data UploadPacket isStreamingDataCaptureUploadRequest_UploadPacket `protobuf_oneof:"upload_packet"` // contains filtered or unexported fields }
StreamingDataCaptureUploadRequest requests to upload the contents and metadata for streaming binary (image + file) data. The first packet must be the DataCaptureUploadMetadata associated with the data.
func (*StreamingDataCaptureUploadRequest) Descriptor
deprecated
added in
v0.1.164
func (*StreamingDataCaptureUploadRequest) Descriptor() ([]byte, []int)
Deprecated: Use StreamingDataCaptureUploadRequest.ProtoReflect.Descriptor instead.
func (*StreamingDataCaptureUploadRequest) GetData ¶ added in v0.1.164
func (x *StreamingDataCaptureUploadRequest) GetData() []byte
func (*StreamingDataCaptureUploadRequest) GetMetadata ¶ added in v0.1.164
func (x *StreamingDataCaptureUploadRequest) GetMetadata() *DataCaptureUploadMetadata
func (*StreamingDataCaptureUploadRequest) GetUploadPacket ¶ added in v0.1.164
func (m *StreamingDataCaptureUploadRequest) GetUploadPacket() isStreamingDataCaptureUploadRequest_UploadPacket
func (*StreamingDataCaptureUploadRequest) ProtoMessage ¶ added in v0.1.164
func (*StreamingDataCaptureUploadRequest) ProtoMessage()
func (*StreamingDataCaptureUploadRequest) ProtoReflect ¶ added in v0.1.164
func (x *StreamingDataCaptureUploadRequest) ProtoReflect() protoreflect.Message
func (*StreamingDataCaptureUploadRequest) Reset ¶ added in v0.1.164
func (x *StreamingDataCaptureUploadRequest) Reset()
func (*StreamingDataCaptureUploadRequest) String ¶ added in v0.1.164
func (x *StreamingDataCaptureUploadRequest) String() string
type StreamingDataCaptureUploadRequest_Data ¶ added in v0.1.164
type StreamingDataCaptureUploadRequest_Data struct {
Data []byte `protobuf:"bytes,2,opt,name=data,proto3,oneof"`
}
type StreamingDataCaptureUploadRequest_Metadata ¶ added in v0.1.164
type StreamingDataCaptureUploadRequest_Metadata struct {
Metadata *DataCaptureUploadMetadata `protobuf:"bytes,1,opt,name=metadata,proto3,oneof"`
}
type StreamingDataCaptureUploadResponse ¶ added in v0.1.164
type StreamingDataCaptureUploadResponse struct { FileId string `protobuf:"bytes,1,opt,name=file_id,json=fileId,proto3" json:"file_id,omitempty"` // contains filtered or unexported fields }
StreamingDataCaptureUploadResponse returns the file id of the uploaded contents and metadata for streaming binary (image + file) data.
func (*StreamingDataCaptureUploadResponse) Descriptor
deprecated
added in
v0.1.164
func (*StreamingDataCaptureUploadResponse) Descriptor() ([]byte, []int)
Deprecated: Use StreamingDataCaptureUploadResponse.ProtoReflect.Descriptor instead.
func (*StreamingDataCaptureUploadResponse) GetFileId ¶ added in v0.1.164
func (x *StreamingDataCaptureUploadResponse) GetFileId() string
func (*StreamingDataCaptureUploadResponse) ProtoMessage ¶ added in v0.1.164
func (*StreamingDataCaptureUploadResponse) ProtoMessage()
func (*StreamingDataCaptureUploadResponse) ProtoReflect ¶ added in v0.1.164
func (x *StreamingDataCaptureUploadResponse) ProtoReflect() protoreflect.Message
func (*StreamingDataCaptureUploadResponse) Reset ¶ added in v0.1.164
func (x *StreamingDataCaptureUploadResponse) Reset()
func (*StreamingDataCaptureUploadResponse) String ¶ added in v0.1.164
func (x *StreamingDataCaptureUploadResponse) String() string
type UnimplementedDataSyncServiceServer ¶
type UnimplementedDataSyncServiceServer struct { }
UnimplementedDataSyncServiceServer must be embedded to have forward compatible implementations.
func (UnimplementedDataSyncServiceServer) DataCaptureUpload ¶ added in v0.1.29
func (UnimplementedDataSyncServiceServer) DataCaptureUpload(context.Context, *DataCaptureUploadRequest) (*DataCaptureUploadResponse, error)
func (UnimplementedDataSyncServiceServer) FileUpload ¶ added in v0.1.29
func (UnimplementedDataSyncServiceServer) FileUpload(DataSyncService_FileUploadServer) error
func (UnimplementedDataSyncServiceServer) StreamingDataCaptureUpload ¶ added in v0.1.164
func (UnimplementedDataSyncServiceServer) StreamingDataCaptureUpload(DataSyncService_StreamingDataCaptureUploadServer) error
type UnsafeDataSyncServiceServer ¶
type UnsafeDataSyncServiceServer interface {
// contains filtered or unexported methods
}
UnsafeDataSyncServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to DataSyncServiceServer will result in compilation errors.
type UploadMetadata ¶
type UploadMetadata struct { PartId string `protobuf:"bytes,1,opt,name=part_id,json=partId,proto3" json:"part_id,omitempty"` ComponentType string `protobuf:"bytes,2,opt,name=component_type,json=componentType,proto3" json:"component_type,omitempty"` ComponentName string `protobuf:"bytes,3,opt,name=component_name,json=componentName,proto3" json:"component_name,omitempty"` MethodName string `protobuf:"bytes,5,opt,name=method_name,json=methodName,proto3" json:"method_name,omitempty"` Type DataType `protobuf:"varint,6,opt,name=type,proto3,enum=viam.app.datasync.v1.DataType" json:"type,omitempty"` FileName string `protobuf:"bytes,7,opt,name=file_name,json=fileName,proto3" json:"file_name,omitempty"` MethodParameters map[string]*anypb.Any `` /* 197-byte string literal not displayed */ FileExtension string `protobuf:"bytes,9,opt,name=file_extension,json=fileExtension,proto3" json:"file_extension,omitempty"` Tags []string `protobuf:"bytes,10,rep,name=tags,proto3" json:"tags,omitempty"` // contains filtered or unexported fields }
UploadMetadata contains the metadata for binary (image + file) data.
func (*UploadMetadata) Descriptor
deprecated
func (*UploadMetadata) Descriptor() ([]byte, []int)
Deprecated: Use UploadMetadata.ProtoReflect.Descriptor instead.
func (*UploadMetadata) GetComponentName ¶
func (x *UploadMetadata) GetComponentName() string
func (*UploadMetadata) GetComponentType ¶
func (x *UploadMetadata) GetComponentType() string
func (*UploadMetadata) GetFileExtension ¶
func (x *UploadMetadata) GetFileExtension() string
func (*UploadMetadata) GetFileName ¶
func (x *UploadMetadata) GetFileName() string
func (*UploadMetadata) GetMethodName ¶
func (x *UploadMetadata) GetMethodName() string
func (*UploadMetadata) GetMethodParameters ¶
func (x *UploadMetadata) GetMethodParameters() map[string]*anypb.Any
func (*UploadMetadata) GetPartId ¶
func (x *UploadMetadata) GetPartId() string
func (*UploadMetadata) GetTags ¶
func (x *UploadMetadata) GetTags() []string
func (*UploadMetadata) GetType ¶
func (x *UploadMetadata) GetType() DataType
func (*UploadMetadata) ProtoMessage ¶
func (*UploadMetadata) ProtoMessage()
func (*UploadMetadata) ProtoReflect ¶
func (x *UploadMetadata) ProtoReflect() protoreflect.Message
func (*UploadMetadata) Reset ¶
func (x *UploadMetadata) Reset()
func (*UploadMetadata) String ¶
func (x *UploadMetadata) String() string