datamodel

package
v0.41.0-rc1 Latest Latest
Warning

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

 Go to latest Published: Dec 6, 2024 License: Apache-2.0 Imports: 9 Imported by: 0

Documentation

Index

Constants

View Source 
const (

	// DaprMissingError is an error message that can be used when Dapr is not installed on the cluster.
	DaprMissingError = "" /* 173-byte string literal not displayed */
)

Variables

This section is empty.

Functions

func IsDaprInstalled 

func IsDaprInstalled(ctx context.Context, kubeClient client.Client) (bool, error)

IsDaprInstalled will check for Dapr to be installed in the deployment environment and return and true if it is installed. Callers of this function can use DaprMissingError for a friendly error message to send back to users.

This check is based on the Dapr Component CRD, and only supports Kubernetes.

Types

type DaprConfigurationStore added in v0.39.0 

type DaprConfigurationStore struct {
	v1.BaseResource

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

	// ResourceMetadata represents internal DataModel properties common to all portable resource types.
	datamodel.PortableResourceMetadata
}

DaprConfigurationStore represents Dapr configuration store portable resource.

func (*DaprConfigurationStore) ApplyDeploymentOutput added in v0.39.0 

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

ApplyDeploymentOutput updates the DaprConfigurationStore resource with the DeploymentOutput values.

func (*DaprConfigurationStore) OutputResources added in v0.39.0 

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

OutputResources returns the OutputResources from the Properties of the DaprConfigurationStore instance.

func (*DaprConfigurationStore) Recipe added in v0.39.0 

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

Recipe returns the recipe information of the resource. Returns nil if recipe execution is disabled.

func (*DaprConfigurationStore) ResourceMetadata added in v0.39.0 

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

ResourceMetadata returns the BasicResourceProperties of the Dapr ConfigurationStore resource i.e. application resources metadata.

func (*DaprConfigurationStore) ResourceTypeName added in v0.39.0 

func (r *DaprConfigurationStore) ResourceTypeName() string

ResourceTypeName returns a string representing the resource type.

type DaprConfigurationStoreProperties added in v0.39.0 

type DaprConfigurationStoreProperties struct {
	rpv1.BasicResourceProperties
	rpv1.BasicDaprResourceProperties

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

	// Metadata of the Dapr Configuration store resource.
	Metadata map[string]*rpv1.DaprComponentMetadataValue `json:"metadata,omitempty"`

	// The recipe used to automatically deploy underlying infrastructure for the Dapr Configuration store resource.
	Recipe portableresources.ResourceRecipe `json:"recipe,omitempty"`

	// List of the resource IDs that support the Dapr Configuration store Broker resource.
	Resources []*portableresources.ResourceReference `json:"resources,omitempty"`

	// Type of the Dapr Configuration Store resource.
	Type string `json:"type,omitempty"`

	// Version of the Dapr Configuration Store resource.
	Version string `json:"version,omitempty"`

	// Auth information for the Dapr Configuration Store resource, mainly secret store name.
	Auth *rpv1.DaprComponentAuth `json:"auth,omitempty"`
}

DaprConfigurationStoreProperties represents the properties of Dapr ConfigurationStore resource.

type DaprPubSubBroker 

type DaprPubSubBroker struct {
	v1.BaseResource

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

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

DaprPubSubBroker represents Dapr PubSubBroker portable resource.

func (*DaprPubSubBroker) ApplyDeploymentOutput 

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

ApplyDeploymentOutput updates the DaprPubSubBroker resource with the DeploymentOutput values.

func (*DaprPubSubBroker) OutputResources 

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

OutputResources returns the OutputResources from the Properties of the DaprPubSubBroker instance.

func (*DaprPubSubBroker) Recipe 

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

Recipe returns the recipe information of the resource. Returns nil if recipe execution is disabled.

func (*DaprPubSubBroker) ResourceMetadata 

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

ResourceMetadata returns the BasicResourceProperties of the Dapr PubSubBroker resource i.e. application resources metadata.

func (*DaprPubSubBroker) ResourceTypeName 

func (r *DaprPubSubBroker) ResourceTypeName() string

ResourceTypeName returns a string representing the resource type.

type DaprPubSubBrokerProperties 

type DaprPubSubBrokerProperties struct {
	rpv1.BasicResourceProperties
	rpv1.BasicDaprResourceProperties

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

	// Metadata of the Dapr Pub/Sub Broker resource.
	Metadata map[string]*rpv1.DaprComponentMetadataValue `json:"metadata,omitempty"`

	// The recipe used to automatically deploy underlying infrastructure for the Dapr Pub/Sub Broker resource.
	Recipe portableresources.ResourceRecipe `json:"recipe,omitempty"`

	// List of the resource IDs that support the Dapr Pub/Sub Broker resource.
	Resources []*portableresources.ResourceReference `json:"resources,omitempty"`

	// Type of the Dapr Pub/Sub Broker resource.
	Type string `json:"type,omitempty"`

	// Version of the Dapr Pub/Sub Broker resource.
	Version string `json:"version,omitempty"`

	// Authentication information for the Dapr Pub/Sub Broker resource, mainly secret store name.
	Auth *rpv1.DaprComponentAuth `json:"auth,omitempty"`
}

DaprPubSubBrokerProperties represents the properties of Dapr PubSubBroker resource.

type DaprSecretStore 

type DaprSecretStore struct {
	v1.BaseResource

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

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

DaprSecretStore represents Dapr SecretStore portable resource.

func (*DaprSecretStore) ApplyDeploymentOutput 

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

ApplyDeploymentOutput updates the DaprSecretStore resource with the DeploymentOutput values.

func (*DaprSecretStore) OutputResources 

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

OutputResources returns the OutputResources array from Properties of the Dapr SecretStore resource.

func (*DaprSecretStore) Recipe 

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

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

func (*DaprSecretStore) ResourceMetadata 

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

ResourceMetadata returns the BasicResourceProperties of the DaprSecretStore resource i.e. application resources metadata.

func (*DaprSecretStore) ResourceTypeName 

func (r *DaprSecretStore) ResourceTypeName() string

ResourceTypeName returns the resource type of the DaprSecretStore resource.

type DaprSecretStoreProperties 

type DaprSecretStoreProperties struct {
	rpv1.BasicResourceProperties
	rpv1.BasicDaprResourceProperties
	Type                 string                                      `json:"type,omitempty"`
	Version              string                                      `json:"version,omitempty"`
	Metadata             map[string]*rpv1.DaprComponentMetadataValue `json:"metadata,omitempty"`
	Recipe               portableresources.ResourceRecipe            `json:"recipe,omitempty"`
	ResourceProvisioning portableresources.ResourceProvisioning      `json:"resourceProvisioning,omitempty"`
}

DaprSecretStoreProperties represents the properties of DaprSecretStore resource.

type DaprStateStore 

type DaprStateStore struct {
	v1.BaseResource

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

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

DaprStateStore represents DaprStateStore portable resource.

func (*DaprStateStore) ApplyDeploymentOutput 

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

ApplyDeploymentOutput updates the DaprStateStore resource with the DeploymentOutput values.

func (*DaprStateStore) OutputResources 

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

OutputResources returns the OutputResources from the Properties of the DaprStateStore resource.

func (*DaprStateStore) Recipe 

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

Recipe returns the recipe information of the resource. It returns nil if the ResourceProvisioning is set to manual.

func (*DaprStateStore) ResourceMetadata 

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

ResourceMetadata returns the BasicResourceProperties of the DaprStateStore resource i.e. application resources metadata.

func (*DaprStateStore) ResourceTypeName 

func (r *DaprStateStore) ResourceTypeName() string

ResourceTypeName returns the resource type of the DaprStateStore resource.

type DaprStateStoreProperties 

type DaprStateStoreProperties struct {
	rpv1.BasicResourceProperties
	rpv1.BasicDaprResourceProperties
	// Specifies how the underlying service/resource is provisioned and managed
	ResourceProvisioning portableresources.ResourceProvisioning      `json:"resourceProvisioning,omitempty"`
	Metadata             map[string]*rpv1.DaprComponentMetadataValue `json:"metadata,omitempty"`
	Recipe               portableresources.ResourceRecipe            `json:"recipe,omitempty"`
	Resources            []*portableresources.ResourceReference      `json:"resources,omitempty"`
	Type                 string                                      `json:"type,omitempty"`
	Version              string                                      `json:"version,omitempty"`
	// Authentication information for the Dapr Pub/Sub Broker resource, mainly secret store name.
	Auth *rpv1.DaprComponentAuth `json:"auth,omitempty"`
}

DaprStateStoreProperties represents the properties of DaprStateStore resource.

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.