apienv

Documentation

Index

• func NewArtifactTrackerClient() (artifacttrackerpb.ArtifactTrackerClient, error)
• func NewConfigManagerServiceClient() (configmanagerpb.ConfigManagerServiceClient, error)
• func NewOrgServiceClient() (profilepb.OrgServiceClient, error)
• func NewPluginServiceClients() (pluginpb.PluginServiceClient, pluginpb.DataRetentionPluginServiceClient, error)
• func NewProfileServiceClient() (profilepb.ProfileServiceClient, error)
• func NewProjectManagerServiceClient() (projectmanagerpb.ProjectManagerServiceClient, error)
• func NewScriptMgrServiceClient() (scriptmgrpb.ScriptMgrServiceClient, error)
• func NewVZMgrServiceClients() (vzmgrpb.VZMgrServiceClient, vzmgrpb.VZDeploymentKeyServiceClient, error)
• type APIEnv
  • func New(ac authpb.AuthServiceClient, pc profilepb.ProfileServiceClient, ...) (APIEnv, error)
• type IdentityProviderClient
• type Impl
  • func (e *Impl) APIKeyClient() authpb.APIKeyServiceClient
  • func (e *Impl) ArtifactTrackerClient() artifacttrackerpb.ArtifactTrackerClient
  • func (e *Impl) AuthClient() authpb.AuthServiceClient
  • func (e *Impl) CookieStore() sessions.Store
  • func (e *Impl) DataRetentionPluginClient() pluginpb.DataRetentionPluginServiceClient
  • func (e *Impl) IdentityProviderClient() IdentityProviderClient
  • func (e *Impl) OrgClient() profilepb.OrgServiceClient
  • func (e *Impl) PluginClient() pluginpb.PluginServiceClient
  • func (e *Impl) ProfileClient() profilepb.ProfileServiceClient
  • func (e *Impl) VZDeploymentKeyClient() vzmgrpb.VZDeploymentKeyServiceClient
  • func (e *Impl) VZMgrClient() vzmgrpb.VZMgrServiceClient

Functions

func NewArtifactTrackerClient

func NewArtifactTrackerClient() (artifacttrackerpb.ArtifactTrackerClient, error)

NewArtifactTrackerClient creates a new artifact tracker RPC client stub.

func NewConfigManagerServiceClient

func NewConfigManagerServiceClient() (configmanagerpb.ConfigManagerServiceClient, error)

NewConfigManagerServiceClient creates a new auth RPC client stub.

func NewOrgServiceClient

func NewOrgServiceClient() (profilepb.OrgServiceClient, error)

NewOrgServiceClient creates a new org RPC client stub.

func NewPluginServiceClients

func NewPluginServiceClients() (pluginpb.PluginServiceClient, pluginpb.DataRetentionPluginServiceClient, error)

NewPluginServiceClients creates the vzmgr RPC client stubs.

func NewProfileServiceClient

func NewProfileServiceClient() (profilepb.ProfileServiceClient, error)

NewProfileServiceClient creates a new profile RPC client stub.

func NewProjectManagerServiceClient

func NewProjectManagerServiceClient() (projectmanagerpb.ProjectManagerServiceClient, error)

NewProjectManagerServiceClient creates a new auth RPC client stub.

func NewScriptMgrServiceClient

func NewScriptMgrServiceClient() (scriptmgrpb.ScriptMgrServiceClient, error)

NewScriptMgrServiceClient creates a new scriptmgr RPC client stub.

func NewVZMgrServiceClients

func NewVZMgrServiceClients() (vzmgrpb.VZMgrServiceClient, vzmgrpb.VZDeploymentKeyServiceClient, error)

NewVZMgrServiceClients creates the vzmgr RPC client stubs.

Types

type APIEnv

type APIEnv interface {
	env.Env
	CookieStore() sessions.Store
	AuthClient() authpb.AuthServiceClient
	ProfileClient() profilepb.ProfileServiceClient
	OrgClient() profilepb.OrgServiceClient
	VZMgrClient() vzmgrpb.VZMgrServiceClient
	VZDeploymentKeyClient() vzmgrpb.VZDeploymentKeyServiceClient
	APIKeyClient() authpb.APIKeyServiceClient
	ArtifactTrackerClient() artifacttrackerpb.ArtifactTrackerClient
	IdentityProviderClient() IdentityProviderClient
	PluginClient() pluginpb.PluginServiceClient
	DataRetentionPluginClient() pluginpb.DataRetentionPluginServiceClient
}

APIEnv store the contextual authenv used for API server requests.

func New

func New(ac authpb.AuthServiceClient, pc profilepb.ProfileServiceClient, oc profilepb.OrgServiceClient,
	vk vzmgrpb.VZDeploymentKeyServiceClient, ak authpb.APIKeyServiceClient, vc vzmgrpb.VZMgrServiceClient,
	at artifacttrackerpb.ArtifactTrackerClient, oa IdentityProviderClient,
	cm configmanagerpb.ConfigManagerServiceClient, pm pluginpb.PluginServiceClient, rm pluginpb.DataRetentionPluginServiceClient) (APIEnv, error)

New creates a new api env.

type IdentityProviderClient

type IdentityProviderClient interface {
	// HandleLogin handles the login for a user into the Identity Provider.
	HandleLogin(session *sessions.Session, w http.ResponseWriter, r *http.Request) error
	// The key to use for the session.
	SessionKey() string
}

IdentityProviderClient is the interface for IdentityProvider clients that require endpoints.

type Impl

type Impl struct {
	*env.BaseEnv
	// contains filtered or unexported fields
}

Impl is an implementation of the APIEnv interface.

func (*Impl) APIKeyClient

func (e *Impl) APIKeyClient() authpb.APIKeyServiceClient

APIKeyClient returns a API key client.

func (*Impl) ArtifactTrackerClient

func (e *Impl) ArtifactTrackerClient() artifacttrackerpb.ArtifactTrackerClient

ArtifactTrackerClient returns an artifact tracker client.

func (*Impl) AuthClient

func (e *Impl) AuthClient() authpb.AuthServiceClient

AuthClient returns an auth service client.

func (*Impl) CookieStore

func (e *Impl) CookieStore() sessions.Store

CookieStore returns the CookieStore from the environment.

func (*Impl) DataRetentionPluginClient

func (e *Impl) DataRetentionPluginClient() pluginpb.DataRetentionPluginServiceClient

DataRetentionPluginClient returns a data retention plugin client.

func (*Impl) IdentityProviderClient

func (e *Impl) IdentityProviderClient() IdentityProviderClient

IdentityProviderClient returns a client that interfaces with an identity provider.

func (*Impl) OrgClient

func (e *Impl) OrgClient() profilepb.OrgServiceClient

OrgClient returns a org service client.

func (*Impl) PluginClient

func (e *Impl) PluginClient() pluginpb.PluginServiceClient

PluginClient returns a plugin client.

func (*Impl) ProfileClient

func (e *Impl) ProfileClient() profilepb.ProfileServiceClient

ProfileClient returns a profile service client.

func (*Impl) VZDeploymentKeyClient

func (e *Impl) VZDeploymentKeyClient() vzmgrpb.VZDeploymentKeyServiceClient

VZDeploymentKeyClient returns a Vizier deploy key client.

func (*Impl) VZMgrClient

func (e *Impl) VZMgrClient() vzmgrpb.VZMgrServiceClient

VZMgrClient returns a vzmgr client.