results

Documentation

Index

• type Client
  • func NewClient(client pb.ResultsClient) *Client
  • func (c *Client) Put(ctx context.Context, o Object, opts ...grpc.CallOption) (*pb.Result, *pb.Record, error)
• type Object

Types

type Client

type Client struct {
	pb.ResultsClient
}

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(client pb.ResultsClient) *Client

NewClient returns a new results client for the particular kind.

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.

type Object

type Object interface {
	metav1.Object
	runtime.Object
}

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.