api

type Authorizer ¶

type Authorizer interface {
	credentials.PerRPCCredentials
	oauth2.TokenSource
}

Authorizer represents an interface which provides a token used for authenticating a client in server-client communication. More specifically, this interfaces requires credentials.PerRPCCredentials, which enables this to be used by a gRPC client to communicate with a gRPC server that requires per-RPC credentials.

func NewOAuthAuthorizerFromClientCredentials(config *clientcredentials.Config) Authorizer

func NewOAuthAuthorizerFromConfig(config *oauth2.Config, token *oauth2.Token) Authorizer

type CloudServiceRequest ¶ added in v1.7.4

type CloudServiceRequest = api.CloudServiceRequest

CloudServiceRequest represents any kind of RPC request, that contains a reference to a cloud service.

Note: GetCloudServiceId() is already implemented by the generated protobuf code for the following messages because they directly have a cloud_service id field:

• orchestrator.RemoveControlFromScopeRequest
• orchestrator.ListControlsInScopeRequest
• orchestrator.GetCloudServiceRequest
• orchestrator.RemoveCloudServiceRequest
• orchestrator.UpdateMetricConfigurationRequest
• orchestrator.GetMetricConfigurationRequest
• orchestrator.ListMetricConfigurationRequest
• orchestrator.MetricChangeEvent
• orchestrator.TargetOfEvaluation
• orchestrator.RemoveTargetOfEvaluationRequest
• orchestrator.GetTargetOfEvaluationRequest
• orchestrator.ListTargetsOfEvaluationRequest
• orchestrator.Certificate

All other requests, especially in cases where the cloud service ID is embedded in a sub-field need to explicitly implement this interface in order. This interface is for example used by authorization checks.

type InitFuncOf ¶ added in v1.4.4

type InitFuncOf[StreamType grpc.ClientStream] func(target string, additionalOpts ...grpc.DialOption) (stream StreamType, err error)

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. Additional gRPC dial options can be specified in additionalOpts.

type PageToken ¶ added in v1.4.6

type PageToken struct {
	Start int64 `protobuf:"varint,1,opt,name=start,proto3" json:"start,omitempty"`
	Size  int32 `protobuf:"varint,2,opt,name=size,proto3" json:"size,omitempty"`
	// contains filtered or unexported fields
}

func DecodePageToken(b64token string) (t *PageToken, err error)

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

func (t *PageToken) Encode() (b64token string, err error)

func (x *PageToken) GetSize() int32

func (x *PageToken) GetStart() int64

func (*PageToken) ProtoMessage()

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

func (x *PageToken) Reset()

func (x *PageToken) String() string

func (m *PageToken) Validate() error

func (m *PageToken) ValidateAll() error

type PageTokenMultiError ¶ added in v1.7.0

type PageTokenMultiError []error

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

func (m PageTokenMultiError) AllErrors() []error

func (m PageTokenMultiError) Error() string

type PageTokenValidationError ¶ added in v1.7.0

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

PageTokenValidationError is the validation error returned by PageToken.Validate if the designated constraints aren't met.

func (e PageTokenValidationError) Cause() error

func (e PageTokenValidationError) Error() string

func (e PageTokenValidationError) ErrorName() string

func (e PageTokenValidationError) Field() string

func (e PageTokenValidationError) Key() bool

func (e PageTokenValidationError) Reason() string

type PaginatedRequest ¶ added in v1.4.6

type PaginatedRequest interface {
	GetPageToken() string
	GetPageSize() int32
	GetOrderBy() string // For ordering
	GetAsc() bool       // For ordering
	proto.Message
}

PaginatedRequest contains the typical parameters for a paginated request, usually a request for a List gRPC call.

type PaginatedResponse ¶ added in v1.4.6

type PaginatedResponse interface {
	GetNextPageToken() string
}

PaginatedResponse contains the typical parameters for a paginated response, usually a response for a List gRPC call.

type PayloadRequest ¶ added in v1.7.4

type PayloadRequest = api.PayloadRequest

PayloadRequest describes any kind of requests that carries a certain payload. This is for example a Create/Update request carrying an embedded message, which should be updated or created.

type RPCConnection ¶ added in v1.7.8

type RPCConnection[T any] struct {
	// Target contains the target used in grpc.Dial. Ideally, this should not be changed after the first client call.
	Target string

	// Opts contain options used in grpc.Dial. Ideally, this should not be changed after the first client call.
	Opts []grpc.DialOption

	// Client contains a gRPC client that is used to issue the actual RPCs.
	Client T
	// contains filtered or unexported fields
}

RPCConnection is a helper struct that wraps all necessary information for a gRPC connection, which is established using grpc.Dial. It features transparent goroutine-safe lazy initialization of the connection by overloading the underlying grpc.ClientConn. The connection is established automatically once the first client call is made. If an io.EOF error is received the connection is tried to be re-established on the next client call.

func NewRPCConnection[T any](target string, newClientFunc func(cc grpc.ClientConnInterface) T, opts ...grpc.DialOption) *RPCConnection[T]

func (conn *RPCConnection[T]) Authorizer() Authorizer

func (conn *RPCConnection[T]) ForceReconnect()

func (conn *RPCConnection[T]) Invoke(ctx context.Context, method string, args interface{}, reply interface{}, opts ...grpc.CallOption) (err error)

func (conn *RPCConnection[T]) NewStream(ctx context.Context, desc *grpc.StreamDesc, method string, opts ...grpc.CallOption) (stream grpc.ClientStream, err error)

func (conn *RPCConnection[T]) SetAuthorizer(auth Authorizer)

type StreamChannelOf ¶ added in v1.4.4

type StreamChannelOf[StreamType grpc.ClientStream, MsgType proto.Message] struct {
	// contains filtered or unexported fields
}

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. This is necessary, because gRPC does not allow sending to a stream from multiple goroutines directly.

func (c *StreamChannelOf[StreamType, MsgType]) Send(msg MsgType)

type StreamsOf ¶ added in v1.4.4

type StreamsOf[StreamType grpc.ClientStream, MsgType proto.Message] struct {
	// contains filtered or unexported fields
}

StreamsOf handles stream channels to multiple gRPC servers, identified by a unique target (usually host and port). Since gRPC does only allow to send to a stream using one goroutine, each stream provides a go channel that can be used to send messages to the particular stream.

A stream for a given target can be retrieved with the GetStream function, which automatically initializes the stream if it does not exist.

func NewStreamsOf[StreamType grpc.ClientStream, MsgType proto.Message](opts ...StreamsOfOption[StreamType, MsgType]) (s *StreamsOf[StreamType, MsgType])

func (s *StreamsOf[StreamType, MsgType]) CloseAll()

func (s *StreamsOf[StreamType, MsgType]) GetStream(target string, component string, init InitFuncOf[StreamType], opts ...grpc.DialOption) (c *StreamChannelOf[StreamType, MsgType], err error)

type StreamsOfOption ¶ added in v1.4.4

type StreamsOfOption[StreamType grpc.ClientStream, MsgType proto.Message] func(*StreamsOf[StreamType, MsgType])

StreamsOfOption is a functional option type to configure the StreamOf type.

func WithLogger[StreamType grpc.ClientStream, MsgType proto.Message](log *logrus.Entry) StreamsOfOption[StreamType, MsgType]

type UsesAuthorizer ¶

type UsesAuthorizer interface {
	SetAuthorizer(auth Authorizer)
	Authorizer() Authorizer
}

UsesAuthorizer is an interface to denote that a struct is willing to accept and use an Authorizer