Documentation ¶
Overview ¶
Package statusv1 is a reverse proxy.
It translates gRPC into RESTful JSON APIs.
Code generated by protoc-gen-deepcopy. DO NOT EDIT.
Index ¶
- Variables
- func RegisterStatusServiceHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error
- func RegisterStatusServiceHandlerClient(ctx context.Context, mux *runtime.ServeMux, client StatusServiceClient) error
- func RegisterStatusServiceHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, ...) (err error)
- func RegisterStatusServiceHandlerServer(ctx context.Context, mux *runtime.ServeMux, server StatusServiceServer) error
- func RegisterStatusServiceServer(s grpc.ServiceRegistrar, srv StatusServiceServer)
- type ErrorDetails
- func (in *ErrorDetails) DeepCopy() *ErrorDetails
- func (in *ErrorDetails) DeepCopyInterface() interface{}
- func (in *ErrorDetails) DeepCopyInto(out *ErrorDetails)
- func (*ErrorDetails) Descriptor() ([]byte, []int)deprecated
- func (x *ErrorDetails) GetMessage() string
- func (msg *ErrorDetails) MarshalJSON() ([]byte, error)
- func (*ErrorDetails) ProtoMessage()
- func (x *ErrorDetails) ProtoReflect() protoreflect.Message
- func (x *ErrorDetails) Reset()
- func (x *ErrorDetails) String() string
- func (msg *ErrorDetails) UnmarshalJSON(b []byte) error
- type GroupStatus
- func (in *GroupStatus) DeepCopy() *GroupStatus
- func (in *GroupStatus) DeepCopyInterface() interface{}
- func (in *GroupStatus) DeepCopyInto(out *GroupStatus)
- func (*GroupStatus) Descriptor() ([]byte, []int)deprecated
- func (x *GroupStatus) GetGroups() map[string]*GroupStatus
- func (x *GroupStatus) GetStatus() *Status
- func (msg *GroupStatus) MarshalJSON() ([]byte, error)
- func (*GroupStatus) ProtoMessage()
- func (x *GroupStatus) ProtoReflect() protoreflect.Message
- func (x *GroupStatus) Reset()
- func (x *GroupStatus) String() string
- func (msg *GroupStatus) UnmarshalJSON(b []byte) error
- type GroupStatusRequest
- func (in *GroupStatusRequest) DeepCopy() *GroupStatusRequest
- func (in *GroupStatusRequest) DeepCopyInterface() interface{}
- func (in *GroupStatusRequest) DeepCopyInto(out *GroupStatusRequest)
- func (*GroupStatusRequest) Descriptor() ([]byte, []int)deprecated
- func (x *GroupStatusRequest) GetPath() string
- func (msg *GroupStatusRequest) MarshalJSON() ([]byte, error)
- func (*GroupStatusRequest) ProtoMessage()
- func (x *GroupStatusRequest) ProtoReflect() protoreflect.Message
- func (x *GroupStatusRequest) Reset()
- func (x *GroupStatusRequest) String() string
- func (msg *GroupStatusRequest) UnmarshalJSON(b []byte) error
- type Status
- func (in *Status) DeepCopy() *Status
- func (in *Status) DeepCopyInterface() interface{}
- func (in *Status) DeepCopyInto(out *Status)
- func (*Status) Descriptor() ([]byte, []int)deprecated
- func (m *Status) GetDetails() isStatus_Details
- func (x *Status) GetError() *ErrorDetails
- func (x *Status) GetMessage() *anypb.Any
- func (x *Status) GetTimestamp() *timestamppb.Timestamp
- func (msg *Status) MarshalJSON() ([]byte, error)
- func (*Status) ProtoMessage()
- func (x *Status) ProtoReflect() protoreflect.Message
- func (x *Status) Reset()
- func (x *Status) String() string
- func (msg *Status) UnmarshalJSON(b []byte) error
- type StatusServiceClient
- type StatusServiceServer
- type Status_Error
- type Status_Message
- type UnimplementedStatusServiceServer
- type UnsafeStatusServiceServer
Constants ¶
This section is empty.
Variables ¶
var File_aperture_common_status_v1_status_proto protoreflect.FileDescriptor
var StatusService_ServiceDesc = grpc.ServiceDesc{ ServiceName: "aperture.common.status.v1.StatusService", HandlerType: (*StatusServiceServer)(nil), Methods: []grpc.MethodDesc{ { MethodName: "GetGroupStatus", Handler: _StatusService_GetGroupStatus_Handler, }, }, Streams: []grpc.StreamDesc{}, Metadata: "aperture/common/status/v1/status.proto", }
StatusService_ServiceDesc is the grpc.ServiceDesc for StatusService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
Functions ¶
func RegisterStatusServiceHandler ¶
func RegisterStatusServiceHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error
RegisterStatusServiceHandler registers the http handlers for service StatusService to "mux". The handlers forward requests to the grpc endpoint over "conn".
func RegisterStatusServiceHandlerClient ¶
func RegisterStatusServiceHandlerClient(ctx context.Context, mux *runtime.ServeMux, client StatusServiceClient) error
RegisterStatusServiceHandlerClient registers the http handlers for service StatusService to "mux". The handlers forward requests to the grpc endpoint over the given implementation of "StatusServiceClient". Note: the gRPC framework executes interceptors within the gRPC handler. If the passed in "StatusServiceClient" doesn't go through the normal gRPC flow (creating a gRPC client etc.) then it will be up to the passed in "StatusServiceClient" to call the correct interceptors.
func RegisterStatusServiceHandlerFromEndpoint ¶
func RegisterStatusServiceHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, opts []grpc.DialOption) (err error)
RegisterStatusServiceHandlerFromEndpoint is same as RegisterStatusServiceHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.
func RegisterStatusServiceHandlerServer ¶
func RegisterStatusServiceHandlerServer(ctx context.Context, mux *runtime.ServeMux, server StatusServiceServer) error
RegisterStatusServiceHandlerServer registers the http handlers for service StatusService to "mux". UnaryRPC :call StatusServiceServer 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 RegisterStatusServiceHandlerFromEndpoint instead.
func RegisterStatusServiceServer ¶
func RegisterStatusServiceServer(s grpc.ServiceRegistrar, srv StatusServiceServer)
Types ¶
type ErrorDetails ¶
type ErrorDetails struct { Message string `protobuf:"bytes,1,opt,name=message,proto3" json:"message,omitempty"` // contains filtered or unexported fields }
ErrorDetails holds raw error message and its cause in a nested field.
func (*ErrorDetails) DeepCopy ¶ added in v0.1.2
func (in *ErrorDetails) DeepCopy() *ErrorDetails
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ErrorDetails. Required by controller-gen.
func (*ErrorDetails) DeepCopyInterface ¶ added in v0.1.2
func (in *ErrorDetails) DeepCopyInterface() interface{}
DeepCopyInterface is an autogenerated deepcopy function, copying the receiver, creating a new ErrorDetails. Required by controller-gen.
func (*ErrorDetails) DeepCopyInto ¶ added in v0.1.2
func (in *ErrorDetails) DeepCopyInto(out *ErrorDetails)
DeepCopyInto supports using ErrorDetails within kubernetes types, where deepcopy-gen is used.
func (*ErrorDetails) Descriptor
deprecated
func (*ErrorDetails) Descriptor() ([]byte, []int)
Deprecated: Use ErrorDetails.ProtoReflect.Descriptor instead.
func (*ErrorDetails) GetMessage ¶
func (x *ErrorDetails) GetMessage() string
func (*ErrorDetails) MarshalJSON ¶
func (msg *ErrorDetails) MarshalJSON() ([]byte, error)
MarshalJSON implements json.Marshaler
func (*ErrorDetails) ProtoMessage ¶
func (*ErrorDetails) ProtoMessage()
func (*ErrorDetails) ProtoReflect ¶
func (x *ErrorDetails) ProtoReflect() protoreflect.Message
func (*ErrorDetails) Reset ¶
func (x *ErrorDetails) Reset()
func (*ErrorDetails) String ¶
func (x *ErrorDetails) String() string
func (*ErrorDetails) UnmarshalJSON ¶
func (msg *ErrorDetails) UnmarshalJSON(b []byte) error
UnmarshalJSON implements json.Unmarshaler
type GroupStatus ¶
type GroupStatus struct { Status *Status `protobuf:"bytes,1,opt,name=status,proto3" json:"status,omitempty"` Groups map[string]*GroupStatus `` /* 153-byte string literal not displayed */ // contains filtered or unexported fields }
Groups is nested structure that holds status information about the node and a pointer to the next node.
func (*GroupStatus) DeepCopy ¶ added in v0.1.2
func (in *GroupStatus) DeepCopy() *GroupStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new GroupStatus. Required by controller-gen.
func (*GroupStatus) DeepCopyInterface ¶ added in v0.1.2
func (in *GroupStatus) DeepCopyInterface() interface{}
DeepCopyInterface is an autogenerated deepcopy function, copying the receiver, creating a new GroupStatus. Required by controller-gen.
func (*GroupStatus) DeepCopyInto ¶ added in v0.1.2
func (in *GroupStatus) DeepCopyInto(out *GroupStatus)
DeepCopyInto supports using GroupStatus within kubernetes types, where deepcopy-gen is used.
func (*GroupStatus) Descriptor
deprecated
func (*GroupStatus) Descriptor() ([]byte, []int)
Deprecated: Use GroupStatus.ProtoReflect.Descriptor instead.
func (*GroupStatus) GetGroups ¶
func (x *GroupStatus) GetGroups() map[string]*GroupStatus
func (*GroupStatus) GetStatus ¶
func (x *GroupStatus) GetStatus() *Status
func (*GroupStatus) MarshalJSON ¶
func (msg *GroupStatus) MarshalJSON() ([]byte, error)
MarshalJSON implements json.Marshaler
func (*GroupStatus) ProtoMessage ¶
func (*GroupStatus) ProtoMessage()
func (*GroupStatus) ProtoReflect ¶
func (x *GroupStatus) ProtoReflect() protoreflect.Message
func (*GroupStatus) Reset ¶
func (x *GroupStatus) Reset()
func (*GroupStatus) String ¶
func (x *GroupStatus) String() string
func (*GroupStatus) UnmarshalJSON ¶
func (msg *GroupStatus) UnmarshalJSON(b []byte) error
UnmarshalJSON implements json.Unmarshaler
type GroupStatusRequest ¶
type GroupStatusRequest struct { Path string `protobuf:"bytes,1,opt,name=path,proto3" json:"path,omitempty"` // contains filtered or unexported fields }
func (*GroupStatusRequest) DeepCopy ¶ added in v0.1.2
func (in *GroupStatusRequest) DeepCopy() *GroupStatusRequest
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new GroupStatusRequest. Required by controller-gen.
func (*GroupStatusRequest) DeepCopyInterface ¶ added in v0.1.2
func (in *GroupStatusRequest) DeepCopyInterface() interface{}
DeepCopyInterface is an autogenerated deepcopy function, copying the receiver, creating a new GroupStatusRequest. Required by controller-gen.
func (*GroupStatusRequest) DeepCopyInto ¶ added in v0.1.2
func (in *GroupStatusRequest) DeepCopyInto(out *GroupStatusRequest)
DeepCopyInto supports using GroupStatusRequest within kubernetes types, where deepcopy-gen is used.
func (*GroupStatusRequest) Descriptor
deprecated
func (*GroupStatusRequest) Descriptor() ([]byte, []int)
Deprecated: Use GroupStatusRequest.ProtoReflect.Descriptor instead.
func (*GroupStatusRequest) GetPath ¶ added in v0.4.0
func (x *GroupStatusRequest) GetPath() string
func (*GroupStatusRequest) MarshalJSON ¶
func (msg *GroupStatusRequest) MarshalJSON() ([]byte, error)
MarshalJSON implements json.Marshaler
func (*GroupStatusRequest) ProtoMessage ¶
func (*GroupStatusRequest) ProtoMessage()
func (*GroupStatusRequest) ProtoReflect ¶
func (x *GroupStatusRequest) ProtoReflect() protoreflect.Message
func (*GroupStatusRequest) Reset ¶
func (x *GroupStatusRequest) Reset()
func (*GroupStatusRequest) String ¶
func (x *GroupStatusRequest) String() string
func (*GroupStatusRequest) UnmarshalJSON ¶
func (msg *GroupStatusRequest) UnmarshalJSON(b []byte) error
UnmarshalJSON implements json.Unmarshaler
type Status ¶
type Status struct { // Types that are assignable to Details: // *Status_Message // *Status_Error Details isStatus_Details `protobuf_oneof:"details"` Timestamp *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=timestamp,proto3" json:"timestamp,omitempty"` // contains filtered or unexported fields }
Status holds details about a status that can be reported to the registry. The details can either be a message (Any) or error (ErrorDetails).
func (*Status) DeepCopy ¶ added in v0.1.2
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Status. Required by controller-gen.
func (*Status) DeepCopyInterface ¶ added in v0.1.2
func (in *Status) DeepCopyInterface() interface{}
DeepCopyInterface is an autogenerated deepcopy function, copying the receiver, creating a new Status. Required by controller-gen.
func (*Status) DeepCopyInto ¶ added in v0.1.2
DeepCopyInto supports using Status within kubernetes types, where deepcopy-gen is used.
func (*Status) Descriptor
deprecated
func (*Status) GetDetails ¶
func (m *Status) GetDetails() isStatus_Details
func (*Status) GetError ¶
func (x *Status) GetError() *ErrorDetails
func (*Status) GetMessage ¶
func (*Status) GetTimestamp ¶
func (x *Status) GetTimestamp() *timestamppb.Timestamp
func (*Status) MarshalJSON ¶
MarshalJSON implements json.Marshaler
func (*Status) ProtoMessage ¶
func (*Status) ProtoMessage()
func (*Status) ProtoReflect ¶
func (x *Status) ProtoReflect() protoreflect.Message
func (*Status) UnmarshalJSON ¶
UnmarshalJSON implements json.Unmarshaler
type StatusServiceClient ¶
type StatusServiceClient interface {
GetGroupStatus(ctx context.Context, in *GroupStatusRequest, opts ...grpc.CallOption) (*GroupStatus, error)
}
StatusServiceClient is the client API for StatusService 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 NewStatusServiceClient ¶
func NewStatusServiceClient(cc grpc.ClientConnInterface) StatusServiceClient
type StatusServiceServer ¶
type StatusServiceServer interface {
GetGroupStatus(context.Context, *GroupStatusRequest) (*GroupStatus, error)
}
StatusServiceServer is the server API for StatusService service. All implementations should embed UnimplementedStatusServiceServer for forward compatibility
type Status_Error ¶
type Status_Error struct {
Error *ErrorDetails `protobuf:"bytes,2,opt,name=error,proto3,oneof"`
}
type Status_Message ¶
type UnimplementedStatusServiceServer ¶
type UnimplementedStatusServiceServer struct { }
UnimplementedStatusServiceServer should be embedded to have forward compatible implementations.
func (UnimplementedStatusServiceServer) GetGroupStatus ¶
func (UnimplementedStatusServiceServer) GetGroupStatus(context.Context, *GroupStatusRequest) (*GroupStatus, error)
type UnsafeStatusServiceServer ¶
type UnsafeStatusServiceServer interface {
// contains filtered or unexported methods
}
UnsafeStatusServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to StatusServiceServer will result in compilation errors.