visitor

package
v0.6.16 Latest Latest
Warning

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

Go to latest
Published: Oct 16, 2023 License: Apache-2.0 Imports: 15 Imported by: 11

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func FetchArtifactContents

func FetchArtifactContents(ctx context.Context, client *gapic.RegistryClient, artifact *rpc.Artifact) error

func FetchSpecContents

func FetchSpecContents(ctx context.Context, client *gapic.RegistryClient, spec *rpc.ApiSpec) error

func GetAPI

func GetAPI(ctx context.Context,
	client *gapic.RegistryClient,
	name names.Api,
	handler ApiHandler) error

func GetArtifact

func GetArtifact(ctx context.Context,
	client *gapic.RegistryClient,
	name names.Artifact,
	getContents bool,
	handler ArtifactHandler) error

func GetDeployment

func GetDeployment(ctx context.Context,
	client *gapic.RegistryClient,
	name names.Deployment,
	handler DeploymentHandler) error

func GetDeploymentRevision

func GetDeploymentRevision(ctx context.Context,
	client *gapic.RegistryClient,
	name names.DeploymentRevision,
	handler DeploymentHandler) error

func GetProject

func GetProject(ctx context.Context,
	client *gapic.AdminClient,
	name names.Project,
	implicitProject *rpc.Project,
	handler ProjectHandler) error

func GetSpec

func GetSpec(ctx context.Context,
	client *gapic.RegistryClient,
	name names.Spec,
	getContents bool,
	handler SpecHandler) error

func GetSpecRevision

func GetSpecRevision(ctx context.Context,
	client *gapic.RegistryClient,
	name names.SpecRevision,
	getContents bool,
	handler SpecHandler) error

func GetVersion

func GetVersion(ctx context.Context,
	client *gapic.RegistryClient,
	name names.Version,
	handler VersionHandler) error

func ListAPIs

func ListAPIs(ctx context.Context,
	client *gapic.RegistryClient,
	name names.Api,
	pageSize int32,
	filter string,
	handler ApiHandler) error

func ListArtifacts

func ListArtifacts(ctx context.Context,
	client *gapic.RegistryClient,
	name names.Artifact,
	pageSize int32,
	filter string,
	getContents bool,
	handler ArtifactHandler) error

func ListDeploymentRevisions

func ListDeploymentRevisions(ctx context.Context,
	client *gapic.RegistryClient,
	name names.DeploymentRevision,
	pageSize int32,
	filter string,
	handler DeploymentHandler) error

func ListDeployments

func ListDeployments(ctx context.Context,
	client *gapic.RegistryClient,
	name names.Deployment,
	pageSize int32,
	filter string,
	handler DeploymentHandler) error

func ListProjects

func ListProjects(ctx context.Context,
	client *gapic.AdminClient,
	name names.Project,
	implicitProject *rpc.Project,
	pageSize int32,
	filter string,
	handler ProjectHandler) error

func ListSpecRevisions

func ListSpecRevisions(ctx context.Context,
	client *gapic.RegistryClient,
	name names.SpecRevision,
	pageSize int32,
	filter string,
	getContents bool,
	handler SpecHandler) error

func ListSpecs

func ListSpecs(ctx context.Context,
	client *gapic.RegistryClient,
	name names.Spec,
	pageSize int32,
	filter string,
	getContents bool,
	handler SpecHandler) error

func ListVersions

func ListVersions(ctx context.Context,
	client *gapic.RegistryClient,
	name names.Version,
	pageSize int32,
	filter string,
	handler VersionHandler) error

func SetArtifact added in v0.6.4

func SetArtifact(ctx context.Context,
	client *gapic.RegistryClient,
	artifact *rpc.Artifact) error

func VerifyLocation added in v0.6.4

func VerifyLocation(ctx context.Context, client connection.RegistryClient, location string) error

func Visit

func Visit(ctx context.Context, v Visitor, options VisitorOptions) error

Visit traverses a registry, applying the Visitor to each selected resource.

Types

type ApiHandler

type ApiHandler func(context.Context, *rpc.Api) error

type ArtifactHandler

type ArtifactHandler func(context.Context, *rpc.Artifact) error

type DeploymentHandler

type DeploymentHandler func(context.Context, *rpc.ApiDeployment) error

type ProjectHandler

type ProjectHandler func(context.Context, *rpc.Project) error

type SpecHandler

type SpecHandler func(context.Context, *rpc.ApiSpec) error

type SubtreeVisitor added in v0.6.4

type SubtreeVisitor struct {
	Options VisitorOptions
	Visitor Visitor
}

SubtreeVisitor is a Visitor implementation that can be passed to the Visit() function. It will run the handlers in Visitor against each resource directly matched in Visit() as well as each resource that is a descendant of those resources. (For example, if the pattern matches a Version, the SubtreeVisitor will be run against all of that Versions's Artifacts and Specs, and the Spec's Artifacts as well.) Only the current revisions of Specs and Deployments are visited.

func (*SubtreeVisitor) ApiHandler added in v0.6.4

func (v *SubtreeVisitor) ApiHandler() ApiHandler

func (*SubtreeVisitor) ArtifactHandler added in v0.6.4

func (v *SubtreeVisitor) ArtifactHandler() ArtifactHandler

func (*SubtreeVisitor) DeploymentHandler added in v0.6.4

func (v *SubtreeVisitor) DeploymentHandler() DeploymentHandler

func (*SubtreeVisitor) DeploymentRevisionHandler added in v0.6.4

func (v *SubtreeVisitor) DeploymentRevisionHandler() DeploymentHandler

func (*SubtreeVisitor) ProjectHandler added in v0.6.4

func (v *SubtreeVisitor) ProjectHandler() ProjectHandler

func (*SubtreeVisitor) SpecHandler added in v0.6.4

func (v *SubtreeVisitor) SpecHandler() SpecHandler

func (*SubtreeVisitor) SpecRevisionHandler added in v0.6.4

func (v *SubtreeVisitor) SpecRevisionHandler() SpecHandler

func (*SubtreeVisitor) VersionHandler added in v0.6.4

func (v *SubtreeVisitor) VersionHandler() VersionHandler

type Unsupported added in v0.6.3

type Unsupported struct {
}

Unsupported provides default handlers for all types that return "unsupported" errors. Include it as an extension to fill out incomplete visitor implementations.

func (*Unsupported) ApiHandler added in v0.6.3

func (v *Unsupported) ApiHandler() ApiHandler

func (*Unsupported) ArtifactHandler added in v0.6.3

func (v *Unsupported) ArtifactHandler() ArtifactHandler

func (*Unsupported) DeploymentHandler added in v0.6.3

func (v *Unsupported) DeploymentHandler() DeploymentHandler

func (*Unsupported) DeploymentRevisionHandler added in v0.6.3

func (v *Unsupported) DeploymentRevisionHandler() DeploymentHandler

func (*Unsupported) ProjectHandler added in v0.6.3

func (v *Unsupported) ProjectHandler() ProjectHandler

func (*Unsupported) SpecHandler added in v0.6.3

func (v *Unsupported) SpecHandler() SpecHandler

func (*Unsupported) SpecRevisionHandler added in v0.6.3

func (v *Unsupported) SpecRevisionHandler() SpecHandler

func (*Unsupported) VersionHandler added in v0.6.3

func (v *Unsupported) VersionHandler() VersionHandler

type VersionHandler

type VersionHandler func(context.Context, *rpc.ApiVersion) error

type Visitor

type Visitor interface {
	ProjectHandler() ProjectHandler
	ApiHandler() ApiHandler
	DeploymentHandler() DeploymentHandler
	DeploymentRevisionHandler() DeploymentHandler
	VersionHandler() VersionHandler
	SpecHandler() SpecHandler
	SpecRevisionHandler() SpecHandler
	ArtifactHandler() ArtifactHandler
}

type VisitorOptions

type VisitorOptions struct {
	RegistryClient  connection.RegistryClient
	AdminClient     connection.AdminClient
	Pattern         string
	PageSize        int32
	Filter          string
	GetContents     bool
	ImplicitProject *rpc.Project // used as placeholder if Project is unaccessible
}

Jump to

Keyboard shortcuts

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