pattern

package
v0.8.135 Latest Latest
Warning

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

Go to latest
Published: Mar 21, 2026 License: Apache-2.0 Imports: 18 Imported by: 4

Documentation

Overview

Package pattern provides primitives to interact with the openapi HTTP API.

Code generated by github.com/oapi-codegen/oapi-codegen/v2 version v2.3.0 DO NOT EDIT.

Package pattern provides primitives to interact with the openapi HTTP API.

Code generated by github.com/oapi-codegen/oapi-codegen/v2 version v2.5.1 DO NOT EDIT.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Action added in v0.8.11

type Action struct {
	Op    string                 `json:"op"`
	Value map[string]interface{} `json:"value"`
}

type DeletePatternModel

type DeletePatternModel struct {
	ID   corev1alpha1.Id   `json:"id,omitempty" yaml:"id,omitempty"`
	Name corev1alpha1.Text `json:"name,omitempty" yaml:"name,omitempty"`
}

DeletePatternModel defines model for DeletePatternModel.

type DesignPreferences added in v0.8.93

type DesignPreferences struct {
	// Layers Map of available layers, where keys are layer names.
	Layers map[string]interface{} `json:"layers" yaml:"layers"`
}

DesignPreferences Design-level preferences

type EvaluationRequest added in v0.7.17

type EvaluationRequest struct {
	// Design Designs are your primary tool for collaborative authorship of your infrastructure, workflow, and processes.
	Design PatternFile `json:"design" yaml:"design"`

	// Options Optional parameters for the evaluation process
	Options *Options `json:"options,omitempty" yaml:"options"`
}

EvaluationRequest defines model for EvaluationRequest.

type EvaluationResponse added in v0.7.17

type EvaluationResponse struct {
	// Design Designs are your primary tool for collaborative authorship of your infrastructure, workflow, and processes.
	Design PatternFile `json:"design" yaml:"design"`

	// EvaluationHash Hash of the input parameters and configuration used for this evaluation. Useful for identifying duplicate evaluations or caching results.
	EvaluationHash *string        `json:"evaluationHash,omitempty" yaml:"evaluationHash"`
	SchemaVersion  coretypes.Text `json:"schemaVersion" yaml:"schemaVersion"`

	// Timestamp ISO 8601 formatted timestamp of when the evaluation was completed.
	Timestamp *time.Time `json:"timestamp,omitempty" yaml:"timestamp"`

	// Trace A detailed trace of the evaluation process, including actions taken and changes made.
	Trace Trace `json:"trace" yaml:"trace"`

	Actions []Action `json:"actions" yaml:"actions"`
}

EvaluationResponse Schema for the response of a relationship evaluation process in Meshery

type Id added in v0.8.129

type Id = corev1alpha1.Uuid

Id A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.

type MesheryPattern

type MesheryPattern struct {
	CatalogData *catalogv1alpha2.CatalogData `json:"catalog_data,omitempty" yaml:"catalog_data,omitempty"`
	CreatedAt   corev1alpha1.Time            `json:"created_at,omitempty" yaml:"created_at,omitempty"`
	ID          corev1alpha1.Id              `json:"id,omitempty" yaml:"id,omitempty"`
	Location    corev1alpha1.MapObject       `json:"location,omitempty" yaml:"location,omitempty"`
	Name        corev1alpha1.Text            `json:"name,omitempty" yaml:"name,omitempty"`

	// PatternFile Designs are your primary tool for collaborative authorship of your infrastructure, workflow, and processes.
	PatternFile *PatternFile      `json:"pattern_file,omitempty" yaml:"pattern_file,omitempty"`
	UpdatedAt   corev1alpha1.Time `json:"updated_at,omitempty" yaml:"updated_at,omitempty"`
	UserId      corev1alpha1.Id   `json:"user_id,omitempty" yaml:"user_id,omitempty"`
	Visibility  corev1alpha1.Text `json:"visibility,omitempty" yaml:"visibility,omitempty"`
}

MesheryPattern defines model for MesheryPattern.

type MesheryPatternDeleteRequestBody

type MesheryPatternDeleteRequestBody struct {
	Patterns *[]DeletePatternModel `json:"patterns,omitempty" yaml:"patterns,omitempty"`
}

MesheryPatternDeleteRequestBody defines model for MesheryPatternDeleteRequestBody.

type MesheryPatternImportRequestBody added in v0.8.15

type MesheryPatternImportRequestBody struct {
	// File Supported formats: Kubernetes Manifests, Helm Charts, Docker Compose, and Meshery Designs. See [Import Designs Documentation](https://docs.meshery.io/guides/configuration-management/importing-designs#import-designs-using-meshery-ui) for details
	File *string `json:"file,omitempty" yaml:"file,omitempty"`

	// FileName The name of the pattern file being imported.
	FileName *string `json:"file_name,omitempty" yaml:"file_name,omitempty"`

	// Name Provide a name for your design file. This name will help you identify the file more easily. You can also change the name of your design after importing it.
	Name *string `json:"name,omitempty" yaml:"name,omitempty"`

	// Url Provide the URL of the file you want to import. This should be a direct URL to a single file, for example: https://raw.github.com/your-design-file.yaml. Also, ensure that design is in a supported format: Kubernetes Manifest, Helm Chart, Docker Compose, or Meshery Design. See [Import Designs Documentation](https://docs.meshery.io/guides/configuration-management/importing-designs#import-designs-using-meshery-ui) for details
	Url *string `json:"url,omitempty" yaml:"url,omitempty"`
}

MesheryPatternImportRequestBody Choose the method you prefer to upload your design file. Select 'File Upload' if you have the file on your local system, or 'URL Import' if you have the file hosted online.

type MesheryPatternPage

type MesheryPatternPage struct {
	Page       *int              `json:"page,omitempty" yaml:"page,omitempty"`
	PageSize   *int              `json:"page_size,omitempty" yaml:"page_size,omitempty"`
	Patterns   *[]MesheryPattern `json:"patterns,omitempty" yaml:"patterns,omitempty"`
	ResultType *string           `json:"resultType,omitempty" yaml:"resultType,omitempty"`
	TotalCount *int              `json:"total_count,omitempty" yaml:"total_count,omitempty"`
}

MesheryPatternPage defines model for MesheryPatternPage.

type MesheryPatternRequestBody

type MesheryPatternRequestBody struct {
	Name        *string               `json:"name,omitempty" yaml:"name,omitempty"`
	Path        corev1alpha1.Text     `json:"path,omitempty" yaml:"path,omitempty"`
	PatternData *MesheryPattern       `json:"pattern_data,omitempty" yaml:"pattern_data,omitempty"`
	Save        *bool                 `json:"save,omitempty" yaml:"save,omitempty"`
	Url         corev1alpha1.Endpoint `json:"url,omitempty" yaml:"url,omitempty"`
}

MesheryPatternRequestBody defines model for MesheryPatternRequestBody.

type Options added in v0.7.17

type Options struct {
	// EnableTrace If true, include detailed trace information in the response
	EnableTrace *bool `json:"enableTrace,omitempty" yaml:"enableTrace"`

	// ReturnDiffOnly If true, only return the diff of changes instead of the complete updated design
	ReturnDiffOnly *bool `json:"returnDiffOnly,omitempty" yaml:"returnDiffOnly"`
}

type Order added in v0.8.129

type Order = string

Order defines model for order.

type Page added in v0.8.129

type Page = string

Page defines model for page.

type Pagesize added in v0.8.129

type Pagesize = string

Pagesize defines model for pagesize.

type PatternFile

type PatternFile struct {
	// Id A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
	ID corev1alpha1.Uuid `json:"id" yaml:"id"`

	// Name Name of the design; a descriptive, but concise title for the design document.
	Name string `json:"name" yaml:"name"`

	// SchemaVersion API version of the object, optionally prefixed with an API group (e.g. "group.example.io/v1beta1" or bare "v1beta1").
	SchemaVersion corev1alpha1.VersionString `json:"schemaVersion" yaml:"schemaVersion"`

	// Version A valid semantic version string between 5 and 100 characters. The pattern allows for a major.minor.patch version followed by an optional pre-release tag like '-alpha' or '-beta.2' and an optional build metadata tag like '+build.1'.
	Version  corev1alpha1.SemverString `json:"version" yaml:"version"`
	Metadata *PatternFile_Metadata     `json:"metadata,omitempty" yaml:"metadata,omitempty"`

	// Components A list of one or more component declarations.
	Components []*component.ComponentDefinition `json:"components" yaml:"components"`

	// Preferences Design-level preferences
	Preferences *DesignPreferences `json:"preferences,omitempty" yaml:"preferences,omitempty"`

	// Relationships List of relationships between components
	Relationships []*relationship.RelationshipDefinition `json:"relationships" yaml:"relationships"`
}

PatternFile Designs are your primary tool for collaborative authorship of your infrastructure, workflow, and processes.

func (*PatternFile) ConvertFrom

func (p *PatternFile) ConvertFrom(pattern conversion.Hub) error

The pattern file indicated by "pattern" is converted to the version to which *PatternFile belongs or simply the package version of the .go file. "pattern" parameter acts as the source and the "p" the destination.

func (*PatternFile) ConvertTo

func (p *PatternFile) ConvertTo(pattern conversion.Hub) error

The pattern file indicated by "p", is converted to the version pointed by "pattern", the version of the patternFile which implements the Hub interface indicates the version the conversion will happen. Only one version of the resource (patternfile in this case) should implement the Hub interface. "pattern" parameter acts as the destination and "p" the source.

type PatternFile_Metadata added in v0.8.1

type PatternFile_Metadata struct {
	// ResolvedAliases Map of resolved aliases present in the design
	ResolvedAliases      *map[string]corev1alpha1.ResolvedAlias `json:"resolvedAliases,omitempty" yaml:"resolvedAliases,omitempty"`
	AdditionalProperties map[string]interface{}                 `json:"-" yaml:"-"`
}

PatternFile_Metadata defines model for PatternFile.Metadata.

func (PatternFile_Metadata) Get added in v0.8.1

func (a PatternFile_Metadata) Get(fieldName string) (value interface{}, found bool)

Getter for additional properties for PatternFile_Metadata. Returns the specified element and whether it was found

func (PatternFile_Metadata) MarshalJSON added in v0.8.1

func (a PatternFile_Metadata) MarshalJSON() ([]byte, error)

Override default JSON handling for PatternFile_Metadata to handle AdditionalProperties

func (*PatternFile_Metadata) Set added in v0.8.1

func (a *PatternFile_Metadata) Set(fieldName string, value interface{})

Setter for additional properties for PatternFile_Metadata

func (*PatternFile_Metadata) UnmarshalJSON added in v0.8.1

func (a *PatternFile_Metadata) UnmarshalJSON(b []byte) error

Override default JSON handling for PatternFile_Metadata to handle AdditionalProperties

type Search = string

Search defines model for search.

type Trace added in v0.7.17

type Trace struct {
	// ComponentsAdded List of new components added to the design.
	ComponentsAdded []component.ComponentDefinition `json:"componentsAdded" yaml:"componentsAdded"`

	// ComponentsRemoved List of components removed from the design.
	ComponentsRemoved []component.ComponentDefinition `json:"componentsRemoved" yaml:"componentsRemoved"`

	// ComponentsUpdated List of components updated in the design.
	ComponentsUpdated []component.ComponentDefinition `json:"componentsUpdated" yaml:"componentsUpdated"`

	// PolicyActions List of policy actions applied during the evaluation.
	PolicyActions []string `json:"policyActions" yaml:"policyActions"`

	// RelationshipsAdded List of new relationships added to the design.
	RelationshipsAdded []relationship.RelationshipDefinition `json:"relationshipsAdded" yaml:"relationshipsAdded"`

	// RelationshipsRemoved List of relationships removed from the design.
	RelationshipsRemoved []relationship.RelationshipDefinition `json:"relationshipsRemoved" yaml:"relationshipsRemoved"`

	// RelationshipsUpdated List of relationships updated in the design.
	RelationshipsUpdated []relationship.RelationshipDefinition `json:"relationshipsUpdated" yaml:"relationshipsUpdated"`
}

Jump to

Keyboard shortcuts

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