types

package
v0.0.0-...-0a771b7 Latest Latest
Warning

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

 Go to latest Published: May 17, 2024 License: Apache-2.0 Imports: 5 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	// ServiceBindingsType represents the type of the ServiceBindings struct; used primarily for logging purposes
	ServiceBindingsType = "service bindings"
	// ServiceBindingType represents the type of the ServiceBinding struct; used primarily for logging purposes
	ServiceBindingType = "service binding"
)
View Source 
const (
	// ServiceInstancesType represents the type of the ServiceInstances struct; used primarily for logging purposes
	ServiceInstancesType = "service instances"
	// ServiceInstanceType represents the type of the ServiceInstance struct; used primarily for logging purposes
	ServiceInstanceType = "service instance"
)
View Source 
const (
	// ServiceOfferingsType represents the type of the ServiceOfferings struct; used primarily for logging purposes
	ServiceOfferingsType = "service offerings"
	// ServiceOfferingType represents the type of the ServiceOffering struct; used primarily for logging purposes
	ServiceOfferingType = "service offering"
)
View Source 
const (
	// ServicePlansType represents the type of the ServicePlans struct; used primarily for logging purposes
	ServicePlansType = "service plans"
	// ServicePlanType represents the type of the ServicePlan struct; used primarily for logging purposes
	ServicePlanType = "service plan"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type OperationState 

type OperationState string

OperationState represents the state of an Operation 

const (
	// OperationStateSucceeded represents a successful operation
	OperationStateSucceeded OperationState = "succeeded"
	// OperationStateInProgress represents a operation that is in progress
	OperationStateInProgress OperationState = "in progress"
	// OperationStateFailed represents a operation that is failed
	OperationStateFailed OperationState = "failed"
)

type OperationStatus 

type OperationStatus struct {
	ID                  string               `json:"id"`
	Ready               bool                 `json:"ready"`
	Type                string               `json:"type"`
	State               OperationState       `json:"state"`
	ResourceID          string               `json:"resource_id"`
	ResourceType        string               `json:"resource_type"`
	PlatformId          string               `json:"platform_id"`
	CorrelationID       string               `json:"correlation_id"`
	Reschedule          bool                 `json:"reschedule"`
	RescheduleTimestamp time.Time            `json:"reschedule_timestamp"`
	DeletionScheduled   time.Time            `json:"deletion_scheduled"`
	CreatedAt           time.Time            `json:"created_at"`
	UpdatedAt           time.Time            `json:"updated_at"`
	Errors              OperationStatusError `json:"errors"`
}

OperationStatus holds info about the operation when a call is asynchronous

type OperationStatusError 

type OperationStatusError struct {
	Error       string `json:"error"`
	Description string `json:"description"`
}

OperationStatusError holds info about the operation error when a call is asynchronous

type ServiceBinding 

type ServiceBinding struct {
	ID                string          `json:"id"`
	Name              string          `json:"name"`
	ServiceInstanceID string          `json:"service_instance_id"`
	Credentials       json.RawMessage `json:"credentials"`
}

ServiceBinding represents a Service Binding

func (*ServiceBinding) GetResourceID 

func (s *ServiceBinding) GetResourceID() string

GetResourceID gets the ServiceBinding ID

func (*ServiceBinding) GetResourceName 

func (s *ServiceBinding) GetResourceName() string

GetResourceName gets the ServiceBinding Name

func (*ServiceBinding) GetResourceType 

func (s *ServiceBinding) GetResourceType() string

GetResourceType gets the return type of the ServiceBinding

func (*ServiceBinding) GetResourceURLPath 

func (s *ServiceBinding) GetResourceURLPath() string

GetResourceURLPath gets the ServiceBinding URL Path

type ServiceBindingMatchParameters 

type ServiceBindingMatchParameters struct {
	ServiceInstancesIDs []string
}

ServiceBindingMatchParameters holds all the necessary fields that are used when matching ServiceBindings

func (*ServiceBindingMatchParameters) Match 

func (sbp *ServiceBindingMatchParameters) Match(resources resources.Resources) (string, error)

Match matches a ServiceBinding based on some criteria

func (*ServiceBindingMatchParameters) MatchMultiple 

func (sbp *ServiceBindingMatchParameters) MatchMultiple(resources resources.Resources) ([]string, error)

MatchMultiple matches several ServiceBindings based on some criteria

type ServiceBindingReqBody 

type ServiceBindingReqBody struct {
	Name             string          `json:"name"`
	ServiceBindingID string          `json:"service_instance_id"`
	Parameters       json.RawMessage `json:"parameters,omitempty"`
}

ServiceBindingReqBody is the request body when a Service Bjd] dj g is being created

func (*ServiceBindingReqBody) GetResourceName 

func (rb *ServiceBindingReqBody) GetResourceName() string

GetResourceName gets the ServiceBinding name from the request body

type ServiceBindings 

type ServiceBindings struct {
	NumItems int               `json:"num_items"`
	Items    []*ServiceBinding `json:"items"`
}

ServiceBindings represents a collection of Service Binding

func (*ServiceBindings) GetIDs 

func (sbs *ServiceBindings) GetIDs() []string

GetIDs gets the IDs of all ServiceBindings

func (*ServiceBindings) GetType 

func (sbs *ServiceBindings) GetType() string

GetType gets the type of the ServiceBindings

func (*ServiceBindings) GetURLPath 

func (sbs *ServiceBindings) GetURLPath() string

GetURLPath gets the URL Path of the ServiceBinding

type ServiceInstance 

type ServiceInstance struct {
	ID            string `json:"id"`
	Name          string `json:"name"`
	ServicePlanID string `json:"service_plan_id"`
	PlatformID    string `json:"platform_id"`
}

ServiceInstance represents a Service Instance

func (*ServiceInstance) GetResourceID 

func (s *ServiceInstance) GetResourceID() string

GetResourceID gets the ServiceInstance ID

func (*ServiceInstance) GetResourceName 

func (s *ServiceInstance) GetResourceName() string

GetResourceName gets the Service

func (*ServiceInstance) GetResourceType 

func (s *ServiceInstance) GetResourceType() string

GetResourceType gets the return type of the ServiceInstance

func (*ServiceInstance) GetResourceURLPath 

func (s *ServiceInstance) GetResourceURLPath() string

GetResourceURLPath gets the ServiceInstance URL Path

type ServiceInstanceMatchParameters 

type ServiceInstanceMatchParameters struct {
	ServiceInstanceName string
}

ServiceInstanceMatchParameters holds all the necessary fields that are used when matching ServiceInstances

func (*ServiceInstanceMatchParameters) Match 

func (sip *ServiceInstanceMatchParameters) Match(resources resources.Resources) (string, error)

Match matches a ServiceInstance based on some criteria

func (*ServiceInstanceMatchParameters) MatchMultiple 

func (sip *ServiceInstanceMatchParameters) MatchMultiple(resources resources.Resources) ([]string, error)

MatchMultiple matches several ServiceInstances based on some criteria

type ServiceInstanceReqBody 

type ServiceInstanceReqBody struct {
	Name          string              `json:"name"`
	ServicePlanID string              `json:"service_plan_id"`
	Parameters    json.RawMessage     `json:"parameters,omitempty"`
	Labels        map[string][]string `json:"labels,omitempty"`
}

ServiceInstanceReqBody is the request body when a Service Instance is being created

func (*ServiceInstanceReqBody) GetResourceName 

func (rb *ServiceInstanceReqBody) GetResourceName() string

GetResourceName gets the ServiceInstance name from the request body

type ServiceInstances 

type ServiceInstances struct {
	NumItems int                `json:"num_items"`
	Items    []*ServiceInstance `json:"items"`
}

ServiceInstances represents a collection of Service Instance

func (*ServiceInstances) GetIDs 

func (sis *ServiceInstances) GetIDs() []string

GetIDs gets the IDs of all ServiceInstances

func (*ServiceInstances) GetType 

func (si *ServiceInstances) GetType() string

GetType gets the type of the ServiceInstances

func (*ServiceInstances) GetURLPath 

func (si *ServiceInstances) GetURLPath() string

GetURLPath gets the URL Path of the ServiceInstance

type ServiceOffering 

type ServiceOffering struct {
	ID          string `json:"id"`
	Name        string `json:"name"`
	Description string `json:"description"`
	BrokerId    string `json:"broker_id"`
	CatalogId   string `json:"catalog_id"`
	CatalogName string `json:"catalog_name"`
}

ServiceOffering represents a Service Offering

func (*ServiceOffering) GetResourceID 

func (s *ServiceOffering) GetResourceID() string

GetResourceID gets the ServiceOffering ID

func (*ServiceOffering) GetResourceName 

func (s *ServiceOffering) GetResourceName() string

GetResourceName gets the ServiceOffering Name

func (*ServiceOffering) GetResourceType 

func (s *ServiceOffering) GetResourceType() string

GetResourceType gets the return type of the ServiceOffering

func (*ServiceOffering) GetResourceURLPath 

func (s *ServiceOffering) GetResourceURLPath() string

GetResourceURLPath gets the ServiceOffering URL Path

type ServiceOfferingMatchParameters 

type ServiceOfferingMatchParameters struct {
	CatalogName string
}

ServiceOfferingMatchParameters holds all the necessary fields that are used when matching ServiceOfferings

func (*ServiceOfferingMatchParameters) Match 

func (sp *ServiceOfferingMatchParameters) Match(resources resources.Resources) (string, error)

Match matches a ServiceOffering based on some criteria

func (*ServiceOfferingMatchParameters) MatchMultiple 

func (sp *ServiceOfferingMatchParameters) MatchMultiple(resources resources.Resources) ([]string, error)

MatchMultiple matches several ServiceOfferings based on some criteria

type ServiceOfferings 

type ServiceOfferings struct {
	NumItems int                `json:"num_items"`
	Items    []*ServiceOffering `json:"items"`
}

ServiceOfferings represents a collection of Service Offering

func (*ServiceOfferings) GetIDs 

func (sos *ServiceOfferings) GetIDs() []string

GetIDs gets the IDs of all ServiceOfferings

func (*ServiceOfferings) GetType 

func (so *ServiceOfferings) GetType() string

GetType gets the type of the ServiceOfferings

func (*ServiceOfferings) GetURLPath 

func (so *ServiceOfferings) GetURLPath() string

type ServicePlan 

type ServicePlan struct {
	ID                string `json:"id"`
	Name              string `json:"name"`
	Description       string `json:"description"`
	CatalogId         string `json:"catalog_id"`
	CatalogName       string `json:"catalog_name"`
	ServiceOfferingId string `json:"service_offering_id"`
}

ServicePlan represents a Service Plan

func (*ServicePlan) GetResourceID 

func (s *ServicePlan) GetResourceID() string

GetResourceID gets the ServicePlan ID

func (*ServicePlan) GetResourceName 

func (s *ServicePlan) GetResourceName() string

GetResourceName gets the ServicePlan Name

func (*ServicePlan) GetResourceType 

func (s *ServicePlan) GetResourceType() string

GetResourceType gets the return type of the ServicePlan

func (*ServicePlan) GetResourceURLPath 

func (s *ServicePlan) GetResourceURLPath() string

GetResourceURLPath gets the ServicePlan URL Path

type ServicePlanMatchParameters 

type ServicePlanMatchParameters struct {
	PlanName   string
	OfferingID string
}

ServicePlanMatchParameters holds all the necessary fields that are used when matching ServicePlans

func (*ServicePlanMatchParameters) Match 

func (spp *ServicePlanMatchParameters) Match(resources resources.Resources) (string, error)

Match matches a ServicePlan based on some criteria

func (*ServicePlanMatchParameters) MatchMultiple 

func (spp *ServicePlanMatchParameters) MatchMultiple(resources resources.Resources) ([]string, error)

MatchMultiple matches several ServicePlans based on some criteria

type ServicePlans 

type ServicePlans struct {
	NumItems int            `json:"num_items"`
	Items    []*ServicePlan `json:"items"`
}

ServicePlans represents a collection of Service Plan

func (*ServicePlans) GetIDs 

func (sps *ServicePlans) GetIDs() []string

GetIDs gets the IDs of all ServicePlans

func (*ServicePlans) GetType 

func (sp *ServicePlans) GetType() string

GetType gets the type of the ServicePlans

func (*ServicePlans) GetURLPath 

func (sp *ServicePlans) GetURLPath() string

GetURLPath gets the URL Path of the ServicePlan

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.