workerclient

Documentation

Overview

Package workerclient provides a way to communicate with a Wharf worker server.

Index

• type ArtifactEvent
• type ArtifactEventsRequest
• type Client
  • func New(baseURL string, opts Options) (Client, error)
• type LogLine
• type LogsRequest
• type Options
• type StatusEvent
• type StatusEventsRequest

Types

type ArtifactEvent

type ArtifactEvent = v1.StreamArtifactEventsResponse

ArtifactEvent is an alias for workerapi/v1.StreamArtifactEventsResponse.

type ArtifactEventsRequest

type ArtifactEventsRequest = v1.StreamArtifactEventsRequest

ArtifactEventsRequest is an alias for workerapi/v1.StreamArtifactEventsResponse.

type Client

type Client interface {
	StreamLogs(ctx context.Context, req *LogsRequest, opts ...grpc.CallOption) (v1.Worker_StreamLogsClient, error)
	StreamStatusEvents(ctx context.Context, req *StatusEventsRequest, opts ...grpc.CallOption) (v1.Worker_StreamStatusEventsClient, error)
	StreamArtifactEvents(ctx context.Context, req *ArtifactEventsRequest, opts ...grpc.CallOption) (v1.Worker_StreamArtifactEventsClient, error)
	DownloadArtifact(ctx context.Context, artifactID uint) (io.ReadCloser, error)
	Ping(ctx context.Context) error
	BuildID() uint

	Close() error
}

Client is an interface with methods to communicate with a Wharf worker server.

func New

func New(baseURL string, opts Options) (Client, error)

New creates a new client that can communicate with a Wharf worker server.

Implements the Closer interface.

type LogLine

type LogLine = v1.StreamLogsResponse

LogLine is an alias for workerapi/v1.StreamLogsResponse.

type LogsRequest

type LogsRequest = v1.StreamLogsRequest

LogsRequest is an alias for workerapi/v1.StreamLogsRequest.

type Options

type Options struct {
	// InsecureSkipVerify disables cert verification if set to true.
	//
	// Should NOT be true in a production environment.
	InsecureSkipVerify bool

	// BuildID is the ID of the build from wharf-api.
	BuildID uint
}

Options contains options that can be used in the creation of a new client.

type StatusEvent

type StatusEvent = v1.StreamStatusEventsResponse

StatusEvent is an alias for workerapi/v1.StreamStatusEventsResponse.

type StatusEventsRequest

type StatusEventsRequest = v1.StreamStatusEventsRequest

StatusEventsRequest is an alias for workerapi/v1.StreamStatusEventsRequest.