datamodel

Documentation

Index

• type MongoDatabase
  • func (r *MongoDatabase) ApplyDeploymentOutput(do rpv1.DeploymentOutput) error
  • func (r *MongoDatabase) OutputResources() []rpv1.OutputResource
  • func (r *MongoDatabase) Recipe() *portableresources.ResourceRecipe
  • func (r *MongoDatabase) ResourceMetadata() *rpv1.BasicResourceProperties
  • func (r *MongoDatabase) ResourceTypeName() string
  • func (r *MongoDatabase) VerifyInputs() error
• type MongoDatabaseProperties
• type MongoDatabaseSecrets
  • func (mongoSecrets MongoDatabaseSecrets) IsEmpty() bool
  • func (mongoSecrets *MongoDatabaseSecrets) ResourceTypeName() string
• type RedisCache
  • func (r *RedisCache) ApplyDeploymentOutput(do rpv1.DeploymentOutput) error
  • func (r *RedisCache) OutputResources() []rpv1.OutputResource
  • func (r *RedisCache) Recipe() *portableresources.ResourceRecipe
  • func (r *RedisCache) ResourceMetadata() *rpv1.BasicResourceProperties
  • func (r *RedisCache) ResourceTypeName() string
  • func (r *RedisCache) VerifyInputs() error
• type RedisCacheProperties
• type RedisCacheSecrets
  • func (redisSecrets *RedisCacheSecrets) IsEmpty() bool
  • func (redis RedisCacheSecrets) ResourceTypeName() string
• type SqlDatabase
  • func (r *SqlDatabase) ApplyDeploymentOutput(do rpv1.DeploymentOutput) error
  • func (r *SqlDatabase) OutputResources() []rpv1.OutputResource
  • func (sql *SqlDatabase) Recipe() *portableresources.ResourceRecipe
  • func (r *SqlDatabase) ResourceMetadata() *rpv1.BasicResourceProperties
  • func (r *SqlDatabase) ResourceTypeName() string
  • func (sql *SqlDatabase) VerifyInputs() error
• type SqlDatabaseProperties
• type SqlDatabaseSecrets
  • func (sqlSecrets SqlDatabaseSecrets) IsEmpty() bool
  • func (sqlSecrets *SqlDatabaseSecrets) ResourceTypeName() string

Types

type MongoDatabase

type MongoDatabase struct {
	v1.BaseResource

	// PortableResourceMetadata represents internal DataModel properties common to all portable resources.
	pr_dm.PortableResourceMetadata

	// Properties is the properties of the resource.
	Properties MongoDatabaseProperties `json:"properties"`
}

MongoDatabase represents Mongo database portable resource.

func (*MongoDatabase) ApplyDeploymentOutput

func (r *MongoDatabase) ApplyDeploymentOutput(do rpv1.DeploymentOutput) error

ApplyDeploymentOutput updates the Mongo database instance's database property, output resources, computed values and secret values with the given DeploymentOutput.

func (*MongoDatabase) OutputResources

func (r *MongoDatabase) OutputResources() []rpv1.OutputResource

OutputResources returns the OutputResources of the Mongo database instance.

func (*MongoDatabase) Recipe

func (r *MongoDatabase) Recipe() *portableresources.ResourceRecipe

Recipe returns the ResourceRecipe associated with the Mongo database instance, or nil if the ResourceProvisioning is set to Manual.

func (*MongoDatabase) ResourceMetadata

func (r *MongoDatabase) ResourceMetadata() *rpv1.BasicResourceProperties

ResourceMetadata returns the BasicResourceProperties of the Mongo database instance i.e. application resource metadata.

func (*MongoDatabase) ResourceTypeName

func (r *MongoDatabase) ResourceTypeName() string

ResourceTypeName returns the resource type for Mongo database resource.

func (*MongoDatabase) VerifyInputs

func (r *MongoDatabase) VerifyInputs() error

VerifyInputs checks if the manual resource provisioning fields are set and returns an error if any of them are missing.

type MongoDatabaseProperties

type MongoDatabaseProperties struct {
	rpv1.BasicResourceProperties
	// Secrets values provided for the Mongo database resource
	Secrets MongoDatabaseSecrets `json:"secrets,omitempty"`
	// Host name of the target Mongo database
	Host string `json:"host,omitempty"`
	// Port value of the target Mongo database
	Port int32 `json:"port,omitempty"`
	// Database name of the target Mongo database
	Database string `json:"database,omitempty"`
	// The recipe used to automatically deploy underlying infrastructure for the Mongo database link
	Recipe portableresources.ResourceRecipe `json:"recipe,omitempty"`
	// List of the resource IDs that support the Mongo database resource
	Resources []*portableresources.ResourceReference `json:"resources,omitempty"`
	// Specifies how the underlying service/resource is provisioned and managed
	ResourceProvisioning portableresources.ResourceProvisioning `json:"resourceProvisioning,omitempty"`
	// Username of the Mongo database
	Username string `json:"username,omitempty"`
}

MongoDatabaseProperties represents the properties of Mongo database resource.

type MongoDatabaseSecrets

type MongoDatabaseSecrets struct {
	Password         string `json:"password"`
	ConnectionString string `json:"connectionString"`
}

Secrets values consisting of secrets provided for the resource

func (MongoDatabaseSecrets) IsEmpty

func (mongoSecrets MongoDatabaseSecrets) IsEmpty() bool

IsEmpty checks if the MongoDatabaseSecrets instance is empty.

func (*MongoDatabaseSecrets) ResourceTypeName

func (mongoSecrets *MongoDatabaseSecrets) ResourceTypeName() string

ResourceTypeName returns the resource type for Mongo database resource.

type RedisCache

type RedisCache struct {
	v1.BaseResource

	// Properties is the properties of the resource.
	Properties RedisCacheProperties `json:"properties"`

	// PortableResourceMetadata represents internal DataModel properties common to all resource types.
	pr_dm.PortableResourceMetadata
}

RedisCache represents Redis cache portable resource.

func (*RedisCache) ApplyDeploymentOutput

func (r *RedisCache) ApplyDeploymentOutput(do rpv1.DeploymentOutput) error

ApplyDeploymentOutput sets the Status, ComputedValues, SecretValues, Host, Port and Username properties of the Redis cache instance based on the DeploymentOutput object.

func (*RedisCache) OutputResources

func (r *RedisCache) OutputResources() []rpv1.OutputResource

OutputResources returns the OutputResources of the Redis cache resource.

func (*RedisCache) Recipe

func (r *RedisCache) Recipe() *portableresources.ResourceRecipe

Recipe returns the ResourceRecipe from the Redis cache Properties if ResourceProvisioning is not set to Manual, otherwise it returns nil.

func (*RedisCache) ResourceMetadata

func (r *RedisCache) ResourceMetadata() *rpv1.BasicResourceProperties

ResourceMetadata returns the BasicResourceProperties of the Redis cache resource.

func (*RedisCache) ResourceTypeName

func (r *RedisCache) ResourceTypeName() string

ResourceTypeName returns the resource type of Redis cache resource.

func (*RedisCache) VerifyInputs

func (r *RedisCache) VerifyInputs() error

VerifyInputs checks if the required fields are set when the resourceProvisioning is set to manual and returns an error if not.

type RedisCacheProperties

type RedisCacheProperties struct {
	rpv1.BasicResourceProperties
	// The host name of the target Redis cache
	Host string `json:"host,omitempty"`

	// The port value of the target Redis cache
	Port int32 `json:"port,omitempty"`

	// The username for Redis cache
	Username string `json:"username,omitempty"`

	// Specifies whether to enable non-SSL or SSL connections
	TLS bool `json:"tls,omitempty"`

	// The recipe used to automatically deploy underlying infrastructure for the Redis caches link
	Recipe portableresources.ResourceRecipe `json:"recipe,omitempty"`

	// Secrets provided by resource
	Secrets RedisCacheSecrets `json:"secrets,omitempty"`

	// Specifies how the underlying service/resource is provisioned and managed
	ResourceProvisioning portableresources.ResourceProvisioning `json:"resourceProvisioning,omitempty"`

	// List of the resource IDs that support the Redis resource
	Resources []*portableresources.ResourceReference `json:"resources,omitempty"`
}

type RedisCacheSecrets

type RedisCacheSecrets struct {
	ConnectionString string `json:"connectionString"`
	Password         string `json:"password"`
	URL              string `json:"url"`
}

Secrets values consisting of secrets provided for the resource

func (*RedisCacheSecrets) IsEmpty

func (redisSecrets *RedisCacheSecrets) IsEmpty() bool

IsEmpty checks if the RedisCacheSecrets instance is empty or not.

func (RedisCacheSecrets) ResourceTypeName

func (redis RedisCacheSecrets) ResourceTypeName() string

ResourceTypeName returns the resource type of RedisCache resource.

type SqlDatabase

type SqlDatabase struct {
	v1.BaseResource

	// Properties is the properties of the resource.
	Properties SqlDatabaseProperties `json:"properties"`

	// ResourceMetadata represents internal DataModel properties common to all portable resources.
	pr_dm.PortableResourceMetadata
}

SqlDatabase represents SQL database portable resource.

func (*SqlDatabase) ApplyDeploymentOutput

func (r *SqlDatabase) ApplyDeploymentOutput(do rpv1.DeploymentOutput) error

ApplyDeploymentOutput updates the output resources of a SQL database resource with the output resources of a DeploymentOutput object and returns no error.

func (*SqlDatabase) OutputResources

func (r *SqlDatabase) OutputResources() []rpv1.OutputResource

OutputResources returns the OutputResources of the SQL database resource.

func (*SqlDatabase) Recipe

func (sql *SqlDatabase) Recipe() *portableresources.ResourceRecipe

Recipe returns the ResourceRecipe associated with the SQL database instance if the ResourceProvisioning is not set to Manual, otherwise it returns nil.

func (*SqlDatabase) ResourceMetadata

func (r *SqlDatabase) ResourceMetadata() *rpv1.BasicResourceProperties

ResourceMetadata returns the BasicResourceProperties of the SQL database resource.

func (*SqlDatabase) ResourceTypeName

func (r *SqlDatabase) ResourceTypeName() string

ResourceTypeName returns the resource type of the SQL database resource.

func (*SqlDatabase) VerifyInputs

func (sql *SqlDatabase) VerifyInputs() error

VerifyInputs checks if the required fields are set when the resourceProvisioning is set to manual and returns an error if any of the required fields are not set.

type SqlDatabaseProperties

type SqlDatabaseProperties struct {
	rpv1.BasicResourceProperties
	// The recipe used to automatically deploy underlying infrastructure for the SQL database resource
	Recipe portableresources.ResourceRecipe `json:"recipe,omitempty"`
	// Database name of the target SQL database resource
	Database string `json:"database,omitempty"`
	// The fully qualified domain name of the SQL database resource
	Server string `json:"server,omitempty"`
	// Port value of the target SQL database resource
	Port int32 `json:"port,omitempty"`
	// Specifies how the underlying service/resource is provisioned and managed
	ResourceProvisioning portableresources.ResourceProvisioning `json:"resourceProvisioning,omitempty"`
	// List of the resource IDs that support the SQL database resource
	Resources []*portableresources.ResourceReference `json:"resources,omitempty"`
	// Username of the SQL database resource
	Username string `json:"username,omitempty"`
	// Secrets values provided for the resource
	Secrets SqlDatabaseSecrets `json:"secrets,omitempty"`
}

SqlDatabaseProperties represents the properties of SQL database resource.

type SqlDatabaseSecrets

type SqlDatabaseSecrets struct {
	Password         string `json:"password"`
	ConnectionString string `json:"connectionString"`
}

Secrets values consisting of secrets provided for the resource

func (SqlDatabaseSecrets) IsEmpty

func (sqlSecrets SqlDatabaseSecrets) IsEmpty() bool

IsEmpty checks if the SqlDatabaseSecrets struct is empty.

func (*SqlDatabaseSecrets) ResourceTypeName

func (sqlSecrets *SqlDatabaseSecrets) ResourceTypeName() string

ResourceTypeName returns the resource type of the SQL database resource.