pattern

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.3.0 DO NOT EDIT.

Index

• type DeletePatternModel
• type DesignShare
• type EvaluationRequest
• type EvaluationResponse
• type MesheryPattern
• type MesheryPatternCatalogDataClass
• type MesheryPatternCatalogDataCompatibility
• type MesheryPatternCatalogDataType
• type MesheryPatternDeleteRequestBody
• type MesheryPatternPage
• type MesheryPatternRequestBody
• type MesheryPatternResource
• type MesheryPatternResourcePage
• type Options
• type PatternFile
  • func (p *PatternFile) ConvertFrom(pattern conversion.Hub) error
  • func (p *PatternFile) ConvertTo(pattern conversion.Hub) error
• type Trace

Types

type DeletePatternModel

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

DeletePatternModel defines model for deletePatternModel.

type DesignShare

type DesignShare struct {
	ContentType string              `json:"content_type"`
	Emails      externalRef1.Emails `json:"emails"`
	ID          externalRef1.Id     `db:"id" json:"id"`
	Share       bool                `json:"share"`
}

DesignShare defines model for designShare.

type EvaluationRequest

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

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  externalRef0.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"`
}

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

type MesheryPattern

type MesheryPattern struct {
	CatalogData *v1alpha2.CatalogData  `json:"catalog_data,omitempty" yaml:"catalog_data"`
	CreatedAt   externalRef1.Time      `json:"created_at,omitempty"`
	UserID      externalRef1.Id        `db:"user_id" json:"user_id"`
	Location    externalRef1.MapObject `json:"location,omitempty"`
	Name        externalRef1.Text      `json:"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" gorm:"type:bytes;serializer:json"`
	UpdatedAt   externalRef1.Time `json:"updated_at,omitempty"`
	ID          externalRef1.Id   `db:"id" json:"id"`
	Visibility  externalRef1.Text `json:"visibility,omitempty"`
}

MesheryPattern defines model for mesheryPattern.

type MesheryPatternCatalogDataClass

type MesheryPatternCatalogDataClass string

MesheryPatternCatalogDataClass Published content is classifed by its support level. Content classes help you understand the origin and expected support level for each piece of content. It is important to note that the level of support may vary within each class, and you should exercise discretion when using community-contributed content. Content produced and fully supported by Meshery maintainers. This represents the highest level of support and is considered the most reliable. Content produced by partners and verified by Meshery maintainers. While not directly maintained by Meshery, it has undergone a verification process to ensure quality and compatibility. Content produced and supported by the respective project or organization responsible for the specific technology. This class offers a level of support from the project maintainers themselves. Content produced and shared by Meshery users. This includes a wide range of content, such as performance profiles, test results, filters, patterns, and applications. Community content may have varying levels of support and reliability.

const (
	Community MesheryPatternCatalogDataClass = "community"
	Official  MesheryPatternCatalogDataClass = "official"
	Verified  MesheryPatternCatalogDataClass = "verified"
)

Defines values for MesheryPatternCatalogDataClass.

type MesheryPatternCatalogDataCompatibility

type MesheryPatternCatalogDataCompatibility string

MesheryPatternCatalogDataCompatibility defines model for MesheryPattern.CatalogData.Compatibility.

const (
	Kubernetes MesheryPatternCatalogDataCompatibility = "kubernetes"
)

Defines values for MesheryPatternCatalogDataCompatibility.

type MesheryPatternCatalogDataType

type MesheryPatternCatalogDataType string

MesheryPatternCatalogDataType Categorization of the type of design or operational flow depicted in this design.

const (
	Deployment        MesheryPatternCatalogDataType = "Deployment"
	Observability     MesheryPatternCatalogDataType = "Observability"
	Resiliency        MesheryPatternCatalogDataType = "Resiliency"
	Scaling           MesheryPatternCatalogDataType = "Scaling"
	Security          MesheryPatternCatalogDataType = "Security"
	TrafficManagement MesheryPatternCatalogDataType = "Traffic-management"
	Troubleshooting   MesheryPatternCatalogDataType = "Troubleshooting"
	Workloads         MesheryPatternCatalogDataType = "Workloads"
)

Defines values for MesheryPatternCatalogDataType.

type MesheryPatternDeleteRequestBody

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

MesheryPatternDeleteRequestBody defines model for mesheryPatternDeleteRequestBody.

type MesheryPatternPage

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

MesheryPatternPage defines model for mesheryPatternPage.

type MesheryPatternRequestBody

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

MesheryPatternRequestBody defines model for mesheryPatternRequestBody.

type MesheryPatternResource

type MesheryPatternResource struct {
	CreatedAt externalRef1.Time `json:"created_at,omitempty"`
	Deleted   *bool             `json:"deleted,omitempty"`
	ID        externalRef1.Id   `db:"id" json:"id"`
	Name      externalRef1.Text `json:"name,omitempty"`
	Namepace  externalRef1.Text `json:"namepace,omitempty"`
	OamType   externalRef1.Text `json:"oam_type,omitempty"`
	Type      externalRef1.Text `json:"type,omitempty"`
	UpdatedAt externalRef1.Time `json:"updated_at,omitempty"`
	UserID    externalRef1.Id   `db:"user_id" json:"user_id"`
}

MesheryPatternResource defines model for mesheryPatternResource.

type MesheryPatternResourcePage

type MesheryPatternResourcePage struct {
	Page       int                       `json:"page,omitempty"`
	PageSize   int                       `json:"page_size,omitempty"`
	Resources  *[]MesheryPatternResource `json:"resources,omitempty"`
	ResultType string                    `json:"resultType,omitempty"`
	TotalCount int                       `json:"total_count,omitempty"`
}

MesheryPatternResourcePage defines model for mesheryPatternResourcePage.

type Options

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 PatternFile

type PatternFile struct {
	Id externalRef1.Id `json:"id,omitempty" yaml:"id,omitempty"`

	// Components List of component declarations
	Components []*component.ComponentDefinition `json:"components" yaml:"components"`

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

	// Preferences Design-level preferences
	Preferences *struct {
		// Layers List of available layers
		Layers []string `json:"layers"`
	} `json:"preferences,omitempty"`

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

	// SchemaVersion Specifies the version of the schema to which the design conforms.
	SchemaVersion string `json:"schemaVersion" yaml:"schemaVersion"`

	// Version Revision of the design as expressed by an auto-incremented, SemVer-compliant version number. May be manually set by a user or third-party system, but will always be required to be of version number higher than the previously defined version number.
	Version string `json:"version" yaml:"version"`
}

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 Trace

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"`

	// 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"`
}