service

Jan 21, 2019

Changes in this version

+ type EnumValue struct

+ Title string

+ Value string

+ func (v EnumValue) MarshalJSON() ([]byte, error)

type StringPropertySchema

+ OneOf []EnumValue

Dec 18, 2018

Changes in this version

+ const DRTag

type CatalogConfig

+ EnableDRServices bool

Oct 3, 2018

Changes in this version

+ const MigrationTag

type CatalogConfig

+ EnableMigrationServices bool

type Service

+ GetTags func() []string

Aug 1, 2018

Changes in this version

type ArrayPropertySchema

+ Title string

type FloatPropertySchema

+ Title string

type IntPropertySchema

+ Title string

type ObjectPropertySchema

+ Title string

type StringPropertySchema

+ Title string

Jun 25, 2018

Changes in this version

type PlanSchemas

+ func (p *PlanSchemas) AddCommonSchema(sp ServiceProperties)

Jun 15, 2018

Changes in this version

+ type ArrayPropertySchema struct

+ CustomPropertyValidator CustomArrayPropertyValidator

+ DefaultValue []interface{}

+ Description string

+ ItemsSchema PropertySchema

+ MaxItems *int

+ MinItems *int

+ func (a ArrayPropertySchema) MarshalJSON() ([]byte, error)

+ type BindingSchemas struct

+ BindingParametersSchema InputParametersSchema

+ type CustomArrayPropertyValidator func(context string, value []interface{}) error

+ type CustomFloatPropertyValidator func(context string, value float64) error

+ type CustomIntPropertyValidator func(context string, value int64) error

+ type CustomObjectPropertyValidator func(context string, value map[string]interface{}) error

+ type CustomStringPropertyValidator func(context, value string) error

+ type FloatPropertySchema struct

+ AllowedIncrement *float64

+ AllowedValues []float64

+ CustomPropertyValidator CustomFloatPropertyValidator

+ DefaultValue *float64

+ Description string

+ MaxValue *float64

+ MinValue *float64

+ func (f FloatPropertySchema) MarshalJSON() ([]byte, error)

+ type InputParametersSchema struct

+ PropertySchemas map[string]PropertySchema

+ RequiredProperties []string

+ SecureProperties []string

+ func (i InputParametersSchema) GetAdditionalPropertySchema() PropertySchema

+ func (i InputParametersSchema) GetPropertySchemas() map[string]PropertySchema

+ func (i InputParametersSchema) MarshalJSON() ([]byte, error)

+ func (i InputParametersSchema) Validate(valMap map[string]interface{}) error

+ type InstanceSchemas struct

+ ProvisioningParametersSchema InputParametersSchema

+ UpdatingParametersSchema InputParametersSchema

+ type IntPropertySchema struct

+ AllowedIncrement *int64

+ AllowedValues []int64

+ CustomPropertyValidator CustomIntPropertyValidator

+ DefaultValue *int64

+ Description string

+ MaxValue *int64

+ MinValue *int64

+ func (i IntPropertySchema) MarshalJSON() ([]byte, error)

+ type KeyedPropertySchemaContainer interface

+ GetAdditionalPropertySchema func() PropertySchema

+ GetPropertySchemas func() map[string]PropertySchema

+ type ObjectPropertySchema struct

+ Additional PropertySchema

+ CustomPropertyValidator CustomObjectPropertyValidator

+ DefaultValue map[string]interface{}

+ Description string

+ PropertySchemas map[string]PropertySchema

+ RequiredProperties []string

+ func (o ObjectPropertySchema) GetAdditionalPropertySchema() PropertySchema

+ func (o ObjectPropertySchema) GetPropertySchemas() map[string]PropertySchema

+ func (o ObjectPropertySchema) MarshalJSON() ([]byte, error)

+ type Parameters struct

+ Data map[string]interface{}

+ Schema KeyedPropertySchemaContainer

+ func (p *Parameters) GetFloat64(key string) float64

+ func (p *Parameters) GetFloat64Array(key string) []float64

+ func (p *Parameters) GetInt64(key string) int64

+ func (p *Parameters) GetInt64Array(key string) []int64

+ func (p *Parameters) GetObject(key string) Parameters

+ func (p *Parameters) GetObjectArray(key string) []Parameters

+ func (p *Parameters) GetString(key string) string

+ func (p *Parameters) GetStringArray(key string) []string

+ func (p *Parameters) UnmarshalJSON(bytes []byte) error

+ func (p Parameters) MarshalJSON() ([]byte, error)

type Plan

+ GetSchemas func() PlanSchemas

+ GetStability func() Stability

type PlanProperties

+ Schemas PlanSchemas

+ Stability Stability

+ type PlanSchemas struct

+ ServiceBindings BindingSchemas

+ ServiceInstances InstanceSchemas

+ type PropertySchema interface

+ type SecureString string

+ func (s *SecureString) UnmarshalJSON(bytes []byte) error

+ func (s SecureString) MarshalJSON() ([]byte, error)

type Service

+ SetPlans func([]Plan)

type ServiceManager

+ GetEmptyBindingDetails func() BindingDetails

+ GetEmptyInstanceDetails func() InstanceDetails

+ type StringPropertySchema struct

+ AllowedPattern *regexp.Regexp

+ AllowedValues []string

+ CustomPropertyValidator CustomStringPropertyValidator

+ DefaultValue string

+ Description string

+ MaxLength *int

+ MinLength *int

+ func (s StringPropertySchema) MarshalJSON() ([]byte, error)

May 1, 2018

Changes in this version

+ type NumericParameterSchema struct

+ Default interface{}

+ Description string

+ ExclusiveMaximum bool

+ ExclusiveMinimum bool

+ Maximum interface{}

+ Minimum interface{}

+ Required bool

+ Type string

type Plan

+ IsEndOfLife func() bool

type PlanProperties

+ BindingParamsSchema map[string]ParameterSchema

+ EndOfLife bool

+ ProvisionParamsSchema map[string]ParameterSchema

+ UpdateParamsSchema map[string]ParameterSchema

type Service

+ GetProperties func() *ServiceProperties

+ IsEndOfLife func() bool

type ServiceProperties

+ EndOfLife bool

+ Extended map[string]interface{}

Apr 12, 2018

Changes in this version

+ const InstanceStateDeprovisioningDeferred

+ const InstanceStateProvisioningDeferred

+ const InstanceStateUpdatingFailed

+ func GetMapFromStruct(s interface{}) (map[string]interface{}, error)

+ func GetStructFromMap(m map[string]interface{}, s interface{}) error

+ type ArrayParameterSchema struct

+ Description string

+ ItemsSchema ParameterSchema

+ Required bool

+ func (a *ArrayParameterSchema) MarshalJSON() ([]byte, error)

type Binding

+ BindingParameters BindingParameters

+ Details BindingDetails

+ EncryptedSecureBindingParameters []byte

+ EncryptedSecureDetails []byte

+ SecureBindingParameters SecureBindingParameters

+ SecureDetails SecureBindingDetails

+ ServiceID string

+ type BindingDetails map[string]interface

+ type CatalogConfig struct

+ MinStability Stability

+ func GetCatalogConfigFromEnvironment() (CatalogConfig, error)

+ func NewCatalogConfigWithDefaults() CatalogConfig

+ type CombinedBindingParameters map[string]interface

+ type CombinedProvisioningParameters map[string]interface

type Instance

+ Alias string

+ Details InstanceDetails

+ EncryptedSecureDetails []byte

+ EncryptedSecureProvisioningParameters []byte

+ EncryptedSecureUpdatingParameters []byte

+ Location string

+ Parent *Instance

+ ParentAlias string

+ Plan Plan

+ ProvisioningParameters ProvisioningParameters

+ ResourceGroup string

+ SecureDetails SecureInstanceDetails

+ SecureProvisioningParameters SecureProvisioningParameters

+ SecureUpdatingParameters SecureProvisioningParameters

+ Service Service

+ Tags map[string]string

+ UpdatingParameters ProvisioningParameters

+ type InstanceDetails map[string]interface

+ type ObjectParameterSchema struct

+ Additional ParameterSchema

+ Description string

+ Properties map[string]ParameterSchema

+ Required bool

+ func (o *ObjectParameterSchema) MarshalJSON() ([]byte, error)

+ type ParameterSchema interface

type PlanProperties

+ Metadata *ServicePlanMetadata

+ type SecureBindingDetails map[string]interface

+ type SecureBindingParameters map[string]interface

+ type SecureInstanceDetails map[string]interface

+ type SecureProvisioningParameters map[string]interface

type Service

+ GetChildServiceID func() string

+ GetParentServiceID func() string

+ GetServiceManager func() ServiceManager

+ IsBindable func() bool

+ type ServiceManager interface

+ Bind func(Instance, BindingParameters, SecureBindingParameters) (BindingDetails, SecureBindingDetails, error)

+ GetCredentials func(Instance, Binding) (Credentials, error)

+ GetDeprovisioner func(Plan) (Deprovisioner, error)

+ GetProvisioner func(Plan) (Provisioner, error)

+ GetUpdater func(Plan) (Updater, error)

+ SplitBindingParameters func(CombinedBindingParameters) (BindingParameters, SecureBindingParameters, error)

+ SplitProvisioningParameters func(CombinedProvisioningParameters) (ProvisioningParameters, SecureProvisioningParameters, error)

+ Unbind func(Instance, Binding) error

+ ValidateBindingParameters func(BindingParameters, SecureBindingParameters) error

+ ValidateProvisioningParameters func(ProvisioningParameters, SecureProvisioningParameters) error

+ ValidateUpdatingParameters func(Instance) error

+ type ServiceMetadata struct

+ DisplayName string

+ DocumentationURL string

+ ImageURL string

+ LongDescription string

+ ProviderDisplayName string

+ SupportURL string

+ type ServicePlanMetadata struct

+ Bullets []string

+ DisplayName string

type ServiceProperties

+ BindingParamsSchema map[string]ParameterSchema

+ ChildServiceID string

+ Metadata *ServiceMetadata

+ ParentServiceID string

+ ProvisionParamsSchema map[string]ParameterSchema

+ UpdateParamsSchema map[string]ParameterSchema

+ type SimpleParameterSchema struct

+ AllowedValues interface{}

+ Default interface{}

+ Description string

+ Required bool

+ Type string

type Stability

+ const StabilityExperimental

+ const StabilityPreview

Nov 1, 2017

Changes in this version

+ const BindingStateBindingFailed

+ const BindingStateBound

+ const BindingStateUnbindingFailed

+ const InstanceStateDeprovisioning

+ const InstanceStateDeprovisioningFailed

+ const InstanceStateProvisioned

+ const InstanceStateProvisioning

+ const InstanceStateProvisioningFailed

+ const InstanceStateUpdated

+ const InstanceStateUpdating

+ type Binding struct

+ BindingID string

+ Created time.Time

+ EncryptedBindingContext []byte

+ EncryptedBindingParameters []byte

+ EncryptedCredentials []byte

+ InstanceID string

+ Status string

+ StatusReason string

+ func NewBindingFromJSON(jsonBytes []byte) (*Binding, error)

+ func (b *Binding) GetBindingContext(context BindingContext, codec crypto.Codec) error

+ func (b *Binding) GetBindingParameters(params BindingParameters, codec crypto.Codec) error

+ func (b *Binding) GetCredentials(credentials Credentials, codec crypto.Codec) error

+ func (b *Binding) SetBindingContext(context BindingContext, codec crypto.Codec) error

+ func (b *Binding) SetBindingParameters(params BindingParameters, codec crypto.Codec) error

+ func (b *Binding) SetCredentials(credentials Credentials, codec crypto.Codec) error

+ func (b *Binding) ToJSON() ([]byte, error)

+ type BindingContext interface

+ type BindingParameters interface

+ type Catalog interface

+ GetService func(serviceID string) (Service, bool)

+ GetServices func() []Service

+ ToJSON func() ([]byte, error)

+ func NewCatalog(services []Service) Catalog

+ func NewCatalogFromJSON(jsonBytes []byte) (Catalog, error)

+ type Credentials interface

+ type Deprovisioner interface

+ GetFirstStepName func() (string, bool)

+ GetNextStepName func(name string) (string, bool)

+ GetStep func(name string) (DeprovisioningStep, bool)

+ func NewDeprovisioner(steps ...DeprovisioningStep) (Deprovisioner, error)

+ type DeprovisioningStep interface

+ Execute func(ctx context.Context, instanceID string, serviceID string, planID string, ...) (ProvisioningContext, error)

+ GetName func() string

+ func NewDeprovisioningStep(name string, fn DeprovisioningStepFunction) DeprovisioningStep

+ type DeprovisioningStepFunction func(ctx context.Context, instanceID string, serviceID string, planID string, ...) (ProvisioningContext, error)

+ type Instance struct

+ Created time.Time

+ EncryptedProvisioningContext []byte

+ EncryptedProvisioningParameters []byte

+ EncryptedUpdatingParameters []byte

+ InstanceID string

+ PlanID string

+ ServiceID string

+ Status string

+ StatusReason string

+ func NewInstanceFromJSON(jsonBytes []byte) (*Instance, error)

+ func (i *Instance) GetProvisioningContext(context ProvisioningContext, codec crypto.Codec) error

+ func (i *Instance) GetProvisioningParameters(params ProvisioningParameters, codec crypto.Codec) error

+ func (i *Instance) GetUpdatingParameters(params UpdatingParameters, codec crypto.Codec) error

+ func (i *Instance) SetProvisioningContext(context ProvisioningContext, codec crypto.Codec) error

+ func (i *Instance) SetProvisioningParameters(params ProvisioningParameters, codec crypto.Codec) error

+ func (i *Instance) SetUpdatingParameters(params UpdatingParameters, codec crypto.Codec) error

+ func (i *Instance) ToJSON() ([]byte, error)

+ type Module interface

+ Bind func(ProvisioningContext, BindingParameters) (BindingContext, Credentials, error)

+ GetCatalog func() (Catalog, error)

+ GetDeprovisioner func(serviceID, planID string) (Deprovisioner, error)

+ GetEmptyBindingContext func() BindingContext

+ GetEmptyBindingParameters func() BindingParameters

+ GetEmptyCredentials func() Credentials

+ GetEmptyProvisioningContext func() ProvisioningContext

+ GetEmptyProvisioningParameters func() ProvisioningParameters

+ GetEmptyUpdatingParameters func() UpdatingParameters

+ GetName func() string

+ GetProvisioner func(serviceID, planID string) (Provisioner, error)

+ GetStability func() Stability

+ GetUpdater func(serviceID, planID string) (Updater, error)

+ Unbind func(ProvisioningContext, BindingContext) error

+ ValidateBindingParameters func(BindingParameters) error

+ ValidateProvisioningParameters func(ProvisioningParameters) error

+ ValidateUpdatingParameters func(UpdatingParameters) error

+ type Plan interface

+ GetID func() string

+ GetName func() string

+ GetProperties func() *PlanProperties

+ ToJSON func() ([]byte, error)

+ func NewPlan(planProperties *PlanProperties) Plan

+ func NewPlanFromJSON(jsonBytes []byte) (Plan, error)

+ type PlanProperties struct

+ Description string

+ Extended map[string]interface{}

+ Free bool

+ ID string

+ Name string

+ type Provisioner interface

+ GetFirstStepName func() (string, bool)

+ GetNextStepName func(name string) (string, bool)

+ GetStep func(name string) (ProvisioningStep, bool)

+ func NewProvisioner(steps ...ProvisioningStep) (Provisioner, error)

+ type ProvisioningContext interface

+ type ProvisioningParameters interface

+ SetResourceGroup func(string)

+ type ProvisioningStep interface

+ Execute func(ctx context.Context, instanceID string, serviceID string, planID string, ...) (ProvisioningContext, error)

+ GetName func() string

+ func NewProvisioningStep(name string, fn ProvisioningStepFunction) ProvisioningStep

+ type ProvisioningStepFunction func(ctx context.Context, instanceID string, serviceID string, planID string, ...) (ProvisioningContext, error)

+ type Service interface

+ GetID func() string

+ GetName func() string

+ GetPlan func(planID string) (Plan, bool)

+ GetPlans func() []Plan

+ ToJSON func() ([]byte, error)

+ func NewService(serviceProperties *ServiceProperties, plans ...Plan) Service

+ func NewServiceFromJSON(jsonBytes []byte) (Service, error)

+ type ServiceProperties struct

+ Bindable bool

+ Description string

+ ID string

+ Name string

+ PlanUpdatable bool

+ Tags []string

+ type Stability int

+ const StabilityAlpha

+ const StabilityBeta

+ const StabilityStable

+ type Updater interface

+ GetFirstStepName func() (string, bool)

+ GetNextStepName func(name string) (string, bool)

+ GetStep func(name string) (UpdatingStep, bool)

+ func NewUpdater(steps ...UpdatingStep) (Updater, error)

+ type UpdatingParameters interface

+ type UpdatingStep interface

+ Execute func(ctx context.Context, instanceID string, serviceID string, planID string, ...) (ProvisioningContext, error)

+ GetName func() string

+ func NewUpdatingStep(name string, fn UpdatingStepFunction) UpdatingStep

+ type UpdatingStepFunction func(ctx context.Context, instanceID string, serviceID string, planID string, ...) (ProvisioningContext, error)

+ type ValidationError struct

+ Field string

+ Issue string

+ func NewValidationError(field, issue string) *ValidationError

+ func (e *ValidationError) Error() string