unifiedcatalog

Documentation

Index

• type AccessControlItem
• type AuditMetadata
• type CatalogDefinitionPropertySpec
• type CatalogDefinitionRevision
• type CatalogDefinitionSubtype
• type CatalogDefinitionType
• type CatalogItem
• type CatalogItemImage
• type CatalogItemInit
• type CatalogItemInitRevision
• type CatalogItemProperty
• type CatalogItemRevision
• type CatalogItemSubscription
• type CatalogItemSubscriptionDefinition
• type CatalogItemSubscriptionState
• type Category
• type ChartDataPoint
• type EntityRelationship
• type ExternalUrlResource
• type ExternalUrlResourceAllOf
• type GenericResource
• type InlineResponse201
• type InlineResponse2011
• type InlineResponse400
• type InlineResponse400Errors
• type InlineResponse400Meta
• type InlineResponse401
• type InlineResponse401Errors
• type InlineResponse401Meta
• type InlineResponse500
• type InlineResponse500Errors

Types

type AccessControlItem

type AccessControlItem struct {
	Id         string        `json:"id,omitempty"`
	EntityType string        `json:"entityType"`
	EntityId   string        `json:"entityId"`
	Metadata   AuditMetadata `json:"metadata,omitempty"`
}

AccessControlItem struct for AccessControlItem

type AuditMetadata

type AuditMetadata struct {
	// The creation time
	CreateTimestamp time.Time `json:"createTimestamp,omitempty"`
	// Id of the user that created the entity
	CreateUserId string `json:"createUserId,omitempty"`
	// The last modification time
	ModifyTimestamp time.Time `json:"modifyTimestamp,omitempty"`
	// Id of the user that last modified the entity
	ModifyUserId string `json:"modifyUserId,omitempty"`
}

AuditMetadata Audit information

type CatalogDefinitionPropertySpec

type CatalogDefinitionPropertySpec struct {
	Name         string   `json:"name,omitempty"`
	SchemaType   string   `json:"schemaType,omitempty"`
	Immutable    bool     `json:"immutable,omitempty"`
	Required     bool     `json:"required,omitempty"`
	AllowedRoles []string `json:"allowedRoles,omitempty"`
	// Indicates if spec data processing is tight to another spec data key properties set.
	CatalogItemSpecRef string `json:"catalogItemSpecRef,omitempty"`
	// Indicates if validation of the spec will fail fast, at the first encountered error.
	FailFast bool `json:"failFast,omitempty"`
}

CatalogDefinitionPropertySpec Defines the CatalogItem properties specifications.

type CatalogDefinitionRevision

type CatalogDefinitionRevision struct {
	Value        int32                           `json:"value,omitempty"`
	Revision     []CatalogDefinitionPropertySpec `json:"revision,omitempty"`
	Subscription []CatalogDefinitionPropertySpec `json:"subscription,omitempty"`
	CatalogItem  []CatalogDefinitionPropertySpec `json:"catalogItem,omitempty"`
}

CatalogDefinitionRevision Defines the properties specs for a specific definition

type CatalogDefinitionSubtype

type CatalogDefinitionSubtype struct {
	Name           string                    `json:"name,omitempty"`
	Value          string                    `json:"value,omitempty"`
	Description    string                    `json:"description,omitempty"`
	Revisions      []int32                   `json:"revisions,omitempty"`
	LatestRevision CatalogDefinitionRevision `json:"latestRevision,omitempty"`
}

CatalogDefinitionSubtype Defines the CatalogItem subtype value

type CatalogDefinitionType

type CatalogDefinitionType struct {
	Value       string                     `json:"value,omitempty"`
	Description string                     `json:"description,omitempty"`
	Subtypes    []CatalogDefinitionSubtype `json:"subtypes,omitempty"`
}

CatalogDefinitionType Defines the type of a CatalogItem

type CatalogItem

type CatalogItem struct {
	// Generated identifier for the resource
	Id string `json:"id,omitempty"`
	// Id of the owning team of this catalog item
	OwningTeamId string `json:"owningTeamId,omitempty"`
	// Type of the definition for the catalog item
	DefinitionType string `json:"definitionType"`
	// Sub-Type of the definition for the catalog item
	DefinitionSubType string `json:"definitionSubType"`
	// Revision of the definition for the catalog item
	DefinitionRevision int32 `json:"definitionRevision"`
	// Name of the catalog item
	Name          string             `json:"name"`
	Relationships EntityRelationship `json:"relationships,omitempty"`
	// Description of the catalog item
	Description        string        `json:"description,omitempty"`
	Tags               []string      `json:"tags,omitempty"`
	Metadata           AuditMetadata `json:"metadata,omitempty"`
	Visibility         string        `json:"visibility"`
	State              string        `json:"state"`
	Access             string        `json:"access,omitempty"`
	AvailableRevisions []int32       `json:"availableRevisions,omitempty"`
	// Latest version of the published revision.
	LatestVersion string `json:"latestVersion,omitempty"`
	// Number of subscriptions for the catalog item
	TotalSubscriptions   int32               `json:"totalSubscriptions,omitempty"`
	LatestVersionDetails CatalogItemRevision `json:"latestVersionDetails,omitempty"`
	Image                CatalogItemImage    `json:"image,omitempty"`
	Categories           []Category          `json:"categories,omitempty"`
	Acl                  []AccessControlItem `json:"acl,omitempty"`
}

CatalogItem struct for CatalogItem

type CatalogItemImage

type CatalogItemImage struct {
	// Content-type of the image
	Data string `json:"data"`
	// Base64 encoded image
	Base64 string `json:"base64"`
}

CatalogItemImage struct for CatalogItemImage

type CatalogItemInit

type CatalogItemInit struct {
	// Id of the owning team of this catalog item
	OwningTeamId string `json:"owningTeamId,omitempty"`
	// Type of the definition for the catalog item
	DefinitionType string `json:"definitionType"`
	// Sub-Type of the definition for the catalog item
	DefinitionSubType string `json:"definitionSubType"`
	// Revision of the definition for the catalog item
	DefinitionRevision int32 `json:"definitionRevision"`
	// Name of the catalog item
	Name string `json:"name"`
	// Description of the catalog item
	Description  string                            `json:"description,omitempty"`
	Properties   []CatalogItemProperty             `json:"properties"`
	Tags         []string                          `json:"tags,omitempty"`
	Visibility   string                            `json:"visibility"`
	Subscription CatalogItemSubscriptionDefinition `json:"subscription"`
	Revision     CatalogItemInitRevision           `json:"revision"`
	// A list of categories ids.
	CategoriesReferences []string `json:"categoriesReferences,omitempty"`
}

CatalogItemInit struct for CatalogItemInit

type CatalogItemInitRevision

type CatalogItemInitRevision struct {
	// Generated identifier for the resource
	Id         string                `json:"id,omitempty"`
	Properties []CatalogItemProperty `json:"properties"`
	Number     int32                 `json:"number,omitempty"`
	// Version name for the revision.
	Version string `json:"version"`
	State   string `json:"state"`
	Status  string `json:"status,omitempty"`
}

CatalogItemInitRevision struct for CatalogItemInitRevision

type CatalogItemProperty

type CatalogItemProperty struct {
	Key   string                 `json:"key"`
	Value map[string]interface{} `json:"value"`
}

CatalogItemProperty struct for CatalogItemProperty

type CatalogItemRevision

type CatalogItemRevision struct {
	// Generated identifier for the resource
	Id       string        `json:"id,omitempty"`
	Metadata AuditMetadata `json:"metadata,omitempty"`
	Number   int32         `json:"number,omitempty"`
	// Version name for the revision.
	Version string `json:"version"`
	State   string `json:"state"`
	Status  string `json:"status,omitempty"`
}

CatalogItemRevision struct for CatalogItemRevision

type CatalogItemSubscription

type CatalogItemSubscription struct {
	Id         string                `json:"id,omitempty"`
	Metadata   AuditMetadata         `json:"metadata,omitempty"`
	Properties []CatalogItemProperty `json:"properties,omitempty"`
	State      string                `json:"state"`
	// Description of the current subscription state.
	StateDescription        string   `json:"stateDescription,omitempty"`
	CatalogItemId           string   `json:"catalogItemId,omitempty"`
	OwningTeamId            string   `json:"owningTeamId,omitempty"`
	Deletable               bool     `json:"deletable,omitempty"`
	NextPossibleStates      []string `json:"nextPossibleStates,omitempty"`
	AllowedTransitionStates []string `json:"allowedTransitionStates,omitempty"`
	Name                    string   `json:"name,omitempty"`
}

CatalogItemSubscription struct for CatalogItemSubscription

type CatalogItemSubscriptionDefinition

type CatalogItemSubscriptionDefinition struct {
	Enabled         bool                  `json:"enabled,omitempty"`
	AutoSubscribe   bool                  `json:"autoSubscribe,omitempty"`
	AutoUnsubscribe bool                  `json:"autoUnsubscribe,omitempty"`
	Metadata        AuditMetadata         `json:"metadata,omitempty"`
	Properties      []CatalogItemProperty `json:"properties,omitempty"`
}

CatalogItemSubscriptionDefinition struct for CatalogItemSubscriptionDefinition

type CatalogItemSubscriptionState

type CatalogItemSubscriptionState struct {
	Id string `json:"id,omitempty"`
	// Description of the subscription state
	Description string        `json:"description,omitempty"`
	State       string        `json:"state"`
	Metadata    AuditMetadata `json:"metadata,omitempty"`
}

CatalogItemSubscriptionState A state of the catalog item subscription

type Category

type Category struct {
	// Generated identifier for the resource
	Id string `json:"id,omitempty"`
	// Name of the category item
	Name string `json:"name"`
	// Description of the catalog item
	Description string        `json:"description,omitempty"`
	Metadata    AuditMetadata `json:"metadata,omitempty"`
}

Category struct for Category

type ChartDataPoint

type ChartDataPoint struct {
	// Data point timestamp
	Time float32 `json:"time"`
	// Value based on chart type
	Total float32 `json:"total,omitempty"`
}

ChartDataPoint struct for ChartDataPoint

type EntityRelationship

type EntityRelationship struct {
	Type             string `json:"type,omitempty"`
	Value            string `json:"value,omitempty"`
	Path             string `json:"path,omitempty"`
	Key              string `json:"key,omitempty"`
	Spec             string `json:"spec,omitempty"`
	FromCompositeKey bool   `json:"fromCompositeKey,omitempty"`
}

EntityRelationship struct for EntityRelationship

type ExternalUrlResource

type ExternalUrlResource struct {
	Id          string           `json:"id,omitempty"`
	Type        string           `json:"type"`
	Tags        []string         `json:"tags,omitempty"`
	Name        string           `json:"name"`
	Description string           `json:"description,omitempty"`
	Metadata    AuditMetadata    `json:"metadata,omitempty"`
	Image       CatalogItemImage `json:"image,omitempty"`
	// Defines the external resource address.
	Url string `json:"url"`
}

ExternalUrlResource struct for ExternalUrlResource

type ExternalUrlResourceAllOf

type ExternalUrlResourceAllOf struct {
	// Defines the external resource address.
	Url string `json:"url"`
}

ExternalUrlResourceAllOf struct for ExternalUrlResourceAllOf

type GenericResource

type GenericResource struct {
	Id          string           `json:"id,omitempty"`
	Type        string           `json:"type"`
	Tags        []string         `json:"tags,omitempty"`
	Name        string           `json:"name"`
	Description string           `json:"description,omitempty"`
	Metadata    AuditMetadata    `json:"metadata,omitempty"`
	Image       CatalogItemImage `json:"image,omitempty"`
}

GenericResource struct for GenericResource

type InlineResponse201

type InlineResponse201 struct {
	Subscription CatalogItemSubscription `json:"subscription,omitempty"`
}

InlineResponse201 struct for InlineResponse201

type InlineResponse2011

type InlineResponse2011 struct {
	ExternalUrlResource ExternalUrlResource `json:"ExternalUrlResource,omitempty"`
}

InlineResponse2011 struct for InlineResponse2011

type InlineResponse400

type InlineResponse400 struct {
	Errors []InlineResponse400Errors `json:"errors,omitempty"`
}

InlineResponse400 struct for InlineResponse400

type InlineResponse400Errors

type InlineResponse400Errors struct {
	Status int32                 `json:"status,omitempty"`
	Title  string                `json:"title,omitempty"`
	Detail string                `json:"detail,omitempty"`
	Meta   InlineResponse400Meta `json:"meta,omitempty"`
}

InlineResponse400Errors struct for InlineResponse400Errors

type InlineResponse400Meta

type InlineResponse400Meta struct {
	InstanceId          string `json:"instanceId,omitempty"`
	TenantId            string `json:"tenantId,omitempty"`
	AuthenticatedUserId string `json:"authenticatedUserId,omitempty"`
	TransactionId       string `json:"transactionId,omitempty"`
}

InlineResponse400Meta struct for InlineResponse400Meta

type InlineResponse401

type InlineResponse401 struct {
	Errors []InlineResponse401Errors `json:"errors,omitempty"`
}

InlineResponse401 struct for InlineResponse401

type InlineResponse401Errors

type InlineResponse401Errors struct {
	Status int32                 `json:"status,omitempty"`
	Title  string                `json:"title,omitempty"`
	Detail string                `json:"detail,omitempty"`
	Meta   InlineResponse401Meta `json:"meta,omitempty"`
}

InlineResponse401Errors struct for InlineResponse401Errors

type InlineResponse401Meta

type InlineResponse401Meta struct {
	InstanceId string `json:"instanceId,omitempty"`
}

InlineResponse401Meta struct for InlineResponse401Meta

type InlineResponse500

type InlineResponse500 struct {
	Errors []InlineResponse500Errors `json:"errors,omitempty"`
}

InlineResponse500 struct for InlineResponse500

type InlineResponse500Errors

type InlineResponse500Errors struct {
	Status string                `json:"status,omitempty"`
	Title  string                `json:"title,omitempty"`
	Detail string                `json:"detail,omitempty"`
	Meta   InlineResponse401Meta `json:"meta,omitempty"`
}

InlineResponse500Errors struct for InlineResponse500Errors