Documentation
¶
Overview ¶
Package results provides the Results client for the watcher.
Index ¶
- func FormatEventListName(resultName string, resultUID uuid.UUID, o Object) string
- type Client
- func (c *Client) GetEventListRecord(ctx context.Context, o Object) (*pb.Record, error)
- func (c *Client) GetLogRecord(ctx context.Context, o Object) (*pb.Record, error)
- func (c *Client) Put(ctx context.Context, o Object, opts ...grpc.CallOption) (*pb.Result, *pb.Record, error)
- func (c *Client) PutEventList(ctx context.Context, o Object, eventList []byte, opts ...grpc.CallOption) (*pb.Record, error)
- func (c *Client) PutLog(ctx context.Context, o Object, opts ...grpc.CallOption) (*pb.Record, error)
- type Object
- type StatusConditionGetter
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type Client ¶
type Client struct {
pb.ResultsClient
pb.LogsClient
reconciler.Config
}
Client is a wrapper around a Results client that provides helpful utilities for performing result operations that require multiple RPCs or data specific operations.
func NewClient ¶
func NewClient(resultsClient pb.ResultsClient, logsClient pb.LogsClient, reconcilerConfig *reconciler.Config) *Client
NewClient returns a new results client for the particular kind.
func (*Client) GetEventListRecord ¶ added in v0.11.0
GetEventListRecord returns eventlist record using gRPC clients.
func (*Client) GetLogRecord ¶ added in v0.5.0
GetLogRecord returns log record using gRPC clients.
func (*Client) Put ¶
func (c *Client) Put(ctx context.Context, o Object, opts ...grpc.CallOption) (*pb.Result, *pb.Record, error)
Put adds the given Object to the Results API. If the parent result is missing or the object is not yet associated with a result, one is created automatically. If the Object is already associated with a Record, the existing Record is updated - otherwise a new Record is created.
func (*Client) PutEventList ¶ added in v0.11.0
func (c *Client) PutEventList(ctx context.Context, o Object, eventList []byte, opts ...grpc.CallOption) (*pb.Record, error)
PutEventList adds the given Object to the Results API. If the parent result is missing or the object is not yet associated with a result, one is created automatically.
type Object ¶ added in v0.3.0
type Object interface {
metav1.Object
runtime.Object
StatusConditionGetter
}
Object is a union type of different base k8s Object interfaces. This is similar in spirit to https://pkg.go.dev/sigs.k8s.io/controller-runtime@v0.9.4/pkg/client#Object, but is defined as its own type to avoid an extra dependency.
type StatusConditionGetter ¶ added in v0.5.0
type StatusConditionGetter interface {
GetStatusCondition() apis.ConditionAccessor
}
StatusConditionGetter defines status for Object interface
Source Files