package
2.0.0-alpha.4
Repository: https://github.com/clouditor/clouditor.git
Documentation: pkg.go.dev

# Packages

Package assessment is a reverse proxy.
Package discovery is a reverse proxy.
Package evaluation is a reverse proxy.
Package evidence is a reverse proxy.
No description provided by the author
Package orchestrator is a reverse proxy.
No description provided by the author

# Functions

DecodePageToken decodes a PageToken out of a base 64 URL encoded string.
DefaultGrpcDialOptions returns a set of sensible default list of grpc.DialOption values.
ListAllPaginated invokes a List gRPC function that supports pagination, fetches all pages using individual calls and finally combines all results of all pages into a single slice.
NewOAuthAuthorizerFromClientCredentials creates a new authorizer based on an OAuth 2.0 client credentials.
NewOAuthAuthorizerFromConfig creates a new authorizer based on an OAuth 2.0 config.
NewRPCConnection creates a new [RPCConnection] to the target using the specified function that creates a new client.
NewStreamsOf creates a new StreamsOf object and initializes all the necessary objects for it.
Validate validates an incoming request according to different criteria: - If the request is nil, [api.ErrEmptyRequest] is returned - The request is validated according to the generated validation method - Lastly, if the request is a [api.PaginatedRequest], an additional check is performed to ensure only valid columns are listed Note: This function already returns a gRPC error, so the error can be returned directly without any wrapping in a request function.
WithLogger can be used to specify a dedicated logger entry which is used for logging.

# Constants

IDField is the name of the ID field used in protobuf messages.
PageTokenField is the protobuf field that contains our page token.

# Variables

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Structs

No description provided by the author
RPCConnection is a helper struct that wraps all necessary information for a gRPC connection, which is established using [grpc.Dial].
StreamChannelOf provides a channel around a connection to a grpc.ClientStream to send messages of type MsgType to that particular stream, using an internal go routine.
StreamsOf handles stream channels to multiple gRPC servers, identified by a unique target (usually host and port).

# Interfaces

Authorizer represents an interface which provides a token used for authenticating a client in server-client communication.
No description provided by the author
PaginatedRequest contains the typical parameters for a paginated request, usually a request for a List gRPC call.
PaginatedResponse contains the typical parameters for a paginated response, usually a response for a List gRPC call.
UsesAuthorizer is an interface to denote that a struct is willing to accept and use an Authorizer.

# Type aliases

CloudServiceRequest represents any kind of RPC request, that contains a reference to a cloud service.
InitFuncOf describes a function with type parameters that creates any kind of stream towards a gRPC server specified in target and returns the stream or an error.
PayloadRequest describes any kind of requests that carries a certain payload.
StreamsOfOption is a functional option type to configure the StreamOf type.