Documentation
¶
Overview ¶
Package v1 is a reverse proxy.
It translates gRPC into RESTful JSON APIs.
Index ¶
- Variables
- func RegisterNotebookServiceHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error
- func RegisterNotebookServiceHandlerClient(ctx context.Context, mux *runtime.ServeMux, client NotebookServiceClient) error
- func RegisterNotebookServiceHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, ...) (err error)
- func RegisterNotebookServiceHandlerServer(ctx context.Context, mux *runtime.ServeMux, server NotebookServiceServer) error
- func RegisterNotebookServiceServer(s grpc.ServiceRegistrar, srv NotebookServiceServer)
- type CreateNotebookRequest
- func (*CreateNotebookRequest) Descriptor() ([]byte, []int)deprecated
- func (x *CreateNotebookRequest) GetNotebook() *v1alpha1.Notebook
- func (*CreateNotebookRequest) ProtoMessage()
- func (x *CreateNotebookRequest) ProtoReflect() protoreflect.Message
- func (x *CreateNotebookRequest) Reset()
- func (x *CreateNotebookRequest) String() string
- type CreateNotebookResponse
- type DeleteNotebookRequest
- func (*DeleteNotebookRequest) Descriptor() ([]byte, []int)deprecated
- func (x *DeleteNotebookRequest) GetName() string
- func (x *DeleteNotebookRequest) GetNamespace() string
- func (*DeleteNotebookRequest) ProtoMessage()
- func (x *DeleteNotebookRequest) ProtoReflect() protoreflect.Message
- func (x *DeleteNotebookRequest) Reset()
- func (x *DeleteNotebookRequest) String() string
- type DeleteNotebookResponse
- type GetNotebookRequest
- func (*GetNotebookRequest) Descriptor() ([]byte, []int)deprecated
- func (x *GetNotebookRequest) GetName() string
- func (x *GetNotebookRequest) GetNamespace() string
- func (*GetNotebookRequest) ProtoMessage()
- func (x *GetNotebookRequest) ProtoReflect() protoreflect.Message
- func (x *GetNotebookRequest) Reset()
- func (x *GetNotebookRequest) String() string
- type GetNotebookResponse
- func (*GetNotebookResponse) Descriptor() ([]byte, []int)deprecated
- func (x *GetNotebookResponse) GetNotebook() *v1alpha1.Notebook
- func (x *GetNotebookResponse) GetYaml() string
- func (*GetNotebookResponse) ProtoMessage()
- func (x *GetNotebookResponse) ProtoReflect() protoreflect.Message
- func (x *GetNotebookResponse) Reset()
- func (x *GetNotebookResponse) String() string
- type ListNotebooksRequest
- func (*ListNotebooksRequest) Descriptor() ([]byte, []int)deprecated
- func (x *ListNotebooksRequest) GetLabels() map[string]string
- func (x *ListNotebooksRequest) GetNamespace() string
- func (x *ListNotebooksRequest) GetOrderBy() string
- func (x *ListNotebooksRequest) GetPageSize() int32
- func (x *ListNotebooksRequest) GetPageToken() string
- func (*ListNotebooksRequest) ProtoMessage()
- func (x *ListNotebooksRequest) ProtoReflect() protoreflect.Message
- func (x *ListNotebooksRequest) Reset()
- func (x *ListNotebooksRequest) String() string
- type ListNotebooksResponse
- func (*ListNotebooksResponse) Descriptor() ([]byte, []int)deprecated
- func (x *ListNotebooksResponse) GetNextPageToken() string
- func (x *ListNotebooksResponse) GetNotebooks() *v1alpha1.NotebookList
- func (*ListNotebooksResponse) ProtoMessage()
- func (x *ListNotebooksResponse) ProtoReflect() protoreflect.Message
- func (x *ListNotebooksResponse) Reset()
- func (x *ListNotebooksResponse) String() string
- type NotebookResponse
- type NotebookServiceClient
- type NotebookServiceServer
- type UnimplementedNotebookServiceServer
- func (UnimplementedNotebookServiceServer) CreateNotebook(context.Context, *CreateNotebookRequest) (*CreateNotebookResponse, error)
- func (UnimplementedNotebookServiceServer) DeleteNotebook(context.Context, *DeleteNotebookRequest) (*DeleteNotebookResponse, error)
- func (UnimplementedNotebookServiceServer) GetNotebook(context.Context, *GetNotebookRequest) (*GetNotebookResponse, error)
- func (UnimplementedNotebookServiceServer) ListNotebooks(context.Context, *ListNotebooksRequest) (*ListNotebooksResponse, error)
- func (UnimplementedNotebookServiceServer) UpdateNotebook(context.Context, *UpdateNotebookRequest) (*UpdateNotebookResponse, error)
- type UnsafeNotebookServiceServer
- type UpdateNotebookRequest
- func (*UpdateNotebookRequest) Descriptor() ([]byte, []int)deprecated
- func (x *UpdateNotebookRequest) GetFieldMask() *field_mask.FieldMask
- func (x *UpdateNotebookRequest) GetNotebook() *v1alpha1.Notebook
- func (*UpdateNotebookRequest) ProtoMessage()
- func (x *UpdateNotebookRequest) ProtoReflect() protoreflect.Message
- func (x *UpdateNotebookRequest) Reset()
- func (x *UpdateNotebookRequest) String() string
- type UpdateNotebookResponse
Constants ¶
This section is empty.
Variables ¶
var File_github_com_metaprov_modelaapi_services_notebook_v1_notebook_proto protoreflect.FileDescriptor
var NotebookService_ServiceDesc = grpc.ServiceDesc{ ServiceName: "github.com.metaprov.modelaapi.services.notebook.v1.NotebookService", HandlerType: (*NotebookServiceServer)(nil), Methods: []grpc.MethodDesc{ { MethodName: "ListNotebooks", Handler: _NotebookService_ListNotebooks_Handler, }, { MethodName: "CreateNotebook", Handler: _NotebookService_CreateNotebook_Handler, }, { MethodName: "GetNotebook", Handler: _NotebookService_GetNotebook_Handler, }, { MethodName: "UpdateNotebook", Handler: _NotebookService_UpdateNotebook_Handler, }, { MethodName: "DeleteNotebook", Handler: _NotebookService_DeleteNotebook_Handler, }, }, Streams: []grpc.StreamDesc{}, Metadata: "github.com/metaprov/modelaapi/services/notebook/v1/notebook.proto", }
NotebookService_ServiceDesc is the grpc.ServiceDesc for NotebookService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
Functions ¶
func RegisterNotebookServiceHandler ¶ added in v0.4.687
func RegisterNotebookServiceHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error
RegisterNotebookServiceHandler registers the http handlers for service NotebookService to "mux". The handlers forward requests to the grpc endpoint over "conn".
func RegisterNotebookServiceHandlerClient ¶ added in v0.4.687
func RegisterNotebookServiceHandlerClient(ctx context.Context, mux *runtime.ServeMux, client NotebookServiceClient) error
RegisterNotebookServiceHandlerClient registers the http handlers for service NotebookService to "mux". The handlers forward requests to the grpc endpoint over the given implementation of "NotebookServiceClient". Note: the gRPC framework executes interceptors within the gRPC handler. If the passed in "NotebookServiceClient" doesn't go through the normal gRPC flow (creating a gRPC client etc.) then it will be up to the passed in "NotebookServiceClient" to call the correct interceptors.
func RegisterNotebookServiceHandlerFromEndpoint ¶ added in v0.4.687
func RegisterNotebookServiceHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, opts []grpc.DialOption) (err error)
RegisterNotebookServiceHandlerFromEndpoint is same as RegisterNotebookServiceHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.
func RegisterNotebookServiceHandlerServer ¶ added in v0.4.687
func RegisterNotebookServiceHandlerServer(ctx context.Context, mux *runtime.ServeMux, server NotebookServiceServer) error
RegisterNotebookServiceHandlerServer registers the http handlers for service NotebookService to "mux". UnaryRPC :call NotebookServiceServer 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 RegisterNotebookServiceHandlerFromEndpoint instead.
func RegisterNotebookServiceServer ¶
func RegisterNotebookServiceServer(s grpc.ServiceRegistrar, srv NotebookServiceServer)
Types ¶
type CreateNotebookRequest ¶
type CreateNotebookRequest struct { Notebook *v1alpha1.Notebook `protobuf:"bytes,1,opt,name=notebook,proto3" json:"notebook,omitempty"` // contains filtered or unexported fields }
func (*CreateNotebookRequest) Descriptor
deprecated
func (*CreateNotebookRequest) Descriptor() ([]byte, []int)
Deprecated: Use CreateNotebookRequest.ProtoReflect.Descriptor instead.
func (*CreateNotebookRequest) GetNotebook ¶ added in v0.4.472
func (x *CreateNotebookRequest) GetNotebook() *v1alpha1.Notebook
func (*CreateNotebookRequest) ProtoMessage ¶
func (*CreateNotebookRequest) ProtoMessage()
func (*CreateNotebookRequest) ProtoReflect ¶
func (x *CreateNotebookRequest) ProtoReflect() protoreflect.Message
func (*CreateNotebookRequest) Reset ¶
func (x *CreateNotebookRequest) Reset()
func (*CreateNotebookRequest) String ¶
func (x *CreateNotebookRequest) String() string
type CreateNotebookResponse ¶
type CreateNotebookResponse struct {
// contains filtered or unexported fields
}
func (*CreateNotebookResponse) Descriptor
deprecated
func (*CreateNotebookResponse) Descriptor() ([]byte, []int)
Deprecated: Use CreateNotebookResponse.ProtoReflect.Descriptor instead.
func (*CreateNotebookResponse) ProtoMessage ¶
func (*CreateNotebookResponse) ProtoMessage()
func (*CreateNotebookResponse) ProtoReflect ¶
func (x *CreateNotebookResponse) ProtoReflect() protoreflect.Message
func (*CreateNotebookResponse) Reset ¶
func (x *CreateNotebookResponse) Reset()
func (*CreateNotebookResponse) String ¶
func (x *CreateNotebookResponse) String() string
type DeleteNotebookRequest ¶
type DeleteNotebookRequest struct { Namespace string `protobuf:"bytes,1,opt,name=namespace,proto3" json:"namespace,omitempty"` Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"` // contains filtered or unexported fields }
func (*DeleteNotebookRequest) Descriptor
deprecated
func (*DeleteNotebookRequest) Descriptor() ([]byte, []int)
Deprecated: Use DeleteNotebookRequest.ProtoReflect.Descriptor instead.
func (*DeleteNotebookRequest) GetName ¶
func (x *DeleteNotebookRequest) GetName() string
func (*DeleteNotebookRequest) GetNamespace ¶
func (x *DeleteNotebookRequest) GetNamespace() string
func (*DeleteNotebookRequest) ProtoMessage ¶
func (*DeleteNotebookRequest) ProtoMessage()
func (*DeleteNotebookRequest) ProtoReflect ¶
func (x *DeleteNotebookRequest) ProtoReflect() protoreflect.Message
func (*DeleteNotebookRequest) Reset ¶
func (x *DeleteNotebookRequest) Reset()
func (*DeleteNotebookRequest) String ¶
func (x *DeleteNotebookRequest) String() string
type DeleteNotebookResponse ¶
type DeleteNotebookResponse struct {
// contains filtered or unexported fields
}
func (*DeleteNotebookResponse) Descriptor
deprecated
func (*DeleteNotebookResponse) Descriptor() ([]byte, []int)
Deprecated: Use DeleteNotebookResponse.ProtoReflect.Descriptor instead.
func (*DeleteNotebookResponse) ProtoMessage ¶
func (*DeleteNotebookResponse) ProtoMessage()
func (*DeleteNotebookResponse) ProtoReflect ¶
func (x *DeleteNotebookResponse) ProtoReflect() protoreflect.Message
func (*DeleteNotebookResponse) Reset ¶
func (x *DeleteNotebookResponse) Reset()
func (*DeleteNotebookResponse) String ¶
func (x *DeleteNotebookResponse) String() string
type GetNotebookRequest ¶
type GetNotebookRequest struct { Namespace string `protobuf:"bytes,1,opt,name=namespace,proto3" json:"namespace,omitempty"` Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"` // contains filtered or unexported fields }
func (*GetNotebookRequest) Descriptor
deprecated
func (*GetNotebookRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetNotebookRequest.ProtoReflect.Descriptor instead.
func (*GetNotebookRequest) GetName ¶
func (x *GetNotebookRequest) GetName() string
func (*GetNotebookRequest) GetNamespace ¶
func (x *GetNotebookRequest) GetNamespace() string
func (*GetNotebookRequest) ProtoMessage ¶
func (*GetNotebookRequest) ProtoMessage()
func (*GetNotebookRequest) ProtoReflect ¶
func (x *GetNotebookRequest) ProtoReflect() protoreflect.Message
func (*GetNotebookRequest) Reset ¶
func (x *GetNotebookRequest) Reset()
func (*GetNotebookRequest) String ¶
func (x *GetNotebookRequest) String() string
type GetNotebookResponse ¶
type GetNotebookResponse struct { Notebook *v1alpha1.Notebook `protobuf:"bytes,1,opt,name=notebook,proto3" json:"notebook,omitempty"` Yaml string `protobuf:"bytes,2,opt,name=yaml,proto3" json:"yaml,omitempty"` // contains filtered or unexported fields }
func (*GetNotebookResponse) Descriptor
deprecated
func (*GetNotebookResponse) Descriptor() ([]byte, []int)
Deprecated: Use GetNotebookResponse.ProtoReflect.Descriptor instead.
func (*GetNotebookResponse) GetNotebook ¶ added in v0.4.475
func (x *GetNotebookResponse) GetNotebook() *v1alpha1.Notebook
func (*GetNotebookResponse) GetYaml ¶
func (x *GetNotebookResponse) GetYaml() string
func (*GetNotebookResponse) ProtoMessage ¶
func (*GetNotebookResponse) ProtoMessage()
func (*GetNotebookResponse) ProtoReflect ¶
func (x *GetNotebookResponse) ProtoReflect() protoreflect.Message
func (*GetNotebookResponse) Reset ¶
func (x *GetNotebookResponse) Reset()
func (*GetNotebookResponse) String ¶
func (x *GetNotebookResponse) String() string
type ListNotebooksRequest ¶
type ListNotebooksRequest struct { Namespace string `protobuf:"bytes,1,opt,name=namespace,proto3" json:"namespace,omitempty"` Labels map[string]string `` /* 153-byte string literal not displayed */ PageSize int32 `protobuf:"varint,3,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"` PageToken string `protobuf:"bytes,4,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"` OrderBy string `protobuf:"bytes,5,opt,name=order_by,json=orderBy,proto3" json:"order_by,omitempty"` // contains filtered or unexported fields }
func (*ListNotebooksRequest) Descriptor
deprecated
func (*ListNotebooksRequest) Descriptor() ([]byte, []int)
Deprecated: Use ListNotebooksRequest.ProtoReflect.Descriptor instead.
func (*ListNotebooksRequest) GetLabels ¶
func (x *ListNotebooksRequest) GetLabels() map[string]string
func (*ListNotebooksRequest) GetNamespace ¶
func (x *ListNotebooksRequest) GetNamespace() string
func (*ListNotebooksRequest) GetOrderBy ¶ added in v0.4.414
func (x *ListNotebooksRequest) GetOrderBy() string
func (*ListNotebooksRequest) GetPageSize ¶ added in v0.4.414
func (x *ListNotebooksRequest) GetPageSize() int32
func (*ListNotebooksRequest) GetPageToken ¶ added in v0.4.414
func (x *ListNotebooksRequest) GetPageToken() string
func (*ListNotebooksRequest) ProtoMessage ¶
func (*ListNotebooksRequest) ProtoMessage()
func (*ListNotebooksRequest) ProtoReflect ¶
func (x *ListNotebooksRequest) ProtoReflect() protoreflect.Message
func (*ListNotebooksRequest) Reset ¶
func (x *ListNotebooksRequest) Reset()
func (*ListNotebooksRequest) String ¶
func (x *ListNotebooksRequest) String() string
type ListNotebooksResponse ¶
type ListNotebooksResponse struct { Notebooks *v1alpha1.NotebookList `protobuf:"bytes,1,opt,name=notebooks,proto3" json:"notebooks,omitempty"` NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"` // contains filtered or unexported fields }
func (*ListNotebooksResponse) Descriptor
deprecated
func (*ListNotebooksResponse) Descriptor() ([]byte, []int)
Deprecated: Use ListNotebooksResponse.ProtoReflect.Descriptor instead.
func (*ListNotebooksResponse) GetNextPageToken ¶ added in v0.4.472
func (x *ListNotebooksResponse) GetNextPageToken() string
func (*ListNotebooksResponse) GetNotebooks ¶ added in v0.4.472
func (x *ListNotebooksResponse) GetNotebooks() *v1alpha1.NotebookList
func (*ListNotebooksResponse) ProtoMessage ¶
func (*ListNotebooksResponse) ProtoMessage()
func (*ListNotebooksResponse) ProtoReflect ¶
func (x *ListNotebooksResponse) ProtoReflect() protoreflect.Message
func (*ListNotebooksResponse) Reset ¶
func (x *ListNotebooksResponse) Reset()
func (*ListNotebooksResponse) String ¶
func (x *ListNotebooksResponse) String() string
type NotebookResponse ¶
type NotebookResponse struct {
// contains filtered or unexported fields
}
func (*NotebookResponse) Descriptor
deprecated
func (*NotebookResponse) Descriptor() ([]byte, []int)
Deprecated: Use NotebookResponse.ProtoReflect.Descriptor instead.
func (*NotebookResponse) ProtoMessage ¶
func (*NotebookResponse) ProtoMessage()
func (*NotebookResponse) ProtoReflect ¶
func (x *NotebookResponse) ProtoReflect() protoreflect.Message
func (*NotebookResponse) Reset ¶
func (x *NotebookResponse) Reset()
func (*NotebookResponse) String ¶
func (x *NotebookResponse) String() string
type NotebookServiceClient ¶
type NotebookServiceClient interface { ListNotebooks(ctx context.Context, in *ListNotebooksRequest, opts ...grpc.CallOption) (*ListNotebooksResponse, error) CreateNotebook(ctx context.Context, in *CreateNotebookRequest, opts ...grpc.CallOption) (*CreateNotebookResponse, error) GetNotebook(ctx context.Context, in *GetNotebookRequest, opts ...grpc.CallOption) (*GetNotebookResponse, error) UpdateNotebook(ctx context.Context, in *UpdateNotebookRequest, opts ...grpc.CallOption) (*UpdateNotebookResponse, error) DeleteNotebook(ctx context.Context, in *DeleteNotebookRequest, opts ...grpc.CallOption) (*DeleteNotebookResponse, error) }
NotebookServiceClient is the client API for NotebookService 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 NewNotebookServiceClient ¶
func NewNotebookServiceClient(cc grpc.ClientConnInterface) NotebookServiceClient
type NotebookServiceServer ¶
type NotebookServiceServer interface { ListNotebooks(context.Context, *ListNotebooksRequest) (*ListNotebooksResponse, error) CreateNotebook(context.Context, *CreateNotebookRequest) (*CreateNotebookResponse, error) GetNotebook(context.Context, *GetNotebookRequest) (*GetNotebookResponse, error) UpdateNotebook(context.Context, *UpdateNotebookRequest) (*UpdateNotebookResponse, error) DeleteNotebook(context.Context, *DeleteNotebookRequest) (*DeleteNotebookResponse, error) // contains filtered or unexported methods }
NotebookServiceServer is the server API for NotebookService service. All implementations must embed UnimplementedNotebookServiceServer for forward compatibility
type UnimplementedNotebookServiceServer ¶
type UnimplementedNotebookServiceServer struct { }
UnimplementedNotebookServiceServer must be embedded to have forward compatible implementations.
func (UnimplementedNotebookServiceServer) CreateNotebook ¶
func (UnimplementedNotebookServiceServer) CreateNotebook(context.Context, *CreateNotebookRequest) (*CreateNotebookResponse, error)
func (UnimplementedNotebookServiceServer) DeleteNotebook ¶
func (UnimplementedNotebookServiceServer) DeleteNotebook(context.Context, *DeleteNotebookRequest) (*DeleteNotebookResponse, error)
func (UnimplementedNotebookServiceServer) GetNotebook ¶
func (UnimplementedNotebookServiceServer) GetNotebook(context.Context, *GetNotebookRequest) (*GetNotebookResponse, error)
func (UnimplementedNotebookServiceServer) ListNotebooks ¶
func (UnimplementedNotebookServiceServer) ListNotebooks(context.Context, *ListNotebooksRequest) (*ListNotebooksResponse, error)
func (UnimplementedNotebookServiceServer) UpdateNotebook ¶
func (UnimplementedNotebookServiceServer) UpdateNotebook(context.Context, *UpdateNotebookRequest) (*UpdateNotebookResponse, error)
type UnsafeNotebookServiceServer ¶ added in v0.4.687
type UnsafeNotebookServiceServer interface {
// contains filtered or unexported methods
}
UnsafeNotebookServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to NotebookServiceServer will result in compilation errors.
type UpdateNotebookRequest ¶
type UpdateNotebookRequest struct { Notebook *v1alpha1.Notebook `protobuf:"bytes,1,opt,name=notebook,proto3" json:"notebook,omitempty"` FieldMask *field_mask.FieldMask `protobuf:"bytes,2,opt,name=field_mask,json=fieldMask,proto3" json:"field_mask,omitempty"` // contains filtered or unexported fields }
func (*UpdateNotebookRequest) Descriptor
deprecated
func (*UpdateNotebookRequest) Descriptor() ([]byte, []int)
Deprecated: Use UpdateNotebookRequest.ProtoReflect.Descriptor instead.
func (*UpdateNotebookRequest) GetFieldMask ¶ added in v0.4.422
func (x *UpdateNotebookRequest) GetFieldMask() *field_mask.FieldMask
func (*UpdateNotebookRequest) GetNotebook ¶ added in v0.4.475
func (x *UpdateNotebookRequest) GetNotebook() *v1alpha1.Notebook
func (*UpdateNotebookRequest) ProtoMessage ¶
func (*UpdateNotebookRequest) ProtoMessage()
func (*UpdateNotebookRequest) ProtoReflect ¶
func (x *UpdateNotebookRequest) ProtoReflect() protoreflect.Message
func (*UpdateNotebookRequest) Reset ¶
func (x *UpdateNotebookRequest) Reset()
func (*UpdateNotebookRequest) String ¶
func (x *UpdateNotebookRequest) String() string
type UpdateNotebookResponse ¶
type UpdateNotebookResponse struct {
// contains filtered or unexported fields
}
func (*UpdateNotebookResponse) Descriptor
deprecated
func (*UpdateNotebookResponse) Descriptor() ([]byte, []int)
Deprecated: Use UpdateNotebookResponse.ProtoReflect.Descriptor instead.
func (*UpdateNotebookResponse) ProtoMessage ¶
func (*UpdateNotebookResponse) ProtoMessage()
func (*UpdateNotebookResponse) ProtoReflect ¶
func (x *UpdateNotebookResponse) ProtoReflect() protoreflect.Message
func (*UpdateNotebookResponse) Reset ¶
func (x *UpdateNotebookResponse) Reset()
func (*UpdateNotebookResponse) String ¶
func (x *UpdateNotebookResponse) String() string