controller

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: 6 Imported by: 1

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var File_google_cloud_apigeeregistry_v1_controller_manifest_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_apigeeregistry_v1_controller_receipt_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type Dependency 

type Dependency struct {

	// A pattern that specifies a dependency.
	// This can specify one particular resource or a group of resources.
	// A pattern in a dependency can contain references to the original resource.
	// Format:
	//
	//	$resource.api/versions/-/specs/-
	//	$resource.version/specs/-/artifacts/-
	Pattern string `protobuf:"bytes,1,opt,name=pattern,proto3" json:"pattern,omitempty"`
	// A filter expression that limits the resources that match the pattern.
	Filter string `protobuf:"bytes,2,opt,name=filter,proto3" json:"filter,omitempty"`
	// contains filtered or unexported fields
}

A dependency of a generated resource is another resource in the registry which should always be older than the generated resource. When dependencies are updated, the generated resource that depends on them should be regenerated.

func (*Dependency) Descriptor deprecated 

func (*Dependency) Descriptor() ([]byte, []int)

Deprecated: Use Dependency.ProtoReflect.Descriptor instead.

func (*Dependency) GetFilter 

func (x *Dependency) GetFilter() string

func (*Dependency) GetPattern 

func (x *Dependency) GetPattern() string

func (*Dependency) ProtoMessage 

func (*Dependency) ProtoMessage()

func (*Dependency) ProtoReflect 

func (x *Dependency) ProtoReflect() protoreflect.Message

func (*Dependency) Reset 

func (x *Dependency) Reset()

func (*Dependency) String 

func (x *Dependency) String() string

type GeneratedResource 

type GeneratedResource struct {

	// A pattern that specifies a generated resource.
	// This can specify one particular resource or a group of resources.
	// Format:
	//
	//	apis/{api}/versions/{version}/specs/{spec}/artifacts/{artifact}
	//	apis/-/versions/-/specs/-/artifacts/-
	Pattern string `protobuf:"bytes,1,opt,name=pattern,proto3" json:"pattern,omitempty"`
	// A filter expression that limits the resources that match the pattern.
	Filter string `protobuf:"bytes,2,opt,name=filter,proto3" json:"filter,omitempty"`
	// The receipt field should be set to true if the action is not going to
	// store any artifact and instead requires a receipt artifact as its
	// generated resource.
	Receipt bool `protobuf:"varint,3,opt,name=receipt,proto3" json:"receipt,omitempty"`
	// The dependencies of the resource.
	// The controller checks for any updates in the dependencies and takes an
	// action if there has been an update in dependencies from the last time
	// the action was taken.
	// Check "refresh" field if it is not possible to list out the dependencies.
	// Either "dependencies" or "refresh" must be set for the controller to work.
	Dependencies []*Dependency `protobuf:"bytes,4,rep,name=dependencies,proto3" json:"dependencies,omitempty"`
	// The action used to generate the resource.
	// An action can contain references to $resource
	// Example: "registry compute complexity $resource"
	Action string `protobuf:"bytes,5,opt,name=action,proto3" json:"action,omitempty"`
	// Refresh interval in seconds (must be >0).
	// Generated resource should be regenerated after the specified duration.
	// This field should be used when the dependencies of the generated resources
	// are dynamic and cannot be listed out in the manifest.
	// If "refresh" is set, the dependencies are ignored and the
	// controller will use this field to decide when to take the action.
	// If refresh=Ns, the controller will wait for at least N seconds
	// before trying to regenerate the generated resource.
	// Either "refresh" or "dependencies" must be set for the controller to work.
	Refresh *durationpb.Duration `protobuf:"bytes,6,opt,name=refresh,proto3" json:"refresh,omitempty"`
	// contains filtered or unexported fields
}

A GeneratedResource describes a resource that is stored in the registry and generated automatically using a specified action. Actions include invocations of the registry tool and other tools available to a deployed instance of the controller.

func (*GeneratedResource) Descriptor deprecated 

func (*GeneratedResource) Descriptor() ([]byte, []int)

Deprecated: Use GeneratedResource.ProtoReflect.Descriptor instead.

func (*GeneratedResource) GetAction 

func (x *GeneratedResource) GetAction() string

func (*GeneratedResource) GetDependencies 

func (x *GeneratedResource) GetDependencies() []*Dependency

func (*GeneratedResource) GetFilter 

func (x *GeneratedResource) GetFilter() string

func (*GeneratedResource) GetPattern 

func (x *GeneratedResource) GetPattern() string

func (*GeneratedResource) GetReceipt 

func (x *GeneratedResource) GetReceipt() bool

func (*GeneratedResource) GetRefresh 

func (x *GeneratedResource) GetRefresh() *durationpb.Duration

func (*GeneratedResource) ProtoMessage 

func (*GeneratedResource) ProtoMessage()

func (*GeneratedResource) ProtoReflect 

func (x *GeneratedResource) ProtoReflect() protoreflect.Message

func (*GeneratedResource) Reset 

func (x *GeneratedResource) Reset()

func (*GeneratedResource) String 

func (x *GeneratedResource) String() string

type Manifest 

type Manifest struct {

	// Artifact identifier. May be used in YAML representations to indicate the id
	// to be used to attach the artifact.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// Artifact kind. May be used in YAML representations to identify the type of
	// this artifact.
	Kind string `protobuf:"bytes,2,opt,name=kind,proto3" json:"kind,omitempty"`
	// A human-friendly name for the manifest.
	DisplayName string `protobuf:"bytes,3,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	// A more detailed description of the manifest.
	Description string `protobuf:"bytes,4,opt,name=description,proto3" json:"description,omitempty"`
	// List of Generated resources.
	GeneratedResources []*GeneratedResource `protobuf:"bytes,5,rep,name=generated_resources,json=generatedResources,proto3" json:"generated_resources,omitempty"`
	// contains filtered or unexported fields
}

A Manifest represents a list of resources in a registry that should be automatically generated and updated in response to changes to their dependencies.

func (*Manifest) Descriptor deprecated 

func (*Manifest) Descriptor() ([]byte, []int)

Deprecated: Use Manifest.ProtoReflect.Descriptor instead.

func (*Manifest) GetDescription 

func (x *Manifest) GetDescription() string

func (*Manifest) GetDisplayName 

func (x *Manifest) GetDisplayName() string

func (*Manifest) GetGeneratedResources 

func (x *Manifest) GetGeneratedResources() []*GeneratedResource

func (*Manifest) GetId 

func (x *Manifest) GetId() string

func (*Manifest) GetKind 

func (x *Manifest) GetKind() string

func (*Manifest) ProtoMessage 

func (*Manifest) ProtoMessage()

func (*Manifest) ProtoReflect 

func (x *Manifest) ProtoReflect() protoreflect.Message

func (*Manifest) Reset 

func (x *Manifest) Reset()

func (*Manifest) String 

func (x *Manifest) String() string

type Receipt 

type Receipt struct {

	// Artifact identifier. May be used in YAML representations to indicate the id
	// to be used to attach the artifact.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// Artifact kind. May be used in YAML representations to identify the type of
	// this artifact.
	Kind string `protobuf:"bytes,2,opt,name=kind,proto3" json:"kind,omitempty"`
	// A human-friendly name for the receipt.
	DisplayName string `protobuf:"bytes,3,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	// A more detailed description of the receipt.
	Description string `protobuf:"bytes,4,opt,name=description,proto3" json:"description,omitempty"`
	// Action whose receipt is stored as an artifact.
	Action string `protobuf:"bytes,5,opt,name=action,proto3" json:"action,omitempty"`
	// If appropriate, a URI of the result of the action.
	ResultUri string `protobuf:"bytes,6,opt,name=result_uri,json=resultUri,proto3" json:"result_uri,omitempty"`
	// contains filtered or unexported fields
}

Stores the receipt of an external action, which does not store any direct artifacts in the registry.

func (*Receipt) Descriptor deprecated 

func (*Receipt) Descriptor() ([]byte, []int)

Deprecated: Use Receipt.ProtoReflect.Descriptor instead.

func (*Receipt) GetAction 

func (x *Receipt) GetAction() string

func (*Receipt) GetDescription 

func (x *Receipt) GetDescription() string

func (*Receipt) GetDisplayName 

func (x *Receipt) GetDisplayName() string

func (*Receipt) GetId 

func (x *Receipt) GetId() string

func (*Receipt) GetKind 

func (x *Receipt) GetKind() string

func (*Receipt) GetResultUri 

func (x *Receipt) GetResultUri() string

func (*Receipt) ProtoMessage 

func (*Receipt) ProtoMessage()

func (*Receipt) ProtoReflect 

func (x *Receipt) ProtoReflect() protoreflect.Message

func (*Receipt) Reset 

func (x *Receipt) Reset()

func (*Receipt) String 

func (x *Receipt) String() string

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.