Documentation ¶
Overview ¶
Package controlpointsv1 is a reverse proxy.
It translates gRPC into RESTful JSON APIs.
Index ¶
- Constants
- Variables
- func RegisterFlowControlPointsServiceHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error
- func RegisterFlowControlPointsServiceHandlerClient(ctx context.Context, mux *runtime.ServeMux, ...) error
- func RegisterFlowControlPointsServiceHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, ...) (err error)
- func RegisterFlowControlPointsServiceHandlerServer(ctx context.Context, mux *runtime.ServeMux, ...) error
- func RegisterFlowControlPointsServiceServer(s grpc.ServiceRegistrar, srv FlowControlPointsServiceServer)
- type FlowControlPoint
- func (*FlowControlPoint) Descriptor() ([]byte, []int)deprecated
- func (x *FlowControlPoint) GetControlPoint() string
- func (x *FlowControlPoint) GetService() string
- func (x *FlowControlPoint) GetType() string
- func (msg *FlowControlPoint) MarshalJSON() ([]byte, error)
- func (*FlowControlPoint) ProtoMessage()
- func (x *FlowControlPoint) ProtoReflect() protoreflect.Message
- func (x *FlowControlPoint) Reset()
- func (x *FlowControlPoint) String() string
- func (msg *FlowControlPoint) UnmarshalJSON(b []byte) error
- func (m *FlowControlPoint) Validate() error
- func (m *FlowControlPoint) ValidateAll() error
- type FlowControlPointMultiError
- type FlowControlPointValidationError
- func (e FlowControlPointValidationError) Cause() error
- func (e FlowControlPointValidationError) Error() string
- func (e FlowControlPointValidationError) ErrorName() string
- func (e FlowControlPointValidationError) Field() string
- func (e FlowControlPointValidationError) Key() bool
- func (e FlowControlPointValidationError) Reason() string
- type FlowControlPoints
- func (*FlowControlPoints) Descriptor() ([]byte, []int)deprecated
- func (x *FlowControlPoints) GetFlowControlPoints() []*FlowControlPoint
- func (msg *FlowControlPoints) MarshalJSON() ([]byte, error)
- func (*FlowControlPoints) ProtoMessage()
- func (x *FlowControlPoints) ProtoReflect() protoreflect.Message
- func (x *FlowControlPoints) Reset()
- func (x *FlowControlPoints) String() string
- func (msg *FlowControlPoints) UnmarshalJSON(b []byte) error
- func (m *FlowControlPoints) Validate() error
- func (m *FlowControlPoints) ValidateAll() error
- type FlowControlPointsMultiError
- type FlowControlPointsServiceClient
- type FlowControlPointsServiceServer
- type FlowControlPointsValidationError
- func (e FlowControlPointsValidationError) Cause() error
- func (e FlowControlPointsValidationError) Error() string
- func (e FlowControlPointsValidationError) ErrorName() string
- func (e FlowControlPointsValidationError) Field() string
- func (e FlowControlPointsValidationError) Key() bool
- func (e FlowControlPointsValidationError) Reason() string
- type UnimplementedFlowControlPointsServiceServer
- type UnsafeFlowControlPointsServiceServer
Constants ¶
const (
FlowControlPointsService_GetControlPoints_FullMethodName = "/aperture.flowcontrol.controlpoints.v1.FlowControlPointsService/GetControlPoints"
)
Variables ¶
var File_aperture_flowcontrol_controlpoints_v1_controlpoints_proto protoreflect.FileDescriptor
var FlowControlPointsService_ServiceDesc = grpc.ServiceDesc{ ServiceName: "aperture.flowcontrol.controlpoints.v1.FlowControlPointsService", HandlerType: (*FlowControlPointsServiceServer)(nil), Methods: []grpc.MethodDesc{ { MethodName: "GetControlPoints", Handler: _FlowControlPointsService_GetControlPoints_Handler, }, }, Streams: []grpc.StreamDesc{}, Metadata: "aperture/flowcontrol/controlpoints/v1/controlpoints.proto", }
FlowControlPointsService_ServiceDesc is the grpc.ServiceDesc for FlowControlPointsService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
Functions ¶
func RegisterFlowControlPointsServiceHandler ¶
func RegisterFlowControlPointsServiceHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error
RegisterFlowControlPointsServiceHandler registers the http handlers for service FlowControlPointsService to "mux". The handlers forward requests to the grpc endpoint over "conn".
func RegisterFlowControlPointsServiceHandlerClient ¶
func RegisterFlowControlPointsServiceHandlerClient(ctx context.Context, mux *runtime.ServeMux, client FlowControlPointsServiceClient) error
RegisterFlowControlPointsServiceHandlerClient registers the http handlers for service FlowControlPointsService to "mux". The handlers forward requests to the grpc endpoint over the given implementation of "FlowControlPointsServiceClient". Note: the gRPC framework executes interceptors within the gRPC handler. If the passed in "FlowControlPointsServiceClient" doesn't go through the normal gRPC flow (creating a gRPC client etc.) then it will be up to the passed in "FlowControlPointsServiceClient" to call the correct interceptors.
func RegisterFlowControlPointsServiceHandlerFromEndpoint ¶
func RegisterFlowControlPointsServiceHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, opts []grpc.DialOption) (err error)
RegisterFlowControlPointsServiceHandlerFromEndpoint is same as RegisterFlowControlPointsServiceHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.
func RegisterFlowControlPointsServiceHandlerServer ¶
func RegisterFlowControlPointsServiceHandlerServer(ctx context.Context, mux *runtime.ServeMux, server FlowControlPointsServiceServer) error
RegisterFlowControlPointsServiceHandlerServer registers the http handlers for service FlowControlPointsService to "mux". UnaryRPC :call FlowControlPointsServiceServer 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 RegisterFlowControlPointsServiceHandlerFromEndpoint instead.
func RegisterFlowControlPointsServiceServer ¶
func RegisterFlowControlPointsServiceServer(s grpc.ServiceRegistrar, srv FlowControlPointsServiceServer)
Types ¶
type FlowControlPoint ¶
type FlowControlPoint struct { ControlPoint string `protobuf:"bytes,2,opt,name=control_point,json=controlPoint,proto3" json:"control_point,omitempty"` Type string `protobuf:"bytes,3,opt,name=type,proto3" json:"type,omitempty"` Service string `protobuf:"bytes,1,opt,name=service,proto3" json:"service,omitempty"` // contains filtered or unexported fields }
func (*FlowControlPoint) Descriptor
deprecated
func (*FlowControlPoint) Descriptor() ([]byte, []int)
Deprecated: Use FlowControlPoint.ProtoReflect.Descriptor instead.
func (*FlowControlPoint) GetControlPoint ¶
func (x *FlowControlPoint) GetControlPoint() string
func (*FlowControlPoint) GetService ¶
func (x *FlowControlPoint) GetService() string
func (*FlowControlPoint) GetType ¶
func (x *FlowControlPoint) GetType() string
func (*FlowControlPoint) MarshalJSON ¶
func (msg *FlowControlPoint) MarshalJSON() ([]byte, error)
MarshalJSON implements json.Marshaler
func (*FlowControlPoint) ProtoMessage ¶
func (*FlowControlPoint) ProtoMessage()
func (*FlowControlPoint) ProtoReflect ¶
func (x *FlowControlPoint) ProtoReflect() protoreflect.Message
func (*FlowControlPoint) Reset ¶
func (x *FlowControlPoint) Reset()
func (*FlowControlPoint) String ¶
func (x *FlowControlPoint) String() string
func (*FlowControlPoint) UnmarshalJSON ¶
func (msg *FlowControlPoint) UnmarshalJSON(b []byte) error
UnmarshalJSON implements json.Unmarshaler
func (*FlowControlPoint) Validate ¶
func (m *FlowControlPoint) Validate() error
Validate checks the field values on FlowControlPoint 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 (*FlowControlPoint) ValidateAll ¶
func (m *FlowControlPoint) ValidateAll() error
ValidateAll checks the field values on FlowControlPoint 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 FlowControlPointMultiError, or nil if none found.
type FlowControlPointMultiError ¶
type FlowControlPointMultiError []error
FlowControlPointMultiError is an error wrapping multiple validation errors returned by FlowControlPoint.ValidateAll() if the designated constraints aren't met.
func (FlowControlPointMultiError) AllErrors ¶
func (m FlowControlPointMultiError) AllErrors() []error
AllErrors returns a list of validation violation errors.
func (FlowControlPointMultiError) Error ¶
func (m FlowControlPointMultiError) Error() string
Error returns a concatenation of all the error messages it wraps.
type FlowControlPointValidationError ¶
type FlowControlPointValidationError struct {
// contains filtered or unexported fields
}
FlowControlPointValidationError is the validation error returned by FlowControlPoint.Validate if the designated constraints aren't met.
func (FlowControlPointValidationError) Cause ¶
func (e FlowControlPointValidationError) Cause() error
Cause function returns cause value.
func (FlowControlPointValidationError) Error ¶
func (e FlowControlPointValidationError) Error() string
Error satisfies the builtin error interface
func (FlowControlPointValidationError) ErrorName ¶
func (e FlowControlPointValidationError) ErrorName() string
ErrorName returns error name.
func (FlowControlPointValidationError) Field ¶
func (e FlowControlPointValidationError) Field() string
Field function returns field value.
func (FlowControlPointValidationError) Key ¶
func (e FlowControlPointValidationError) Key() bool
Key function returns key value.
func (FlowControlPointValidationError) Reason ¶
func (e FlowControlPointValidationError) Reason() string
Reason function returns reason value.
type FlowControlPoints ¶
type FlowControlPoints struct { FlowControlPoints []*FlowControlPoint `protobuf:"bytes,1,rep,name=flow_control_points,json=flowControlPoints,proto3" json:"flow_control_points,omitempty"` // contains filtered or unexported fields }
func (*FlowControlPoints) Descriptor
deprecated
func (*FlowControlPoints) Descriptor() ([]byte, []int)
Deprecated: Use FlowControlPoints.ProtoReflect.Descriptor instead.
func (*FlowControlPoints) GetFlowControlPoints ¶
func (x *FlowControlPoints) GetFlowControlPoints() []*FlowControlPoint
func (*FlowControlPoints) MarshalJSON ¶
func (msg *FlowControlPoints) MarshalJSON() ([]byte, error)
MarshalJSON implements json.Marshaler
func (*FlowControlPoints) ProtoMessage ¶
func (*FlowControlPoints) ProtoMessage()
func (*FlowControlPoints) ProtoReflect ¶
func (x *FlowControlPoints) ProtoReflect() protoreflect.Message
func (*FlowControlPoints) Reset ¶
func (x *FlowControlPoints) Reset()
func (*FlowControlPoints) String ¶
func (x *FlowControlPoints) String() string
func (*FlowControlPoints) UnmarshalJSON ¶
func (msg *FlowControlPoints) UnmarshalJSON(b []byte) error
UnmarshalJSON implements json.Unmarshaler
func (*FlowControlPoints) Validate ¶
func (m *FlowControlPoints) Validate() error
Validate checks the field values on FlowControlPoints 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 (*FlowControlPoints) ValidateAll ¶
func (m *FlowControlPoints) ValidateAll() error
ValidateAll checks the field values on FlowControlPoints 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 FlowControlPointsMultiError, or nil if none found.
type FlowControlPointsMultiError ¶
type FlowControlPointsMultiError []error
FlowControlPointsMultiError is an error wrapping multiple validation errors returned by FlowControlPoints.ValidateAll() if the designated constraints aren't met.
func (FlowControlPointsMultiError) AllErrors ¶
func (m FlowControlPointsMultiError) AllErrors() []error
AllErrors returns a list of validation violation errors.
func (FlowControlPointsMultiError) Error ¶
func (m FlowControlPointsMultiError) Error() string
Error returns a concatenation of all the error messages it wraps.
type FlowControlPointsServiceClient ¶
type FlowControlPointsServiceClient interface {
GetControlPoints(ctx context.Context, in *emptypb.Empty, opts ...grpc.CallOption) (*FlowControlPoints, error)
}
FlowControlPointsServiceClient is the client API for FlowControlPointsService 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 NewFlowControlPointsServiceClient ¶
func NewFlowControlPointsServiceClient(cc grpc.ClientConnInterface) FlowControlPointsServiceClient
type FlowControlPointsServiceServer ¶
type FlowControlPointsServiceServer interface {
GetControlPoints(context.Context, *emptypb.Empty) (*FlowControlPoints, error)
}
FlowControlPointsServiceServer is the server API for FlowControlPointsService service. All implementations should embed UnimplementedFlowControlPointsServiceServer for forward compatibility
type FlowControlPointsValidationError ¶
type FlowControlPointsValidationError struct {
// contains filtered or unexported fields
}
FlowControlPointsValidationError is the validation error returned by FlowControlPoints.Validate if the designated constraints aren't met.
func (FlowControlPointsValidationError) Cause ¶
func (e FlowControlPointsValidationError) Cause() error
Cause function returns cause value.
func (FlowControlPointsValidationError) Error ¶
func (e FlowControlPointsValidationError) Error() string
Error satisfies the builtin error interface
func (FlowControlPointsValidationError) ErrorName ¶
func (e FlowControlPointsValidationError) ErrorName() string
ErrorName returns error name.
func (FlowControlPointsValidationError) Field ¶
func (e FlowControlPointsValidationError) Field() string
Field function returns field value.
func (FlowControlPointsValidationError) Key ¶
func (e FlowControlPointsValidationError) Key() bool
Key function returns key value.
func (FlowControlPointsValidationError) Reason ¶
func (e FlowControlPointsValidationError) Reason() string
Reason function returns reason value.
type UnimplementedFlowControlPointsServiceServer ¶
type UnimplementedFlowControlPointsServiceServer struct { }
UnimplementedFlowControlPointsServiceServer should be embedded to have forward compatible implementations.
func (UnimplementedFlowControlPointsServiceServer) GetControlPoints ¶
func (UnimplementedFlowControlPointsServiceServer) GetControlPoints(context.Context, *emptypb.Empty) (*FlowControlPoints, error)
type UnsafeFlowControlPointsServiceServer ¶
type UnsafeFlowControlPointsServiceServer interface {
// contains filtered or unexported methods
}
UnsafeFlowControlPointsServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to FlowControlPointsServiceServer will result in compilation errors.