statusv1

package
v2.12.1-rc.1 Latest Latest
Warning

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

 Go to latest Published: Aug 18, 2023 License: Apache-2.0 Imports: 32 Imported by: 0

Documentation

Overview

Package statusv1 is a reverse proxy.

It translates gRPC into RESTful JSON APIs.

Index

Constants

View Source 
const (
	StatusService_GetGroupStatus_FullMethodName = "/aperture.status.v1.StatusService/GetGroupStatus"
)

Variables

View Source 
var (
	ErrInvalidLength        = fmt.Errorf("proto: negative length found during unmarshaling")
	ErrIntOverflow          = fmt.Errorf("proto: integer overflow")
	ErrUnexpectedEndOfGroup = fmt.Errorf("proto: unexpected end of group")
)
View Source 
var File_aperture_status_v1_status_proto protoreflect.FileDescriptor
View Source 
var StatusService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "aperture.status.v1.StatusService",
	HandlerType: (*StatusServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "GetGroupStatus",
			Handler:    _StatusService_GetGroupStatus_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "aperture/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 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) 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) MarshalToSizedBufferVT added in v2.7.0 

func (m *GroupStatus) MarshalToSizedBufferVT(dAtA []byte) (int, error)

func (*GroupStatus) MarshalToVT added in v2.7.0 

func (m *GroupStatus) MarshalToVT(dAtA []byte) (int, error)

func (*GroupStatus) MarshalVT added in v2.7.0 

func (m *GroupStatus) MarshalVT() (dAtA []byte, err error)

func (*GroupStatus) ProtoMessage 

func (*GroupStatus) ProtoMessage()

func (*GroupStatus) ProtoReflect 

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

func (*GroupStatus) Reset 

func (x *GroupStatus) Reset()

func (*GroupStatus) SizeVT added in v2.7.0 

func (m *GroupStatus) SizeVT() (n int)

func (*GroupStatus) String 

func (x *GroupStatus) String() string

func (*GroupStatus) UnmarshalJSON 

func (msg *GroupStatus) UnmarshalJSON(b []byte) error

UnmarshalJSON implements json.Unmarshaler

func (*GroupStatus) UnmarshalVT added in v2.7.0 

func (m *GroupStatus) UnmarshalVT(dAtA []byte) error

func (*GroupStatus) Validate 

func (m *GroupStatus) Validate() error

Validate checks the field values on GroupStatus with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*GroupStatus) ValidateAll 

func (m *GroupStatus) ValidateAll() error

ValidateAll checks the field values on GroupStatus with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in GroupStatusMultiError, or nil if none found.

type GroupStatusMultiError 

type GroupStatusMultiError []error

GroupStatusMultiError is an error wrapping multiple validation errors returned by GroupStatus.ValidateAll() if the designated constraints aren't met.

func (GroupStatusMultiError) AllErrors 

func (m GroupStatusMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (GroupStatusMultiError) Error 

func (m GroupStatusMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type GroupStatusRequest 

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

func (*GroupStatusRequest) Descriptor deprecated 

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

Deprecated: Use GroupStatusRequest.ProtoReflect.Descriptor instead.

func (*GroupStatusRequest) GetPath 

func (x *GroupStatusRequest) GetPath() string

func (*GroupStatusRequest) MarshalJSON 

func (msg *GroupStatusRequest) MarshalJSON() ([]byte, error)

MarshalJSON implements json.Marshaler

func (*GroupStatusRequest) MarshalToSizedBufferVT added in v2.7.0 

func (m *GroupStatusRequest) MarshalToSizedBufferVT(dAtA []byte) (int, error)

func (*GroupStatusRequest) MarshalToVT added in v2.7.0 

func (m *GroupStatusRequest) MarshalToVT(dAtA []byte) (int, error)

func (*GroupStatusRequest) MarshalVT added in v2.7.0 

func (m *GroupStatusRequest) MarshalVT() (dAtA []byte, err error)

func (*GroupStatusRequest) ProtoMessage 

func (*GroupStatusRequest) ProtoMessage()

func (*GroupStatusRequest) ProtoReflect 

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

func (*GroupStatusRequest) Reset 

func (x *GroupStatusRequest) Reset()

func (*GroupStatusRequest) SizeVT added in v2.7.0 

func (m *GroupStatusRequest) SizeVT() (n int)

func (*GroupStatusRequest) String 

func (x *GroupStatusRequest) String() string

func (*GroupStatusRequest) UnmarshalJSON 

func (msg *GroupStatusRequest) UnmarshalJSON(b []byte) error

UnmarshalJSON implements json.Unmarshaler

func (*GroupStatusRequest) UnmarshalVT added in v2.7.0 

func (m *GroupStatusRequest) UnmarshalVT(dAtA []byte) error

func (*GroupStatusRequest) Validate 

func (m *GroupStatusRequest) Validate() error

Validate checks the field values on GroupStatusRequest with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*GroupStatusRequest) ValidateAll 

func (m *GroupStatusRequest) ValidateAll() error

ValidateAll checks the field values on GroupStatusRequest with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in GroupStatusRequestMultiError, or nil if none found.

type GroupStatusRequestMultiError 

type GroupStatusRequestMultiError []error

GroupStatusRequestMultiError is an error wrapping multiple validation errors returned by GroupStatusRequest.ValidateAll() if the designated constraints aren't met.

func (GroupStatusRequestMultiError) AllErrors 

func (m GroupStatusRequestMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (GroupStatusRequestMultiError) Error 

func (m GroupStatusRequestMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type GroupStatusRequestValidationError 

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

GroupStatusRequestValidationError is the validation error returned by GroupStatusRequest.Validate if the designated constraints aren't met.

func (GroupStatusRequestValidationError) Cause 

func (e GroupStatusRequestValidationError) Cause() error

Cause function returns cause value.

func (GroupStatusRequestValidationError) Error 

func (e GroupStatusRequestValidationError) Error() string

Error satisfies the builtin error interface

func (GroupStatusRequestValidationError) ErrorName 

func (e GroupStatusRequestValidationError) ErrorName() string

ErrorName returns error name.

func (GroupStatusRequestValidationError) Field 

func (e GroupStatusRequestValidationError) Field() string

Field function returns field value.

func (GroupStatusRequestValidationError) Key 

func (e GroupStatusRequestValidationError) Key() bool

Key function returns key value.

func (GroupStatusRequestValidationError) Reason 

func (e GroupStatusRequestValidationError) Reason() string

Reason function returns reason value.

type GroupStatusValidationError 

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

GroupStatusValidationError is the validation error returned by GroupStatus.Validate if the designated constraints aren't met.

func (GroupStatusValidationError) Cause 

func (e GroupStatusValidationError) Cause() error

Cause function returns cause value.

func (GroupStatusValidationError) Error 

func (e GroupStatusValidationError) Error() string

Error satisfies the builtin error interface

func (GroupStatusValidationError) ErrorName 

func (e GroupStatusValidationError) ErrorName() string

ErrorName returns error name.

func (GroupStatusValidationError) Field 

func (e GroupStatusValidationError) Field() string

Field function returns field value.

func (GroupStatusValidationError) Key 

func (e GroupStatusValidationError) Key() bool

Key function returns key value.

func (GroupStatusValidationError) Reason 

func (e GroupStatusValidationError) Reason() string

Reason function returns reason value.

type Status 

type Status struct {
	Message   *anypb.Any             `protobuf:"bytes,1,opt,name=message,proto3" json:"message,omitempty"`
	Error     *Status_Error          `protobuf:"bytes,2,opt,name=error,proto3" json:"error,omitempty"`
	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.

func (*Status) Descriptor deprecated 

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

Deprecated: Use Status.ProtoReflect.Descriptor instead.

func (*Status) GetError 

func (x *Status) GetError() *Status_Error

func (*Status) GetMessage 

func (x *Status) GetMessage() *anypb.Any

func (*Status) GetTimestamp 

func (x *Status) GetTimestamp() *timestamppb.Timestamp

func (*Status) MarshalJSON 

func (msg *Status) MarshalJSON() ([]byte, error)

MarshalJSON implements json.Marshaler

func (*Status) MarshalToSizedBufferVT added in v2.7.0 

func (m *Status) MarshalToSizedBufferVT(dAtA []byte) (int, error)

func (*Status) MarshalToVT added in v2.7.0 

func (m *Status) MarshalToVT(dAtA []byte) (int, error)

func (*Status) MarshalVT added in v2.7.0 

func (m *Status) MarshalVT() (dAtA []byte, err error)

func (*Status) ProtoMessage 

func (*Status) ProtoMessage()

func (*Status) ProtoReflect 

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

func (*Status) Reset 

func (x *Status) Reset()

func (*Status) SizeVT added in v2.7.0 

func (m *Status) SizeVT() (n int)

func (*Status) String 

func (x *Status) String() string

func (*Status) UnmarshalJSON 

func (msg *Status) UnmarshalJSON(b []byte) error

UnmarshalJSON implements json.Unmarshaler

func (*Status) UnmarshalVT added in v2.7.0 

func (m *Status) UnmarshalVT(dAtA []byte) error

func (*Status) Validate 

func (m *Status) Validate() error

Validate checks the field values on Status with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*Status) ValidateAll 

func (m *Status) ValidateAll() error

ValidateAll checks the field values on Status with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in StatusMultiError, or nil if none found.

type StatusMultiError 

type StatusMultiError []error

StatusMultiError is an error wrapping multiple validation errors returned by Status.ValidateAll() if the designated constraints aren't met.

func (StatusMultiError) AllErrors 

func (m StatusMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (StatusMultiError) Error 

func (m StatusMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

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 StatusValidationError 

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

StatusValidationError is the validation error returned by Status.Validate if the designated constraints aren't met.

func (StatusValidationError) Cause 

func (e StatusValidationError) Cause() error

Cause function returns cause value.

func (StatusValidationError) Error 

func (e StatusValidationError) Error() string

Error satisfies the builtin error interface

func (StatusValidationError) ErrorName 

func (e StatusValidationError) ErrorName() string

ErrorName returns error name.

func (StatusValidationError) Field 

func (e StatusValidationError) Field() string

Field function returns field value.

func (StatusValidationError) Key 

func (e StatusValidationError) Key() bool

Key function returns key value.

func (StatusValidationError) Reason 

func (e StatusValidationError) Reason() string

Reason function returns reason value.

type Status_Error 

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

Error holds raw error message and its cause in a nested field.

func (*Status_Error) Descriptor deprecated 

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

Deprecated: Use Status_Error.ProtoReflect.Descriptor instead.

func (*Status_Error) GetMessage 

func (x *Status_Error) GetMessage() string

func (*Status_Error) MarshalJSON 

func (msg *Status_Error) MarshalJSON() ([]byte, error)

MarshalJSON implements json.Marshaler

func (*Status_Error) MarshalToSizedBufferVT added in v2.7.0 

func (m *Status_Error) MarshalToSizedBufferVT(dAtA []byte) (int, error)

func (*Status_Error) MarshalToVT added in v2.7.0 

func (m *Status_Error) MarshalToVT(dAtA []byte) (int, error)

func (*Status_Error) MarshalVT added in v2.7.0 

func (m *Status_Error) MarshalVT() (dAtA []byte, err error)

func (*Status_Error) ProtoMessage 

func (*Status_Error) ProtoMessage()

func (*Status_Error) ProtoReflect 

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

func (*Status_Error) Reset 

func (x *Status_Error) Reset()

func (*Status_Error) SizeVT added in v2.7.0 

func (m *Status_Error) SizeVT() (n int)

func (*Status_Error) String 

func (x *Status_Error) String() string

func (*Status_Error) UnmarshalJSON 

func (msg *Status_Error) UnmarshalJSON(b []byte) error

UnmarshalJSON implements json.Unmarshaler

func (*Status_Error) UnmarshalVT added in v2.7.0 

func (m *Status_Error) UnmarshalVT(dAtA []byte) error

func (*Status_Error) Validate 

func (m *Status_Error) Validate() error

Validate checks the field values on Status_Error with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*Status_Error) ValidateAll 

func (m *Status_Error) ValidateAll() error

ValidateAll checks the field values on Status_Error with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in Status_ErrorMultiError, or nil if none found.

type Status_ErrorMultiError 

type Status_ErrorMultiError []error

Status_ErrorMultiError is an error wrapping multiple validation errors returned by Status_Error.ValidateAll() if the designated constraints aren't met.

func (Status_ErrorMultiError) AllErrors 

func (m Status_ErrorMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (Status_ErrorMultiError) Error 

func (m Status_ErrorMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type Status_ErrorValidationError 

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

Status_ErrorValidationError is the validation error returned by Status_Error.Validate if the designated constraints aren't met.

func (Status_ErrorValidationError) Cause 

func (e Status_ErrorValidationError) Cause() error

Cause function returns cause value.

func (Status_ErrorValidationError) Error 

func (e Status_ErrorValidationError) Error() string

Error satisfies the builtin error interface

func (Status_ErrorValidationError) ErrorName 

func (e Status_ErrorValidationError) ErrorName() string

ErrorName returns error name.

func (Status_ErrorValidationError) Field 

func (e Status_ErrorValidationError) Field() string

Field function returns field value.

func (Status_ErrorValidationError) Key 

func (e Status_ErrorValidationError) Key() bool

Key function returns key value.

func (Status_ErrorValidationError) Reason 

func (e Status_ErrorValidationError) Reason() string

Reason function returns reason value.

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.

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.