apiclient

package
v4.0.7 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 7, 2026 License: Apache-2.0 Imports: 44 Imported by: 0

Documentation

Index

Constants

View Source
const (
	// MaxGRPCMessageSize contains max grpc message size supported by the client
	MaxClientGRPCMessageSize = 100 * 1024 * 1024
)

Variables

View Source
var (
	ErrNoArgoServer = fmt.Errorf("this is impossible if you are not using the Argo Server, see %s", help.CLI())
)
View Source
var ErrOffline = fmt.Errorf("not supported when you are in offline mode")

Functions

This section is empty.

Types

type ArgoKubeOpts

type ArgoKubeOpts struct {
	// Closing caching channel will stop caching informers
	CachingCloseCh chan struct{}

	// Whether to cache Workflows
	// This improves performance of reading Workflows, but it increases memory usage and startup time
	//
	// Workflow caching uses in-memory SQLite DB and it provides full capabilities
	CacheWorkflows bool

	// Whether to cache WorkflowTemplates
	// This improves performance of reading WorkflowTemplates, but it increases memory usage and startup time
	// It is especially visible during validating templates with many references,
	//
	// Note that templates caching currently uses informers, so not all template
	// get/list can use it, since informer has limited capabilities (such as filtering)
	CacheWorkflowTemplates bool

	// Whether to cache ClusterWorkflowTemplates
	// This improves performance of reading ClusterWorkflowTemplates, but it increases memory usage and startup time
	// It is especially visible during validating templates with many references,
	//
	// Note that templates caching currently uses informers, so not all template
	// get/list can use it, since informer has limited capabilities (such as filtering)
	CacheClusterWorkflowTemplates bool
}

type ArgoServerOpts

type ArgoServerOpts struct {
	// argo server host port, must be `host:port`, e.g. localhost:2746
	URL string
	// any base path needed (e.g. due to being behind an ingress)
	Path               string
	Secure             bool
	InsecureSkipVerify bool
	// whether or not to use HTTP1
	HTTP1 bool
	// use custom http client
	HTTP1Client *http.Client
	Headers     []string
}

func (ArgoServerOpts) GetURL

func (o ArgoServerOpts) GetURL() string

func (ArgoServerOpts) String

func (o ArgoServerOpts) String() string

type Client

type Client interface {
	NewArchivedWorkflowServiceClient() (workflowarchivepkg.ArchivedWorkflowServiceClient, error)
	NewWorkflowServiceClient(ctx context.Context) workflowpkg.WorkflowServiceClient
	NewCronWorkflowServiceClient() (cronworkflowpkg.CronWorkflowServiceClient, error)
	NewWorkflowTemplateServiceClient() (workflowtemplatepkg.WorkflowTemplateServiceClient, error)
	NewClusterWorkflowTemplateServiceClient() (clusterworkflowtmplpkg.ClusterWorkflowTemplateServiceClient, error)
	NewInfoServiceClient() (infopkg.InfoServiceClient, error)
	NewSyncServiceClient(ctx context.Context) (syncpkg.SyncServiceClient, error)
}

func NewClientFromOptsWithContext

func NewClientFromOptsWithContext(ctx context.Context, opts Opts) (context.Context, Client, error)

type OfflineClusterWorkflowTemplateServiceClient

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

type OfflineCronWorkflowServiceClient

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

func (OfflineCronWorkflowServiceClient) CreateCronWorkflow

func (OfflineCronWorkflowServiceClient) GetCronWorkflow

func (OfflineCronWorkflowServiceClient) LintCronWorkflow

func (OfflineCronWorkflowServiceClient) ListCronWorkflows

func (OfflineCronWorkflowServiceClient) ResumeCronWorkflow

func (OfflineCronWorkflowServiceClient) SuspendCronWorkflow

func (OfflineCronWorkflowServiceClient) UpdateCronWorkflow

type OfflineWorkflowServiceClient

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

func (OfflineWorkflowServiceClient) CreateWorkflow

func (OfflineWorkflowServiceClient) GetWorkflow

func (OfflineWorkflowServiceClient) LintWorkflow

func (OfflineWorkflowServiceClient) ListWorkflows

func (OfflineWorkflowServiceClient) ResubmitWorkflow

func (OfflineWorkflowServiceClient) ResumeWorkflow

func (OfflineWorkflowServiceClient) RetryWorkflow

func (OfflineWorkflowServiceClient) SetWorkflow

func (OfflineWorkflowServiceClient) StopWorkflow

func (OfflineWorkflowServiceClient) SubmitWorkflow

func (OfflineWorkflowServiceClient) SuspendWorkflow

func (OfflineWorkflowServiceClient) TerminateWorkflow

type OfflineWorkflowTemplateServiceClient

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

func (OfflineWorkflowTemplateServiceClient) LintWorkflowTemplate

type Opts

type Opts struct {
	ArgoServerOpts ArgoServerOpts
	ArgoKubeOpts   ArgoKubeOpts
	InstanceID     string
	AuthSupplier   func() string
	// DEPRECATED: use `ClientConfigSupplier`
	ClientConfig         clientcmd.ClientConfig
	ClientConfigSupplier func() clientcmd.ClientConfig
	Offline              bool
	OfflineFiles         []string
	// DEPRECATED: use NewClientFromOptsWithContext
	//nolint: containedctx
	Context   context.Context
	LogLevel  string
	LogFormat string
}

func (Opts) String

func (o Opts) String() string

Directories

Path Synopsis
Package artifact is a reverse proxy.
Package artifact is a reverse proxy.
Package clusterworkflowtemplate is a reverse proxy.
Package clusterworkflowtemplate is a reverse proxy.
Package cronworkflow is a reverse proxy.
Package cronworkflow is a reverse proxy.
Package event is a reverse proxy.
Package event is a reverse proxy.
Package eventsource is a reverse proxy.
Package eventsource is a reverse proxy.
Package info is a reverse proxy.
Package info is a reverse proxy.
Package sensor is a reverse proxy.
Package sensor is a reverse proxy.
Package sync is a reverse proxy.
Package sync is a reverse proxy.
Package workflow is a reverse proxy.
Package workflow is a reverse proxy.
Package workflowarchive is a reverse proxy.
Package workflowarchive is a reverse proxy.
Package workflowtemplate is a reverse proxy.
Package workflowtemplate is a reverse proxy.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL