Documentation ¶
Overview ¶
Package model is a reverse proxy.
It translates gRPC into RESTful JSON APIs.
Index ¶
- Constants
- Variables
- func RegisterModelHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error
- func RegisterModelHandlerClient(ctx context.Context, mux *runtime.ServeMux, client ModelClient) error
- func RegisterModelHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, ...) (err error)
- func RegisterModelHandlerServer(ctx context.Context, mux *runtime.ServeMux, server ModelServer) error
- func RegisterModelServer(s grpc.ServiceRegistrar, srv ModelServer)
- type Body
- type DeleteManifestRequest
- func (*DeleteManifestRequest) Descriptor() ([]byte, []int)deprecated
- func (x *DeleteManifestRequest) GetEmpty() *emptypb.Empty
- func (*DeleteManifestRequest) ProtoMessage()
- func (x *DeleteManifestRequest) ProtoReflect() protoreflect.Message
- func (x *DeleteManifestRequest) Reset()
- func (x *DeleteManifestRequest) String() string
- type DeleteManifestResponse
- func (*DeleteManifestResponse) Descriptor() ([]byte, []int)deprecated
- func (x *DeleteManifestResponse) GetResult() *emptypb.Empty
- func (*DeleteManifestResponse) ProtoMessage()
- func (x *DeleteManifestResponse) ProtoReflect() protoreflect.Message
- func (x *DeleteManifestResponse) Reset()
- func (x *DeleteManifestResponse) String() string
- type GetManifestRequest
- func (*GetManifestRequest) Descriptor() ([]byte, []int)deprecated
- func (x *GetManifestRequest) GetEmpty() *emptypb.Empty
- func (*GetManifestRequest) ProtoMessage()
- func (x *GetManifestRequest) ProtoReflect() protoreflect.Message
- func (x *GetManifestRequest) Reset()
- func (x *GetManifestRequest) String() string
- type GetManifestResponse
- func (*GetManifestResponse) Descriptor() ([]byte, []int)deprecated
- func (x *GetManifestResponse) GetBody() *Body
- func (x *GetManifestResponse) GetMetadata() *Metadata
- func (x *GetManifestResponse) GetModel() *structpb.Struct
- func (m *GetManifestResponse) GetMsg() isGetManifestResponse_Msg
- func (*GetManifestResponse) ProtoMessage()
- func (x *GetManifestResponse) ProtoReflect() protoreflect.Message
- func (x *GetManifestResponse) Reset()
- func (x *GetManifestResponse) String() string
- type GetManifestResponse_Body
- type GetManifestResponse_Metadata
- type GetManifestResponse_Model
- type Metadata
- type ModelClient
- type ModelServer
- type Model_GetManifestClient
- type Model_GetManifestServer
- type Model_SetManifestClient
- type Model_SetManifestServer
- type SetManifestRequest
- func (*SetManifestRequest) Descriptor() ([]byte, []int)deprecated
- func (x *SetManifestRequest) GetBody() *Body
- func (m *SetManifestRequest) GetMsg() isSetManifestRequest_Msg
- func (*SetManifestRequest) ProtoMessage()
- func (x *SetManifestRequest) ProtoReflect() protoreflect.Message
- func (x *SetManifestRequest) Reset()
- func (x *SetManifestRequest) String() string
- type SetManifestRequest_Body
- type SetManifestResponse
- func (*SetManifestResponse) Descriptor() ([]byte, []int)deprecated
- func (x *SetManifestResponse) GetResult() *emptypb.Empty
- func (*SetManifestResponse) ProtoMessage()
- func (x *SetManifestResponse) ProtoReflect() protoreflect.Message
- func (x *SetManifestResponse) Reset()
- func (x *SetManifestResponse) String() string
- type UnimplementedModelServer
- type UnsafeModelServer
Constants ¶
const ( Model_GetManifest_FullMethodName = "/aserto.directory.model.v3.Model/GetManifest" Model_SetManifest_FullMethodName = "/aserto.directory.model.v3.Model/SetManifest" Model_DeleteManifest_FullMethodName = "/aserto.directory.model.v3.Model/DeleteManifest" )
Variables ¶
var File_aserto_directory_model_v3_model_proto protoreflect.FileDescriptor
var Model_ServiceDesc = grpc.ServiceDesc{ ServiceName: "aserto.directory.model.v3.Model", HandlerType: (*ModelServer)(nil), Methods: []grpc.MethodDesc{ { MethodName: "DeleteManifest", Handler: _Model_DeleteManifest_Handler, }, }, Streams: []grpc.StreamDesc{ { StreamName: "GetManifest", Handler: _Model_GetManifest_Handler, ServerStreams: true, }, { StreamName: "SetManifest", Handler: _Model_SetManifest_Handler, ClientStreams: true, }, }, Metadata: "aserto/directory/model/v3/model.proto", }
Model_ServiceDesc is the grpc.ServiceDesc for Model service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
Functions ¶
func RegisterModelHandler ¶
RegisterModelHandler registers the http handlers for service Model to "mux". The handlers forward requests to the grpc endpoint over "conn".
func RegisterModelHandlerClient ¶
func RegisterModelHandlerClient(ctx context.Context, mux *runtime.ServeMux, client ModelClient) error
RegisterModelHandlerClient registers the http handlers for service Model to "mux". The handlers forward requests to the grpc endpoint over the given implementation of "ModelClient". Note: the gRPC framework executes interceptors within the gRPC handler. If the passed in "ModelClient" doesn't go through the normal gRPC flow (creating a gRPC client etc.) then it will be up to the passed in "ModelClient" to call the correct interceptors.
func RegisterModelHandlerFromEndpoint ¶
func RegisterModelHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, opts []grpc.DialOption) (err error)
RegisterModelHandlerFromEndpoint is same as RegisterModelHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.
func RegisterModelHandlerServer ¶
func RegisterModelHandlerServer(ctx context.Context, mux *runtime.ServeMux, server ModelServer) error
RegisterModelHandlerServer registers the http handlers for service Model to "mux". UnaryRPC :call ModelServer 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 RegisterModelHandlerFromEndpoint instead.
func RegisterModelServer ¶
func RegisterModelServer(s grpc.ServiceRegistrar, srv ModelServer)
Types ¶
type Body ¶
type Body struct { // manifest content Data []byte `protobuf:"bytes,2,opt,name=data,proto3" json:"data,omitempty"` // contains filtered or unexported fields }
func (*Body) Descriptor
deprecated
func (*Body) ProtoMessage ¶
func (*Body) ProtoMessage()
func (*Body) ProtoReflect ¶
func (x *Body) ProtoReflect() protoreflect.Message
type DeleteManifestRequest ¶
type DeleteManifestRequest struct { // empty request Empty *emptypb.Empty `protobuf:"bytes,1,opt,name=empty,proto3" json:"empty,omitempty"` // contains filtered or unexported fields }
func (*DeleteManifestRequest) Descriptor
deprecated
func (*DeleteManifestRequest) Descriptor() ([]byte, []int)
Deprecated: Use DeleteManifestRequest.ProtoReflect.Descriptor instead.
func (*DeleteManifestRequest) GetEmpty ¶
func (x *DeleteManifestRequest) GetEmpty() *emptypb.Empty
func (*DeleteManifestRequest) ProtoMessage ¶
func (*DeleteManifestRequest) ProtoMessage()
func (*DeleteManifestRequest) ProtoReflect ¶
func (x *DeleteManifestRequest) ProtoReflect() protoreflect.Message
func (*DeleteManifestRequest) Reset ¶
func (x *DeleteManifestRequest) Reset()
func (*DeleteManifestRequest) String ¶
func (x *DeleteManifestRequest) String() string
type DeleteManifestResponse ¶
type DeleteManifestResponse struct { // empty result Result *emptypb.Empty `protobuf:"bytes,1,opt,name=result,proto3" json:"result,omitempty"` // contains filtered or unexported fields }
func (*DeleteManifestResponse) Descriptor
deprecated
func (*DeleteManifestResponse) Descriptor() ([]byte, []int)
Deprecated: Use DeleteManifestResponse.ProtoReflect.Descriptor instead.
func (*DeleteManifestResponse) GetResult ¶
func (x *DeleteManifestResponse) GetResult() *emptypb.Empty
func (*DeleteManifestResponse) ProtoMessage ¶
func (*DeleteManifestResponse) ProtoMessage()
func (*DeleteManifestResponse) ProtoReflect ¶
func (x *DeleteManifestResponse) ProtoReflect() protoreflect.Message
func (*DeleteManifestResponse) Reset ¶
func (x *DeleteManifestResponse) Reset()
func (*DeleteManifestResponse) String ¶
func (x *DeleteManifestResponse) String() string
type GetManifestRequest ¶
type GetManifestRequest struct { // empty request Empty *emptypb.Empty `protobuf:"bytes,1,opt,name=empty,proto3" json:"empty,omitempty"` // contains filtered or unexported fields }
func (*GetManifestRequest) Descriptor
deprecated
func (*GetManifestRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetManifestRequest.ProtoReflect.Descriptor instead.
func (*GetManifestRequest) GetEmpty ¶
func (x *GetManifestRequest) GetEmpty() *emptypb.Empty
func (*GetManifestRequest) ProtoMessage ¶
func (*GetManifestRequest) ProtoMessage()
func (*GetManifestRequest) ProtoReflect ¶
func (x *GetManifestRequest) ProtoReflect() protoreflect.Message
func (*GetManifestRequest) Reset ¶
func (x *GetManifestRequest) Reset()
func (*GetManifestRequest) String ¶
func (x *GetManifestRequest) String() string
type GetManifestResponse ¶
type GetManifestResponse struct { // Types that are assignable to Msg: // // *GetManifestResponse_Metadata // *GetManifestResponse_Body // *GetManifestResponse_Model Msg isGetManifestResponse_Msg `protobuf_oneof:"msg"` // contains filtered or unexported fields }
func (*GetManifestResponse) Descriptor
deprecated
func (*GetManifestResponse) Descriptor() ([]byte, []int)
Deprecated: Use GetManifestResponse.ProtoReflect.Descriptor instead.
func (*GetManifestResponse) GetBody ¶
func (x *GetManifestResponse) GetBody() *Body
func (*GetManifestResponse) GetMetadata ¶
func (x *GetManifestResponse) GetMetadata() *Metadata
func (*GetManifestResponse) GetModel ¶
func (x *GetManifestResponse) GetModel() *structpb.Struct
func (*GetManifestResponse) GetMsg ¶
func (m *GetManifestResponse) GetMsg() isGetManifestResponse_Msg
func (*GetManifestResponse) ProtoMessage ¶
func (*GetManifestResponse) ProtoMessage()
func (*GetManifestResponse) ProtoReflect ¶
func (x *GetManifestResponse) ProtoReflect() protoreflect.Message
func (*GetManifestResponse) Reset ¶
func (x *GetManifestResponse) Reset()
func (*GetManifestResponse) String ¶
func (x *GetManifestResponse) String() string
type GetManifestResponse_Body ¶
type GetManifestResponse_Body struct { // Manifest content Body *Body `protobuf:"bytes,2,opt,name=body,proto3,oneof"` }
type GetManifestResponse_Metadata ¶
type GetManifestResponse_Metadata struct { // Manifest metadata Metadata *Metadata `protobuf:"bytes,1,opt,name=metadata,proto3,oneof"` }
type Metadata ¶
type Metadata struct { // last updated timestamp (UTC) UpdatedAt *timestamppb.Timestamp `protobuf:"bytes,21,opt,name=updated_at,json=updatedAt,proto3" json:"updated_at,omitempty"` // object instance etag Etag string `protobuf:"bytes,23,opt,name=etag,proto3" json:"etag,omitempty"` // contains filtered or unexported fields }
func (*Metadata) Descriptor
deprecated
func (*Metadata) GetUpdatedAt ¶
func (x *Metadata) GetUpdatedAt() *timestamppb.Timestamp
func (*Metadata) ProtoMessage ¶
func (*Metadata) ProtoMessage()
func (*Metadata) ProtoReflect ¶
func (x *Metadata) ProtoReflect() protoreflect.Message
type ModelClient ¶
type ModelClient interface { GetManifest(ctx context.Context, in *GetManifestRequest, opts ...grpc.CallOption) (Model_GetManifestClient, error) SetManifest(ctx context.Context, opts ...grpc.CallOption) (Model_SetManifestClient, error) DeleteManifest(ctx context.Context, in *DeleteManifestRequest, opts ...grpc.CallOption) (*DeleteManifestResponse, error) }
ModelClient is the client API for Model 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 NewModelClient ¶
func NewModelClient(cc grpc.ClientConnInterface) ModelClient
type ModelServer ¶
type ModelServer interface { GetManifest(*GetManifestRequest, Model_GetManifestServer) error SetManifest(Model_SetManifestServer) error DeleteManifest(context.Context, *DeleteManifestRequest) (*DeleteManifestResponse, error) }
ModelServer is the server API for Model service. All implementations should embed UnimplementedModelServer for forward compatibility
type Model_GetManifestClient ¶
type Model_GetManifestClient interface { Recv() (*GetManifestResponse, error) grpc.ClientStream }
type Model_GetManifestServer ¶
type Model_GetManifestServer interface { Send(*GetManifestResponse) error grpc.ServerStream }
type Model_SetManifestClient ¶
type Model_SetManifestClient interface { Send(*SetManifestRequest) error CloseAndRecv() (*SetManifestResponse, error) grpc.ClientStream }
type Model_SetManifestServer ¶
type Model_SetManifestServer interface { SendAndClose(*SetManifestResponse) error Recv() (*SetManifestRequest, error) grpc.ServerStream }
type SetManifestRequest ¶
type SetManifestRequest struct { // manifest instance // // Types that are assignable to Msg: // // *SetManifestRequest_Body Msg isSetManifestRequest_Msg `protobuf_oneof:"msg"` // contains filtered or unexported fields }
func (*SetManifestRequest) Descriptor
deprecated
func (*SetManifestRequest) Descriptor() ([]byte, []int)
Deprecated: Use SetManifestRequest.ProtoReflect.Descriptor instead.
func (*SetManifestRequest) GetBody ¶
func (x *SetManifestRequest) GetBody() *Body
func (*SetManifestRequest) GetMsg ¶
func (m *SetManifestRequest) GetMsg() isSetManifestRequest_Msg
func (*SetManifestRequest) ProtoMessage ¶
func (*SetManifestRequest) ProtoMessage()
func (*SetManifestRequest) ProtoReflect ¶
func (x *SetManifestRequest) ProtoReflect() protoreflect.Message
func (*SetManifestRequest) Reset ¶
func (x *SetManifestRequest) Reset()
func (*SetManifestRequest) String ¶
func (x *SetManifestRequest) String() string
type SetManifestRequest_Body ¶
type SetManifestRequest_Body struct { // Manifest content Body *Body `protobuf:"bytes,1,opt,name=body,proto3,oneof"` }
type SetManifestResponse ¶
type SetManifestResponse struct { // empty result Result *emptypb.Empty `protobuf:"bytes,1,opt,name=result,proto3" json:"result,omitempty"` // contains filtered or unexported fields }
func (*SetManifestResponse) Descriptor
deprecated
func (*SetManifestResponse) Descriptor() ([]byte, []int)
Deprecated: Use SetManifestResponse.ProtoReflect.Descriptor instead.
func (*SetManifestResponse) GetResult ¶
func (x *SetManifestResponse) GetResult() *emptypb.Empty
func (*SetManifestResponse) ProtoMessage ¶
func (*SetManifestResponse) ProtoMessage()
func (*SetManifestResponse) ProtoReflect ¶
func (x *SetManifestResponse) ProtoReflect() protoreflect.Message
func (*SetManifestResponse) Reset ¶
func (x *SetManifestResponse) Reset()
func (*SetManifestResponse) String ¶
func (x *SetManifestResponse) String() string
type UnimplementedModelServer ¶
type UnimplementedModelServer struct { }
UnimplementedModelServer should be embedded to have forward compatible implementations.
func (UnimplementedModelServer) DeleteManifest ¶
func (UnimplementedModelServer) DeleteManifest(context.Context, *DeleteManifestRequest) (*DeleteManifestResponse, error)
func (UnimplementedModelServer) GetManifest ¶
func (UnimplementedModelServer) GetManifest(*GetManifestRequest, Model_GetManifestServer) error
func (UnimplementedModelServer) SetManifest ¶
func (UnimplementedModelServer) SetManifest(Model_SetManifestServer) error
type UnsafeModelServer ¶
type UnsafeModelServer interface {
// contains filtered or unexported methods
}
UnsafeModelServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to ModelServer will result in compilation errors.