models

Documentation

Index

• type APIKey
• type AccessGroup
• type AccessGroupMember
• type AccessGroupMemberV2
• type AccessGroupV2
• type CertificateDelete
• type CertificateGetData
• type CertificateImportData
• type CertificateInfo
• type CertificateIssuanceInfo
• type CertificateMetadataUpdate
• type CertificateOrderData
• type CertificateReimportData
• type CertificateRenewData
• type Customer
• type Data
• type Deployment
• type DeploymentMetaData
• type Geolocation
• type LastOperationType
• type Linkage
• type MetadataDeploymentFragment
• type MetadataServiceFragment
• type MetadataType
• type PlatformServiceResourceMetadata
• type Policy
• type PolicyResource
• type PolicyRole
• type QuotaDefinition
• type Region
• type ResourceGroup
• type ResourceGroupv2
• type ResourceOrigin
  • func (o ResourceOrigin) String() string
• type Role
  • func (r Role) ToPolicyRole() PolicyRole
• type RoleAction
• type RuntimeResourceMetadata
• type Service
  • func (s *Service) UnmarshalJSON(data []byte) error
• type ServiceAlias
  • func (a ServiceAlias) ScopeSpaceID() string
• type ServiceBinding
• type ServiceDeployment
• type ServiceDeploymentAlias
• type ServiceID
• type ServiceInstance
• type ServiceKey
• type ServiceMetadata
• type ServicePlan
• type ServiceQuota
• type ServiceResourceMetadata
• type TemplateResourceMetadata

Types

type APIKey

type APIKey struct {
	UUID       string `json:"uuid,omitempty"`
	Version    string `json:"version,omitempty"`
	Crn        string `json:"crn,omitempty"`
	CreatedAt  string `json:"createdAt,omitempty"`
	ModifiedAt string `json:"modifiedAt,omitempty"`

	Name         string `json:"name,omitempty"`
	Description  string `json:"description,omitempty"`
	Format       string `json:"format,omitempty"`
	BoundTo      string `json:"boundTo,omitempty"`
	APIKey       string `json:"apiKey,omitempty"`
	APIKeyID     string `json:"apiKeyId,omitempty"`
	APIKeySecret string `json:"apiKeySecret,omitempty"`
	Locked       bool   `json:"locked,omitempty"`
}

type AccessGroup

type AccessGroup struct {
	ID          string `json:"id,omitempty"`
	Name        string `json:"name,omitempty"`
	Description string `json:"description,omitempty"`
}

AccessGroup represents the access group of IAM UUM

type AccessGroupMember

type AccessGroupMember struct {
	ID   string `json:"id"`
	Type string `json:"type"`
}

type AccessGroupMemberV2

type AccessGroupMemberV2 struct {
	ID          string `json:"iam_id,omitempty"`
	Type        string `json:"type,omitempty"`
	Href        string `json:"href,omitempty"`
	Name        string `json:"name,omitempty"`
	Email       string `json:"email,omitempty"`
	CreatedAt   string `json:"created_at,omitempty"`
	CreatedByID string `json:"created_by_id,omitempty"`
}

type AccessGroupV2

type AccessGroupV2 struct {
	AccessGroup
	AccountID        string `json:"account_id,omitempty"`
	CreatedAt        string `json:"created_at,omitempty"`
	CreatedByID      string `json:"created_by_id,omitempty"`
	LastModifiedAt   string `json:"last_modified_at,omitempty"`
	LastModifiedByID string `json:"last_modified_by_id,omitempty"`
}

type CertificateDelete

type CertificateDelete struct {
	Message string
}

CertificateDelete struct for cert-delete success response.

type CertificateGetData

type CertificateGetData struct {
	ID           string                  `json:"_id"`
	Name         string                  `json:"name"`
	Description  string                  `json:"description"`
	Domains      []string                `json:"domains"`
	Status       string                  `json:"status"`
	Issuer       string                  `json:"issuer"`
	BeginsOn     int64                   `json:"begins_on"`
	ExpiresOn    int64                   `json:"expires_on"`
	Algorithm    string                  `json:"algorithm"`
	KeyAlgorithm string                  `json:"key_algorithm"`
	Imported     bool                    `json:"imported"`
	HasPrevious  bool                    `json:"has_previous"`
	IssuanceInfo CertificateIssuanceInfo `json:"issuance_info"`
	Data         *Data                   `json:"data"`
	DataKeyID    string                  `json:"data_key_id"`
}

CertificateGetData ...

type CertificateImportData

type CertificateImportData struct {
	Name        string `json:"name"`
	Description string `json:"description"`
	Data        Data   `json:"data"`
}

CertificateImportData struct for holding user-provided certificates and keys for cert-import.

type CertificateInfo

type CertificateInfo struct {
	ID           string                   `json:"_id"`
	Name         string                   `json:"name"`
	Description  string                   `json:"description"`
	Domains      []string                 `json:"domains"`
	RotateKeys   bool                     `json:"rotate_keys"`
	Status       string                   `json:"status"`
	Issuer       string                   `json:"issuer"`
	BeginsOn     int64                    `json:"begins_on"`
	ExpiresOn    int64                    `json:"expires_on"`
	Algorithm    string                   `json:"algorithm"`
	KeyAlgorithm string                   `json:"key_algorithm"`
	Imported     bool                     `json:"imported"`
	HasPrevious  bool                     `json:"has_previous"`
	IssuanceInfo *CertificateIssuanceInfo `json:"issuance_info"`
}

CertificateInfo struct for cert-import & cert-reimport success response.

type CertificateIssuanceInfo

type CertificateIssuanceInfo struct {
	Status         string `json:"status"`
	Code           string `json:"code"`
	AdditionalInfo string `json:"additional_info"`
	Auto           bool   `json:"auto"`
	OrderedOn      int64  `json:"ordered_on"`
}

CertificateIssuanceInfo struct

type CertificateMetadataUpdate

type CertificateMetadataUpdate struct {
	Name        string `json:"name,omitempty"`
	Description string `json:"description,omitempty"`
}

CertificateMetadataUpdate struct for cert-metadata-update's request body.

type CertificateOrderData

type CertificateOrderData struct {
	Name                   string   `json:"name"`
	Description            string   `json:"description,omitempty"`
	Domains                []string `json:"domains"`
	DomainValidationMethod string   `json:"domain_validation_method"`
	DNSProviderInstanceCrn string   `json:"dns_provider_instance_crn,omitempty"`
	Issuer                 string   `json:"issuer,omitempty"`
	Algorithm              string   `json:"algorithm,omitempty"`
	KeyAlgorithm           string   `json:"key_algorithm,omitempty"`
	AutoRenewEnabled       bool     `json:"auto_renew_enabled,omitempty"`
}

CertificateOrderData struct for holding user-provided order data for cert-order.

type CertificateReimportData

type CertificateReimportData struct {
	Content                 string `json:"content"`
	Privatekey              string `json:"priv_key,omitempty"`
	IntermediateCertificate string `json:"intermediate,omitempty"`
}

CertificateReimportData struct for holding user-provided certificates and keys for cert-reimport.

type CertificateRenewData

type CertificateRenewData struct {
	RotateKeys bool `json:"rotate_keys"`
}

CertificateRenewData struct for holding user-provided renew data for cert-renew.

type Customer

type Customer struct {
	Name        string
	DisplayName string `json:"display_name"`
}

type Data

type Data struct {
	Content                 string `json:"content"`
	Privatekey              string `json:"priv_key,omitempty"`
	IntermediateCertificate string `json:"intermediate,omitempty"`
}

Data of Imported Certificate

type Deployment

type Deployment struct {
	Name        string
	DisplayName string `json:"display_name"`
}

type DeploymentMetaData

type DeploymentMetaData struct {
	RCCompatible  bool                       `json:"rc_compatible"`
	IAMCompatible bool                       `json:"iam_compatible"`
	Deployment    MetadataDeploymentFragment `json:"deployment,omitempty"`
	Service       MetadataServiceFragment    `json:"service,omitempty"`
}

type Geolocation

type Geolocation struct {
	Name        string
	DisplayName string `json:"display_name"`
}

type LastOperationType

type LastOperationType struct {
	Type        string     `json:"type"`
	State       string     `json:"state"`
	Description *string    `json:"description"`
	UpdatedAt   *time.Time `json:"updated_at"`
}

type Linkage

type Linkage struct {
	ResourceID     string         `json:"resource_id"`
	ResourceOrigin ResourceOrigin `json:"resource_origin"`
}

type MetadataDeploymentFragment

type MetadataDeploymentFragment struct {
	DeploymentID string  `json:"deployment_id,omitempty"`
	TargetCrn    crn.CRN `json:"target_crn"`
	Location     string  `json:"location"`
}

type MetadataServiceFragment

type MetadataServiceFragment struct {
	Bindable            bool   `json:"bindable"`
	IAMCompatible       bool   `json:"iam_compatible"`
	RCProvisionable     bool   `json:"rc_provisionable"`
	PlanUpdateable      bool   `json:"plan_updateable"`
	ServiceCheckEnabled bool   `json:"service_check_enabled"`
	ServiceKeySupported bool   `json:"service_key_supported"`
	State               string `json:"state"`
	TestCheckInterval   int    `json:"test_check_interval"`
	UniqueAPIKey        bool   `json:"unique_api_key"`

	// CF properties
	ServiceBrokerGUID string `json:"service_broker_guid"`
}

type MetadataType

type MetadataType struct {
	ID        string     `json:"id"`
	Guid      string     `json:"guid"`
	Url       string     `json:"url"`
	CreatedAt *time.Time `json:"created_at"`
	UpdatedAt *time.Time `json:"updated_at"`
	DeletedAt *time.Time `json:"deleted_at"`
}

type PlatformServiceResourceMetadata

type PlatformServiceResourceMetadata struct {
}

type Policy

type Policy struct {
	ID        string           `json:"id,omitempty"`
	Roles     []PolicyRole     `json:"roles"`
	Resources []PolicyResource `json:"resources"`
	Version   string           `json:"-"`
}

type PolicyResource

type PolicyResource struct {
	ServiceName     string `json:"serviceName,omitempty"`
	ServiceInstance string `json:"serviceInstance,omitempty"`
	Region          string `json:"region,omitempty"`
	ResourceType    string `json:"resourceType,omitempty"`
	Resource        string `json:"resource,omitempty"`
	SpaceID         string `json:"spaceId,omitempty"`
	AccountID       string `json:"accountId,omitempty"`
	OrganizationID  string `json:"organizationId,omitempty"`
	ResourceGroupID string `json:"resourceGroupId,omitempty"`
	AccessGroupID   string `json:"accessGroupId,omitempty"`
}

type PolicyRole

type PolicyRole struct {
	ID          crn.CRN      `json:"id"`
	DisplayName string       `json:"displayName"`
	Description string       `json:"description"`
	Actions     []RoleAction `json:"actions,omitempty"`
}

type QuotaDefinition

type QuotaDefinition struct {
	ID                        string         `json:"_id,omitempty"`
	Revision                  string         `json:"_rev,omitempty"`
	Name                      string         `json:"name,omitmempty"`
	Type                      string         `json:"type,omitempty"`
	ServiceInstanceCountLimit int            `json:"number_of_service_instances,omitempty"`
	AppCountLimit             int            `json:"number_of_apps,omitempty"`
	AppInstanceCountLimit     int            `json:"instances_per_app,omitempty"`
	AppInstanceMemoryLimit    string         `json:"instance_memory,omitempty"`
	TotalAppMemoryLimit       string         `json:"total_app_memory,omitempty"`
	VSICountLimit             int            `json:"vsi_limit,omitempty"`
	ServiceQuotas             []ServiceQuota `json:"service_quotas,omitempty"`
	CreatedAt                 string         `json:"created_at,omitempty"`
	UpdatedAt                 string         `json:"updated_at,omitempty"`
}

type Region

type Region struct {
	ID              string `json:"id"`
	Name            string `json:"name"`
	DisplayName     string `json:"display_name"`
	Domain          string `json:"domain"`
	APIEndpoint     string `json:"cf_api"`
	ConsoleEndpoint string `json:"console_url"`
	MCCPEndpoint    string `json:"mccp_api"`
	Type            string `json:"type"`
	Geolocation     `json:"geo"`
	Customer        `json:"customer"`
	Deployment      `json:"deployment"`
	IsHome          bool `json:"home"`
}

type ResourceGroup

type ResourceGroup struct {
	ID              string    `json:"id,omitempty"`
	AccountID       string    `json:"account_id,omitempty"`
	Name            string    `json:"name,omitempty"`
	Default         bool      `json:"default,omitempty"`
	State           string    `json:"state,omitempty"`
	QuotaID         string    `json:"quota_id,omitempty"`
	PaymentMethodID string    `json:"payment_method_id,omitempty"`
	Linkages        []Linkage `json:"resource_linkages,omitempty"`
	CreatedAt       string    `json:"created_at,omitempty"`
	UpdatedAt       string    `json:"updated_at,omitempty"`
}

type ResourceGroupv2

type ResourceGroupv2 struct {
	ResourceGroup
	CRN               string `json:"crn,omitempty"`
	QuotaURL          string `json:"quota_url,omitempty"`
	PaymentMethodsUrl string `json:"payment_methods_url,omitempty"`
	TeamsURL          string `json:"teams_url,omitempty"`
}

type ResourceOrigin

type ResourceOrigin string

func (ResourceOrigin) String

func (o ResourceOrigin) String() string

type Role

type Role struct {
	CRN         crn.CRN `json:"crn"`
	Name        string  `json:"displayName"`
	Description string  `json:"description"`
}

func (Role) ToPolicyRole

func (r Role) ToPolicyRole() PolicyRole

type RoleAction

type RoleAction struct {
	ID          string `json:"id"`
	Name        string `json:"displayName"`
	Description string `json:"description"`
}

type RuntimeResourceMetadata

type RuntimeResourceMetadata struct {
}

type Service

type Service struct {
	ID         string `json:"id"`
	Name       string `json:"name"`
	CatalogCRN string `json:"catalog_crn"`
	URL        string `json:"url"`
	Kind       string `json:"kind"`

	Metadata ServiceMetadata `json:"-"`
	Children []Service       `json:"children"`
	Active   bool            `json:"active"`
}

func (*Service) UnmarshalJSON

func (s *Service) UnmarshalJSON(data []byte) error

UnmarshalJSON provide custom JSON unmarshal behavior to support multiple types of `metadata`

type ServiceAlias

type ServiceAlias struct {
	ID                string                 `json:"id"`
	Name              string                 `json:"name"`
	ServiceInstanceID string                 `json:"resource_instance_id"`
	ScopeCRN          crn.CRN                `json:"scope_crn"`
	CRN               crn.CRN                `json:"crn"`
	Tags              []string               `json:"tags,omitempty"`
	Parameters        map[string]interface{} `json:"parameters,omitempty"` // TODO: check whether the response contains the field
	State             string                 `json:"state"`
}

func (ServiceAlias) ScopeSpaceID

func (a ServiceAlias) ScopeSpaceID() string

type ServiceBinding

type ServiceBinding struct {
	*MetadataType
	SourceCrn         crn.CRN                `json:"source_crn"`
	TargetCrn         crn.CRN                `json:"target_crn"`
	Parameters        map[string]interface{} `json:"parameters,omitempty"`
	Crn               crn.CRN                `json:"crn"`
	RegionBindingID   string                 `json:"region_binding_id"`
	AccountID         string                 `json:"account_id"`
	State             string                 `json:"state"`
	Credentials       map[string]interface{} `json:"credentials"`
	ServiceAliasesUrl string                 `json:"resource_aliases_url"`
	TargetName        string
}

type ServiceDeployment

type ServiceDeployment struct {
	ID         string             `json:"id"`
	Name       string             `json:"name"`
	CatalogCRN string             `json:"catalog_crn"`
	Metadata   DeploymentMetaData `json:"metadata,omitempty"`
}

type ServiceDeploymentAlias

type ServiceDeploymentAlias struct {
	Metadata DeploymentMetaData `json:"metadata,omitempty"`
}

type ServiceID

type ServiceID struct {
	UUID        string `json:"uuid,omitempty"`
	IAMID       string `json:"iam_id,omitempty"`
	CRN         string `json:"crn,omitempty"`
	Version     string `json:"version,omitempty"`
	BoundTo     string `json:"boundTo,omitempty"`
	Name        string `json:"name,omitempty"`
	Description string `json:"description,omitempty"`
	CreatedAt   string `json:"createdAt,omitempty"`
	ModifiedAt  string `json:"modifiedAt,omitempty"`
	Locked      bool   `json:"locked,omitempty"`
}

type ServiceInstance

type ServiceInstance struct {
	*MetadataType
	Name                string `json:"name"`
	RegionID            string `json:"region_id"`
	AccountID           string `json:"account_id"`
	ServicePlanID       string `json:"resource_plan_id"`
	ServicePlanName     string
	ResourceGroupID     string `json:"resource_group_id"`
	ResourceGroupName   string
	Crn                 crn.CRN                `json:"crn,omitempty"`
	Tags                []string               `json:"tags,omitempty"`
	Parameters          map[string]interface{} `json:"parameters,omitempty"`
	CreateTime          int64                  `json:"create_time"`
	State               string                 `json:"state"`
	Type                string                 `json:"type"`
	ServiceID           string                 `json:"resource_id"`
	ServiceName         string
	DashboardUrl        *string            `json:"dashboard_url"`
	LastOperation       *LastOperationType `json:"last_operation"`
	AccountUrl          string             `json:"account_url"`
	ResourcePlanUrl     string             `json:"resource_plan_url"`
	ResourceBindingsUrl string             `json:"resource_bindings_url"`
	ResourceAliasesUrl  string             `json:"resource_aliases_url"`
	SiblingsUrl         string             `json:"siblings_url"`
	TargetCrn           crn.CRN            `json:"target_crn"`
}

type ServiceKey

type ServiceKey struct {
	MetadataType
	Name        string                 `json:"name"`
	SourceCrn   crn.CRN                `json:"source_crn"`
	Parameters  map[string]interface{} `json:"parameters,omitempty"`
	Crn         crn.CRN                `json:"crn"`
	State       string                 `json:"state"`
	AccountID   string                 `json:"account_id"`
	Credentials map[string]interface{} `json:"credentials"`
	Role        crn.CRN                `json:"role"`
}

type ServiceMetadata

type ServiceMetadata interface{}

type ServicePlan

type ServicePlan struct {
	ID         string `json:"id"`
	Name       string `json:"name"`
	CatalogCRN string `json:"catalog_crn"`
	URL        string `json:"url"`
	Kind       string `json:"kind"`
}

type ServiceQuota

type ServiceQuota struct {
	ID        string `json:"_id,omitempty"`
	ServiceID string `json:"service_id,omitempty"`
	Limit     int    `json:"limit,omitempty"`
}

type ServiceResourceMetadata

type ServiceResourceMetadata struct {
	Service MetadataServiceFragment `json:"service"`
}

type TemplateResourceMetadata

type TemplateResourceMetadata struct {
}