v1

package
v0.1.367 Latest Latest
Warning

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

 Go to latest Published: Nov 22, 2024 License: Apache-2.0 Imports: 16 Imported by: 2

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 DatasetService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "viam.app.dataset.v1.DatasetService",
	HandlerType: (*DatasetServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "CreateDataset",
			Handler:    _DatasetService_CreateDataset_Handler,
		},
		{
			MethodName: "DeleteDataset",
			Handler:    _DatasetService_DeleteDataset_Handler,
		},
		{
			MethodName: "RenameDataset",
			Handler:    _DatasetService_RenameDataset_Handler,
		},
		{
			MethodName: "ListDatasetsByOrganizationID",
			Handler:    _DatasetService_ListDatasetsByOrganizationID_Handler,
		},
		{
			MethodName: "ListDatasetsByIDs",
			Handler:    _DatasetService_ListDatasetsByIDs_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "app/dataset/v1/dataset.proto",
}

DatasetService_ServiceDesc is the grpc.ServiceDesc for DatasetService 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_dataset_v1_dataset_proto protoreflect.FileDescriptor

Functions

func RegisterDatasetServiceHandler 

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

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

func RegisterDatasetServiceHandlerClient 

func RegisterDatasetServiceHandlerClient(ctx context.Context, mux *runtime.ServeMux, client DatasetServiceClient) error

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

func RegisterDatasetServiceHandlerFromEndpoint 

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

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

func RegisterDatasetServiceHandlerServer 

func RegisterDatasetServiceHandlerServer(ctx context.Context, mux *runtime.ServeMux, server DatasetServiceServer) error

RegisterDatasetServiceHandlerServer registers the http handlers for service DatasetService to "mux". UnaryRPC :call DatasetServiceServer 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 RegisterDatasetServiceHandlerFromEndpoint instead.

func RegisterDatasetServiceServer 

func RegisterDatasetServiceServer(s grpc.ServiceRegistrar, srv DatasetServiceServer)

Types

type CreateDatasetRequest 

type CreateDatasetRequest struct {
	Name           string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	OrganizationId string `protobuf:"bytes,2,opt,name=organization_id,json=organizationId,proto3" json:"organization_id,omitempty"`
	// contains filtered or unexported fields
}

CreateDatasetRequest defines the name and organization ID of a dataset.

func (*CreateDatasetRequest) Descriptor deprecated 

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

Deprecated: Use CreateDatasetRequest.ProtoReflect.Descriptor instead.

func (*CreateDatasetRequest) GetName 

func (x *CreateDatasetRequest) GetName() string

func (*CreateDatasetRequest) GetOrganizationId 

func (x *CreateDatasetRequest) GetOrganizationId() string

func (*CreateDatasetRequest) ProtoMessage 

func (*CreateDatasetRequest) ProtoMessage()

func (*CreateDatasetRequest) ProtoReflect 

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

func (*CreateDatasetRequest) Reset 

func (x *CreateDatasetRequest) Reset()

func (*CreateDatasetRequest) String 

func (x *CreateDatasetRequest) String() string

type CreateDatasetResponse 

type CreateDatasetResponse struct {
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// contains filtered or unexported fields
}

CreateDatasetResponse returns the dataset ID of the created dataset.

func (*CreateDatasetResponse) Descriptor deprecated 

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

Deprecated: Use CreateDatasetResponse.ProtoReflect.Descriptor instead.

func (*CreateDatasetResponse) GetId 

func (x *CreateDatasetResponse) GetId() string

func (*CreateDatasetResponse) ProtoMessage 

func (*CreateDatasetResponse) ProtoMessage()

func (*CreateDatasetResponse) ProtoReflect 

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

func (*CreateDatasetResponse) Reset 

func (x *CreateDatasetResponse) Reset()

func (*CreateDatasetResponse) String 

func (x *CreateDatasetResponse) String() string

type Dataset 

type Dataset struct {
	Id             string                 `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	Name           string                 `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
	OrganizationId string                 `protobuf:"bytes,3,opt,name=organization_id,json=organizationId,proto3" json:"organization_id,omitempty"`
	TimeCreated    *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=time_created,json=timeCreated,proto3" json:"time_created,omitempty"`
	// contains filtered or unexported fields
}

Dataset stores the metadata of a dataset.

func (*Dataset) Descriptor deprecated 

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

Deprecated: Use Dataset.ProtoReflect.Descriptor instead.

func (*Dataset) GetId 

func (x *Dataset) GetId() string

func (*Dataset) GetName 

func (x *Dataset) GetName() string

func (*Dataset) GetOrganizationId 

func (x *Dataset) GetOrganizationId() string

func (*Dataset) GetTimeCreated 

func (x *Dataset) GetTimeCreated() *timestamppb.Timestamp

func (*Dataset) ProtoMessage 

func (*Dataset) ProtoMessage()

func (*Dataset) ProtoReflect 

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

func (*Dataset) Reset 

func (x *Dataset) Reset()

func (*Dataset) String 

func (x *Dataset) String() string

type DatasetServiceClient 

type DatasetServiceClient interface {
	// CreateDataset makes a new dataset.
	CreateDataset(ctx context.Context, in *CreateDatasetRequest, opts ...grpc.CallOption) (*CreateDatasetResponse, error)
	// DeleteDatasets deletes an existing dataset.
	DeleteDataset(ctx context.Context, in *DeleteDatasetRequest, opts ...grpc.CallOption) (*DeleteDatasetResponse, error)
	// RenameDataset modifies the name of an existing dataset.
	RenameDataset(ctx context.Context, in *RenameDatasetRequest, opts ...grpc.CallOption) (*RenameDatasetResponse, error)
	// ListDatasetsByOrganizationID lists all of the datasets for an organization.
	ListDatasetsByOrganizationID(ctx context.Context, in *ListDatasetsByOrganizationIDRequest, opts ...grpc.CallOption) (*ListDatasetsByOrganizationIDResponse, error)
	// ListDatasetsByIDs lists all of the datasets specified by the given dataset IDs.
	ListDatasetsByIDs(ctx context.Context, in *ListDatasetsByIDsRequest, opts ...grpc.CallOption) (*ListDatasetsByIDsResponse, error)
}

DatasetServiceClient is the client API for DatasetService 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 NewDatasetServiceClient 

func NewDatasetServiceClient(cc grpc.ClientConnInterface) DatasetServiceClient

type DatasetServiceServer 

type DatasetServiceServer interface {
	// CreateDataset makes a new dataset.
	CreateDataset(context.Context, *CreateDatasetRequest) (*CreateDatasetResponse, error)
	// DeleteDatasets deletes an existing dataset.
	DeleteDataset(context.Context, *DeleteDatasetRequest) (*DeleteDatasetResponse, error)
	// RenameDataset modifies the name of an existing dataset.
	RenameDataset(context.Context, *RenameDatasetRequest) (*RenameDatasetResponse, error)
	// ListDatasetsByOrganizationID lists all of the datasets for an organization.
	ListDatasetsByOrganizationID(context.Context, *ListDatasetsByOrganizationIDRequest) (*ListDatasetsByOrganizationIDResponse, error)
	// ListDatasetsByIDs lists all of the datasets specified by the given dataset IDs.
	ListDatasetsByIDs(context.Context, *ListDatasetsByIDsRequest) (*ListDatasetsByIDsResponse, error)
	// contains filtered or unexported methods
}

DatasetServiceServer is the server API for DatasetService service. All implementations must embed UnimplementedDatasetServiceServer for forward compatibility

type DeleteDatasetRequest 

type DeleteDatasetRequest struct {
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// contains filtered or unexported fields
}

DeleteDatasetRequest deletes the dataset specified by the dataset ID.

func (*DeleteDatasetRequest) Descriptor deprecated 

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

Deprecated: Use DeleteDatasetRequest.ProtoReflect.Descriptor instead.

func (*DeleteDatasetRequest) GetId 

func (x *DeleteDatasetRequest) GetId() string

func (*DeleteDatasetRequest) ProtoMessage 

func (*DeleteDatasetRequest) ProtoMessage()

func (*DeleteDatasetRequest) ProtoReflect 

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

func (*DeleteDatasetRequest) Reset 

func (x *DeleteDatasetRequest) Reset()

func (*DeleteDatasetRequest) String 

func (x *DeleteDatasetRequest) String() string

type DeleteDatasetResponse 

type DeleteDatasetResponse struct {
	// contains filtered or unexported fields
}

func (*DeleteDatasetResponse) Descriptor deprecated 

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

Deprecated: Use DeleteDatasetResponse.ProtoReflect.Descriptor instead.

func (*DeleteDatasetResponse) ProtoMessage 

func (*DeleteDatasetResponse) ProtoMessage()

func (*DeleteDatasetResponse) ProtoReflect 

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

func (*DeleteDatasetResponse) Reset 

func (x *DeleteDatasetResponse) Reset()

func (*DeleteDatasetResponse) String 

func (x *DeleteDatasetResponse) String() string

type ListDatasetsByIDsRequest 

type ListDatasetsByIDsRequest struct {
	Ids []string `protobuf:"bytes,1,rep,name=ids,proto3" json:"ids,omitempty"`
	// contains filtered or unexported fields
}

ListDatasetsByIDsRequest requests all of the datasets by their dataset IDs.

func (*ListDatasetsByIDsRequest) Descriptor deprecated 

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

Deprecated: Use ListDatasetsByIDsRequest.ProtoReflect.Descriptor instead.

func (*ListDatasetsByIDsRequest) GetIds 

func (x *ListDatasetsByIDsRequest) GetIds() []string

func (*ListDatasetsByIDsRequest) ProtoMessage 

func (*ListDatasetsByIDsRequest) ProtoMessage()

func (*ListDatasetsByIDsRequest) ProtoReflect 

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

func (*ListDatasetsByIDsRequest) Reset 

func (x *ListDatasetsByIDsRequest) Reset()

func (*ListDatasetsByIDsRequest) String 

func (x *ListDatasetsByIDsRequest) String() string

type ListDatasetsByIDsResponse 

type ListDatasetsByIDsResponse struct {
	Datasets []*Dataset `protobuf:"bytes,1,rep,name=datasets,proto3" json:"datasets,omitempty"`
	// contains filtered or unexported fields
}

ListDatasetsByIDsResponse returns all the dataset metadata for the associated dataset IDs.

func (*ListDatasetsByIDsResponse) Descriptor deprecated 

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

Deprecated: Use ListDatasetsByIDsResponse.ProtoReflect.Descriptor instead.

func (*ListDatasetsByIDsResponse) GetDatasets 

func (x *ListDatasetsByIDsResponse) GetDatasets() []*Dataset

func (*ListDatasetsByIDsResponse) ProtoMessage 

func (*ListDatasetsByIDsResponse) ProtoMessage()

func (*ListDatasetsByIDsResponse) ProtoReflect 

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

func (*ListDatasetsByIDsResponse) Reset 

func (x *ListDatasetsByIDsResponse) Reset()

func (*ListDatasetsByIDsResponse) String 

func (x *ListDatasetsByIDsResponse) String() string

type ListDatasetsByOrganizationIDRequest 

type ListDatasetsByOrganizationIDRequest struct {
	OrganizationId string `protobuf:"bytes,1,opt,name=organization_id,json=organizationId,proto3" json:"organization_id,omitempty"`
	// contains filtered or unexported fields
}

ListDatasetsByOrganizationIDRequest requests all of the datasets for an organization.

func (*ListDatasetsByOrganizationIDRequest) Descriptor deprecated 

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

Deprecated: Use ListDatasetsByOrganizationIDRequest.ProtoReflect.Descriptor instead.

func (*ListDatasetsByOrganizationIDRequest) GetOrganizationId 

func (x *ListDatasetsByOrganizationIDRequest) GetOrganizationId() string

func (*ListDatasetsByOrganizationIDRequest) ProtoMessage 

func (*ListDatasetsByOrganizationIDRequest) ProtoMessage()

func (*ListDatasetsByOrganizationIDRequest) ProtoReflect 

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

func (*ListDatasetsByOrganizationIDRequest) Reset 

func (x *ListDatasetsByOrganizationIDRequest) Reset()

func (*ListDatasetsByOrganizationIDRequest) String 

func (x *ListDatasetsByOrganizationIDRequest) String() string

type ListDatasetsByOrganizationIDResponse 

type ListDatasetsByOrganizationIDResponse struct {
	Datasets []*Dataset `protobuf:"bytes,1,rep,name=datasets,proto3" json:"datasets,omitempty"`
	// contains filtered or unexported fields
}

ListDatasetsByOrganizationIDResponse returns all the dataset metadata for the organization.

func (*ListDatasetsByOrganizationIDResponse) Descriptor deprecated 

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

Deprecated: Use ListDatasetsByOrganizationIDResponse.ProtoReflect.Descriptor instead.

func (*ListDatasetsByOrganizationIDResponse) GetDatasets 

func (x *ListDatasetsByOrganizationIDResponse) GetDatasets() []*Dataset

func (*ListDatasetsByOrganizationIDResponse) ProtoMessage 

func (*ListDatasetsByOrganizationIDResponse) ProtoMessage()

func (*ListDatasetsByOrganizationIDResponse) ProtoReflect 

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

func (*ListDatasetsByOrganizationIDResponse) Reset 

func (x *ListDatasetsByOrganizationIDResponse) Reset()

func (*ListDatasetsByOrganizationIDResponse) String 

func (x *ListDatasetsByOrganizationIDResponse) String() string

type RenameDatasetRequest 

type RenameDatasetRequest struct {
	Id   string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

RenameDatasetRequest applies the new name to the dataset specified by the dataset ID.

func (*RenameDatasetRequest) Descriptor deprecated 

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

Deprecated: Use RenameDatasetRequest.ProtoReflect.Descriptor instead.

func (*RenameDatasetRequest) GetId 

func (x *RenameDatasetRequest) GetId() string

func (*RenameDatasetRequest) GetName 

func (x *RenameDatasetRequest) GetName() string

func (*RenameDatasetRequest) ProtoMessage 

func (*RenameDatasetRequest) ProtoMessage()

func (*RenameDatasetRequest) ProtoReflect 

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

func (*RenameDatasetRequest) Reset 

func (x *RenameDatasetRequest) Reset()

func (*RenameDatasetRequest) String 

func (x *RenameDatasetRequest) String() string

type RenameDatasetResponse 

type RenameDatasetResponse struct {
	// contains filtered or unexported fields
}

func (*RenameDatasetResponse) Descriptor deprecated 

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

Deprecated: Use RenameDatasetResponse.ProtoReflect.Descriptor instead.

func (*RenameDatasetResponse) ProtoMessage 

func (*RenameDatasetResponse) ProtoMessage()

func (*RenameDatasetResponse) ProtoReflect 

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

func (*RenameDatasetResponse) Reset 

func (x *RenameDatasetResponse) Reset()

func (*RenameDatasetResponse) String 

func (x *RenameDatasetResponse) String() string

type UnimplementedDatasetServiceServer 

type UnimplementedDatasetServiceServer struct {
}

UnimplementedDatasetServiceServer must be embedded to have forward compatible implementations.

func (UnimplementedDatasetServiceServer) CreateDataset 

func (UnimplementedDatasetServiceServer) CreateDataset(context.Context, *CreateDatasetRequest) (*CreateDatasetResponse, error)

func (UnimplementedDatasetServiceServer) DeleteDataset 

func (UnimplementedDatasetServiceServer) DeleteDataset(context.Context, *DeleteDatasetRequest) (*DeleteDatasetResponse, error)

func (UnimplementedDatasetServiceServer) ListDatasetsByIDs 

func (UnimplementedDatasetServiceServer) ListDatasetsByIDs(context.Context, *ListDatasetsByIDsRequest) (*ListDatasetsByIDsResponse, error)

func (UnimplementedDatasetServiceServer) ListDatasetsByOrganizationID 

func (UnimplementedDatasetServiceServer) ListDatasetsByOrganizationID(context.Context, *ListDatasetsByOrganizationIDRequest) (*ListDatasetsByOrganizationIDResponse, error)

func (UnimplementedDatasetServiceServer) RenameDataset 

func (UnimplementedDatasetServiceServer) RenameDataset(context.Context, *RenameDatasetRequest) (*RenameDatasetResponse, error)

type UnsafeDatasetServiceServer 

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

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

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.