gardener

Documentation

Index

• type JobClient
  • func NewJobClient(api url.URL) *JobClient
  • func (c *JobClient) Error(ctx context.Context, id tracker.Key, errString string) error
  • func (c *JobClient) Heartbeat(ctx context.Context, id tracker.Key) error
  • func (c *JobClient) Next(ctx context.Context) (*tracker.JobWithTarget, error)
  • func (c *JobClient) Update(ctx context.Context, id tracker.Key, state tracker.State, detail string) error

Types

type JobClient

type JobClient struct {
	// Client is used for all HTTP requests to the Gardener API. A
	// NewJobClient uses http.DefaultClient but may be overridden.
	Client *http.Client
	// contains filtered or unexported fields
}

JobClient manages requests to the Gardener Jobs API.

func NewJobClient

func NewJobClient(api url.URL) *JobClient

NewJobClient creates a new JobClient that targets the given base API URL.

func (*JobClient) Error

func (c *JobClient) Error(ctx context.Context, id tracker.Key, errString string) error

Error reports an error message for the given job ID.

func (*JobClient) Heartbeat

func (c *JobClient) Heartbeat(ctx context.Context, id tracker.Key) error

Heartbeat sends a heartbeat message for the given job ID, notifying Gardener that the job is still in progress.

func (*JobClient) Next

func (c *JobClient) Next(ctx context.Context) (*tracker.JobWithTarget, error)

Next requests a new parse job from the Gardener Jobs API.

func (*JobClient) Update

func (c *JobClient) Update(ctx context.Context, id tracker.Key, state tracker.State, detail string) error

Update sets a new state with given detail for the given job ID.