Documentation
¶
Overview ¶
Package v1 is a reverse proxy.
It translates gRPC into RESTful JSON APIs.
Index ¶
- Variables
- func RegisterEntityServiceHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error
- func RegisterEntityServiceHandlerClient(ctx context.Context, mux *runtime.ServeMux, client EntityServiceClient) error
- func RegisterEntityServiceHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, ...) (err error)
- func RegisterEntityServiceHandlerServer(ctx context.Context, mux *runtime.ServeMux, server EntityServiceServer) error
- func RegisterEntityServiceServer(s grpc.ServiceRegistrar, srv EntityServiceServer)
- type CreateEntityRequest
- func (*CreateEntityRequest) Descriptor() ([]byte, []int)deprecated
- func (x *CreateEntityRequest) GetEntity() *v1alpha1.Entity
- func (*CreateEntityRequest) ProtoMessage()
- func (x *CreateEntityRequest) ProtoReflect() protoreflect.Message
- func (x *CreateEntityRequest) Reset()
- func (x *CreateEntityRequest) String() string
- type CreateEntityResponse
- type DeleteEntityRequest
- func (*DeleteEntityRequest) Descriptor() ([]byte, []int)deprecated
- func (x *DeleteEntityRequest) GetName() string
- func (x *DeleteEntityRequest) GetNamespace() string
- func (*DeleteEntityRequest) ProtoMessage()
- func (x *DeleteEntityRequest) ProtoReflect() protoreflect.Message
- func (x *DeleteEntityRequest) Reset()
- func (x *DeleteEntityRequest) String() string
- type DeleteEntityResponse
- type EntityServiceClient
- type EntityServiceServer
- type GetEntityRequest
- func (*GetEntityRequest) Descriptor() ([]byte, []int)deprecated
- func (x *GetEntityRequest) GetFieldMask() *field_mask.FieldMask
- func (x *GetEntityRequest) GetName() string
- func (x *GetEntityRequest) GetNamespace() string
- func (*GetEntityRequest) ProtoMessage()
- func (x *GetEntityRequest) ProtoReflect() protoreflect.Message
- func (x *GetEntityRequest) Reset()
- func (x *GetEntityRequest) String() string
- type GetEntityResponse
- func (*GetEntityResponse) Descriptor() ([]byte, []int)deprecated
- func (x *GetEntityResponse) GetEntity() *v1alpha1.Entity
- func (x *GetEntityResponse) GetYaml() string
- func (*GetEntityResponse) ProtoMessage()
- func (x *GetEntityResponse) ProtoReflect() protoreflect.Message
- func (x *GetEntityResponse) Reset()
- func (x *GetEntityResponse) String() string
- type ListEntitiesRequest
- func (*ListEntitiesRequest) Descriptor() ([]byte, []int)deprecated
- func (x *ListEntitiesRequest) GetLabels() map[string]string
- func (x *ListEntitiesRequest) GetNamespace() string
- func (x *ListEntitiesRequest) GetOrderBy() string
- func (x *ListEntitiesRequest) GetPageSize() int32
- func (x *ListEntitiesRequest) GetPageToken() string
- func (*ListEntitiesRequest) ProtoMessage()
- func (x *ListEntitiesRequest) ProtoReflect() protoreflect.Message
- func (x *ListEntitiesRequest) Reset()
- func (x *ListEntitiesRequest) String() string
- type ListEntitiesResponse
- func (*ListEntitiesResponse) Descriptor() ([]byte, []int)deprecated
- func (x *ListEntitiesResponse) GetEntities() *v1alpha1.EntityList
- func (x *ListEntitiesResponse) GetNextPageToken() string
- func (*ListEntitiesResponse) ProtoMessage()
- func (x *ListEntitiesResponse) ProtoReflect() protoreflect.Message
- func (x *ListEntitiesResponse) Reset()
- func (x *ListEntitiesResponse) String() string
- type UnimplementedEntityServiceServer
- func (UnimplementedEntityServiceServer) CreateEntity(context.Context, *CreateEntityRequest) (*CreateEntityResponse, error)
- func (UnimplementedEntityServiceServer) DeleteEntity(context.Context, *DeleteEntityRequest) (*DeleteEntityResponse, error)
- func (UnimplementedEntityServiceServer) GetEntity(context.Context, *GetEntityRequest) (*GetEntityResponse, error)
- func (UnimplementedEntityServiceServer) ListEntities(context.Context, *ListEntitiesRequest) (*ListEntitiesResponse, error)
- func (UnimplementedEntityServiceServer) UpdateEntity(context.Context, *UpdateEntityRequest) (*UpdateEntityResponse, error)
- type UnsafeEntityServiceServer
- type UpdateEntityRequest
- func (*UpdateEntityRequest) Descriptor() ([]byte, []int)deprecated
- func (x *UpdateEntityRequest) GetEntity() *v1alpha1.Entity
- func (x *UpdateEntityRequest) GetFieldMask() *field_mask.FieldMask
- func (*UpdateEntityRequest) ProtoMessage()
- func (x *UpdateEntityRequest) ProtoReflect() protoreflect.Message
- func (x *UpdateEntityRequest) Reset()
- func (x *UpdateEntityRequest) String() string
- type UpdateEntityResponse
Constants ¶
This section is empty.
Variables ¶
var EntityService_ServiceDesc = grpc.ServiceDesc{ ServiceName: "github.com.metaprov.modelaapi.services.entity.v1.EntityService", HandlerType: (*EntityServiceServer)(nil), Methods: []grpc.MethodDesc{ { MethodName: "ListEntities", Handler: _EntityService_ListEntities_Handler, }, { MethodName: "CreateEntity", Handler: _EntityService_CreateEntity_Handler, }, { MethodName: "GetEntity", Handler: _EntityService_GetEntity_Handler, }, { MethodName: "UpdateEntity", Handler: _EntityService_UpdateEntity_Handler, }, { MethodName: "DeleteEntity", Handler: _EntityService_DeleteEntity_Handler, }, }, Streams: []grpc.StreamDesc{}, Metadata: "github.com/metaprov/modelaapi/services/entity/v1/entity.proto", }
EntityService_ServiceDesc is the grpc.ServiceDesc for EntityService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
var File_github_com_metaprov_modelaapi_services_entity_v1_entity_proto protoreflect.FileDescriptor
Functions ¶
func RegisterEntityServiceHandler ¶ added in v0.4.687
func RegisterEntityServiceHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error
RegisterEntityServiceHandler registers the http handlers for service EntityService to "mux". The handlers forward requests to the grpc endpoint over "conn".
func RegisterEntityServiceHandlerClient ¶ added in v0.4.687
func RegisterEntityServiceHandlerClient(ctx context.Context, mux *runtime.ServeMux, client EntityServiceClient) error
RegisterEntityServiceHandlerClient registers the http handlers for service EntityService to "mux". The handlers forward requests to the grpc endpoint over the given implementation of "EntityServiceClient". Note: the gRPC framework executes interceptors within the gRPC handler. If the passed in "EntityServiceClient" doesn't go through the normal gRPC flow (creating a gRPC client etc.) then it will be up to the passed in "EntityServiceClient" to call the correct interceptors.
func RegisterEntityServiceHandlerFromEndpoint ¶ added in v0.4.687
func RegisterEntityServiceHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, opts []grpc.DialOption) (err error)
RegisterEntityServiceHandlerFromEndpoint is same as RegisterEntityServiceHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.
func RegisterEntityServiceHandlerServer ¶ added in v0.4.687
func RegisterEntityServiceHandlerServer(ctx context.Context, mux *runtime.ServeMux, server EntityServiceServer) error
RegisterEntityServiceHandlerServer registers the http handlers for service EntityService to "mux". UnaryRPC :call EntityServiceServer 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 RegisterEntityServiceHandlerFromEndpoint instead.
func RegisterEntityServiceServer ¶
func RegisterEntityServiceServer(s grpc.ServiceRegistrar, srv EntityServiceServer)
Types ¶
type CreateEntityRequest ¶
type CreateEntityRequest struct { Entity *v1alpha1.Entity `protobuf:"bytes,1,opt,name=entity,proto3" json:"entity,omitempty"` // contains filtered or unexported fields }
func (*CreateEntityRequest) Descriptor
deprecated
func (*CreateEntityRequest) Descriptor() ([]byte, []int)
Deprecated: Use CreateEntityRequest.ProtoReflect.Descriptor instead.
func (*CreateEntityRequest) GetEntity ¶ added in v0.4.472
func (x *CreateEntityRequest) GetEntity() *v1alpha1.Entity
func (*CreateEntityRequest) ProtoMessage ¶
func (*CreateEntityRequest) ProtoMessage()
func (*CreateEntityRequest) ProtoReflect ¶
func (x *CreateEntityRequest) ProtoReflect() protoreflect.Message
func (*CreateEntityRequest) Reset ¶
func (x *CreateEntityRequest) Reset()
func (*CreateEntityRequest) String ¶
func (x *CreateEntityRequest) String() string
type CreateEntityResponse ¶
type CreateEntityResponse struct {
// contains filtered or unexported fields
}
func (*CreateEntityResponse) Descriptor
deprecated
func (*CreateEntityResponse) Descriptor() ([]byte, []int)
Deprecated: Use CreateEntityResponse.ProtoReflect.Descriptor instead.
func (*CreateEntityResponse) ProtoMessage ¶
func (*CreateEntityResponse) ProtoMessage()
func (*CreateEntityResponse) ProtoReflect ¶
func (x *CreateEntityResponse) ProtoReflect() protoreflect.Message
func (*CreateEntityResponse) Reset ¶
func (x *CreateEntityResponse) Reset()
func (*CreateEntityResponse) String ¶
func (x *CreateEntityResponse) String() string
type DeleteEntityRequest ¶
type DeleteEntityRequest 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 (*DeleteEntityRequest) Descriptor
deprecated
func (*DeleteEntityRequest) Descriptor() ([]byte, []int)
Deprecated: Use DeleteEntityRequest.ProtoReflect.Descriptor instead.
func (*DeleteEntityRequest) GetName ¶
func (x *DeleteEntityRequest) GetName() string
func (*DeleteEntityRequest) GetNamespace ¶
func (x *DeleteEntityRequest) GetNamespace() string
func (*DeleteEntityRequest) ProtoMessage ¶
func (*DeleteEntityRequest) ProtoMessage()
func (*DeleteEntityRequest) ProtoReflect ¶
func (x *DeleteEntityRequest) ProtoReflect() protoreflect.Message
func (*DeleteEntityRequest) Reset ¶
func (x *DeleteEntityRequest) Reset()
func (*DeleteEntityRequest) String ¶
func (x *DeleteEntityRequest) String() string
type DeleteEntityResponse ¶
type DeleteEntityResponse struct {
// contains filtered or unexported fields
}
func (*DeleteEntityResponse) Descriptor
deprecated
func (*DeleteEntityResponse) Descriptor() ([]byte, []int)
Deprecated: Use DeleteEntityResponse.ProtoReflect.Descriptor instead.
func (*DeleteEntityResponse) ProtoMessage ¶
func (*DeleteEntityResponse) ProtoMessage()
func (*DeleteEntityResponse) ProtoReflect ¶
func (x *DeleteEntityResponse) ProtoReflect() protoreflect.Message
func (*DeleteEntityResponse) Reset ¶
func (x *DeleteEntityResponse) Reset()
func (*DeleteEntityResponse) String ¶
func (x *DeleteEntityResponse) String() string
type EntityServiceClient ¶
type EntityServiceClient interface { ListEntities(ctx context.Context, in *ListEntitiesRequest, opts ...grpc.CallOption) (*ListEntitiesResponse, error) CreateEntity(ctx context.Context, in *CreateEntityRequest, opts ...grpc.CallOption) (*CreateEntityResponse, error) GetEntity(ctx context.Context, in *GetEntityRequest, opts ...grpc.CallOption) (*GetEntityResponse, error) UpdateEntity(ctx context.Context, in *UpdateEntityRequest, opts ...grpc.CallOption) (*UpdateEntityResponse, error) DeleteEntity(ctx context.Context, in *DeleteEntityRequest, opts ...grpc.CallOption) (*DeleteEntityResponse, error) }
EntityServiceClient is the client API for EntityService 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 NewEntityServiceClient ¶
func NewEntityServiceClient(cc grpc.ClientConnInterface) EntityServiceClient
type EntityServiceServer ¶
type EntityServiceServer interface { ListEntities(context.Context, *ListEntitiesRequest) (*ListEntitiesResponse, error) CreateEntity(context.Context, *CreateEntityRequest) (*CreateEntityResponse, error) GetEntity(context.Context, *GetEntityRequest) (*GetEntityResponse, error) UpdateEntity(context.Context, *UpdateEntityRequest) (*UpdateEntityResponse, error) DeleteEntity(context.Context, *DeleteEntityRequest) (*DeleteEntityResponse, error) // contains filtered or unexported methods }
EntityServiceServer is the server API for EntityService service. All implementations must embed UnimplementedEntityServiceServer for forward compatibility
type GetEntityRequest ¶
type GetEntityRequest 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"` FieldMask *field_mask.FieldMask `protobuf:"bytes,3,opt,name=field_mask,json=fieldMask,proto3" json:"field_mask,omitempty"` // contains filtered or unexported fields }
func (*GetEntityRequest) Descriptor
deprecated
func (*GetEntityRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetEntityRequest.ProtoReflect.Descriptor instead.
func (*GetEntityRequest) GetFieldMask ¶ added in v0.4.422
func (x *GetEntityRequest) GetFieldMask() *field_mask.FieldMask
func (*GetEntityRequest) GetName ¶
func (x *GetEntityRequest) GetName() string
func (*GetEntityRequest) GetNamespace ¶
func (x *GetEntityRequest) GetNamespace() string
func (*GetEntityRequest) ProtoMessage ¶
func (*GetEntityRequest) ProtoMessage()
func (*GetEntityRequest) ProtoReflect ¶
func (x *GetEntityRequest) ProtoReflect() protoreflect.Message
func (*GetEntityRequest) Reset ¶
func (x *GetEntityRequest) Reset()
func (*GetEntityRequest) String ¶
func (x *GetEntityRequest) String() string
type GetEntityResponse ¶
type GetEntityResponse struct { Entity *v1alpha1.Entity `protobuf:"bytes,1,opt,name=entity,proto3" json:"entity,omitempty"` Yaml string `protobuf:"bytes,2,opt,name=yaml,proto3" json:"yaml,omitempty"` // contains filtered or unexported fields }
func (*GetEntityResponse) Descriptor
deprecated
func (*GetEntityResponse) Descriptor() ([]byte, []int)
Deprecated: Use GetEntityResponse.ProtoReflect.Descriptor instead.
func (*GetEntityResponse) GetEntity ¶ added in v0.4.475
func (x *GetEntityResponse) GetEntity() *v1alpha1.Entity
func (*GetEntityResponse) GetYaml ¶
func (x *GetEntityResponse) GetYaml() string
func (*GetEntityResponse) ProtoMessage ¶
func (*GetEntityResponse) ProtoMessage()
func (*GetEntityResponse) ProtoReflect ¶
func (x *GetEntityResponse) ProtoReflect() protoreflect.Message
func (*GetEntityResponse) Reset ¶
func (x *GetEntityResponse) Reset()
func (*GetEntityResponse) String ¶
func (x *GetEntityResponse) String() string
type ListEntitiesRequest ¶
type ListEntitiesRequest 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 (*ListEntitiesRequest) Descriptor
deprecated
func (*ListEntitiesRequest) Descriptor() ([]byte, []int)
Deprecated: Use ListEntitiesRequest.ProtoReflect.Descriptor instead.
func (*ListEntitiesRequest) GetLabels ¶
func (x *ListEntitiesRequest) GetLabels() map[string]string
func (*ListEntitiesRequest) GetNamespace ¶
func (x *ListEntitiesRequest) GetNamespace() string
func (*ListEntitiesRequest) GetOrderBy ¶ added in v0.4.414
func (x *ListEntitiesRequest) GetOrderBy() string
func (*ListEntitiesRequest) GetPageSize ¶ added in v0.4.414
func (x *ListEntitiesRequest) GetPageSize() int32
func (*ListEntitiesRequest) GetPageToken ¶ added in v0.4.414
func (x *ListEntitiesRequest) GetPageToken() string
func (*ListEntitiesRequest) ProtoMessage ¶
func (*ListEntitiesRequest) ProtoMessage()
func (*ListEntitiesRequest) ProtoReflect ¶
func (x *ListEntitiesRequest) ProtoReflect() protoreflect.Message
func (*ListEntitiesRequest) Reset ¶
func (x *ListEntitiesRequest) Reset()
func (*ListEntitiesRequest) String ¶
func (x *ListEntitiesRequest) String() string
type ListEntitiesResponse ¶
type ListEntitiesResponse struct { Entities *v1alpha1.EntityList `protobuf:"bytes,1,opt,name=entities,proto3" json:"entities,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 (*ListEntitiesResponse) Descriptor
deprecated
func (*ListEntitiesResponse) Descriptor() ([]byte, []int)
Deprecated: Use ListEntitiesResponse.ProtoReflect.Descriptor instead.
func (*ListEntitiesResponse) GetEntities ¶ added in v0.4.472
func (x *ListEntitiesResponse) GetEntities() *v1alpha1.EntityList
func (*ListEntitiesResponse) GetNextPageToken ¶ added in v0.4.472
func (x *ListEntitiesResponse) GetNextPageToken() string
func (*ListEntitiesResponse) ProtoMessage ¶
func (*ListEntitiesResponse) ProtoMessage()
func (*ListEntitiesResponse) ProtoReflect ¶
func (x *ListEntitiesResponse) ProtoReflect() protoreflect.Message
func (*ListEntitiesResponse) Reset ¶
func (x *ListEntitiesResponse) Reset()
func (*ListEntitiesResponse) String ¶
func (x *ListEntitiesResponse) String() string
type UnimplementedEntityServiceServer ¶
type UnimplementedEntityServiceServer struct { }
UnimplementedEntityServiceServer must be embedded to have forward compatible implementations.
func (UnimplementedEntityServiceServer) CreateEntity ¶
func (UnimplementedEntityServiceServer) CreateEntity(context.Context, *CreateEntityRequest) (*CreateEntityResponse, error)
func (UnimplementedEntityServiceServer) DeleteEntity ¶
func (UnimplementedEntityServiceServer) DeleteEntity(context.Context, *DeleteEntityRequest) (*DeleteEntityResponse, error)
func (UnimplementedEntityServiceServer) GetEntity ¶
func (UnimplementedEntityServiceServer) GetEntity(context.Context, *GetEntityRequest) (*GetEntityResponse, error)
func (UnimplementedEntityServiceServer) ListEntities ¶
func (UnimplementedEntityServiceServer) ListEntities(context.Context, *ListEntitiesRequest) (*ListEntitiesResponse, error)
func (UnimplementedEntityServiceServer) UpdateEntity ¶
func (UnimplementedEntityServiceServer) UpdateEntity(context.Context, *UpdateEntityRequest) (*UpdateEntityResponse, error)
type UnsafeEntityServiceServer ¶ added in v0.4.687
type UnsafeEntityServiceServer interface {
// contains filtered or unexported methods
}
UnsafeEntityServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to EntityServiceServer will result in compilation errors.
type UpdateEntityRequest ¶
type UpdateEntityRequest struct { Entity *v1alpha1.Entity `protobuf:"bytes,1,opt,name=entity,proto3" json:"entity,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 (*UpdateEntityRequest) Descriptor
deprecated
func (*UpdateEntityRequest) Descriptor() ([]byte, []int)
Deprecated: Use UpdateEntityRequest.ProtoReflect.Descriptor instead.
func (*UpdateEntityRequest) GetEntity ¶ added in v0.4.475
func (x *UpdateEntityRequest) GetEntity() *v1alpha1.Entity
func (*UpdateEntityRequest) GetFieldMask ¶ added in v0.4.422
func (x *UpdateEntityRequest) GetFieldMask() *field_mask.FieldMask
func (*UpdateEntityRequest) ProtoMessage ¶
func (*UpdateEntityRequest) ProtoMessage()
func (*UpdateEntityRequest) ProtoReflect ¶
func (x *UpdateEntityRequest) ProtoReflect() protoreflect.Message
func (*UpdateEntityRequest) Reset ¶
func (x *UpdateEntityRequest) Reset()
func (*UpdateEntityRequest) String ¶
func (x *UpdateEntityRequest) String() string
type UpdateEntityResponse ¶
type UpdateEntityResponse struct {
// contains filtered or unexported fields
}
func (*UpdateEntityResponse) Descriptor
deprecated
func (*UpdateEntityResponse) Descriptor() ([]byte, []int)
Deprecated: Use UpdateEntityResponse.ProtoReflect.Descriptor instead.
func (*UpdateEntityResponse) ProtoMessage ¶
func (*UpdateEntityResponse) ProtoMessage()
func (*UpdateEntityResponse) ProtoReflect ¶
func (x *UpdateEntityResponse) ProtoReflect() protoreflect.Message
func (*UpdateEntityResponse) Reset ¶
func (x *UpdateEntityResponse) Reset()
func (*UpdateEntityResponse) String ¶
func (x *UpdateEntityResponse) String() string