model

package
v0.0.0-...-a423d60 Latest Latest
Warning

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

Go to latest
Published: Jul 4, 2024 License: Apache-2.0 Imports: 16 Imported by: 0

Documentation

Index

Constants

View Source
const (
	// InitialAssignmentState indicates that nothing has been done with the formation assignment
	InitialAssignmentState FormationAssignmentState = "INITIAL"
	// ReadyAssignmentState indicates that the formation assignment is in a ready state
	ReadyAssignmentState FormationAssignmentState = "READY"
	// ConfigPendingAssignmentState indicates that the config is either missing or not finalized in the formation assignment
	ConfigPendingAssignmentState FormationAssignmentState = "CONFIG_PENDING"
	// CreateErrorAssignmentState indicates that an error occurred during the creation of the formation assignment
	CreateErrorAssignmentState FormationAssignmentState = "CREATE_ERROR"
	// DeletingAssignmentState indicates that async unassign notification is sent and status report is expected from the receiver
	DeletingAssignmentState FormationAssignmentState = "DELETING"
	// DeleteErrorAssignmentState indicates that an error occurred during the deletion of the formation assignment
	DeleteErrorAssignmentState FormationAssignmentState = "DELETE_ERROR"
	// CreateReadyFormationAssignmentState indicates that the formation assignment is in a ready state and the response is for an assign notification
	CreateReadyFormationAssignmentState FormationAssignmentState = "CREATE_READY"
	// DeleteReadyFormationAssignmentState indicates that the formation assignment is in a ready state and the response is for an unassign notification
	DeleteReadyFormationAssignmentState FormationAssignmentState = "DELETE_READY"
	// NotificationRecursionDepthLimit is the maximum count of configuration exchanges during assigning an object to formation
	NotificationRecursionDepthLimit int = 10
)
View Source
const AppPathURL = "/%s/v1/events"

AppPathURL missing godoc

View Source
const DefaultTemplateName = "Side-by-Side Extensibility with Kyma"

DefaultTemplateName will be used as default formation template name if no other options are provided

View Source
const (
	// ScenariosKey is scenarios label key
	ScenariosKey = "scenarios"
)

Variables

ResynchronizableFormationAssignmentStates is an array of supported assignment states for resynchronization

View Source
var (
	// SchemaForScenariosSchema is used to validate ScenariosSchema (allows only modifications to enum field)
	SchemaForScenariosSchema = map[string]interface{}{
		"type":                 "object",
		"additionalProperties": false,
		"required":             []string{"type", "minItems", "uniqueItems", "items"},
		"properties": map[string]interface{}{
			"type": map[string]interface{}{
				"const": "array",
			},
			"minItems": map[string]interface{}{
				"const": 1,
			},
			"uniqueItems": map[string]interface{}{
				"const": true,
			},
			"items": map[string]interface{}{
				"type":                 "object",
				"additionalProperties": false,
				"required":             []string{"type", "enum"},
				"properties": map[string]interface{}{
					"type": map[string]interface{}{
						"const": "string",
					},
					"pattern": map[string]interface{}{
						"const": "^[A-Za-z0-9]([-_A-Za-z0-9\\s]*[A-Za-z0-9])$",
					},
					"maxLength": map[string]interface{}{
						"const": 128,
					},
					"enum": map[string]interface{}{
						"type": "array",
						"items": map[string]interface{}{
							"type":      "string",
							"pattern":   "^[A-Za-z0-9]([-_A-Za-z0-9\\s]*[A-Za-z0-9])$",
							"maxLength": 128,
						},
						"contains": map[string]interface{}{},
					},
				},
			},
		},
	}
)

SupportedFormationAssignmentStates contains the supported formation assignment states

Functions

func NewScenariosSchema

func NewScenariosSchema(scenarios []string) map[string]interface{}

NewScenariosSchema returns new scenario schema for given scenarios

Types

type APIDefinition

type APIDefinition struct {
	ApplicationID                           *string
	ApplicationTemplateVersionID            *string
	PackageID                               *string
	Name                                    string
	Description                             *string
	TargetURLs                              json.RawMessage
	Group                                   *string //  group allows you to find the same API but in different version
	OrdID                                   *string
	LocalTenantID                           *string
	ShortDescription                        *string
	SystemInstanceAware                     *bool
	PolicyLevel                             *string
	CustomPolicyLevel                       *string
	APIProtocol                             *string
	Tags                                    json.RawMessage
	Countries                               json.RawMessage
	Links                                   json.RawMessage
	APIResourceLinks                        json.RawMessage
	ReleaseStatus                           *string
	SunsetDate                              *string
	Successors                              json.RawMessage
	ChangeLogEntries                        json.RawMessage
	Labels                                  json.RawMessage
	Visibility                              *string
	Disabled                                *bool
	PartOfProducts                          json.RawMessage
	LineOfBusiness                          json.RawMessage
	Industry                                json.RawMessage
	ImplementationStandard                  *string
	CustomImplementationStandard            *string
	CustomImplementationStandardDescription *string
	Version                                 *Version
	Extensible                              json.RawMessage
	ResourceHash                            *string
	SupportedUseCases                       json.RawMessage
	DocumentationLabels                     json.RawMessage
	CorrelationIDs                          json.RawMessage
	Direction                               *string
	LastUpdate                              *string
	DeprecationDate                         *string
	Responsible                             *string
	Usage                                   *string
	*BaseEntity
}

APIDefinition missing godoc

func (*APIDefinition) GetType

func (*APIDefinition) GetType() resource.Type

GetType missing godoc

type APIDefinitionInput

type APIDefinitionInput struct {
	OrdPackageID                            *string                       `json:"partOfPackage"`
	Tenant                                  string                        `json:",omitempty"`
	Name                                    string                        `json:"title"`
	Description                             *string                       `json:"description"`
	TargetURLs                              json.RawMessage               `json:"entryPoints"`
	Group                                   *string                       `json:",omitempty"` //  group allows you to find the same API but in different version
	OrdID                                   *string                       `json:"ordId"`
	LocalTenantID                           *string                       `json:"localId"`
	ShortDescription                        *string                       `json:"shortDescription"`
	SystemInstanceAware                     *bool                         `json:"systemInstanceAware"`
	PolicyLevel                             *string                       `json:"policyLevel"`
	CustomPolicyLevel                       *string                       `json:"customPolicyLevel"`
	APIProtocol                             *string                       `json:"apiProtocol"`
	Tags                                    json.RawMessage               `json:"tags"`
	Countries                               json.RawMessage               `json:"countries"`
	Links                                   json.RawMessage               `json:"links"`
	APIResourceLinks                        json.RawMessage               `json:"apiResourceLinks"`
	ReleaseStatus                           *string                       `json:"releaseStatus"`
	SunsetDate                              *string                       `json:"sunsetDate"`
	Successors                              json.RawMessage               `json:"successors,omitempty"`
	ChangeLogEntries                        json.RawMessage               `json:"changelogEntries"`
	Labels                                  json.RawMessage               `json:"labels"`
	Visibility                              *string                       `json:"visibility"`
	Disabled                                *bool                         `json:"disabled"`
	PartOfProducts                          json.RawMessage               `json:"partOfProducts"`
	LineOfBusiness                          json.RawMessage               `json:"lineOfBusiness"`
	Industry                                json.RawMessage               `json:"industry"`
	ImplementationStandard                  *string                       `json:"implementationStandard"`
	CustomImplementationStandard            *string                       `json:"customImplementationStandard"`
	CustomImplementationStandardDescription *string                       `json:"customImplementationStandardDescription"`
	Extensible                              json.RawMessage               `json:"extensible"`
	ResourceDefinitions                     []*APIResourceDefinition      `json:"resourceDefinitions"`
	PartOfConsumptionBundles                []*ConsumptionBundleReference `json:"partOfConsumptionBundles"`
	DefaultConsumptionBundle                *string                       `json:"defaultConsumptionBundle"`
	SupportedUseCases                       json.RawMessage               `json:"supportedUseCases"`
	EntityTypeMappings                      []*EntityTypeMappingInput     `json:"entityTypeMappings"`
	DocumentationLabels                     json.RawMessage               `json:"documentationLabels"`
	CorrelationIDs                          json.RawMessage               `json:"correlationIds,omitempty"`
	Direction                               *string                       `json:"direction"`
	LastUpdate                              *string                       `json:"lastUpdate" hash:"ignore"`
	DeprecationDate                         *string                       `json:"deprecationDate"`
	Responsible                             *string                       `json:"responsible"`
	Usage                                   *string                       `json:"usage"`
	*VersionInput                           `hash:"ignore"`
}

APIDefinitionInput missing godoc

func (*APIDefinitionInput) ToAPIDefinition

func (a *APIDefinitionInput) ToAPIDefinition(id string, resourceType resource.Type, resourceID string, packageID *string, apiHash uint64) *APIDefinition

ToAPIDefinition missing godoc

type APIDefinitionPage

type APIDefinitionPage struct {
	Data       []*APIDefinition
	PageInfo   *pagination.Page
	TotalCount int
}

APIDefinitionPage missing godoc

func (APIDefinitionPage) IsPageable

func (APIDefinitionPage) IsPageable()

IsPageable missing godoc

type APIModelSelector

type APIModelSelector struct {
	Type          string  `json:"type"`
	EntitySetName *string `json:"entitySetName,omitempty"`
	JSONPointer   *string `json:"jsonPointer,omitempty"`
}

APIModelSelector represents the API Model Selector entity

type APIResourceDefinition

type APIResourceDefinition struct {
	Type           APISpecType                     `json:"type"`
	CustomType     string                          `json:"customType"`
	MediaType      SpecFormat                      `json:"mediaType"`
	URL            string                          `json:"url"`
	AccessStrategy accessstrategy.AccessStrategies `json:"accessStrategies"`
}

APIResourceDefinition missing godoc

func (*APIResourceDefinition) ToSpec

func (rd *APIResourceDefinition) ToSpec() *SpecInput

ToSpec missing godoc

type APIRuntimeAuth

type APIRuntimeAuth struct {
	ID        *string
	TenantID  string
	RuntimeID string
	APIDefID  string
	Value     *Auth
}

APIRuntimeAuth missing godoc

type APISpecType

type APISpecType string

APISpecType is the type of the API Specification.

const (
	// APISpecTypeOdata is the OData Specification.
	APISpecTypeOdata APISpecType = "ODATA"
	// APISpecTypeOpenAPI is the OpenAPI Specification.
	APISpecTypeOpenAPI APISpecType = "OPEN_API"

	// APISpecTypeOpenAPIV2 is the OpenAPI V2 Specification.
	APISpecTypeOpenAPIV2 APISpecType = "openapi-v2"
	// APISpecTypeOpenAPIV3 is the OpenAPI V3 Specification.
	APISpecTypeOpenAPIV3 APISpecType = "openapi-v3"
	// APISpecTypeRaml is the RAML Specification.
	APISpecTypeRaml APISpecType = "raml-v1"
	// APISpecTypeEDMX is the EDMX Specification.
	APISpecTypeEDMX APISpecType = "edmx"
	// APISpecTypeCsdl is the CSDL Specification.
	APISpecTypeCsdl APISpecType = "csdl-json"
	// APISpecTypeWsdlV1 is the WSDL V1 Specification.
	APISpecTypeWsdlV1 APISpecType = "wsdl-v1"
	// APISpecTypeWsdlV2 is the WSDL V2 Specification.
	APISpecTypeWsdlV2 APISpecType = "wsdl-v2"
	// APISpecTypeRfcMetadata is the RFC Metadata Specification.
	APISpecTypeRfcMetadata APISpecType = "sap-rfc-metadata-v1"
	// APISpecTypeSQLAPIDefinitionV1 is the SQL API Definition Specification.
	APISpecTypeSQLAPIDefinitionV1 APISpecType = "sap-sql-api-definition-v1"
	// APISpecTypeGraphqlSDL is the Graphql Specification.
	APISpecTypeGraphqlSDL APISpecType = "graphql-sdl"
	// APISpecTypeCustom is the Custom Specification.
	APISpecTypeCustom APISpecType = "custom"
)

type Application

type Application struct {
	ProviderName          *string
	Name                  string
	Description           *string
	Status                *ApplicationStatus
	HealthCheckURL        *string
	IntegrationSystemID   *string
	ApplicationTemplateID *string
	SystemNumber          *string
	LocalTenantID         *string
	BaseURL               *string         `json:"baseUrl"`
	ApplicationNamespace  *string         `json:"applicationNamespace"`
	OrdLabels             json.RawMessage `json:"labels"`
	CorrelationIDs        json.RawMessage `json:"correlationIds,omitempty"`
	Type                  string          `json:"-"`
	// SystemStatus shows whether the on-premise system is reachable or unreachable
	SystemStatus        *string
	Tags                json.RawMessage `json:"tags"`
	DocumentationLabels json.RawMessage `json:"documentationLabels"`

	*BaseEntity
}

Application missing godoc

func (*Application) GetType

func (*Application) GetType() resource.Type

GetType returns Type application

func (*Application) SetFromUpdateInput

func (app *Application) SetFromUpdateInput(update ApplicationUpdateInput, timestamp time.Time)

SetFromUpdateInput missing godoc

type ApplicationEventingConfiguration

type ApplicationEventingConfiguration struct {
	EventingConfiguration
}

ApplicationEventingConfiguration missing godoc

func NewApplicationEventingConfiguration

func NewApplicationEventingConfiguration(runtimeEventURL url.URL, appName string) (*ApplicationEventingConfiguration, error)

NewApplicationEventingConfiguration missing godoc

func NewEmptyApplicationEventingConfig

func NewEmptyApplicationEventingConfig() (*ApplicationEventingConfiguration, error)

NewEmptyApplicationEventingConfig missing godoc

type ApplicationFromTemplateInput

type ApplicationFromTemplateInput struct {
	ID                  *string
	TemplateName        string
	Values              ApplicationFromTemplateInputValues
	PlaceholdersPayload *string
	Labels              map[string]interface{}
}

ApplicationFromTemplateInput missing godoc

type ApplicationFromTemplateInputValues

type ApplicationFromTemplateInputValues []*ApplicationTemplateValueInput

ApplicationFromTemplateInputValues missing godoc

func (ApplicationFromTemplateInputValues) FindPlaceholderValue

func (in ApplicationFromTemplateInputValues) FindPlaceholderValue(name string) (string, error)

FindPlaceholderValue missing godoc

type ApplicationPage

type ApplicationPage struct {
	Data       []*Application
	PageInfo   *pagination.Page
	TotalCount int
}

ApplicationPage missing godoc

type ApplicationRegisterInput

type ApplicationRegisterInput struct {
	Name                 string
	ProviderName         *string
	Description          *string
	Labels               map[string]interface{}
	HealthCheckURL       *string
	Webhooks             []*WebhookInput
	Bundles              []*BundleCreateInput
	IntegrationSystemID  *string
	StatusCondition      *ApplicationStatusCondition
	BaseURL              *string
	ApplicationNamespace *string
	SystemNumber         *string
	OrdLabels            json.RawMessage
	CorrelationIDs       json.RawMessage
	SystemStatus         *string
	Tags                 json.RawMessage
	DocumentationLabels  json.RawMessage
	LocalTenantID        *string
}

ApplicationRegisterInput missing godoc

func (*ApplicationRegisterInput) ToApplication

func (i *ApplicationRegisterInput) ToApplication(timestamp time.Time, id string) *Application

ToApplication missing godoc

type ApplicationRegisterInputWithTemplate

type ApplicationRegisterInputWithTemplate struct {
	ApplicationRegisterInput
	TemplateID string
}

ApplicationRegisterInputWithTemplate missing godoc

type ApplicationStatus

type ApplicationStatus struct {
	Condition ApplicationStatusCondition
	Timestamp time.Time
}

ApplicationStatus missing godoc

type ApplicationStatusCondition

type ApplicationStatusCondition string

ApplicationStatusCondition missing godoc

const (
	// ApplicationStatusConditionInitial missing godoc
	ApplicationStatusConditionInitial ApplicationStatusCondition = "INITIAL"
	// ApplicationStatusConditionConnected missing godoc
	ApplicationStatusConditionConnected ApplicationStatusCondition = "CONNECTED"
	// ApplicationStatusConditionFailed missing godoc
	ApplicationStatusConditionFailed ApplicationStatusCondition = "FAILED"
	// ApplicationStatusConditionCreating missing godoc
	ApplicationStatusConditionCreating ApplicationStatusCondition = "CREATING"
	// ApplicationStatusConditionCreateFailed missing godoc
	ApplicationStatusConditionCreateFailed ApplicationStatusCondition = "CREATE_FAILED"
	// ApplicationStatusConditionCreateSucceeded missing godoc
	ApplicationStatusConditionCreateSucceeded ApplicationStatusCondition = "CREATE_SUCCEEDED"
	// ApplicationStatusConditionUpdating missing godoc
	ApplicationStatusConditionUpdating ApplicationStatusCondition = "UPDATING"
	// ApplicationStatusConditionUpdateFailed missing godoc
	ApplicationStatusConditionUpdateFailed ApplicationStatusCondition = "UPDATE_FAILED"
	// ApplicationStatusConditionUpdateSucceeded missing godoc
	ApplicationStatusConditionUpdateSucceeded ApplicationStatusCondition = "UPDATE_SUCCEEDED"
	// ApplicationStatusConditionDeleting missing godoc
	ApplicationStatusConditionDeleting ApplicationStatusCondition = "DELETING"
	// ApplicationStatusConditionDeleteFailed missing godoc
	ApplicationStatusConditionDeleteFailed ApplicationStatusCondition = "DELETE_FAILED"
	// ApplicationStatusConditionDeleteSucceeded missing godoc
	ApplicationStatusConditionDeleteSucceeded ApplicationStatusCondition = "DELETE_SUCCEEDED"
	// ApplicationStatusConditionUnpairing Status condition when an application is being unpairing
	ApplicationStatusConditionUnpairing ApplicationStatusCondition = "UNPAIRING"
	// ApplicationStatusConditionUnpairFailed Status condition when an application has failed to unpair
	ApplicationStatusConditionUnpairFailed ApplicationStatusCondition = "UNPAIR_FAILED"
)

type ApplicationTemplate

type ApplicationTemplate struct {
	ID                   string
	Name                 string
	Description          *string
	ApplicationNamespace *string
	ApplicationInputJSON string
	Placeholders         []ApplicationTemplatePlaceholder
	AccessLevel          ApplicationTemplateAccessLevel
	Webhooks             []Webhook
	Labels               map[string]interface{}
	CreatedAt            time.Time
	UpdatedAt            time.Time
}

ApplicationTemplate missing godoc

func (*ApplicationTemplate) SetCreatedAt

func (at *ApplicationTemplate) SetCreatedAt(t time.Time)

SetCreatedAt is a setter for CreatedAt property

func (*ApplicationTemplate) SetUpdatedAt

func (at *ApplicationTemplate) SetUpdatedAt(t time.Time)

SetUpdatedAt is a setter for UpdatedAt property

type ApplicationTemplateAccessLevel

type ApplicationTemplateAccessLevel string

ApplicationTemplateAccessLevel missing godoc

const (
	GlobalApplicationTemplateAccessLevel ApplicationTemplateAccessLevel = "GLOBAL"
)

GlobalApplicationTemplateAccessLevel missing godoc

type ApplicationTemplateInput

type ApplicationTemplateInput struct {
	ID                   *string
	Name                 string
	Description          *string
	ApplicationNamespace *string
	ApplicationInputJSON string
	Placeholders         []ApplicationTemplatePlaceholder
	AccessLevel          ApplicationTemplateAccessLevel
	Labels               map[string]interface{}
	Webhooks             []*WebhookInput
}

ApplicationTemplateInput missing godoc

func (*ApplicationTemplateInput) ToApplicationTemplate

func (a *ApplicationTemplateInput) ToApplicationTemplate(id string) ApplicationTemplate

ToApplicationTemplate missing godoc

type ApplicationTemplatePage

type ApplicationTemplatePage struct {
	Data       []*ApplicationTemplate
	PageInfo   *pagination.Page
	TotalCount int
}

ApplicationTemplatePage missing godoc

type ApplicationTemplatePlaceholder

type ApplicationTemplatePlaceholder struct {
	Name        string
	Description *string
	JSONPath    *string
	Optional    *bool
}

ApplicationTemplatePlaceholder missing godoc

type ApplicationTemplateUpdateInput

type ApplicationTemplateUpdateInput struct {
	Name                 string
	Description          *string
	ApplicationNamespace *string
	ApplicationInputJSON string
	Placeholders         []ApplicationTemplatePlaceholder
	AccessLevel          ApplicationTemplateAccessLevel
	Labels               map[string]interface{}
	Webhooks             []*WebhookInput
}

ApplicationTemplateUpdateInput missing godoc

func (*ApplicationTemplateUpdateInput) ToApplicationTemplate

func (a *ApplicationTemplateUpdateInput) ToApplicationTemplate(id string) ApplicationTemplate

ToApplicationTemplate missing godoc

type ApplicationTemplateValueInput

type ApplicationTemplateValueInput struct {
	Placeholder string
	Value       string
}

ApplicationTemplateValueInput missing godoc

type ApplicationTemplateVersion

type ApplicationTemplateVersion struct {
	ID                    string
	Version               string
	Title                 *string
	ReleaseDate           *string
	CorrelationIDs        json.RawMessage
	CreatedAt             time.Time
	ApplicationTemplateID string
}

ApplicationTemplateVersion represents a struct for Application Template Version data

type ApplicationTemplateVersionInput

type ApplicationTemplateVersionInput struct {
	Version        string
	Title          *string
	ReleaseDate    *string
	CorrelationIDs json.RawMessage
}

ApplicationTemplateVersionInput represents a struct with the updatable fields

func (*ApplicationTemplateVersionInput) ToApplicationTemplateVersion

func (a *ApplicationTemplateVersionInput) ToApplicationTemplateVersion(id, appTemplateID string) ApplicationTemplateVersion

ToApplicationTemplateVersion converts ApplicationTemplateVersionInput into ApplicationTemplateVersion

type ApplicationUpdateInput

type ApplicationUpdateInput struct {
	ProviderName         *string
	Description          *string
	HealthCheckURL       *string
	IntegrationSystemID  *string
	StatusCondition      *ApplicationStatusCondition
	BaseURL              *string
	ApplicationNamespace *string
	OrdLabels            json.RawMessage
	CorrelationIDs       json.RawMessage
	SystemStatus         *string
	Tags                 json.RawMessage
	DocumentationLabels  json.RawMessage
	LocalTenantID        *string
}

ApplicationUpdateInput missing godoc

type ApplicationWithLabel

type ApplicationWithLabel struct {
	App      *Application
	SccLabel *Label
}

ApplicationWithLabel missing godoc

type ApplicationWithTenants

type ApplicationWithTenants struct {
	Application Application
	Tenants     []*BusinessTenantMapping
}

ApplicationWithTenants represents an application with its associated tenants.

type ApplicationWithTenantsPage

type ApplicationWithTenantsPage struct {
	Data       []*ApplicationWithTenants
	PageInfo   *pagination.Page
	TotalCount int
}

ApplicationWithTenantsPage represents a page containing an array of applications with their associated tenants.

type Aspect

type Aspect struct {
	ApplicationID                *string
	ApplicationTemplateVersionID *string
	IntegrationDependencyID      string
	Title                        string
	Description                  *string
	Mandatory                    *bool
	SupportMultipleProviders     *bool
	APIResources                 json.RawMessage
	*BaseEntity
}

Aspect represent structure for Aspect

func (*Aspect) GetType

func (*Aspect) GetType() resource.Type

GetType returns Type aspect

type AspectEventResource

type AspectEventResource struct {
	ApplicationID                *string
	ApplicationTemplateVersionID *string
	AspectID                     string
	OrdID                        string
	MinVersion                   *string
	Subset                       json.RawMessage
	*BaseEntity
}

AspectEventResource represent structure for Aspect Event Resource

func (*AspectEventResource) GetType

func (*AspectEventResource) GetType() resource.Type

GetType returns Type aspectEventResource

type AspectEventResourceInput

type AspectEventResourceInput struct {
	OrdID      string          `json:"ordId"`
	MinVersion *string         `json:"minVersion"`
	Subset     json.RawMessage `json:"subset"`
}

AspectEventResourceInput is an input for creating a new AspectEventResource

func (*AspectEventResourceInput) ToAspectEventResource

func (a *AspectEventResourceInput) ToAspectEventResource(id string, resourceType resource.Type, resourceID string, aspectID string) *AspectEventResource

ToAspectEventResource converts AspectEventResourceInput to AspectEventResource

type AspectInput

type AspectInput struct {
	Title                    string                      `json:"title"`
	Description              *string                     `json:"description"`
	Mandatory                *bool                       `json:"mandatory"`
	SupportMultipleProviders *bool                       `json:"supportMultipleProviders"`
	APIResources             json.RawMessage             `json:"apiResources"`
	EventResources           []*AspectEventResourceInput `json:"eventResources"`
}

AspectInput is an input for creating a new Aspect

func (*AspectInput) ToAspect

func (a *AspectInput) ToAspect(id string, resourceType resource.Type, resourceID string, integrationDependencyID string) *Aspect

ToAspect converts AspectInput to Aspect

type AssignmentOperation

type AssignmentOperation struct {
	ID                    string                  `json:"id"`
	Type                  AssignmentOperationType `json:"type"`
	FormationAssignmentID string                  `json:"formation_assignment_id"`
	FormationID           string                  `json:"formation_id"`
	TriggeredBy           OperationTrigger        `json:"triggered_by"`
	StartedAtTimestamp    *time.Time              `json:"started_at_timestamp"`
	FinishedAtTimestamp   *time.Time              `json:"finished_at_timestamp"`
}

AssignmentOperation represent structure for AssignmentOperation

type AssignmentOperationInput

type AssignmentOperationInput struct {
	Type                  AssignmentOperationType `json:"type"`
	FormationAssignmentID string                  `json:"formation_assignment_id"`
	FormationID           string                  `json:"formation_id"`
	TriggeredBy           OperationTrigger        `json:"triggered_by"`
}

AssignmentOperationInput is an input for creating a new AssignmentOperation

func (AssignmentOperationInput) ToModel

ToModel converts AssignmentOperationInput to AssignmentOperation model object with provided id

type AssignmentOperationPage

type AssignmentOperationPage struct {
	Data       []*AssignmentOperation
	PageInfo   *pagination.Page
	TotalCount int
}

AssignmentOperationPage missing godoc

type AssignmentOperationType

type AssignmentOperationType string

AssignmentOperationType describes possible assignment operation types - assign, unassign

const (
	// Assign denotes the operation is assigning object to a formation
	Assign AssignmentOperationType = "ASSIGN"
	// Unassign denotes the operation is unassigning object from a formation
	Unassign AssignmentOperationType = "UNASSIGN"
	// InstanceCreatorUnassign denotes the operation is related to Instance Creator unassign
	InstanceCreatorUnassign AssignmentOperationType = "INSTANCE_CREATOR_UNASSIGN"
)

func FromFormationOperationType

func FromFormationOperationType(op FormationOperation) AssignmentOperationType

FromFormationOperationType converts FormationOperation to AssignmentOperationType

type Auth

type Auth struct {
	Credential            CredentialData
	AccessStrategy        *string
	AdditionalHeaders     map[string][]string
	AdditionalQueryParams map[string][]string
	RequestAuth           *CredentialRequestAuth
	OneTimeToken          *OneTimeToken
	CertCommonName        string
}

Auth missing godoc

type AuthInput

type AuthInput struct {
	Credential            *CredentialDataInput
	AccessStrategy        *string
	AdditionalHeaders     map[string][]string
	AdditionalQueryParams map[string][]string
	RequestAuth           *CredentialRequestAuthInput
	OneTimeToken          *OneTimeToken
}

AuthInput missing godoc

func (*AuthInput) ToAuth

func (i *AuthInput) ToAuth() *Auth

ToAuth missing godoc

type AutomaticScenarioAssignment

type AutomaticScenarioAssignment struct {
	ScenarioName   string
	Tenant         string
	TargetTenantID string
}

AutomaticScenarioAssignment missing godoc

type AutomaticScenarioAssignmentPage

type AutomaticScenarioAssignmentPage struct {
	Data       []*AutomaticScenarioAssignment
	PageInfo   *pagination.Page
	TotalCount int
}

AutomaticScenarioAssignmentPage missing godoc

type BaseEntity

type BaseEntity struct {
	ID        string
	Ready     bool
	CreatedAt *time.Time
	UpdatedAt *time.Time
	DeletedAt *time.Time
	Error     *string
}

BaseEntity missing godoc

func (*BaseEntity) GetCreatedAt

func (e *BaseEntity) GetCreatedAt() time.Time

GetCreatedAt missing godoc

func (*BaseEntity) GetDeletedAt

func (e *BaseEntity) GetDeletedAt() time.Time

GetDeletedAt missing godoc

func (*BaseEntity) GetError

func (e *BaseEntity) GetError() *string

GetError missing godoc

func (*BaseEntity) GetID

func (e *BaseEntity) GetID() string

GetID missing godoc

func (*BaseEntity) GetReady

func (e *BaseEntity) GetReady() bool

GetReady missing godoc

func (*BaseEntity) GetType

func (e *BaseEntity) GetType() resource.Type

GetType missing godoc

func (*BaseEntity) GetUpdatedAt

func (e *BaseEntity) GetUpdatedAt() time.Time

GetUpdatedAt missing godoc

func (*BaseEntity) SetCreatedAt

func (e *BaseEntity) SetCreatedAt(t time.Time)

SetCreatedAt missing godoc

func (*BaseEntity) SetDeletedAt

func (e *BaseEntity) SetDeletedAt(t time.Time)

SetDeletedAt missing godoc

func (*BaseEntity) SetError

func (e *BaseEntity) SetError(err string)

SetError missing godoc

func (*BaseEntity) SetReady

func (e *BaseEntity) SetReady(ready bool)

SetReady missing godoc

func (*BaseEntity) SetUpdatedAt

func (e *BaseEntity) SetUpdatedAt(t time.Time)

SetUpdatedAt missing godoc

type BasicCredentialData

type BasicCredentialData struct {
	Username string
	Password string
}

BasicCredentialData missing godoc

type BasicCredentialDataInput

type BasicCredentialDataInput struct {
	Username string
	Password string
}

BasicCredentialDataInput missing godoc

func (*BasicCredentialDataInput) ToBasicCredentialData

func (i *BasicCredentialDataInput) ToBasicCredentialData() *BasicCredentialData

ToBasicCredentialData missing godoc

type Bundle

type Bundle struct {
	ApplicationID                  *string
	ApplicationTemplateVersionID   *string
	Name                           string
	Description                    *string
	Version                        *string
	ResourceHash                   *string
	InstanceAuthRequestInputSchema *string
	DefaultInstanceAuth            *Auth
	OrdID                          *string
	LocalTenantID                  *string
	ShortDescription               *string
	Links                          json.RawMessage
	Labels                         json.RawMessage
	CredentialExchangeStrategies   json.RawMessage
	CorrelationIDs                 json.RawMessage
	Tags                           json.RawMessage
	DocumentationLabels            json.RawMessage
	LastUpdate                     *string
	*BaseEntity
}

Bundle missing godoc

func (*Bundle) GetType

func (*Bundle) GetType() resource.Type

GetType missing godoc

func (*Bundle) SetFromUpdateInput

func (bndl *Bundle) SetFromUpdateInput(update BundleUpdateInput, bndlHash uint64)

SetFromUpdateInput missing godoc

type BundleCreateInput

type BundleCreateInput struct {
	Name                           string                  `json:"title"`
	Description                    *string                 `json:"description"`
	Version                        *string                 `json:"version" hash:"ignore"`
	InstanceAuthRequestInputSchema *string                 `json:",omitempty"`
	DefaultInstanceAuth            *AuthInput              `json:",omitempty"`
	OrdID                          *string                 `json:"ordId"`
	LocalTenantID                  *string                 `json:"localId"`
	ShortDescription               *string                 `json:"shortDescription"`
	Links                          json.RawMessage         `json:"links"`
	Labels                         json.RawMessage         `json:"labels"`
	CredentialExchangeStrategies   json.RawMessage         `json:"credentialExchangeStrategies"`
	APIDefinitions                 []*APIDefinitionInput   `json:",omitempty"`
	APISpecs                       []*SpecInput            `json:",omitempty"`
	EventDefinitions               []*EventDefinitionInput `json:",omitempty"`
	EventSpecs                     []*SpecInput            `json:",omitempty"`
	Documents                      []*DocumentInput        `json:",omitempty"`
	CorrelationIDs                 json.RawMessage         `json:"correlationIds"`
	Tags                           json.RawMessage         `json:"tags"`
	DocumentationLabels            json.RawMessage         `json:"documentationLabels"`
	LastUpdate                     *string                 `json:"lastUpdate" hash:"ignore"`
}

BundleCreateInput missing godoc

func (*BundleCreateInput) ToBundle

func (i *BundleCreateInput) ToBundle(id string, resourceType resource.Type, resourceID string, bndlHash uint64) *Bundle

ToBundle missing godoc

type BundleInstanceAuth

type BundleInstanceAuth struct {
	ID               string
	BundleID         string
	RuntimeID        *string
	RuntimeContextID *string
	Owner            string
	Context          *string
	InputParams      *string
	Auth             *Auth
	Status           *BundleInstanceAuthStatus
}

BundleInstanceAuth missing godoc

func (*BundleInstanceAuth) SetDefaultStatus

func (a *BundleInstanceAuth) SetDefaultStatus(condition BundleInstanceAuthStatusCondition, timestamp time.Time) error

SetDefaultStatus missing godoc

func (*BundleInstanceAuth) SetFromUpdateInput

func (a *BundleInstanceAuth) SetFromUpdateInput(in BundleInstanceAuthUpdateInput)

SetFromUpdateInput sets fields to BundleInstanceAuth from BundleInstanceAuthUpdateInput

type BundleInstanceAuthCreateInput

type BundleInstanceAuthCreateInput struct {
	Context          *string
	InputParams      *string
	Auth             *AuthInput
	RuntimeID        *string
	RuntimeContextID *string
}

BundleInstanceAuthCreateInput type is input for createBundleInstanceAuth mutation

func (BundleInstanceAuthCreateInput) ToBundleInstanceAuth

func (ri BundleInstanceAuthCreateInput) ToBundleInstanceAuth(id, bundleID, tenant string, status *BundleInstanceAuthStatus) BundleInstanceAuth

ToBundleInstanceAuth creates BundleInstanceAuth from BundleInstanceAuthCreateInput

type BundleInstanceAuthRequestInput

type BundleInstanceAuthRequestInput struct {
	ID          *string
	Context     *string
	InputParams *string
}

BundleInstanceAuthRequestInput type for requestBundleInstanceAuthCreation

func (BundleInstanceAuthRequestInput) ToBundleInstanceAuth

func (ri BundleInstanceAuthRequestInput) ToBundleInstanceAuth(id, bundleID, tenant string, auth *Auth, status *BundleInstanceAuthStatus, runtimeID *string, runtimeContextID *string) BundleInstanceAuth

ToBundleInstanceAuth missing godoc

type BundleInstanceAuthSetInput

type BundleInstanceAuthSetInput struct {
	Auth   *AuthInput
	Status *BundleInstanceAuthStatusInput
}

BundleInstanceAuthSetInput type for setBundleInstanceAuth

type BundleInstanceAuthSetStatusConditionInput

type BundleInstanceAuthSetStatusConditionInput string

BundleInstanceAuthSetStatusConditionInput missing godoc

const (
	// BundleInstanceAuthSetStatusConditionInputSucceeded missing godoc
	BundleInstanceAuthSetStatusConditionInputSucceeded BundleInstanceAuthSetStatusConditionInput = "SUCCEEDED"
	// BundleInstanceAuthSetStatusConditionInputFailed missing godoc
	BundleInstanceAuthSetStatusConditionInputFailed BundleInstanceAuthSetStatusConditionInput = "FAILED"
)

type BundleInstanceAuthStatus

type BundleInstanceAuthStatus struct {
	Condition BundleInstanceAuthStatusCondition
	Timestamp time.Time
	Message   string
	Reason    string
}

BundleInstanceAuthStatus missing godoc

type BundleInstanceAuthStatusCondition

type BundleInstanceAuthStatusCondition string

BundleInstanceAuthStatusCondition missing godoc

const (
	// BundleInstanceAuthStatusConditionPending missing godoc
	BundleInstanceAuthStatusConditionPending BundleInstanceAuthStatusCondition = "PENDING"
	// BundleInstanceAuthStatusConditionSucceeded missing godoc
	BundleInstanceAuthStatusConditionSucceeded BundleInstanceAuthStatusCondition = "SUCCEEDED"
	// BundleInstanceAuthStatusConditionFailed missing godoc
	BundleInstanceAuthStatusConditionFailed BundleInstanceAuthStatusCondition = "FAILED"
	// BundleInstanceAuthStatusConditionUnused missing godoc
	BundleInstanceAuthStatusConditionUnused BundleInstanceAuthStatusCondition = "UNUSED"
)

type BundleInstanceAuthStatusInput

type BundleInstanceAuthStatusInput struct {
	Condition BundleInstanceAuthSetStatusConditionInput
	Message   string
	Reason    string
}

BundleInstanceAuthStatusInput missing godoc

func (*BundleInstanceAuthStatusInput) ToBundleInstanceAuthStatus

func (si *BundleInstanceAuthStatusInput) ToBundleInstanceAuthStatus(timestamp time.Time) *BundleInstanceAuthStatus

ToBundleInstanceAuthStatus missing godoc

type BundleInstanceAuthUpdateInput

type BundleInstanceAuthUpdateInput struct {
	Context     *string
	InputParams *string
	Auth        *AuthInput
}

BundleInstanceAuthUpdateInput type is input for updateBundleInstanceAuth mutation

type BundlePage

type BundlePage struct {
	Data       []*Bundle
	PageInfo   *pagination.Page
	TotalCount int
}

BundlePage missing godoc

func (BundlePage) IsPageable

func (BundlePage) IsPageable()

IsPageable missing godoc

type BundleReference

type BundleReference struct {
	ID                  string
	BundleID            *string
	ObjectType          BundleReferenceObjectType
	ObjectID            *string
	APIDefaultTargetURL *string
	IsDefaultBundle     *bool
}

BundleReference missing godoc

type BundleReferenceInput

type BundleReferenceInput struct {
	APIDefaultTargetURL *string
	IsDefaultBundle     *bool
}

BundleReferenceInput missing godoc

func (*BundleReferenceInput) ToBundleReference

func (b *BundleReferenceInput) ToBundleReference(id string, objectType BundleReferenceObjectType, bundleID, objectID *string) (*BundleReference, error)

ToBundleReference missing godoc

type BundleReferenceObjectType

type BundleReferenceObjectType string

BundleReferenceObjectType missing godoc

const (
	// BundleAPIReference missing godoc
	BundleAPIReference BundleReferenceObjectType = "API"
	// BundleEventReference missing godoc
	BundleEventReference BundleReferenceObjectType = "Event"
)

type BundleUpdateInput

type BundleUpdateInput struct {
	Name                           string
	Description                    *string
	Version                        *string
	InstanceAuthRequestInputSchema *string
	DefaultInstanceAuth            *AuthInput
	OrdID                          *string
	LocalTenantID                  *string
	ShortDescription               *string
	Links                          json.RawMessage
	Labels                         json.RawMessage
	CredentialExchangeStrategies   json.RawMessage
	CorrelationIDs                 json.RawMessage
	Tags                           json.RawMessage
	DocumentationLabels            json.RawMessage
	LastUpdate                     *string
}

BundleUpdateInput missing godoc

type BusinessTenantMapping

type BusinessTenantMapping struct {
	ID             string
	Name           string
	ExternalTenant string
	Parents        []string
	Type           tenant.Type
	Provider       string
	Status         tenant.Status
	Initialized    *bool // computed value
	LicenseType    *string
}

BusinessTenantMapping missing godoc

func (BusinessTenantMapping) ToInput

ToInput converts BusinessTenantMapping to BusinessTenantMappingInput

func (BusinessTenantMapping) WithExternalTenant

func (t BusinessTenantMapping) WithExternalTenant(externalTenant string) BusinessTenantMapping

WithExternalTenant missing godoc

func (BusinessTenantMapping) WithStatus

WithStatus missing godoc

type BusinessTenantMappingInput

type BusinessTenantMappingInput struct {
	Name           string   `json:"name"`
	ExternalTenant string   `json:"id"`
	Parents        []string `json:"parents"`
	Subdomain      string   `json:"subdomain"`
	Region         string   `json:"region"`
	Type           string   `json:"type"`
	Provider       string
	LicenseType    *string `json:"licenseType"`
	CustomerID     *string `json:"customerID"`
	CostObjectID   *string `json:"costObjectID"`
	CostObjectType *string `json:"costObjectType"`
}

BusinessTenantMappingInput missing godoc

func (*BusinessTenantMappingInput) ToBusinessTenantMapping

func (i *BusinessTenantMappingInput) ToBusinessTenantMapping(id string) *BusinessTenantMapping

ToBusinessTenantMapping missing godoc

func (BusinessTenantMappingInput) WithExternalTenant

func (i BusinessTenantMappingInput) WithExternalTenant(externalTenant string) BusinessTenantMappingInput

WithExternalTenant missing godoc

type BusinessTenantMappingPage

type BusinessTenantMappingPage struct {
	Data       []*BusinessTenantMapping
	PageInfo   *pagination.Page
	TotalCount int
}

BusinessTenantMappingPage Struct for BusinessTenantMapping data with page info

type CSRFTokenCredentialRequestAuth

type CSRFTokenCredentialRequestAuth struct {
	TokenEndpointURL      string
	Credential            CredentialData
	AdditionalHeaders     map[string][]string
	AdditionalQueryParams map[string][]string
}

CSRFTokenCredentialRequestAuth missing godoc

type CSRFTokenCredentialRequestAuthInput

type CSRFTokenCredentialRequestAuthInput struct {
	TokenEndpointURL      string
	Credential            *CredentialDataInput
	AdditionalHeaders     map[string][]string
	AdditionalQueryParams map[string][]string
}

CSRFTokenCredentialRequestAuthInput missing godoc

func (*CSRFTokenCredentialRequestAuthInput) ToCSRFTokenCredentialRequestAuth

func (i *CSRFTokenCredentialRequestAuthInput) ToCSRFTokenCredentialRequestAuth() *CSRFTokenCredentialRequestAuth

ToCSRFTokenCredentialRequestAuth missing godoc

type Capability

type Capability struct {
	ApplicationID                *string
	ApplicationTemplateVersionID *string
	PackageID                    *string
	Name                         string
	Description                  *string
	OrdID                        *string
	Type                         string
	CustomType                   *string
	LocalTenantID                *string
	ShortDescription             *string
	SystemInstanceAware          *bool
	Tags                         json.RawMessage
	RelatedEntityTypes           json.RawMessage
	Links                        json.RawMessage
	ReleaseStatus                *string
	Labels                       json.RawMessage
	Visibility                   *string
	Version                      *Version
	ResourceHash                 *string
	DocumentationLabels          json.RawMessage
	CorrelationIDs               json.RawMessage
	LastUpdate                   *string
	*BaseEntity
}

Capability missing godoc

func (*Capability) GetType

func (*Capability) GetType() resource.Type

GetType missing godoc

type CapabilityDefinition

type CapabilityDefinition struct {
	Type           CapabilitySpecType              `json:"type"`
	CustomType     string                          `json:"customType"`
	MediaType      SpecFormat                      `json:"mediaType"`
	URL            string                          `json:"url"`
	AccessStrategy accessstrategy.AccessStrategies `json:"accessStrategies"`
}

CapabilityDefinition missing godoc

func (*CapabilityDefinition) ToSpec

func (cd *CapabilityDefinition) ToSpec() *SpecInput

ToSpec missing godoc

type CapabilityInput

type CapabilityInput struct {
	OrdPackageID          *string                 `json:"partOfPackage"`
	Tenant                string                  `json:",omitempty"`
	Name                  string                  `json:"title"`
	Description           *string                 `json:"description"`
	OrdID                 *string                 `json:"ordId"`
	Type                  string                  `json:"type"`
	CustomType            *string                 `json:"customType"`
	LocalTenantID         *string                 `json:"localId"`
	ShortDescription      *string                 `json:"shortDescription"`
	SystemInstanceAware   *bool                   `json:"systemInstanceAware"`
	Tags                  json.RawMessage         `json:"tags"`
	RelatedEntityTypes    json.RawMessage         `json:"relatedEntityTypes"`
	Links                 json.RawMessage         `json:"links"`
	ReleaseStatus         *string                 `json:"releaseStatus"`
	Labels                json.RawMessage         `json:"labels"`
	Visibility            *string                 `json:"visibility"`
	CapabilityDefinitions []*CapabilityDefinition `json:"definitions"`
	DocumentationLabels   json.RawMessage         `json:"documentationLabels"`
	CorrelationIDs        json.RawMessage         `json:"correlationIds,omitempty"`
	LastUpdate            *string

	*VersionInput `hash:"ignore"`
}

CapabilityInput missing godoc

func (*CapabilityInput) ToCapability

func (a *CapabilityInput) ToCapability(id string, resourceType resource.Type, resourceID string, packageID *string, capabilityHash uint64) *Capability

ToCapability missing godoc

type CapabilitySpecType

type CapabilitySpecType string

CapabilitySpecType is the type of the Capability Specification

const (
	// CapabilitySpecTypeMDICapabilityDefinitionV1 is the MDI Capability Definition V1 Specification
	CapabilitySpecTypeMDICapabilityDefinitionV1 CapabilitySpecType = "sap.mdo:mdi-capability-definition:v1"
	// CapabilitySpecTypeCustom is the Custom specification
	CapabilitySpecTypeCustom CapabilitySpecType = "custom"
)

type CertSubjectMapping

type CertSubjectMapping struct {
	ID                 string     `json:"id"`
	Subject            string     `json:"subject"`
	ConsumerType       string     `json:"consumer_type"`
	InternalConsumerID *string    `json:"internal_consumer_id"`
	TenantAccessLevels []string   `json:"tenant_access_levels"`
	CreatedAt          time.Time  `json:"created_at"`
	UpdatedAt          *time.Time `json:"updated_at"`
}

CertSubjectMapping is a structure that represents a certificate subject mapped to internal consumer with given tenant access levels

type CertSubjectMappingInput

type CertSubjectMappingInput struct {
	Subject            string   `json:"subject"`
	ConsumerType       string   `json:"consumer_type"`
	InternalConsumerID *string  `json:"internal_consumer_id"`
	TenantAccessLevels []string `json:"tenant_access_levels"`
}

CertSubjectMappingInput is an input for creating a new CertSubjectMapping

func (*CertSubjectMappingInput) ToModel

ToModel converts CertSubjectMappingInput to CertSubjectMapping

type CertSubjectMappingPage

type CertSubjectMappingPage struct {
	Data       []*CertSubjectMapping
	PageInfo   *pagination.Page
	TotalCount int
}

CertSubjectMappingPage contains CertSubjectMapping data with page info

type CertificateOAuthCredentialData

type CertificateOAuthCredentialData struct {
	ClientID    string
	Certificate string
	URL         string
}

CertificateOAuthCredentialData represents a structure for mTLS OAuth credentials

type CertificateOAuthCredentialDataInput

type CertificateOAuthCredentialDataInput struct {
	ClientID    string
	Certificate string
	URL         string
}

CertificateOAuthCredentialDataInput represents an input structure for mTLS OAuth credentials

func (*CertificateOAuthCredentialDataInput) ToCertificateOAuthCredentialData

func (i *CertificateOAuthCredentialDataInput) ToCertificateOAuthCredentialData() *CertificateOAuthCredentialData

ToCertificateOAuthCredentialData converts a CertificateOAuthCredentialDataInput into CertificateOAuthCredentialData

type ConsumptionBundleReference

type ConsumptionBundleReference struct {
	BundleOrdID      string `json:"ordId"`
	DefaultTargetURL string `json:"defaultEntryPoint"`
}

ConsumptionBundleReference missing godoc

type CredentialData

type CredentialData struct {
	Basic            *BasicCredentialData
	Oauth            *OAuthCredentialData
	CertificateOAuth *CertificateOAuthCredentialData
}

CredentialData missing godoc

type CredentialDataInput

type CredentialDataInput struct {
	Basic            *BasicCredentialDataInput
	Oauth            *OAuthCredentialDataInput
	CertificateOAuth *CertificateOAuthCredentialDataInput
}

CredentialDataInput missing godoc

func (*CredentialDataInput) ToCredentialData

func (i *CredentialDataInput) ToCredentialData() *CredentialData

ToCredentialData missing godoc

type CredentialRequestAuth

type CredentialRequestAuth struct {
	Csrf *CSRFTokenCredentialRequestAuth
}

CredentialRequestAuth missing godoc

type CredentialRequestAuthInput

type CredentialRequestAuthInput struct {
	Csrf *CSRFTokenCredentialRequestAuthInput
}

CredentialRequestAuthInput missing godoc

func (*CredentialRequestAuthInput) ToCredentialRequestAuth

func (i *CredentialRequestAuthInput) ToCredentialRequestAuth() *CredentialRequestAuth

ToCredentialRequestAuth missing godoc

type DataProduct

type DataProduct struct {
	ApplicationID                *string
	ApplicationTemplateVersionID *string
	OrdID                        *string
	LocalTenantID                *string
	CorrelationIDs               json.RawMessage
	Title                        string
	ShortDescription             *string
	Description                  *string
	PackageID                    *string
	Version                      *Version
	LastUpdate                   *string
	Visibility                   *string
	ReleaseStatus                *string
	Disabled                     *bool
	DeprecationDate              *string
	SunsetDate                   *string
	Successors                   json.RawMessage
	ChangeLogEntries             json.RawMessage
	Type                         string
	Category                     string
	EntityTypes                  json.RawMessage
	InputPorts                   json.RawMessage
	OutputPorts                  json.RawMessage
	Responsible                  *string
	DataProductLinks             json.RawMessage
	Links                        json.RawMessage
	Industry                     json.RawMessage
	LineOfBusiness               json.RawMessage
	Tags                         json.RawMessage
	Labels                       json.RawMessage
	DocumentationLabels          json.RawMessage
	PolicyLevel                  *string
	CustomPolicyLevel            *string
	SystemInstanceAware          *bool
	ResourceHash                 *string
	*BaseEntity
}

DataProduct represents the structure for DataProduct

func (*DataProduct) GetType

func (*DataProduct) GetType() resource.Type

GetType returns Type DataProduct

type DataProductInput

type DataProductInput struct {
	OrdID               *string         `json:"ordID"`
	LocalTenantID       *string         `json:"localId,omitempty"`
	CorrelationIDs      json.RawMessage `json:"correlationIds,omitempty"`
	Title               string          `json:"title"`
	ShortDescription    *string         `json:"shortDescription,omitempty"`
	Description         *string         `json:"description"`
	OrdPackageID        *string         `json:"partOfPackage"`
	LastUpdate          *string         `json:"lastUpdate,omitempty" hash:"ignore"`
	Visibility          *string         `json:"visibility"`
	ReleaseStatus       *string         `json:"releaseStatus"`
	Disabled            *bool           `json:"disabled"`
	DeprecationDate     *string         `json:"deprecationDate"`
	SunsetDate          *string         `json:"sunsetDate,omitempty"`
	Successors          json.RawMessage `json:"successors,omitempty"`
	ChangeLogEntries    json.RawMessage `json:"changeLogEntries"`
	Type                string          `json:"type"`
	Category            string          `json:"category"`
	EntityTypes         json.RawMessage `json:"entityTypes"`
	InputPorts          json.RawMessage `json:"inputPorts"`
	OutputPorts         json.RawMessage `json:"outputPorts"`
	Responsible         *string         `json:"responsible"`
	DataProductLinks    json.RawMessage `json:"dataProductLinks"`
	Links               json.RawMessage `json:"links,omitempty"`
	Industry            json.RawMessage `json:"industry"`
	LineOfBusiness      json.RawMessage `json:"lineOfBusiness"`
	Tags                json.RawMessage `json:"tags,omitempty"`
	Labels              json.RawMessage `json:"labels,omitempty"`
	DocumentationLabels json.RawMessage `json:"documentationLabels,omitempty"`
	PolicyLevel         *string         `json:"policyLevel"`
	CustomPolicyLevel   *string         `json:"customPolicyLevel"`
	SystemInstanceAware *bool           `json:"systemInstanceAware"`
	*VersionInput       `hash:"ignore"`
}

DataProductInput is an input for creating a new Data Product

func (*DataProductInput) ToDataProduct

func (d *DataProductInput) ToDataProduct(id string, resourceType resource.Type, resourceID string, packageID *string, dataProductHash uint64) *DataProduct

ToDataProduct converts DataProductInput to DataProduct

type Destination

type Destination struct {
	ID                    string  `json:"id"`
	Name                  string  `json:"name"`
	Type                  string  `json:"type"`
	URL                   string  `json:"url"`
	Authentication        string  `json:"authentication"`
	SubaccountID          string  `json:"subaccount_id"`
	InstanceID            *string `json:"instanceId"`
	FormationAssignmentID *string `json:"formationAssignmentID"`
}

Destination is an internal model representation of the destination entity

type DestinationInput

type DestinationInput struct {
	Name              string `json:"Name"`
	Type              string `json:"Type"`
	URL               string `json:"URL"`
	Authentication    string `json:"Authentication"`
	XCorrelationID    string `json:"correlationIds"`
	XSystemTenantID   string `json:"x-system-id"`
	XSystemTenantName string `json:"x-system-name"`
	XSystemType       string `json:"x-system-type"`
	XSystemBaseURL    string `json:"x-system-base-url"`
}

DestinationInput missing godoc

func (*DestinationInput) HasValidIdentifiers

func (d *DestinationInput) HasValidIdentifiers() bool

HasValidIdentifiers checks if the destination has either one of the pairs: XSystemTenantID and XSystemType, or XSystemBaseURL and XSystemTenantName

type Document

type Document struct {
	BundleID                     string
	AppID                        *string
	ApplicationTemplateVersionID *string
	Title                        string
	DisplayName                  string
	Description                  string
	Format                       DocumentFormat
	// for example Service Class, API etc
	Kind *string
	Data *string
	*BaseEntity
}

Document missing godoc

func (*Document) GetType

func (*Document) GetType() resource.Type

GetType missing godoc

type DocumentFormat

type DocumentFormat string

DocumentFormat missing godoc

const (
	DocumentFormatMarkdown DocumentFormat = "MARKDOWN"
)

DocumentFormatMarkdown missing godoc

type DocumentInput

type DocumentInput struct {
	Title        string
	DisplayName  string
	Description  string
	Format       DocumentFormat
	Kind         *string
	Data         *string
	FetchRequest *FetchRequestInput
}

DocumentInput missing godoc

func (*DocumentInput) ToDocumentWithinBundle

func (d *DocumentInput) ToDocumentWithinBundle(id, bundleID string, resourceType resource.Type, resourceID string) *Document

ToDocumentWithinBundle missing godoc

type DocumentPage

type DocumentPage struct {
	Data       []*Document
	PageInfo   *pagination.Page
	TotalCount int
}

DocumentPage missing godoc

type Entity

type Entity interface {
	GetID() string
	GetType() resource.Type

	GetReady() bool
	SetReady(ready bool)

	GetCreatedAt() time.Time
	SetCreatedAt(t time.Time)

	GetUpdatedAt() time.Time
	SetUpdatedAt(t time.Time)

	GetDeletedAt() time.Time
	SetDeletedAt(t time.Time)

	GetError() *string
	SetError(err string)
}

Entity denotes a model-layer entity which can be timestamped with created_at, updated_at, deleted_at and ready values

type EntityType

type EntityType struct {
	ApplicationID                *string
	ApplicationTemplateVersionID *string
	OrdID                        string
	LocalTenantID                string
	CorrelationIDs               json.RawMessage
	Level                        string
	Title                        string
	ShortDescription             *string
	Description                  *string
	SystemInstanceAware          *bool
	ChangeLogEntries             json.RawMessage
	PackageID                    string
	Visibility                   string
	Links                        json.RawMessage
	PartOfProducts               json.RawMessage
	LastUpdate                   *string
	PolicyLevel                  *string
	CustomPolicyLevel            *string
	ReleaseStatus                string
	SunsetDate                   *string
	DeprecationDate              *string
	Successors                   json.RawMessage
	Extensible                   json.RawMessage
	Tags                         json.RawMessage
	Labels                       json.RawMessage
	DocumentationLabels          json.RawMessage
	ResourceHash                 *string
	Version                      *Version
	*BaseEntity
}

EntityType missing godoc

func (*EntityType) GetType

func (*EntityType) GetType() resource.Type

GetType missing godoc

func (*EntityType) SetFromUpdateInput

func (entityType *EntityType) SetFromUpdateInput(update EntityTypeInput, packageID string, entityTypeHash uint64)

SetFromUpdateInput missing godoc

type EntityTypeInput

type EntityTypeInput struct {
	OrdID               string          `json:"ordId"`
	LocalTenantID       string          `json:"localId"`
	CorrelationIDs      json.RawMessage `json:"correlationIds,omitempty"`
	Level               string          `json:"level"`
	Title               string          `json:"title"`
	ShortDescription    *string         `json:"shortDescription,omitempty"`
	Description         *string         `json:"description,omitempty"`
	SystemInstanceAware *bool           `json:"systemInstanceAware"`
	ChangeLogEntries    json.RawMessage `json:"changelogEntries,omitempty"`
	OrdPackageID        string          `json:"partOfPackage"`
	Visibility          string          `json:"visibility"`
	Links               json.RawMessage `json:"links,omitempty"`
	PartOfProducts      json.RawMessage `json:"partOfProducts,omitempty"`
	LastUpdate          *string         `json:"lastUpdate,omitempty" hash:"ignore"`
	PolicyLevel         *string         `json:"policyLevel,omitempty"`
	CustomPolicyLevel   *string         `json:"customPolicyLevel,omitempty"`
	ReleaseStatus       string          `json:"releaseStatus"`
	SunsetDate          *string         `json:"sunsetDate,omitempty"`
	DeprecationDate     *string         `json:"deprecationDate,omitempty"`
	Successors          json.RawMessage `json:"successors,omitempty"`
	Extensible          json.RawMessage `json:"extensible,omitempty"`
	Tags                json.RawMessage `json:"tags,omitempty"`
	Labels              json.RawMessage `json:"labels,omitempty"`
	DocumentationLabels json.RawMessage `json:"documentationLabels,omitempty"`

	*VersionInput `hash:"ignore"`
}

EntityTypeInput missing godoc

func (*EntityTypeInput) ToEntityType

func (i *EntityTypeInput) ToEntityType(id string, resourceType resource.Type, resourceID string, packageID string, entityTypeHash uint64) *EntityType

ToEntityType missing godoc

type EntityTypeMapping

type EntityTypeMapping struct {
	APIDefinitionID   *string
	EventDefinitionID *string
	APIModelSelectors json.RawMessage
	EntityTypeTargets json.RawMessage
	*BaseEntity
}

EntityTypeMapping missing godoc

func (*EntityTypeMapping) GetType

func (*EntityTypeMapping) GetType() resource.Type

GetType missing godoc

func (*EntityTypeMapping) SetFromUpdateInput

func (entityTypeMapping *EntityTypeMapping) SetFromUpdateInput(update EntityTypeMappingInput)

SetFromUpdateInput missing godoc

type EntityTypeMappingInput

type EntityTypeMappingInput struct {
	APIModelSelectors json.RawMessage `json:"apiModelSelectors,omitempty"`
	EntityTypeTargets json.RawMessage `json:"entityTypeTargets,omitempty"`
}

EntityTypeMappingInput missing godoc

func (*EntityTypeMappingInput) ToEntityTypeMapping

func (i *EntityTypeMappingInput) ToEntityTypeMapping(id string, resourceType resource.Type, resourceID string) *EntityTypeMapping

ToEntityTypeMapping missing godoc

type EntityTypePage

type EntityTypePage struct {
	Data       []*EntityType
	PageInfo   *pagination.Page
	TotalCount int
}

EntityTypePage missing godoc

func (EntityTypePage) IsPageable

func (EntityTypePage) IsPageable()

IsPageable missing godoc

type EntityTypeTarget

type EntityTypeTarget struct {
	OrdID         *string `json:"ordId,omitempty"`
	CorrelationID *string `json:"correlationId,omitempty"`
}

EntityTypeTarget represents the Entity Type Target entity

type EventDefinition

type EventDefinition struct {
	ApplicationID                           *string
	ApplicationTemplateVersionID            *string
	PackageID                               *string
	Name                                    string
	Description                             *string
	Group                                   *string
	OrdID                                   *string
	LocalTenantID                           *string
	ShortDescription                        *string
	SystemInstanceAware                     *bool
	PolicyLevel                             *string
	CustomPolicyLevel                       *string
	ChangeLogEntries                        json.RawMessage
	Links                                   json.RawMessage
	EventResourceLinks                      json.RawMessage
	Tags                                    json.RawMessage
	Countries                               json.RawMessage
	ReleaseStatus                           *string
	SunsetDate                              *string
	Successors                              json.RawMessage
	Labels                                  json.RawMessage
	Visibility                              *string
	Disabled                                *bool
	PartOfProducts                          json.RawMessage
	LineOfBusiness                          json.RawMessage
	Industry                                json.RawMessage
	ImplementationStandard                  *string
	CustomImplementationStandard            *string
	CustomImplementationStandardDescription *string
	Extensible                              json.RawMessage
	ResourceHash                            *string
	Version                                 *Version
	DocumentationLabels                     json.RawMessage
	CorrelationIDs                          json.RawMessage
	LastUpdate                              *string
	DeprecationDate                         *string
	Responsible                             *string
	*BaseEntity
}

EventDefinition missing godoc

func (*EventDefinition) GetType

func (*EventDefinition) GetType() resource.Type

GetType missing godoc

type EventDefinitionInput

type EventDefinitionInput struct {
	OrdPackageID                            *string                       `json:"partOfPackage"`
	Name                                    string                        `json:"title"`
	Description                             *string                       `json:"description"`
	Group                                   *string                       `json:",omitempty"`
	OrdID                                   *string                       `json:"ordId"`
	LocalTenantID                           *string                       `json:"localId"`
	ShortDescription                        *string                       `json:"shortDescription"`
	SystemInstanceAware                     *bool                         `json:"systemInstanceAware"`
	PolicyLevel                             *string                       `json:"policyLevel"`
	CustomPolicyLevel                       *string                       `json:"customPolicyLevel"`
	ChangeLogEntries                        json.RawMessage               `json:"changelogEntries"`
	Links                                   json.RawMessage               `json:"links"`
	EventResourceLinks                      json.RawMessage               `json:"eventResourceLinks"`
	Tags                                    json.RawMessage               `json:"tags"`
	Countries                               json.RawMessage               `json:"countries"`
	ReleaseStatus                           *string                       `json:"releaseStatus"`
	SunsetDate                              *string                       `json:"sunsetDate"`
	Successors                              json.RawMessage               `json:"successors,omitempty"`
	Labels                                  json.RawMessage               `json:"labels"`
	Visibility                              *string                       `json:"visibility"`
	Disabled                                *bool                         `json:"disabled"`
	PartOfProducts                          json.RawMessage               `json:"partOfProducts"`
	LineOfBusiness                          json.RawMessage               `json:"lineOfBusiness"`
	Industry                                json.RawMessage               `json:"industry"`
	ImplementationStandard                  *string                       `json:"implementationStandard"`
	CustomImplementationStandard            *string                       `json:"customImplementationStandard"`
	CustomImplementationStandardDescription *string                       `json:"customImplementationStandardDescription"`
	Extensible                              json.RawMessage               `json:"extensible"`
	ResourceDefinitions                     []*EventResourceDefinition    `json:"resourceDefinitions"`
	PartOfConsumptionBundles                []*ConsumptionBundleReference `json:"partOfConsumptionBundles"`
	DefaultConsumptionBundle                *string                       `json:"defaultConsumptionBundle"`
	EntityTypeMappings                      []*EntityTypeMappingInput     `json:"entityTypeMappings"`
	DocumentationLabels                     json.RawMessage               `json:"documentationLabels"`
	CorrelationIDs                          json.RawMessage               `json:"correlationIds,omitempty"`
	LastUpdate                              *string                       `json:"lastUpdate" hash:"ignore"`
	DeprecationDate                         *string                       `json:"deprecationDate"`
	Responsible                             *string                       `json:"responsible"`
	*VersionInput                           `hash:"ignore"`
}

EventDefinitionInput missing godoc

func (*EventDefinitionInput) ToEventDefinition

func (e *EventDefinitionInput) ToEventDefinition(id string, resourceType resource.Type, resourceID string, packageID *string, eventHash uint64) *EventDefinition

ToEventDefinition missing godoc

type EventDefinitionPage

type EventDefinitionPage struct {
	Data       []*EventDefinition
	PageInfo   *pagination.Page
	TotalCount int
}

EventDefinitionPage missing godoc

func (EventDefinitionPage) IsPageable

func (EventDefinitionPage) IsPageable()

IsPageable missing godoc

type EventResourceDefinition

type EventResourceDefinition struct {
	Type           EventSpecType                   `json:"type"`
	CustomType     string                          `json:"customType"`
	MediaType      SpecFormat                      `json:"mediaType"`
	URL            string                          `json:"url"`
	AccessStrategy accessstrategy.AccessStrategies `json:"accessStrategies"`
}

EventResourceDefinition missing godoc

func (*EventResourceDefinition) ToSpec

func (rd *EventResourceDefinition) ToSpec() *SpecInput

ToSpec missing godoc

type EventSpecType

type EventSpecType string

EventSpecType is the type of the Event Specification.

const (
	// EventSpecTypeAsyncAPI is the AsyncAPI Specification.
	EventSpecTypeAsyncAPI EventSpecType = "ASYNC_API"

	// EventSpecTypeAsyncAPIV2 is the AsyncAPI V2 Specification.
	EventSpecTypeAsyncAPIV2 EventSpecType = "asyncapi-v2"
	// EventSpecTypeCustom is the Custom Specification.
	EventSpecTypeCustom EventSpecType = "custom"
)

type EventingConfiguration

type EventingConfiguration struct {
	DefaultURL url.URL
}

EventingConfiguration missing godoc

type FetchMode

type FetchMode string

FetchMode is a legacy never delivered feature.

const (
	// FetchModeSingle is a legacy never delivered feature.
	FetchModeSingle FetchMode = "SINGLE"
	// FetchModeBundle is a legacy never delivered feature.
	FetchModeBundle FetchMode = "BUNDLE"
	// FetchModeIndex is a legacy never delivered feature.
	FetchModeIndex FetchMode = "INDEX"
)

type FetchRequest

type FetchRequest struct {
	ID         string
	URL        string
	Auth       *Auth
	Mode       FetchMode
	Filter     *string
	Status     *FetchRequestStatus
	ObjectType FetchRequestReferenceObjectType
	ObjectID   string
}

FetchRequest represents a request to fetch a specification resource from a remote system.

type FetchRequestInput

type FetchRequestInput struct {
	URL    string
	Auth   *AuthInput
	Mode   *FetchMode
	Filter *string
}

FetchRequestInput represents the input for creating a fetch request.

func (*FetchRequestInput) ToFetchRequest

func (f *FetchRequestInput) ToFetchRequest(timestamp time.Time, id string, objectType FetchRequestReferenceObjectType, objectID string) *FetchRequest

ToFetchRequest converts a FetchRequestInput to a FetchRequest.

type FetchRequestReferenceObjectType

type FetchRequestReferenceObjectType string

FetchRequestReferenceObjectType represents the type of the object that the fetch request is referencing.

const (
	// APISpecFetchRequestReference represents a fetch request for an API Specification.
	APISpecFetchRequestReference FetchRequestReferenceObjectType = "APISpec"
	// EventSpecFetchRequestReference represents a fetch request for an Event Specification.
	EventSpecFetchRequestReference FetchRequestReferenceObjectType = "EventSpec"
	// CapabilitySpecFetchRequestReference represents a fetch request for a Capability Specification.
	CapabilitySpecFetchRequestReference FetchRequestReferenceObjectType = "CapabilitySpec"
	// DocumentFetchRequestReference represents a fetch request for an Document Specification.
	DocumentFetchRequestReference FetchRequestReferenceObjectType = "Document"
)

func (FetchRequestReferenceObjectType) GetResourceType

func (obj FetchRequestReferenceObjectType) GetResourceType() resource.Type

GetResourceType returns the resource type of the fetch request based on the referenced entity.

type FetchRequestStatus

type FetchRequestStatus struct {
	Condition FetchRequestStatusCondition
	Message   *string
	Timestamp time.Time
}

FetchRequestStatus is the status of an executed fetch request.

type FetchRequestStatusCondition

type FetchRequestStatusCondition string

FetchRequestStatusCondition represents the condition of a fetch request.

const (
	// FetchRequestStatusConditionInitial represents the initial state of a fetch request.
	FetchRequestStatusConditionInitial FetchRequestStatusCondition = "INITIAL"
	// FetchRequestStatusConditionSucceeded represents the state of a fetch request after it has been successfully executed.
	FetchRequestStatusConditionSucceeded FetchRequestStatusCondition = "SUCCEEDED"
	// FetchRequestStatusConditionFailed represents the state of a fetch request after it has failed.
	FetchRequestStatusConditionFailed FetchRequestStatusCondition = "FAILED"
)

type Formation

type Formation struct {
	ID                            string
	TenantID                      string
	FormationTemplateID           string
	Name                          string
	State                         FormationState
	Error                         json.RawMessage
	LastStateChangeTimestamp      *time.Time
	LastNotificationSentTimestamp *time.Time
}

Formation missing godoc

type FormationAssignment

type FormationAssignment struct {
	ID                            string                  `json:"id"`
	FormationID                   string                  `json:"formation_id"`
	TenantID                      string                  `json:"tenant_id"`
	Source                        string                  `json:"source"`
	SourceType                    FormationAssignmentType `json:"source_type"`
	Target                        string                  `json:"target"`
	TargetType                    FormationAssignmentType `json:"target_type"`
	State                         string                  `json:"state"`
	Value                         json.RawMessage         `json:"value"`
	Error                         json.RawMessage         `json:"error"`
	LastStateChangeTimestamp      *time.Time              `json:"last_state_change_timestamp"`
	LastNotificationSentTimestamp *time.Time              `json:"last_notification_sent_timestamp"`
}

FormationAssignment represent structure for FormationAssignment

func (*FormationAssignment) Clone

Clone clones the formation assignment

func (*FormationAssignment) GetAddress

func (fa *FormationAssignment) GetAddress() uintptr

GetAddress returns the memory address of the FormationAssignment in form of an uninterpreted type(integer number) Currently, it's used in some formation constraints input templates, so we could propagate the memory address to the formation constraints operators and later on to modify/update it.

func (*FormationAssignment) IsInErrorState

func (fa *FormationAssignment) IsInErrorState() bool

IsInErrorState returns if the formation assignment is in error state

func (*FormationAssignment) IsInProgressState

func (fa *FormationAssignment) IsInProgressState() bool

IsInProgressState returns if the formation assignment is in progress state

func (*FormationAssignment) SetStateToDeleting

func (fa *FormationAssignment) SetStateToDeleting() bool

SetStateToDeleting sets the state to deleting and returns if the formation assignment is updated

type FormationAssignmentInput

type FormationAssignmentInput struct {
	FormationID string                  `json:"formation_id"`
	Source      string                  `json:"source"`
	SourceType  FormationAssignmentType `json:"source_type"`
	Target      string                  `json:"target"`
	TargetType  FormationAssignmentType `json:"target_type"`
	State       string                  `json:"state"`
	Value       json.RawMessage         `json:"value"`
	Error       json.RawMessage         `json:"error"`
}

FormationAssignmentInput is an input for creating a new FormationAssignment

func (*FormationAssignmentInput) ToModel

func (i *FormationAssignmentInput) ToModel(id, tenantID string) *FormationAssignment

ToModel converts FormationAssignmentInput to FormationAssignment

type FormationAssignmentPage

type FormationAssignmentPage struct {
	Data       []*FormationAssignment
	PageInfo   *pagination.Page
	TotalCount int
}

FormationAssignmentPage missing godoc

type FormationAssignmentState

type FormationAssignmentState string

FormationAssignmentState represents the possible states a formation assignment can be in

type FormationAssignmentType

type FormationAssignmentType string

FormationAssignmentType describes possible source and target types

const (
	// FormationAssignmentTypeApplication represent application type in formation assignment
	FormationAssignmentTypeApplication FormationAssignmentType = "APPLICATION"
	// FormationAssignmentTypeRuntime represent runtime type in formation assignment
	FormationAssignmentTypeRuntime FormationAssignmentType = "RUNTIME"
	// FormationAssignmentTypeRuntimeContext represent runtime context type in formation assignment
	FormationAssignmentTypeRuntimeContext FormationAssignmentType = "RUNTIME_CONTEXT"
)

type FormationConstraint

type FormationConstraint struct {
	ID              string
	Name            string
	Description     string
	ConstraintType  FormationConstraintType
	TargetOperation TargetOperation
	Operator        string
	ResourceType    ResourceType
	ResourceSubtype string
	InputTemplate   string
	ConstraintScope FormationConstraintScope
	Priority        int
	CreatedAt       *time.Time
}

FormationConstraint represents the constraint entity

type FormationConstraintInput

type FormationConstraintInput struct {
	Name            string
	Description     string
	ConstraintType  FormationConstraintType
	TargetOperation TargetOperation
	Operator        string
	ResourceType    ResourceType
	ResourceSubtype string
	InputTemplate   string
	ConstraintScope FormationConstraintScope
	Priority        int
}

FormationConstraintInput represents the input for creating FormationConstraint

type FormationConstraintScope

type FormationConstraintScope string

FormationConstraintScope defines the scope of the constraint

const (
	// GlobalFormationConstraintScope denotes the constraint is not bound to any formation type
	GlobalFormationConstraintScope FormationConstraintScope = "GLOBAL"
	// FormationTypeFormationConstraintScope denotes the constraint is applicable only to formations of the specified formation type
	FormationTypeFormationConstraintScope FormationConstraintScope = "FORMATION_TYPE"
)

type FormationConstraintType

type FormationConstraintType string

FormationConstraintType represents the constraint type. It is part of the Join point location along with TargetOperation

const (
	// PreOperation denotes the constraint should be enforced before the operation execution
	PreOperation FormationConstraintType = "PRE"
	// PostOperation denotes the constraint should be enforced after the operation execution
	PostOperation FormationConstraintType = "POST"
)

type FormationOperation

type FormationOperation string

FormationOperation defines the kind of operation done on a given formation

const (
	// AssignFormation represents the assign operation done on a given formation
	AssignFormation FormationOperation = "assign"
	// UnassignFormation represents the unassign operation done on a given formation
	UnassignFormation FormationOperation = "unassign"
	// CreateFormation represents the create operation on a given formation
	CreateFormation FormationOperation = "createFormation"
	// DeleteFormation represents the delete operation on a given formation
	DeleteFormation FormationOperation = "deleteFormation"
)

type FormationPage

type FormationPage struct {
	Data       []*Formation
	PageInfo   *pagination.Page
	TotalCount int
}

FormationPage contains Formation data with page info

type FormationState

type FormationState string

FormationState represents the possible states a formation can be in

const (
	// InitialFormationState indicates that nothing has been done with the formation
	InitialFormationState FormationState = "INITIAL"
	// ReadyFormationState indicates that the formation is in a ready state
	ReadyFormationState FormationState = "READY"
	// CreateErrorFormationState indicates that an error occurred during the creation of the formation
	CreateErrorFormationState FormationState = "CREATE_ERROR"
	// DeleteErrorFormationState indicates that an error occurred during the deletion of the formation
	DeleteErrorFormationState FormationState = "DELETE_ERROR"
	// DeletingFormationState indicates that the formation is in deleting state
	DeletingFormationState FormationState = "DELETING"
	// DraftFormationState indicates that the formation is not yet fully shaped
	DraftFormationState FormationState = "DRAFT"
)

type FormationTemplate

type FormationTemplate struct {
	ID                     string                 `json:"id"`
	Name                   string                 `json:"name"`
	ApplicationTypes       []string               `json:"applicationTypes"`
	RuntimeTypes           []string               `json:"runtimeTypes"`
	RuntimeTypeDisplayName *string                `json:"runtimeTypeDisplayName"`
	RuntimeArtifactKind    *RuntimeArtifactKind   `json:"runtimeArtifactKind"`
	TenantID               *string                `json:"tenant_id"`
	Webhooks               []*Webhook             `json:"webhooks"`
	LeadingProductIDs      []string               `json:"leadingProductIDs"`
	SupportsReset          bool                   `json:"supportsReset"`
	DiscoveryConsumers     []string               `json:"discoveryConsumers"`
	Labels                 map[string]interface{} `json:"labels"`
	CreatedAt              time.Time              `json:"createdAt"`
	UpdatedAt              *time.Time             `json:"updatedAt"`
}

FormationTemplate missing godoc

type FormationTemplateConstraintReference

type FormationTemplateConstraintReference struct {
	ConstraintID        string
	FormationTemplateID string
}

FormationTemplateConstraintReference represents the connection between FormationConstraint and FormationTemplate

type FormationTemplatePage

type FormationTemplatePage struct {
	Data       []*FormationTemplate
	PageInfo   *pagination.Page
	TotalCount int
}

FormationTemplatePage missing godoc

type FormationTemplateRegisterInput

type FormationTemplateRegisterInput struct {
	Name                   string                 `json:"name"`
	ApplicationTypes       []string               `json:"applicationTypes"`
	RuntimeTypes           []string               `json:"runtimeTypes"`
	RuntimeTypeDisplayName *string                `json:"runtimeTypeDisplayName"`
	RuntimeArtifactKind    *RuntimeArtifactKind   `json:"runtimeArtifactKind"`
	Webhooks               []*WebhookInput        `json:"webhooks"`
	LeadingProductIDs      []string               `json:"leadingProductIDs"`
	SupportsReset          bool                   `json:"supportsReset"`
	DiscoveryConsumers     []string               `json:"discoveryConsumers"`
	Labels                 map[string]interface{} `json:"labels"`
}

FormationTemplateRegisterInput is an input used for formation template registration

type FormationTemplateUpdateInput

type FormationTemplateUpdateInput struct {
	Name                   string               `json:"name"`
	ApplicationTypes       []string             `json:"applicationTypes"`
	RuntimeTypes           []string             `json:"runtimeTypes"`
	RuntimeTypeDisplayName *string              `json:"runtimeTypeDisplayName"`
	RuntimeArtifactKind    *RuntimeArtifactKind `json:"runtimeArtifactKind"`
	LeadingProductIDs      []string             `json:"leadingProductIDs"`
	SupportsReset          bool                 `json:"supportsReset"`
	DiscoveryConsumers     []string             `json:"discoveryConsumers"`
}

FormationTemplateUpdateInput is an input used for formation template update operations

type Identifiable

type Identifiable interface {
	GetID() string
}

Identifiable is an interface that can be used to identify an object.

type InitialConfigurations

type InitialConfigurations map[string]map[string]json.RawMessage

InitialConfigurations holds the Initial configuration provided for the AssignFormation mutation. It is a map with key SourceID from the InitialConfiguration object and values - map with key TargetID from the InitialConfiguration Object and value - the configuration

type IntegrationDependency

type IntegrationDependency struct {
	ApplicationID                  *string
	ApplicationTemplateVersionID   *string
	OrdID                          *string
	LocalTenantID                  *string
	CorrelationIDs                 json.RawMessage
	Title                          string
	ShortDescription               *string
	Description                    *string
	PackageID                      *string
	Version                        *Version
	LastUpdate                     *string
	Visibility                     string
	ReleaseStatus                  *string
	SunsetDate                     *string
	Successors                     json.RawMessage
	Mandatory                      *bool
	RelatedIntegrationDependencies json.RawMessage
	Links                          json.RawMessage
	Tags                           json.RawMessage
	Labels                         json.RawMessage
	DocumentationLabels            json.RawMessage
	ResourceHash                   *string
	*BaseEntity
}

IntegrationDependency represent structure for IntegrationDependency

func (*IntegrationDependency) GetType

func (*IntegrationDependency) GetType() resource.Type

GetType returns Type integrationDependency

type IntegrationDependencyInput

type IntegrationDependencyInput struct {
	OrdID                          *string         `json:"ordId"`
	LocalTenantID                  *string         `json:"localId,omitempty"`
	CorrelationIDs                 json.RawMessage `json:"correlationIds,omitempty"`
	Title                          string          `json:"title"`
	ShortDescription               *string         `json:"shortDescription,omitempty"`
	Description                    *string         `json:"description,omitempty"`
	OrdPackageID                   *string         `json:"partOfPackage"`
	LastUpdate                     *string         `json:"lastUpdate,omitempty" hash:"ignore"`
	Visibility                     string          `json:"visibility"`
	ReleaseStatus                  *string         `json:"releaseStatus"`
	SunsetDate                     *string         `json:"sunsetDate,omitempty"`
	Successors                     json.RawMessage `json:"successors,omitempty"`
	Mandatory                      *bool           `json:"mandatory"`
	Aspects                        []*AspectInput  `json:"aspects,omitempty"`
	RelatedIntegrationDependencies json.RawMessage `json:"relatedIntegrationDependencies,omitempty"`
	Links                          json.RawMessage `json:"links,omitempty"`
	Tags                           json.RawMessage `json:"tags,omitempty"`
	Labels                         json.RawMessage `json:"labels,omitempty"`
	DocumentationLabels            json.RawMessage `json:"documentationLabels,omitempty"`
	*VersionInput                  `hash:"ignore"`
}

IntegrationDependencyInput is an input for creating a new IntegrationDependency

func (*IntegrationDependencyInput) ToIntegrationDependency

func (i *IntegrationDependencyInput) ToIntegrationDependency(id string, resourceType resource.Type, resourceID string, packageID *string, integrationDependencyHash uint64) *IntegrationDependency

ToIntegrationDependency converts IntegrationDependencyInput to IntegrationDependency

type IntegrationDependencyPage

type IntegrationDependencyPage struct {
	Data       []*IntegrationDependency
	PageInfo   *pagination.Page
	TotalCount int
}

IntegrationDependencyPage Struct for IntegrationDependency data with page info

func (IntegrationDependencyPage) IsPageable

func (IntegrationDependencyPage) IsPageable()

IsPageable missing godoc

type IntegrationSystem

type IntegrationSystem struct {
	ID          string
	Name        string
	Description *string
}

IntegrationSystem missing godoc

type IntegrationSystemInput

type IntegrationSystemInput struct {
	Name        string
	Description *string
}

IntegrationSystemInput missing godoc

func (*IntegrationSystemInput) ToIntegrationSystem

func (i *IntegrationSystemInput) ToIntegrationSystem(id string) IntegrationSystem

ToIntegrationSystem missing godoc

type IntegrationSystemPage

type IntegrationSystemPage struct {
	Data       []*IntegrationSystem
	PageInfo   *pagination.Page
	TotalCount int
}

IntegrationSystemPage missing godoc

type Label

type Label struct {
	ID         string
	Tenant     *string
	Key        string
	Value      interface{}
	ObjectID   string
	ObjectType LabelableObject
	Version    int
}

Label represents a label with additional metadata for a given entity.

func NewLabelForRuntime

func NewLabelForRuntime(runtimeID, tenant, key string, value interface{}) *Label

NewLabelForRuntime creates a new label for a runtime.

func (*Label) GetValue

func (l *Label) GetValue() (string, error)

GetValue returns a Label value as string.

type LabelDefinition

type LabelDefinition struct {
	ID      string
	Tenant  string
	Key     string
	Schema  *interface{}
	Version int
}

LabelDefinition missing godoc

type LabelInput

type LabelInput struct {
	Key        string
	Value      interface{}
	ObjectID   string
	ObjectType LabelableObject
	Version    int
}

LabelInput is an input for creating a new label.

func (*LabelInput) ToLabel

func (i *LabelInput) ToLabel(id, tenant string) *Label

ToLabel converts a LabelInput to a Label.

type LabelableObject

type LabelableObject string

LabelableObject represents the type of entity that can have labels.

const (
	// RuntimeLabelableObject represents a runtime entity.
	RuntimeLabelableObject LabelableObject = "Runtime"
	// RuntimeContextLabelableObject represents a runtime context entity.
	RuntimeContextLabelableObject LabelableObject = "Runtime Context"
	// ApplicationLabelableObject represents an application entity.
	ApplicationLabelableObject LabelableObject = "Application"
	// TenantLabelableObject represents a tenant entity.
	TenantLabelableObject LabelableObject = "Tenant"
	// AppTemplateLabelableObject represents an application template entity.
	AppTemplateLabelableObject LabelableObject = "Application Template"
	// WebhookLabelableObject represents a webhook entity.
	WebhookLabelableObject LabelableObject = "Webhook"
	// FormationTemplateLabelableObject represents a formation template entity.
	FormationTemplateLabelableObject LabelableObject = "Formation Template"
)

func (LabelableObject) GetResourceType

func (obj LabelableObject) GetResourceType() resource.Type

GetResourceType returns the resource type of the label based on the referenced entity.

type MovedSubaccountMappingInput

type MovedSubaccountMappingInput struct {
	TenantMappingInput BusinessTenantMappingInput
	SubaccountID       string
	SourceTenant       string
	TargetTenant       string
}

MovedSubaccountMappingInput missing godoc

type OAuthCredentialData

type OAuthCredentialData struct {
	ClientID     string
	ClientSecret string
	URL          string
}

OAuthCredentialData missing godoc

type OAuthCredentialDataInput

type OAuthCredentialDataInput struct {
	ClientID     string
	ClientSecret string
	URL          string
}

OAuthCredentialDataInput missing godoc

func (*OAuthCredentialDataInput) ToOAuthCredentialData

func (i *OAuthCredentialDataInput) ToOAuthCredentialData() *OAuthCredentialData

ToOAuthCredentialData missing godoc

type OneTimeToken

type OneTimeToken struct {
	Token          string
	ConnectorURL   string
	Type           tokens.TokenType
	CreatedAt      time.Time
	Used           bool
	ExpiresAt      time.Time
	UsedAt         time.Time
	ScenarioGroups []string
}

OneTimeToken missing godoc

type Operation

type Operation struct {
	ID            string
	OpType        OperationType
	Status        OperationStatus
	Data          json.RawMessage
	Error         json.RawMessage
	ErrorSeverity OperationErrorSeverity
	Priority      int
	CreatedAt     *time.Time
	UpdatedAt     *time.Time
}

Operation represents an Operation

type OperationErrorSeverity

type OperationErrorSeverity string

OperationErrorSeverity defines operation's error severity

const (
	// OperationErrorSeverityError represents Error severity
	OperationErrorSeverityError OperationErrorSeverity = "ERROR"
	// OperationErrorSeverityWarning represents Warning severity
	OperationErrorSeverityWarning OperationErrorSeverity = "WARNING"
	// OperationErrorSeverityInfo represents Info severity
	OperationErrorSeverityInfo OperationErrorSeverity = "INFO"
	// OperationErrorSeverityNone represents missing severity
	OperationErrorSeverityNone OperationErrorSeverity = "NONE"
)

type OperationInput

type OperationInput struct {
	OpType        OperationType
	Status        OperationStatus
	Data          json.RawMessage
	Error         json.RawMessage
	ErrorSeverity OperationErrorSeverity
	Priority      int
	CreatedAt     *time.Time
	UpdatedAt     *time.Time
}

OperationInput represents an OperationInput

func (*OperationInput) ToOperation

func (i *OperationInput) ToOperation(id string) *Operation

ToOperation converts OperationInput to Operation

type OperationStatus

type OperationStatus string

OperationStatus defines operation status

const (
	// OperationStatusScheduled scheduled operation status
	OperationStatusScheduled OperationStatus = "SCHEDULED"
	// OperationStatusInProgress in progress operation status
	OperationStatusInProgress OperationStatus = "IN_PROGRESS"
	// OperationStatusCompleted completed operation status
	OperationStatusCompleted OperationStatus = "COMPLETED"
	// OperationStatusFailed failed operation status
	OperationStatusFailed OperationStatus = "FAILED"
)

func (OperationStatus) ToString

func (os OperationStatus) ToString() string

ToString stringifies OperationStatus

type OperationTrigger

type OperationTrigger string

OperationTrigger denotes what triggered the operation - assign, unassign, reset etc.

const (
	// AssignObject denotes the operation was triggered by assigning object a formation
	AssignObject OperationTrigger = "ASSIGN_OBJECT"
	// UnassignObject denotes the operation was triggered by unassigning object a formation
	UnassignObject OperationTrigger = "UNASSIGN_OBJECT"
	// ResetAssignment denotes the operation was triggered by resetting formation assignment
	ResetAssignment OperationTrigger = "RESET"
	// ResyncAssignment denotes the operation was triggered by resynchronizing formation assignment
	ResyncAssignment OperationTrigger = "RESYNC"
)

type OperationType

type OperationType string

OperationType defines supported operation types

const (
	// OperationTypeOrdAggregation specifies open resource discovery operation type
	OperationTypeOrdAggregation OperationType = "ORD_AGGREGATION"
	// OperationTypeSystemFetching specifies system fetching operation type
	OperationTypeSystemFetching OperationType = "SYSTEM_FETCHING"
	// OperationTypeSaasRegistryDiscovery specifies saas registry discovery operation type
	OperationTypeSaasRegistryDiscovery OperationType = "SAAS_REGISTRY_DISCOVERY"
)

type Package

type Package struct {
	ID                           string
	ApplicationID                *string
	ApplicationTemplateVersionID *string
	OrdID                        string
	Vendor                       *string
	Title                        string
	ShortDescription             string
	Description                  string
	Version                      string
	PackageLinks                 json.RawMessage
	Links                        json.RawMessage
	LicenseType                  *string
	SupportInfo                  *string
	Tags                         json.RawMessage
	RuntimeRestriction           *string
	Countries                    json.RawMessage
	Labels                       json.RawMessage
	PolicyLevel                  *string
	CustomPolicyLevel            *string
	PartOfProducts               json.RawMessage
	LineOfBusiness               json.RawMessage
	Industry                     json.RawMessage
	ResourceHash                 *string
	DocumentationLabels          json.RawMessage
}

Package missing godoc

func (*Package) SetFromUpdateInput

func (p *Package) SetFromUpdateInput(update PackageInput, pkgHash uint64)

SetFromUpdateInput missing godoc

type PackageInput

type PackageInput struct {
	OrdID               string          `json:"ordId"`
	Vendor              *string         `json:"vendor"`
	Title               string          `json:"title"`
	ShortDescription    string          `json:"shortDescription"`
	Description         string          `json:"description"`
	Version             string          `json:"version" hash:"ignore"`
	PackageLinks        json.RawMessage `json:"packageLinks"`
	Links               json.RawMessage `json:"links"`
	LicenseType         *string         `json:"licenseType"`
	SupportInfo         *string         `json:"supportInfo"`
	Tags                json.RawMessage `json:"tags"`
	RuntimeRestriction  *string         `json:"runtimeRestriction"`
	Countries           json.RawMessage `json:"countries"`
	Labels              json.RawMessage `json:"labels"`
	PolicyLevel         *string         `json:"policyLevel"`
	CustomPolicyLevel   *string         `json:"customPolicyLevel"`
	PartOfProducts      json.RawMessage `json:"partOfProducts"`
	LineOfBusiness      json.RawMessage `json:"lineOfBusiness"`
	Industry            json.RawMessage `json:"industry"`
	DocumentationLabels json.RawMessage `json:"documentationLabels"`
}

PackageInput missing godoc

func (*PackageInput) ToPackage

func (i *PackageInput) ToPackage(id string, resourceType resource.Type, resourceID string, pkgHash uint64) *Package

ToPackage missing godoc

type Product

type Product struct {
	ID                           string
	OrdID                        string
	ApplicationID                *string
	ApplicationTemplateVersionID *string
	Title                        string
	ShortDescription             string
	Description                  *string
	Vendor                       string
	Parent                       *string
	CorrelationIDs               json.RawMessage
	Tags                         json.RawMessage
	Labels                       json.RawMessage
	DocumentationLabels          json.RawMessage
}

Product missing godoc

func (*Product) SetFromUpdateInput

func (p *Product) SetFromUpdateInput(update ProductInput)

SetFromUpdateInput missing godoc

type ProductInput

type ProductInput struct {
	OrdID               string          `json:"ordId"`
	Title               string          `json:"title"`
	ShortDescription    string          `json:"shortDescription"`
	Description         *string         `json:"description"`
	Vendor              string          `json:"vendor"`
	Parent              *string         `json:"parent"`
	CorrelationIDs      json.RawMessage `json:"correlationIds"`
	Tags                json.RawMessage `json:"tags"`
	Labels              json.RawMessage `json:"labels"`
	DocumentationLabels json.RawMessage `json:"documentationLabels"`
}

ProductInput missing godoc

func (*ProductInput) ToProduct

func (i *ProductInput) ToProduct(id string, resourceType resource.Type, resourceID string) *Product

ToProduct missing godoc

type ResourceType

type ResourceType string

ResourceType represents the type of resource the constraint is applicable to

const (
	// ApplicationResourceType represents the application resource type
	ApplicationResourceType ResourceType = "APPLICATION"
	// RuntimeResourceType represents the runtime resource type
	RuntimeResourceType ResourceType = "RUNTIME"
	// RuntimeContextResourceType represents the runtime context resource type
	RuntimeContextResourceType ResourceType = "RUNTIME_CONTEXT"
	// TenantResourceType represents the tenant resource type
	TenantResourceType ResourceType = "TENANT"
	// FormationResourceType represents the formation resource type
	FormationResourceType ResourceType = "FORMATION"
)

type Runtime

type Runtime struct {
	ID                   string
	Name                 string
	Description          *string
	Status               *RuntimeStatus
	CreationTimestamp    time.Time
	ApplicationNamespace *string
}

Runtime missing godoc

func (*Runtime) GetID

func (runtime *Runtime) GetID() string

GetID missing godoc

func (*Runtime) SetFromUpdateInput

func (runtime *Runtime) SetFromUpdateInput(update RuntimeUpdateInput, id string, creationTimestamp, conditionTimestamp time.Time)

SetFromUpdateInput sets fields to model Runtime from RuntimeUpdateInput

type RuntimeArtifactKind

type RuntimeArtifactKind string

RuntimeArtifactKind missing godoc

const (
	// RuntimeArtifactKindSubscription missing godoc
	RuntimeArtifactKindSubscription RuntimeArtifactKind = "SUBSCRIPTION"
	// RuntimeArtifactKindServiceInstance missing godoc
	RuntimeArtifactKindServiceInstance RuntimeArtifactKind = "SERVICE_INSTANCE"
	// RuntimeArtifactKindEnvironmentInstance missing godoc
	RuntimeArtifactKindEnvironmentInstance RuntimeArtifactKind = "ENVIRONMENT_INSTANCE"
)

type RuntimeContext

type RuntimeContext struct {
	ID        string
	RuntimeID string
	Key       string
	Value     string
}

RuntimeContext missing godoc

func (*RuntimeContext) GetID

func (r *RuntimeContext) GetID() string

GetID missing godoc

type RuntimeContextInput

type RuntimeContextInput struct {
	Key       string
	Value     string
	RuntimeID string
}

RuntimeContextInput missing godoc

func (*RuntimeContextInput) ToRuntimeContext

func (i *RuntimeContextInput) ToRuntimeContext(id string) *RuntimeContext

ToRuntimeContext missing godoc

type RuntimeContextPage

type RuntimeContextPage struct {
	Data       []*RuntimeContext
	PageInfo   *pagination.Page
	TotalCount int
}

RuntimeContextPage missing godoc

type RuntimeEventingConfiguration

type RuntimeEventingConfiguration struct {
	EventingConfiguration
}

RuntimeEventingConfiguration missing godoc

func NewRuntimeEventingConfiguration

func NewRuntimeEventingConfiguration(rawEventURL string) (*RuntimeEventingConfiguration, error)

NewRuntimeEventingConfiguration missing godoc

type RuntimePage

type RuntimePage struct {
	Data       []*Runtime
	PageInfo   *pagination.Page
	TotalCount int
}

RuntimePage missing godoc

type RuntimeRegisterInput

type RuntimeRegisterInput struct {
	Name                 string
	Description          *string
	Labels               map[string]interface{}
	Webhooks             []*WebhookInput
	StatusCondition      *RuntimeStatusCondition
	ApplicationNamespace *string
}

RuntimeRegisterInput missing godoc

func (*RuntimeRegisterInput) ToRuntime

func (i *RuntimeRegisterInput) ToRuntime(id string, creationTimestamp, conditionTimestamp time.Time) *Runtime

ToRuntime missing godoc

type RuntimeStatus

type RuntimeStatus struct {
	Condition RuntimeStatusCondition
	Timestamp time.Time
}

RuntimeStatus missing godoc

type RuntimeStatusCondition

type RuntimeStatusCondition string

RuntimeStatusCondition missing godoc

const (
	// RuntimeStatusConditionInitial missing godoc
	RuntimeStatusConditionInitial RuntimeStatusCondition = "INITIAL"
	// RuntimeStatusConditionProvisioning missing godoc
	RuntimeStatusConditionProvisioning RuntimeStatusCondition = "PROVISIONING"
	// RuntimeStatusConditionConnected missing godoc
	RuntimeStatusConditionConnected RuntimeStatusCondition = "CONNECTED"
	// RuntimeStatusConditionFailed missing godoc
	RuntimeStatusConditionFailed RuntimeStatusCondition = "FAILED"
)

type RuntimeUpdateInput

type RuntimeUpdateInput struct {
	Name                 string
	Description          *string
	Labels               map[string]interface{}
	StatusCondition      *RuntimeStatusCondition
	ApplicationNamespace *string
}

RuntimeUpdateInput missing godoc

type SccMetadata

type SccMetadata struct {
	Subaccount           string
	InternalSubaccountID string
	LocationID           string
}

SccMetadata contains metadata for SCC

type Spec

type Spec struct {
	ID         string
	ObjectType SpecReferenceObjectType
	ObjectID   string

	Data           *string
	Format         SpecFormat
	APIType        *APISpecType
	EventType      *EventSpecType
	CapabilityType *CapabilitySpecType
	CustomType     *string
}

Spec represents a specification of a resource.

type SpecFormat

type SpecFormat string

SpecFormat is the format of the specification.

const (
	// SpecFormatYaml is the YAML format.
	SpecFormatYaml SpecFormat = "YAML"
	// SpecFormatJSON is the JSON format.
	SpecFormatJSON SpecFormat = "JSON"
	// SpecFormatXML is the XML format.
	SpecFormatXML SpecFormat = "XML"

	// SpecFormatApplicationJSON is the Application JSON format.
	SpecFormatApplicationJSON SpecFormat = "application/json"
	// SpecFormatTextYAML is the Text YAML format.
	SpecFormatTextYAML SpecFormat = "text/yaml"
	// SpecFormatApplicationXML is the Application XML format.
	SpecFormatApplicationXML SpecFormat = "application/xml"
	// SpecFormatPlainText is the Plain Text format.
	SpecFormatPlainText SpecFormat = "text/plain"
	// SpecFormatOctetStream is the Octet Stream format.
	SpecFormatOctetStream SpecFormat = "application/octet-stream"
)

type SpecInput

type SpecInput struct {
	Data           *string
	Format         SpecFormat
	APIType        *APISpecType
	EventType      *EventSpecType
	CapabilityType *CapabilitySpecType
	CustomType     *string

	FetchRequest *FetchRequestInput
}

SpecInput is an input for creating/updating specification.

func (*SpecInput) ToSpec

func (s *SpecInput) ToSpec(id string, objectType SpecReferenceObjectType, objectID string) (*Spec, error)

ToSpec converts the input to a Spec.

type SpecReferenceObjectType

type SpecReferenceObjectType string

SpecReferenceObjectType represents the type of the referenced object by the Spec.

const (
	// APISpecReference is a reference to an API Specification.
	APISpecReference SpecReferenceObjectType = "API"
	// EventSpecReference is a reference to an Event Specification.
	EventSpecReference SpecReferenceObjectType = "Event"
	// CapabilitySpecReference is a reference to a Capability Specification.
	CapabilitySpecReference SpecReferenceObjectType = "Capability"
)

func (SpecReferenceObjectType) GetResourceType

func (obj SpecReferenceObjectType) GetResourceType() resource.Type

GetResourceType returns the resource type of the specification based on the referenced entity.

type SystemSynchronizationTimestamp

type SystemSynchronizationTimestamp struct {
	ID                string
	TenantID          string
	ProductID         string
	LastSyncTimestamp time.Time
}

SystemSynchronizationTimestamp represents the last synchronization time of a system

type TargetOperation

type TargetOperation string

TargetOperation represents the operation to which the constraint is applicable. Different values are defined in the GraphQL schema.

const (
	// AssignFormationOperation represents the assign formation operation
	AssignFormationOperation TargetOperation = "ASSIGN_FORMATION"
	// UnassignFormationOperation represents the unassign formation operation
	UnassignFormationOperation TargetOperation = "UNASSIGN_FORMATION"
	// CreateFormationOperation represents the create formation operation
	CreateFormationOperation TargetOperation = "CREATE_FORMATION"
	// DeleteFormationOperation represents the delete formation operation
	DeleteFormationOperation TargetOperation = "DELETE_FORMATION"
	// GenerateFormationAssignmentNotificationOperation represents the generate formation assignment notifications operation
	GenerateFormationAssignmentNotificationOperation TargetOperation = "GENERATE_FORMATION_ASSIGNMENT_NOTIFICATION"
	// GenerateFormationNotificationOperation represents the generate formation notifications operation
	GenerateFormationNotificationOperation TargetOperation = "GENERATE_FORMATION_NOTIFICATION"
	// SendNotificationOperation represents the send notification operation
	SendNotificationOperation TargetOperation = "SEND_NOTIFICATION"
	// NotificationStatusReturned represents the notification status returned operation
	NotificationStatusReturned TargetOperation = "NOTIFICATION_STATUS_RETURNED"
)

type TenantAccess

type TenantAccess struct {
	ExternalTenantID string
	InternalTenantID string
	ResourceType     resource.Type
	ResourceID       string
	Owner            bool
	Source           string
}

TenantAccess represents the tenant's access level to the resource

type Tombstone

type Tombstone struct {
	ID                           string
	OrdID                        string
	ApplicationID                *string
	ApplicationTemplateVersionID *string
	RemovalDate                  string
	Description                  *string
}

Tombstone missing godoc

func (*Tombstone) SetFromUpdateInput

func (p *Tombstone) SetFromUpdateInput(update TombstoneInput)

SetFromUpdateInput missing godoc

type TombstoneInput

type TombstoneInput struct {
	OrdID       string  `json:"ordId"`
	RemovalDate string  `json:"removalDate"`
	Description *string `json:"description"`
}

TombstoneInput missing godoc

func (*TombstoneInput) ToTombstone

func (i *TombstoneInput) ToTombstone(id string, resourceType resource.Type, resourceID string) *Tombstone

ToTombstone missing godoc

type Vendor

type Vendor struct {
	ID                           string
	OrdID                        string
	ApplicationID                *string
	ApplicationTemplateVersionID *string
	Title                        string
	Partners                     json.RawMessage
	Tags                         json.RawMessage
	Labels                       json.RawMessage
	DocumentationLabels          json.RawMessage
}

Vendor missing godoc

func (*Vendor) SetFromUpdateInput

func (p *Vendor) SetFromUpdateInput(update VendorInput)

SetFromUpdateInput missing godoc

type VendorInput

type VendorInput struct {
	OrdID               string          `json:"ordId"`
	Title               string          `json:"title"`
	Partners            json.RawMessage `json:"partners"`
	Tags                json.RawMessage `json:"tags"`
	Labels              json.RawMessage `json:"labels"`
	DocumentationLabels json.RawMessage `json:"documentationLabels"`
}

VendorInput missing godoc

func (*VendorInput) ToVendor

func (i *VendorInput) ToVendor(id string, resourceType resource.Type, resourceID string) *Vendor

ToVendor missing godoc

type Version

type Version struct {
	// for example 4.6
	Value      string
	Deprecated *bool
	// for example 4.5
	DeprecatedSince *string
	// if true, will be removed in the next version
	ForRemoval *bool
}

Version missing godoc

type VersionInput

type VersionInput struct {
	Value           string  `json:"version"`
	Deprecated      *bool   `json:",omitempty"`
	DeprecatedSince *string `json:",omitempty"`
	ForRemoval      *bool   `json:",omitempty"`
}

VersionInput missing godoc

func (*VersionInput) ToVersion

func (v *VersionInput) ToVersion() *Version

ToVersion missing godoc

type Webhook

type Webhook struct {
	ID               string
	ObjectID         string
	ObjectType       WebhookReferenceObjectType
	CorrelationIDKey *string
	Type             WebhookType
	URL              *string
	ProxyURL         *string
	Auth             *Auth
	Mode             *WebhookMode
	RetryInterval    *int
	Timeout          *int
	URLTemplate      *string
	InputTemplate    *string
	HeaderTemplate   *string
	OutputTemplate   *string
	StatusTemplate   *string
	CreatedAt        *time.Time
}

Webhook represents a webhook that is called by Compass.

type WebhookInput

type WebhookInput struct {
	ID               string
	CorrelationIDKey *string
	Type             WebhookType
	URL              *string
	ProxyURL         *string
	Auth             *AuthInput
	Mode             *WebhookMode
	RetryInterval    *int
	Timeout          *int
	URLTemplate      *string
	InputTemplate    *string
	HeaderTemplate   *string
	OutputTemplate   *string
	StatusTemplate   *string
}

WebhookInput represents a webhook input for creating/updating webhooks.

func (*WebhookInput) ToWebhook

func (i *WebhookInput) ToWebhook(id, objID string, objectType WebhookReferenceObjectType) *Webhook

ToWebhook converts the given input to a webhook.

type WebhookMode

type WebhookMode string

WebhookMode represents the mode of the webhook.

const (
	// WebhookModeSync represents a webhook that is called synchronously.
	WebhookModeSync WebhookMode = "SYNC"
	// WebhookModeAsync represents a webhook that is called asynchronously.
	WebhookModeAsync WebhookMode = "ASYNC"
	// WebhookModeAsyncCallback represents a webhook that is called asynchronously and status is expected via callback on a status API.
	WebhookModeAsyncCallback WebhookMode = "ASYNC_CALLBACK"
)

type WebhookReferenceObjectType

type WebhookReferenceObjectType string

WebhookReferenceObjectType represents the type of the object that is referenced by the webhook.

const (
	// UnknownWebhookReference is used when the webhook's reference entity cannot be determined.
	// For example in case of update we have only the target's webhook ID and the input, we cannot determine the reference entity.
	// In those cases an aggregated view with all the webhook ref entity tenant access views unioned together is used for tenant isolation.
	UnknownWebhookReference WebhookReferenceObjectType = "Unknown"
	// ApplicationWebhookReference is used when the webhook's reference entity is an application.
	ApplicationWebhookReference WebhookReferenceObjectType = "ApplicationWebhook"
	// RuntimeWebhookReference is used when the webhook's reference entity is a runtime.
	RuntimeWebhookReference WebhookReferenceObjectType = "RuntimeWebhook"
	// ApplicationTemplateWebhookReference is used when the webhook's reference entity is an application template.
	ApplicationTemplateWebhookReference WebhookReferenceObjectType = "ApplicationTemplateWebhook"
	// IntegrationSystemWebhookReference is used when the webhook's reference entity is an integration system.
	IntegrationSystemWebhookReference WebhookReferenceObjectType = "IntegrationSystemWebhook"
	// FormationTemplateWebhookReference is used when the webhook's reference entity is a formation template.
	FormationTemplateWebhookReference WebhookReferenceObjectType = "FormationTemplateWebhook"
)

func (WebhookReferenceObjectType) GetResourceType

func (obj WebhookReferenceObjectType) GetResourceType() resource.Type

GetResourceType returns the resource type of the webhook based on the referenced entity.

type WebhookType

type WebhookType string

WebhookType represents the type of the webhook.

const (
	// WebhookTypeConfigurationChanged represents a webhook that is called when a configuration is changed.
	WebhookTypeConfigurationChanged WebhookType = "CONFIGURATION_CHANGED"
	// WebhookTypeApplicationTenantMapping represents a webhook that is called for app to app notifications for formation changes.
	WebhookTypeApplicationTenantMapping WebhookType = "APPLICATION_TENANT_MAPPING"
	// WebhookTypeRegisterApplication represents a webhook that is called when an application is registered.
	WebhookTypeRegisterApplication WebhookType = "REGISTER_APPLICATION"
	// WebhookTypeDeleteApplication represents a webhook that is called when an application is deleted.
	WebhookTypeDeleteApplication WebhookType = "UNREGISTER_APPLICATION"
	// WebhookTypeOpenResourceDiscovery represents a webhook that is called to aggregate ORD information of a system.
	WebhookTypeOpenResourceDiscovery WebhookType = "OPEN_RESOURCE_DISCOVERY"
	// WebhookTypeOpenResourceDiscoveryStatic represents a webhook that is called to aggregate static ORD information.
	WebhookTypeOpenResourceDiscoveryStatic WebhookType = "OPEN_RESOURCE_DISCOVERY_STATIC"
	// WebhookTypeFormationLifecycle represents a webhook that is called when lifecycle event (creation/deletion) of formation occurs
	WebhookTypeFormationLifecycle WebhookType = "FORMATION_LIFECYCLE"
	// WebhookTypeSystemFieldDiscovery represents a webhook that is called to enrich an application information
	WebhookTypeSystemFieldDiscovery WebhookType = "SYSTEM_FIELD_DISCOVERY"
)

Jump to

Keyboard shortcuts

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