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 ¶
- type Action
- type CatalogContentClass
- type CatalogContentItem
- type CatalogContentPage
- type CatalogContentPayload
- type CatalogRequest
- type CatalogRequestsPage
- type DeletePatternModel
- type DesignPreferences
- type EvaluationRequest
- type EvaluationResponse
- type Id
- type MesheryFilter
- type MesheryPattern
- type MesheryPatternDeleteRequestBody
- type MesheryPatternImportFilePayload
- type MesheryPatternImportRequestBody
- func (t MesheryPatternImportRequestBody) AsMesheryPatternImportFilePayload() (MesheryPatternImportFilePayload, error)
- func (t MesheryPatternImportRequestBody) AsMesheryPatternImportURLPayload() (MesheryPatternImportURLPayload, error)
- func (t *MesheryPatternImportRequestBody) FromMesheryPatternImportFilePayload(v MesheryPatternImportFilePayload) error
- func (t *MesheryPatternImportRequestBody) FromMesheryPatternImportURLPayload(v MesheryPatternImportURLPayload) error
- func (t MesheryPatternImportRequestBody) MarshalJSON() ([]byte, error)
- func (t *MesheryPatternImportRequestBody) MergeMesheryPatternImportFilePayload(v MesheryPatternImportFilePayload) error
- func (t *MesheryPatternImportRequestBody) MergeMesheryPatternImportURLPayload(v MesheryPatternImportURLPayload) error
- func (t *MesheryPatternImportRequestBody) UnmarshalJSON(b []byte) error
- type MesheryPatternImportURLPayload
- type MesheryPatternPage
- type MesheryPatternRequestBody
- type Options
- type Order
- type Page
- type Pagesize
- type PatternFile
- type PatternFile_Metadata
- type ResourceAccessActorsResponse
- type ResourceAccessMapping
- type ResourceSharePayload
- type Search
- type Trace
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type CatalogContentClass ¶ added in v0.9.0
type CatalogContentClass struct {
Class *string `json:"class,omitempty" yaml:"class,omitempty"`
Description *string `json:"description,omitempty" yaml:"description,omitempty"`
AdditionalProperties map[string]interface{} `json:"-" yaml:"-"`
}
CatalogContentClass defines model for CatalogContentClass.
func (CatalogContentClass) Get ¶ added in v0.9.0
func (a CatalogContentClass) Get(fieldName string) (value interface{}, found bool)
Getter for additional properties for CatalogContentClass. Returns the specified element and whether it was found
func (CatalogContentClass) MarshalJSON ¶ added in v0.9.0
func (a CatalogContentClass) MarshalJSON() ([]byte, error)
Override default JSON handling for CatalogContentClass to handle AdditionalProperties
func (*CatalogContentClass) Set ¶ added in v0.9.0
func (a *CatalogContentClass) Set(fieldName string, value interface{})
Setter for additional properties for CatalogContentClass
func (*CatalogContentClass) UnmarshalJSON ¶ added in v0.9.0
func (a *CatalogContentClass) UnmarshalJSON(b []byte) error
Override default JSON handling for CatalogContentClass to handle AdditionalProperties
type CatalogContentItem ¶ added in v0.9.0
type CatalogContentItem map[string]interface{}
CatalogContentItem defines model for CatalogContentItem.
type CatalogContentPage ¶ added in v0.9.0
type CatalogContentPage struct {
CategoryCount *[]map[string]interface{} `json:"categoryCount,omitempty" yaml:"categoryCount,omitempty"`
Filters *[]MesheryFilter `json:"filters,omitempty" yaml:"filters,omitempty"`
ModelsCount *[]map[string]interface{} `json:"modelsCount,omitempty" yaml:"modelsCount,omitempty"`
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"`
TotalCount *int `json:"total_count,omitempty" yaml:"total_count,omitempty"`
}
CatalogContentPage defines model for CatalogContentPage.
type CatalogContentPayload ¶ added in v0.9.0
type CatalogContentPayload map[string]interface{}
CatalogContentPayload defines model for catalogContentPayload.
type CatalogRequest ¶ added in v0.9.0
type CatalogRequest map[string]interface{}
CatalogRequest defines model for CatalogRequest.
type CatalogRequestsPage ¶ added in v0.9.0
type CatalogRequestsPage struct {
CatalogRequests *[]CatalogRequest `json:"catalogRequests,omitempty" yaml:"catalogRequests,omitempty"`
Page *int `json:"page,omitempty" yaml:"page,omitempty"`
PageSize *int `json:"page_size,omitempty" yaml:"page_size,omitempty"`
TotalCount *int `json:"total_count,omitempty" yaml:"total_count,omitempty"`
}
CatalogRequestsPage defines model for CatalogRequestsPage.
type DeletePatternModel ¶
type DeletePatternModel struct {
ID core.Id `json:"id,omitempty" yaml:"id,omitempty"`
Name core.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
Id A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
type MesheryFilter ¶ added in v0.9.0
type MesheryFilter map[string]interface{}
MesheryFilter defines model for MesheryFilter.
type MesheryPattern ¶
type MesheryPattern struct {
CatalogData *catalogv1beta1.CatalogData `json:"catalogData,omitempty" yaml:"catalogData,omitempty"`
CreatedAt core.Time `json:"created_at,omitempty" yaml:"created_at,omitempty"`
ID core.Id `json:"id,omitempty" yaml:"id,omitempty"`
Location core.MapObject `json:"location,omitempty" yaml:"location,omitempty"`
Name core.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:"patternFile,omitempty" yaml:"patternFile,omitempty"`
UpdatedAt core.Time `json:"updated_at,omitempty" yaml:"updated_at,omitempty"`
UserId core.Id `json:"user_id,omitempty" yaml:"user_id,omitempty"`
Visibility core.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 MesheryPatternImportFilePayload ¶ added in v1.0.9
type MesheryPatternImportFilePayload struct {
// File Base64-encoded file bytes. 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 []byte `json:"file" yaml:"file"`
// FileName The name of the pattern file being imported. Include the extension (e.g. `design.yaml`), as the server uses it to identify the file type.
FileName string `json:"file_name" yaml:"file_name"`
// Name Provide a name for your design. This name will help you identify the design later. You can also change the name of your design after importing it.
Name *string `json:"name,omitempty" yaml:"name,omitempty"`
}
MesheryPatternImportFilePayload Upload a design file from the local system. Both `file` and `file_name` are required; the server uses the file name to identify the file type (Kubernetes Manifest, Helm Chart, Docker Compose, or Meshery Design).
type MesheryPatternImportRequestBody ¶ added in v0.8.15
type MesheryPatternImportRequestBody struct {
// contains filtered or unexported fields
}
MesheryPatternImportRequestBody Body for POST /api/pattern/import. Consumed by the server as application/json. Exactly one of two variants must be supplied: a File Import carrying base64-encoded bytes plus a file name, or a URL Import naming a remote location the server will fetch. Sending both variants at once, or neither, is rejected with 400.
func (MesheryPatternImportRequestBody) AsMesheryPatternImportFilePayload ¶ added in v1.0.9
func (t MesheryPatternImportRequestBody) AsMesheryPatternImportFilePayload() (MesheryPatternImportFilePayload, error)
AsMesheryPatternImportFilePayload returns the union data inside the MesheryPatternImportRequestBody as a MesheryPatternImportFilePayload
func (MesheryPatternImportRequestBody) AsMesheryPatternImportURLPayload ¶ added in v1.0.9
func (t MesheryPatternImportRequestBody) AsMesheryPatternImportURLPayload() (MesheryPatternImportURLPayload, error)
AsMesheryPatternImportURLPayload returns the union data inside the MesheryPatternImportRequestBody as a MesheryPatternImportURLPayload
func (*MesheryPatternImportRequestBody) FromMesheryPatternImportFilePayload ¶ added in v1.0.9
func (t *MesheryPatternImportRequestBody) FromMesheryPatternImportFilePayload(v MesheryPatternImportFilePayload) error
FromMesheryPatternImportFilePayload overwrites any union data inside the MesheryPatternImportRequestBody as the provided MesheryPatternImportFilePayload
func (*MesheryPatternImportRequestBody) FromMesheryPatternImportURLPayload ¶ added in v1.0.9
func (t *MesheryPatternImportRequestBody) FromMesheryPatternImportURLPayload(v MesheryPatternImportURLPayload) error
FromMesheryPatternImportURLPayload overwrites any union data inside the MesheryPatternImportRequestBody as the provided MesheryPatternImportURLPayload
func (MesheryPatternImportRequestBody) MarshalJSON ¶ added in v1.0.9
func (t MesheryPatternImportRequestBody) MarshalJSON() ([]byte, error)
func (*MesheryPatternImportRequestBody) MergeMesheryPatternImportFilePayload ¶ added in v1.0.9
func (t *MesheryPatternImportRequestBody) MergeMesheryPatternImportFilePayload(v MesheryPatternImportFilePayload) error
MergeMesheryPatternImportFilePayload performs a merge with any union data inside the MesheryPatternImportRequestBody, using the provided MesheryPatternImportFilePayload
func (*MesheryPatternImportRequestBody) MergeMesheryPatternImportURLPayload ¶ added in v1.0.9
func (t *MesheryPatternImportRequestBody) MergeMesheryPatternImportURLPayload(v MesheryPatternImportURLPayload) error
MergeMesheryPatternImportURLPayload performs a merge with any union data inside the MesheryPatternImportRequestBody, using the provided MesheryPatternImportURLPayload
func (*MesheryPatternImportRequestBody) UnmarshalJSON ¶ added in v1.0.9
func (t *MesheryPatternImportRequestBody) UnmarshalJSON(b []byte) error
type MesheryPatternImportURLPayload ¶ added in v1.0.9
type MesheryPatternImportURLPayload struct {
// Name Provide a name for your design. This name will help you identify the design later. You can also change the name of your design after importing it.
Name *string `json:"name,omitempty" yaml:"name,omitempty"`
// Url A direct URL to a single file, for example: https://raw.github.com/your-design-file.yaml. Ensure the resource 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" yaml:"url"`
}
MesheryPatternImportURLPayload Import a design by URL. The server will fetch the resource and derive the file type from the response.
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 core.Text `json:"path,omitempty" yaml:"path,omitempty"`
PatternData *MesheryPattern `json:"patternData,omitempty" yaml:"patternData,omitempty"`
Save *bool `json:"save,omitempty" yaml:"save,omitempty"`
Url core.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 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 core.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 core.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 core.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]core.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 ResourceAccessActorsResponse ¶ added in v0.9.0
type ResourceAccessActorsResponse struct {
Users *[]map[string]interface{} `json:"users,omitempty" yaml:"users,omitempty"`
}
ResourceAccessActorsResponse defines model for ResourceAccessActorsResponse.
type ResourceAccessMapping ¶ added in v0.9.0
type ResourceAccessMapping map[string]interface{}
ResourceAccessMapping defines model for ResourceAccessMapping.
type ResourceSharePayload ¶ added in v0.9.0
type ResourceSharePayload map[string]interface{}
ResourceSharePayload defines model for resourceSharePayload.
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"`
}