Documentation ¶
Overview ¶
Copyright 2023 Cisco Systems, Inc.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
Copyright 2023 Cisco Systems, Inc.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
Index ¶
- Constants
- func Fetch(path string, httpOptions *api.Options) map[string]interface{}
- func GetSolutionForkCommand() *cobra.Command
- func GetTag(envVars interface{}) string
- func LoadEnvVars(cmd *cobra.Command, tag, envVarsFile string) (interface{}, error)
- func NewSubCmd() *cobra.Command
- func ReplaceStringInFile(fileSystem afero.Fs, filePath string, searchValue string, replaceValue string) error
- type ComponentDef
- type DashuiCartesian
- type DashuiCartesianAxis
- type DashuiCartesianMetric
- type DashuiCartesianSeries
- type DashuiClickable
- type DashuiEcpHomeEntity
- type DashuiEcpHomeSection
- type DashuiEvent
- type DashuiFocusedEntity
- type DashuiGrid
- type DashuiGridCell
- type DashuiGridColumn
- type DashuiHtmlWidget
- type DashuiLabel
- type DashuiLogsWidget
- type DashuiOcpSingle
- type DashuiProperties
- type DashuiProperty
- type DashuiString
- type DashuiTemplate
- type DashuiTemplatePropsExtension
- type DashuiTooltip
- type DashuiWidget
- type EcpHome
- type EcpInspectorWidget
- type EcpLeftBar
- type EcpRelationshipMapEntry
- type ErrorItem
- type Errors
- type FmmAssociationDeclaration
- type FmmAssociationTypesTypeDef
- type FmmAttributeDefinitionsTypeDef
- type FmmAttributeTypeDef
- type FmmEntity
- type FmmEvent
- type FmmLifecycleConfigTypeDef
- type FmmMapAndTransform
- type FmmMetric
- type FmmMetricCategory
- type FmmMetricContentType
- type FmmMetricType
- type FmmNameMappings
- type FmmNamespace
- type FmmNamespaceAssignTypeDef
- type FmmResourceMapping
- type FmmTemporality
- type FmmTypeDef
- type IdGenerationDef
- type KnowledgeDef
- type Manifest
- func (manifest *Manifest) AppendDependency(solutionName string)
- func (manifest *Manifest) CheckDependencyExists(solutionName string) bool
- func (manifest *Manifest) GetComponentDef(typeName string) *ComponentDef
- func (manifest *Manifest) GetComponentDefs(typeName string) []ComponentDef
- func (manifest *Manifest) GetDashuiTemplates() []*DashuiTemplate
- func (manifest *Manifest) GetFmmEntities() []*FmmEntity
- func (manifest *Manifest) GetFmmEvents() []*FmmEvent
- func (manifest *Manifest) GetFmmMetrics() []*FmmMetric
- func (manifest *Manifest) GetNamespaceName() string
- func (manifest *Manifest) GetSolutionName() string
- func (manifest *Manifest) HasIsolation() bool
- type ResponseBlob
- type Result
- type ServiceDef
- type Solution
- type SolutionDef
- type SolutionList
- type SolutionTestAssertion
- type SolutionTestAssertionTransform
- type SolutionTestObject
- type SolutionTestObjects
- type SolutionTestResult
- type SolutionTestSetup
- type SolutionTestStatusResult
- type StatusData
- type StatusItem
- type StatusMessage
- type SubscriptionStatusData
- type SubscriptionStatusItem
- type SubscriptionStatusResponseBlob
Constants ¶
const MAX_SUBSCRIBE_TRIES = 4
Variables ¶
This section is empty.
Functions ¶
func GetSolutionForkCommand ¶
func LoadEnvVars ¶ added in v0.45.0
Types ¶
type ComponentDef ¶
type DashuiCartesian ¶ added in v0.38.0
type DashuiCartesian struct { *DashuiWidget Children []*DashuiCartesianSeries `json:"children"` }
func NewDashuiCartesian ¶ added in v0.38.0
func NewDashuiCartesian() *DashuiCartesian
type DashuiCartesianAxis ¶ added in v0.38.0
type DashuiCartesianAxis struct {
Field string `json:"type"`
}
type DashuiCartesianMetric ¶ added in v0.38.0
type DashuiCartesianMetric struct { Name string `json:"name"` Source string `json:"source"` Y *DashuiCartesianAxis `json:"y"` }
type DashuiCartesianSeries ¶ added in v0.38.0
type DashuiCartesianSeries struct { Props interface{} `json:"props"` Metric *DashuiCartesianMetric `json:"metric"` Type string `json:"type"` }
func NewDashuiCartesianSeries ¶ added in v0.38.0
func NewDashuiCartesianSeries(seriesName string, metricName string, metricSource string, seriesType string) *DashuiCartesianSeries
type DashuiClickable ¶ added in v0.38.0
type DashuiClickable struct { *DashuiWidget OnClick *DashuiEvent `json:"onclick,omitempty"` Trigger *DashuiLabel `json:"trigger,omitempty"` }
func NewDashuiClickable ¶ added in v0.38.0
func NewDashuiClickable() *DashuiClickable
type DashuiEcpHomeEntity ¶ added in v0.38.0
type DashuiEcpHomeSection ¶ added in v0.38.0
type DashuiEvent ¶ added in v0.38.0
type DashuiFocusedEntity ¶ added in v0.38.0
type DashuiFocusedEntity struct { *DashuiWidget Mode string `json:"mode"` }
type DashuiGrid ¶ added in v0.38.0
type DashuiGrid struct { *DashuiWidget RowSets interface{} `json:"rowSets"` Style interface{} `json:"style,omitempty"` Mode string `json:"mode"` Columns []*DashuiGridColumn `json:"columns"` OnRowSingleClick *DashuiEvent `json:"onRowSingleClick,omitempty"` OnRowDoubleClick *DashuiEvent `json:"onRowDoubleClick,omitempty"` }
func NewDashuiGrid ¶ added in v0.38.0
func NewDashuiGrid() *DashuiGrid
type DashuiGridCell ¶ added in v0.38.0
type DashuiGridCell struct {
Default interface{} `json:"default,omitempty"`
}
func NewClickableDashuiGridCell ¶ added in v0.38.0
func NewClickableDashuiGridCell(attribute string) *DashuiGridCell
func NewDashuiGridCell ¶ added in v0.38.0
func NewDashuiGridCell(attribute string) *DashuiGridCell
type DashuiGridColumn ¶ added in v0.38.0
type DashuiGridColumn struct { Label string `json:"label"` Flex int `json:"flex"` Width int `json:"width"` Cell *DashuiGridCell `json:"cell"` }
type DashuiHtmlWidget ¶ added in v0.38.0
type DashuiHtmlWidget struct { *DashuiWidget Style interface{} `json:"style,omitempty"` }
func NewDashuiHtmlWidget ¶ added in v0.38.0
func NewDashuiHtmlWidget() *DashuiHtmlWidget
type DashuiLabel ¶ added in v0.38.0
type DashuiLabel struct { InstanceOf interface{} `json:"instanceOf"` Path interface{} `json:"path"` }
type DashuiLogsWidget ¶ added in v0.38.0
type DashuiLogsWidget struct { InstanceOf interface{} `json:"instanceOf"` Source string `json:"source"` }
func NewDashuiLogsWidget ¶ added in v0.38.0
func NewDashuiLogsWidget() *DashuiLogsWidget
type DashuiOcpSingle ¶ added in v0.38.0
type DashuiOcpSingle struct { *DashuiWidget NameAttribute string `json:"nameAttribute"` }
func NewDashuiOcpSingle ¶ added in v0.38.0
func NewDashuiOcpSingle(nameAttribute string) *DashuiOcpSingle
type DashuiProperties ¶ added in v0.38.0
type DashuiProperties struct { InstanceOf interface{} `json:"instanceOf"` Elements []*DashuiProperty `json:"elements"` }
func NewDashuiProperties ¶ added in v0.38.0
func NewDashuiProperties() *DashuiProperties
type DashuiProperty ¶ added in v0.38.0
type DashuiProperty struct { Label *DashuiString `json:"label"` Value *DashuiLabel `json:"value"` }
type DashuiString ¶ added in v0.38.0
type DashuiTemplate ¶ added in v0.38.0
type DashuiTemplatePropsExtension ¶ added in v0.38.0
type DashuiTemplatePropsExtension struct { Kind string `json:"kind"` Id string `json:"id"` Name string `json:"name"` View string `json:"view"` Target string `json:"target"` RequiredEntityTypes []string `json:"requiredEntityTypes"` Props interface{} `json:"props"` }
func NewDashuiTemplatePropsExtension ¶ added in v0.38.0
type DashuiTooltip ¶ added in v0.38.0
type DashuiTooltip struct { *DashuiWidget Truncate bool `json:"truncate,omitempty"` Trigger interface{} `json:"trigger,omitempty"` }
func NewDashuiTooltip ¶ added in v0.38.0
func NewDashuiTooltip(attributeName string, isClickable bool) *DashuiTooltip
type DashuiWidget ¶ added in v0.38.0
type DashuiWidget struct { InstanceOf interface{} `json:"instanceOf"` Props interface{} `json:"props,omitempty"` Elements interface{} `json:"elements,omitempty"` Element interface{} `json:"element,omitempty"` }
type EcpHome ¶ added in v0.38.0
type EcpHome struct { Sections []*DashuiEcpHomeSection `json:"sections"` Entities []*DashuiEcpHomeEntity `json:"entities"` }
type EcpInspectorWidget ¶ added in v0.38.0
type EcpInspectorWidget struct { *DashuiWidget Title string `json:"title"` }
func NewEcpInspectorWidget ¶ added in v0.38.0
func NewEcpInspectorWidget(title string) *EcpInspectorWidget
type EcpLeftBar ¶ added in v0.38.0
type EcpLeftBar struct { *DashuiWidget Label string `json:"label"` }
type EcpRelationshipMapEntry ¶ added in v0.38.0
type FmmAssociationDeclaration ¶ added in v0.38.0
type FmmAssociationDeclaration struct { *FmmTypeDef ScopeFilter string `json:"scopeFilter"` FromType string `json:"fromType"` ToType string `json:"toType"` AssociationType string `json:"associationType"` }
type FmmAssociationTypesTypeDef ¶
type FmmAssociationTypesTypeDef struct { Aggregates_of []string `json:"common:aggregates_of,omitempty"` Consists_of []string `json:"common:consists_of,omitempty"` Is_a []string `json:"common:is_a,omitempty"` Has []string `json:"common:has,omitempty"` Relates_to []string `json:"common:relates_to,omitempty"` Uses []string `json:"common:uses,omitempty"` }
type FmmAttributeDefinitionsTypeDef ¶
type FmmAttributeDefinitionsTypeDef struct { Required []string `json:"required"` Optimized []string `json:"optimized"` Attributes map[string]*FmmAttributeTypeDef `json:"attributes"` }
type FmmAttributeTypeDef ¶
type FmmEntity ¶
type FmmEntity struct { *FmmTypeDef AttributeDefinitions *FmmAttributeDefinitionsTypeDef `json:"attributeDefinitions"` LifecyleConfiguration *FmmLifecycleConfigTypeDef `json:"lifecycleConfiguration"` MetricTypes []string `json:"metricTypes,omitempty"` EventTypes []string `json:"eventTypes,omitempty"` AssociationTypes *FmmAssociationTypesTypeDef `json:"associationTypes,omitempty"` }
func (*FmmEntity) GetTypeName ¶ added in v0.38.0
type FmmEvent ¶ added in v0.28.0
type FmmEvent struct { *FmmTypeDef AttributeDefinitions *FmmAttributeDefinitionsTypeDef `json:"attributeDefinitions"` }
type FmmMapAndTransform ¶
type FmmMetric ¶
type FmmMetric struct { *FmmTypeDef Category FmmMetricCategory `json:"category"` ContentType FmmMetricContentType `json:"contentType"` AggregationTemporality string `json:"aggregationTemporality"` IsMonotonic bool `json:"isMonotonic"` Type FmmMetricType `json:"type"` Unit string `json:"unit"` AttributeDefinitions *FmmAttributeDefinitionsTypeDef `json:"attributeDefinitions"` IngestGranularities []int `json:"ingestGranularities,omitempty"` }
type FmmMetricCategory ¶
type FmmMetricCategory string
const ( Category_Sum FmmMetricCategory = "sum" Category_Average FmmMetricCategory = "average" Category_Rate FmmMetricCategory = "rate" Category_Current FmmMetricCategory = "current" )
type FmmMetricContentType ¶
type FmmMetricContentType string
const ( ContentType_Sum FmmMetricContentType = "sum" ContentType_Gauge FmmMetricContentType = "gauge" ContentType_Distribution FmmMetricContentType = "distribution" )
type FmmMetricType ¶
type FmmMetricType string
const ( Type_Long FmmMetricType = "long" Type_Double FmmMetricType = "double" )
type FmmNameMappings ¶
type FmmNamespace ¶
type FmmNamespace struct {
Name string `json:"name"`
}
type FmmResourceMapping ¶
type FmmResourceMapping struct { *FmmTypeDef EntityType string `json:"entityType"` ScopeFilter string `json:"scopeFilter"` Mappings []FmmMapAndTransform `json:"mappings,omitempty"` AttributeNameMappings FmmNameMappings `json:"attributeNameMappings,omitempty"` }
type FmmTemporality ¶
type FmmTemporality string
const ( Temp_Delta FmmTemporality = "delta" Temp_False FmmTemporality = "unspecified" )
type FmmTypeDef ¶
type FmmTypeDef struct { Namespace *FmmNamespaceAssignTypeDef `json:"namespace"` Kind string `json:"kind"` Name string `json:"name"` DisplayName string `json:"displayName,omitempty"` }
type IdGenerationDef ¶
type KnowledgeDef ¶
type KnowledgeDef struct { Name string `json:"name,omitempty"` AllowedLayers []string `json:"allowedLayers,omitempty"` IdGeneration *IdGenerationDef `json:"idGeneration,omitempty"` SecureProperties []string `json:"secureProperties,omitempty"` JsonSchema map[string]interface{} `json:"jsonSchema,omitempty"` }
type Manifest ¶
type Manifest struct { ManifestVersion string `json:"manifestVersion,omitempty"` Name string `json:"name,omitempty"` SolutionVersion string `json:"solutionVersion,omitempty"` Dependencies []string `json:"dependencies"` Description string `json:"description,omitempty"` Contact string `json:"contact,omitempty"` HomePage string `json:"homepage,omitempty"` GitRepoUrl string `json:"gitRepoUrl,omitempty"` Readme string `json:"readme,omitempty"` Objects []ComponentDef `json:"objects,omitempty"` Types []string `json:"types,omitempty"` }
func GetManifest ¶ added in v0.30.0
func GetManifest() *Manifest
func (*Manifest) AppendDependency ¶ added in v0.38.0
func (*Manifest) CheckDependencyExists ¶ added in v0.38.0
func (*Manifest) GetComponentDef ¶ added in v0.38.0
func (manifest *Manifest) GetComponentDef(typeName string) *ComponentDef
func (*Manifest) GetComponentDefs ¶ added in v0.38.0
func (manifest *Manifest) GetComponentDefs(typeName string) []ComponentDef
func (*Manifest) GetDashuiTemplates ¶ added in v0.38.0
func (manifest *Manifest) GetDashuiTemplates() []*DashuiTemplate
func (*Manifest) GetFmmEntities ¶ added in v0.38.0
func (*Manifest) GetFmmEvents ¶ added in v0.38.0
func (*Manifest) GetFmmMetrics ¶ added in v0.38.0
func (*Manifest) GetNamespaceName ¶ added in v0.45.0
func (*Manifest) GetSolutionName ¶ added in v0.45.0
func (*Manifest) HasIsolation ¶ added in v0.45.0
type ResponseBlob ¶
type ResponseBlob struct {
Items []StatusItem `json:"items"`
}
type ServiceDef ¶
type Solution ¶ added in v0.28.0
type Solution struct { ID string `json:"id"` LayerID string `json:"layerId"` LayerType string `json:"layerType"` ObjectMimeType string `json:"objectMimeType"` TargetObjectId string `json:"targetObjectId"` CreatedAt string `json:"createdAt"` UpdatedAt string `json:"updatedAt"` DisplayName string `json:"displayName"` }
type SolutionDef ¶
type SolutionList ¶ added in v0.33.0
type SolutionList struct {
Items []Solution `json:"items"`
}
type SolutionTestAssertion ¶ added in v0.38.0
type SolutionTestAssertion struct { UQL string `json:"uql"` Transforms []SolutionTestAssertionTransform `json:"transforms"` }
type SolutionTestAssertionTransform ¶ added in v0.38.0
type SolutionTestObject ¶ added in v0.38.0
type SolutionTestObject struct { Name string `json:"name,omitempty"` Type string `json:"type,omitempty"` Description string `json:"description,omitempty"` Setup SolutionTestSetup `json:"setup"` Assertions []SolutionTestAssertion `json:"assertions"` }
type SolutionTestObjects ¶ added in v0.38.0
type SolutionTestObjects struct { Tests []SolutionTestObject `json:"tests"` InitialDelay int `json:"initialDelay,omitempty"` MaxRetryCount int `json:"retryCount,omitempty"` RetryDelay int `json:"retryDelay,omitempty"` }
type SolutionTestResult ¶ added in v0.38.0
type SolutionTestResult struct {
ID string `json:"testRunId"`
}
type SolutionTestSetup ¶ added in v0.38.0
type SolutionTestStatusResult ¶ added in v0.38.0
type SolutionTestStatusResult struct { Complete bool `json:"completed"` Status string `json:"status"` StatusMessages []StatusMessage `json:"statusMessages"` }
type StatusData ¶
type StatusItem ¶
type StatusItem struct { StatusData StatusData `json:"data"` CreatedAt string `json:"createdAt"` }
type StatusMessage ¶ added in v0.38.0
type SubscriptionStatusData ¶ added in v0.34.0
type SubscriptionStatusItem ¶ added in v0.34.0
type SubscriptionStatusItem struct { SubscriptionStatusData SubscriptionStatusData `json:"data"` CreatedAt string `json:"createdAt"` }
func (SubscriptionStatusItem) IsEmpty ¶ added in v0.34.0
func (s SubscriptionStatusItem) IsEmpty() bool
type SubscriptionStatusResponseBlob ¶ added in v0.34.0
type SubscriptionStatusResponseBlob struct {
Items []SubscriptionStatusItem `json:"items"`
}
Source Files ¶
- bump.go
- check.go
- describe.go
- download.go
- embed-isolate.go
- extend-dashui.go
- extend-fmm.go
- extend.go
- fork.go
- init.go
- isolate.go
- list.go
- name.go
- package.go
- push.go
- solution.go
- status.go
- subscribe.go
- test.go
- types-dashui.go
- types-fmm.go
- types-solution-test.go
- types.go
- unsubscribe.go
- upload.go
- validate.go