Documentation ¶
Overview ¶
Package profiles is a reverse proxy.
It translates gRPC into RESTful JSON APIs.
Index ¶
- Variables
- func RegisterProfilesHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error
- func RegisterProfilesHandlerClient(ctx context.Context, mux *runtime.ServeMux, client ProfilesClient) error
- func RegisterProfilesHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, ...) (err error)
- func RegisterProfilesHandlerServer(ctx context.Context, mux *runtime.ServeMux, server ProfilesServer) error
- func RegisterProfilesServer(s grpc.ServiceRegistrar, srv ProfilesServer)
- type GetProfileValuesRequest
- func (*GetProfileValuesRequest) Descriptor() ([]byte, []int)deprecated
- func (x *GetProfileValuesRequest) GetProfileName() string
- func (x *GetProfileValuesRequest) GetProfileVersion() string
- func (*GetProfileValuesRequest) ProtoMessage()
- func (x *GetProfileValuesRequest) ProtoReflect() protoreflect.Message
- func (x *GetProfileValuesRequest) Reset()
- func (x *GetProfileValuesRequest) String() string
- type GetProfileValuesResponse
- func (*GetProfileValuesResponse) Descriptor() ([]byte, []int)deprecated
- func (x *GetProfileValuesResponse) GetValues() string
- func (*GetProfileValuesResponse) ProtoMessage()
- func (x *GetProfileValuesResponse) ProtoReflect() protoreflect.Message
- func (x *GetProfileValuesResponse) Reset()
- func (x *GetProfileValuesResponse) String() string
- type GetProfilesRequest
- type GetProfilesResponse
- func (*GetProfilesResponse) Descriptor() ([]byte, []int)deprecated
- func (x *GetProfilesResponse) GetProfiles() []*Profile
- func (*GetProfilesResponse) ProtoMessage()
- func (x *GetProfilesResponse) ProtoReflect() protoreflect.Message
- func (x *GetProfilesResponse) Reset()
- func (x *GetProfilesResponse) String() string
- type HelmRepository
- func (*HelmRepository) Descriptor() ([]byte, []int)deprecated
- func (x *HelmRepository) GetName() string
- func (x *HelmRepository) GetNamespace() string
- func (*HelmRepository) ProtoMessage()
- func (x *HelmRepository) ProtoReflect() protoreflect.Message
- func (x *HelmRepository) Reset()
- func (x *HelmRepository) String() string
- type Maintainer
- func (*Maintainer) Descriptor() ([]byte, []int)deprecated
- func (x *Maintainer) GetEmail() string
- func (x *Maintainer) GetName() string
- func (x *Maintainer) GetUrl() string
- func (*Maintainer) ProtoMessage()
- func (x *Maintainer) ProtoReflect() protoreflect.Message
- func (x *Maintainer) Reset()
- func (x *Maintainer) String() string
- type Profile
- func (*Profile) Descriptor() ([]byte, []int)deprecated
- func (x *Profile) GetAnnotations() map[string]string
- func (x *Profile) GetAvailableVersions() []string
- func (x *Profile) GetDescription() string
- func (x *Profile) GetHelmRepository() *HelmRepository
- func (x *Profile) GetHome() string
- func (x *Profile) GetIcon() string
- func (x *Profile) GetKeywords() []string
- func (x *Profile) GetKubeVersion() string
- func (x *Profile) GetLayer() string
- func (x *Profile) GetMaintainers() []*Maintainer
- func (x *Profile) GetName() string
- func (x *Profile) GetSources() []string
- func (*Profile) ProtoMessage()
- func (x *Profile) ProtoReflect() protoreflect.Message
- func (x *Profile) Reset()
- func (x *Profile) String() string
- type ProfileValues
- func (*ProfileValues) Descriptor() ([]byte, []int)deprecated
- func (x *ProfileValues) GetName() string
- func (x *ProfileValues) GetValues() string
- func (x *ProfileValues) GetVersion() string
- func (*ProfileValues) ProtoMessage()
- func (x *ProfileValues) ProtoReflect() protoreflect.Message
- func (x *ProfileValues) Reset()
- func (x *ProfileValues) String() string
- type ProfilesClient
- type ProfilesServer
- type UnimplementedProfilesServer
- type UnsafeProfilesServer
Constants ¶
This section is empty.
Variables ¶
var File_api_profiles_profiles_proto protoreflect.FileDescriptor
var Profiles_ServiceDesc = grpc.ServiceDesc{ ServiceName: "wego_profiles.v1.Profiles", HandlerType: (*ProfilesServer)(nil), Methods: []grpc.MethodDesc{ { MethodName: "GetProfiles", Handler: _Profiles_GetProfiles_Handler, }, { MethodName: "GetProfileValues", Handler: _Profiles_GetProfileValues_Handler, }, }, Streams: []grpc.StreamDesc{}, Metadata: "api/profiles/profiles.proto", }
Profiles_ServiceDesc is the grpc.ServiceDesc for Profiles service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
Functions ¶
func RegisterProfilesHandler ¶
func RegisterProfilesHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error
RegisterProfilesHandler registers the http handlers for service Profiles to "mux". The handlers forward requests to the grpc endpoint over "conn".
func RegisterProfilesHandlerClient ¶
func RegisterProfilesHandlerClient(ctx context.Context, mux *runtime.ServeMux, client ProfilesClient) error
RegisterProfilesHandlerClient registers the http handlers for service Profiles to "mux". The handlers forward requests to the grpc endpoint over the given implementation of "ProfilesClient". Note: the gRPC framework executes interceptors within the gRPC handler. If the passed in "ProfilesClient" doesn't go through the normal gRPC flow (creating a gRPC client etc.) then it will be up to the passed in "ProfilesClient" to call the correct interceptors.
func RegisterProfilesHandlerFromEndpoint ¶
func RegisterProfilesHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, opts []grpc.DialOption) (err error)
RegisterProfilesHandlerFromEndpoint is same as RegisterProfilesHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.
func RegisterProfilesHandlerServer ¶
func RegisterProfilesHandlerServer(ctx context.Context, mux *runtime.ServeMux, server ProfilesServer) error
RegisterProfilesHandlerServer registers the http handlers for service Profiles to "mux". UnaryRPC :call ProfilesServer 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 RegisterProfilesHandlerFromEndpoint instead.
func RegisterProfilesServer ¶
func RegisterProfilesServer(s grpc.ServiceRegistrar, srv ProfilesServer)
Types ¶
type GetProfileValuesRequest ¶
type GetProfileValuesRequest struct { // The name of the Profile ProfileName string `protobuf:"bytes,1,opt,name=profile_name,json=profileName,proto3" json:"profile_name,omitempty"` // The version of the Profile ProfileVersion string `protobuf:"bytes,2,opt,name=profile_version,json=profileVersion,proto3" json:"profile_version,omitempty"` // contains filtered or unexported fields }
func (*GetProfileValuesRequest) Descriptor
deprecated
func (*GetProfileValuesRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetProfileValuesRequest.ProtoReflect.Descriptor instead.
func (*GetProfileValuesRequest) GetProfileName ¶
func (x *GetProfileValuesRequest) GetProfileName() string
func (*GetProfileValuesRequest) GetProfileVersion ¶
func (x *GetProfileValuesRequest) GetProfileVersion() string
func (*GetProfileValuesRequest) ProtoMessage ¶
func (*GetProfileValuesRequest) ProtoMessage()
func (*GetProfileValuesRequest) ProtoReflect ¶
func (x *GetProfileValuesRequest) ProtoReflect() protoreflect.Message
func (*GetProfileValuesRequest) Reset ¶
func (x *GetProfileValuesRequest) Reset()
func (*GetProfileValuesRequest) String ¶
func (x *GetProfileValuesRequest) String() string
type GetProfileValuesResponse ¶
type GetProfileValuesResponse struct { // The base64 encoded values file of the profile. Values string `protobuf:"bytes,1,opt,name=values,proto3" json:"values,omitempty"` // contains filtered or unexported fields }
func (*GetProfileValuesResponse) Descriptor
deprecated
func (*GetProfileValuesResponse) Descriptor() ([]byte, []int)
Deprecated: Use GetProfileValuesResponse.ProtoReflect.Descriptor instead.
func (*GetProfileValuesResponse) GetValues ¶
func (x *GetProfileValuesResponse) GetValues() string
func (*GetProfileValuesResponse) ProtoMessage ¶
func (*GetProfileValuesResponse) ProtoMessage()
func (*GetProfileValuesResponse) ProtoReflect ¶
func (x *GetProfileValuesResponse) ProtoReflect() protoreflect.Message
func (*GetProfileValuesResponse) Reset ¶
func (x *GetProfileValuesResponse) Reset()
func (*GetProfileValuesResponse) String ¶
func (x *GetProfileValuesResponse) String() string
type GetProfilesRequest ¶
type GetProfilesRequest struct {
// contains filtered or unexported fields
}
func (*GetProfilesRequest) Descriptor
deprecated
func (*GetProfilesRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetProfilesRequest.ProtoReflect.Descriptor instead.
func (*GetProfilesRequest) ProtoMessage ¶
func (*GetProfilesRequest) ProtoMessage()
func (*GetProfilesRequest) ProtoReflect ¶
func (x *GetProfilesRequest) ProtoReflect() protoreflect.Message
func (*GetProfilesRequest) Reset ¶
func (x *GetProfilesRequest) Reset()
func (*GetProfilesRequest) String ¶
func (x *GetProfilesRequest) String() string
type GetProfilesResponse ¶
type GetProfilesResponse struct { // A list of Profiles Profiles []*Profile `protobuf:"bytes,1,rep,name=profiles,proto3" json:"profiles,omitempty"` // contains filtered or unexported fields }
func (*GetProfilesResponse) Descriptor
deprecated
func (*GetProfilesResponse) Descriptor() ([]byte, []int)
Deprecated: Use GetProfilesResponse.ProtoReflect.Descriptor instead.
func (*GetProfilesResponse) GetProfiles ¶
func (x *GetProfilesResponse) GetProfiles() []*Profile
func (*GetProfilesResponse) ProtoMessage ¶
func (*GetProfilesResponse) ProtoMessage()
func (*GetProfilesResponse) ProtoReflect ¶
func (x *GetProfilesResponse) ProtoReflect() protoreflect.Message
func (*GetProfilesResponse) Reset ¶
func (x *GetProfilesResponse) Reset()
func (*GetProfilesResponse) String ¶
func (x *GetProfilesResponse) String() string
type HelmRepository ¶
type HelmRepository struct { // The name of the HelmRepository Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` // The namespace of the HelmRepository Namespace string `protobuf:"bytes,2,opt,name=namespace,proto3" json:"namespace,omitempty"` // contains filtered or unexported fields }
func (*HelmRepository) Descriptor
deprecated
func (*HelmRepository) Descriptor() ([]byte, []int)
Deprecated: Use HelmRepository.ProtoReflect.Descriptor instead.
func (*HelmRepository) GetName ¶
func (x *HelmRepository) GetName() string
func (*HelmRepository) GetNamespace ¶
func (x *HelmRepository) GetNamespace() string
func (*HelmRepository) ProtoMessage ¶
func (*HelmRepository) ProtoMessage()
func (*HelmRepository) ProtoReflect ¶
func (x *HelmRepository) ProtoReflect() protoreflect.Message
func (*HelmRepository) Reset ¶
func (x *HelmRepository) Reset()
func (*HelmRepository) String ¶
func (x *HelmRepository) String() string
type Maintainer ¶
type Maintainer struct { // The name of the Maintainer Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` // The email of the Maintainer Email string `protobuf:"bytes,2,opt,name=email,proto3" json:"email,omitempty"` // The URL to a Maintainer's website Url string `protobuf:"bytes,3,opt,name=url,proto3" json:"url,omitempty"` // contains filtered or unexported fields }
func (*Maintainer) Descriptor
deprecated
func (*Maintainer) Descriptor() ([]byte, []int)
Deprecated: Use Maintainer.ProtoReflect.Descriptor instead.
func (*Maintainer) GetEmail ¶
func (x *Maintainer) GetEmail() string
func (*Maintainer) GetName ¶
func (x *Maintainer) GetName() string
func (*Maintainer) GetUrl ¶
func (x *Maintainer) GetUrl() string
func (*Maintainer) ProtoMessage ¶
func (*Maintainer) ProtoMessage()
func (*Maintainer) ProtoReflect ¶
func (x *Maintainer) ProtoReflect() protoreflect.Message
func (*Maintainer) Reset ¶
func (x *Maintainer) Reset()
func (*Maintainer) String ¶
func (x *Maintainer) String() string
type Profile ¶
type Profile struct { // The name of the Profile Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` // The URL to a relevant project page, git repo, or contact person Home string `protobuf:"bytes,2,opt,name=home,proto3" json:"home,omitempty"` // A list of URLs to the source code of this chart Sources []string `protobuf:"bytes,3,rep,name=sources,proto3" json:"sources,omitempty"` // A one-sentence description of the Profile Description string `protobuf:"bytes,4,opt,name=description,proto3" json:"description,omitempty"` // A list of string keywords Keywords []string `protobuf:"bytes,5,rep,name=keywords,proto3" json:"keywords,omitempty"` // A list of Maintainers Maintainers []*Maintainer `protobuf:"bytes,6,rep,name=maintainers,proto3" json:"maintainers,omitempty"` // The URL to an icon file Icon string `protobuf:"bytes,7,opt,name=icon,proto3" json:"icon,omitempty"` // A map of annotations Annotations map[string]string `` /* 163-byte string literal not displayed */ // The Kubernetes version KubeVersion string `protobuf:"bytes,9,opt,name=kube_version,json=kubeVersion,proto3" json:"kube_version,omitempty"` // The Flux HelmRepository HelmRepository *HelmRepository `protobuf:"bytes,10,opt,name=helm_repository,json=helmRepository,proto3" json:"helm_repository,omitempty"` // A list of available versions AvailableVersions []string `protobuf:"bytes,11,rep,name=available_versions,json=availableVersions,proto3" json:"available_versions,omitempty"` // The layer of the profile Layer string `protobuf:"bytes,12,opt,name=layer,proto3" json:"layer,omitempty"` // contains filtered or unexported fields }
func (*Profile) Descriptor
deprecated
func (*Profile) GetAnnotations ¶
func (*Profile) GetAvailableVersions ¶
func (*Profile) GetDescription ¶
func (*Profile) GetHelmRepository ¶
func (x *Profile) GetHelmRepository() *HelmRepository
func (*Profile) GetKeywords ¶
func (*Profile) GetKubeVersion ¶
func (*Profile) GetMaintainers ¶
func (x *Profile) GetMaintainers() []*Maintainer
func (*Profile) GetSources ¶
func (*Profile) ProtoMessage ¶
func (*Profile) ProtoMessage()
func (*Profile) ProtoReflect ¶
func (x *Profile) ProtoReflect() protoreflect.Message
type ProfileValues ¶
type ProfileValues struct { // The name of the Profile Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` // The version of the Profile Version string `protobuf:"bytes,2,opt,name=version,proto3" json:"version,omitempty"` // The base64 encoded values file of the profile Values string `protobuf:"bytes,3,opt,name=values,proto3" json:"values,omitempty"` // contains filtered or unexported fields }
func (*ProfileValues) Descriptor
deprecated
func (*ProfileValues) Descriptor() ([]byte, []int)
Deprecated: Use ProfileValues.ProtoReflect.Descriptor instead.
func (*ProfileValues) GetName ¶
func (x *ProfileValues) GetName() string
func (*ProfileValues) GetValues ¶
func (x *ProfileValues) GetValues() string
func (*ProfileValues) GetVersion ¶
func (x *ProfileValues) GetVersion() string
func (*ProfileValues) ProtoMessage ¶
func (*ProfileValues) ProtoMessage()
func (*ProfileValues) ProtoReflect ¶
func (x *ProfileValues) ProtoReflect() protoreflect.Message
func (*ProfileValues) Reset ¶
func (x *ProfileValues) Reset()
func (*ProfileValues) String ¶
func (x *ProfileValues) String() string
type ProfilesClient ¶
type ProfilesClient interface { // GetProfiles returns a list of profiles from the cluster. GetProfiles(ctx context.Context, in *GetProfilesRequest, opts ...grpc.CallOption) (*GetProfilesResponse, error) // GetProfileValues returns a list of values for a given version of a profile from the cluster. GetProfileValues(ctx context.Context, in *GetProfileValuesRequest, opts ...grpc.CallOption) (*httpbody.HttpBody, error) }
ProfilesClient is the client API for Profiles 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 NewProfilesClient ¶
func NewProfilesClient(cc grpc.ClientConnInterface) ProfilesClient
type ProfilesServer ¶
type ProfilesServer interface { // GetProfiles returns a list of profiles from the cluster. GetProfiles(context.Context, *GetProfilesRequest) (*GetProfilesResponse, error) // GetProfileValues returns a list of values for a given version of a profile from the cluster. GetProfileValues(context.Context, *GetProfileValuesRequest) (*httpbody.HttpBody, error) // contains filtered or unexported methods }
ProfilesServer is the server API for Profiles service. All implementations must embed UnimplementedProfilesServer for forward compatibility
type UnimplementedProfilesServer ¶
type UnimplementedProfilesServer struct { }
UnimplementedProfilesServer must be embedded to have forward compatible implementations.
func (UnimplementedProfilesServer) GetProfileValues ¶
func (UnimplementedProfilesServer) GetProfileValues(context.Context, *GetProfileValuesRequest) (*httpbody.HttpBody, error)
func (UnimplementedProfilesServer) GetProfiles ¶
func (UnimplementedProfilesServer) GetProfiles(context.Context, *GetProfilesRequest) (*GetProfilesResponse, error)
type UnsafeProfilesServer ¶
type UnsafeProfilesServer interface {
// contains filtered or unexported methods
}
UnsafeProfilesServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to ProfilesServer will result in compilation errors.