payloads

package
v0.12.0 Latest Latest
Warning

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

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

Documentation

Index

Constants

View Source 
const (
	RoleAdmin                      = "admin"
	RoleAdminReadOnly              = "admin_read_only"
	RoleGlobalAuditor              = "global_auditor"
	RoleOrganizationAuditor        = "organization_auditor"
	RoleOrganizationBillingManager = "organization_billing_manager"
	RoleOrganizationManager        = "organization_manager"
	RoleOrganizationUser           = "organization_user"
	RoleSpaceAuditor               = "space_auditor"
	RoleSpaceDeveloper             = "space_developer"
	RoleSpaceManager               = "space_manager"
	RoleSpaceSupporter             = "space_supporter"
)

Variables

View Source 
var DefaultLifecycleConfig = config.DefaultLifecycleConfig{
	Type:            "buildpack",
	Stack:           "cflinuxfs3",
	StagingMemoryMB: 1024,
}

DefaultLifecycleConfig is overwritten by main.go

Functions

This section is empty.

Types

type AppCreate 

type AppCreate struct {
	Name                 string            `json:"name"`
	EnvironmentVariables map[string]string `json:"environment_variables"`
	Relationships        *AppRelationships `json:"relationships"`
	Lifecycle            *Lifecycle        `json:"lifecycle"`
	Metadata             Metadata          `json:"metadata"`
}

func (AppCreate) ToAppCreateMessage 

func (p AppCreate) ToAppCreateMessage() repositories.CreateAppMessage

func (AppCreate) Validate added in v0.8.0 

func (c AppCreate) Validate() error

type AppList 

type AppList struct {
	Names         string
	GUIDs         string
	SpaceGuids    string
	OrderBy       string
	LabelSelector string
}

func (*AppList) DecodeFromURLValues added in v0.6.0 

func (a *AppList) DecodeFromURLValues(values url.Values) error

func (*AppList) SupportedKeys added in v0.2.0 

func (a *AppList) SupportedKeys() []string

func (*AppList) ToMessage 

func (a *AppList) ToMessage() repositories.ListAppsMessage

func (AppList) Validate added in v0.8.0 

func (a AppList) Validate() error

type AppPatch added in v0.3.0 

type AppPatch struct {
	Name      string          `json:"name"`
	Metadata  MetadataPatch   `json:"metadata"`
	Lifecycle *LifecyclePatch `json:"lifecycle"`
}

func (*AppPatch) ToMessage added in v0.3.0 

func (a *AppPatch) ToMessage(appGUID, spaceGUID string) repositories.PatchAppMessage

func (AppPatch) Validate added in v0.8.0 

func (p AppPatch) Validate() error

type AppPatchEnvVars 

type AppPatchEnvVars struct {
	Var map[string]interface{} `json:"var"`
}

func (*AppPatchEnvVars) ToMessage 

func (a *AppPatchEnvVars) ToMessage(appGUID, spaceGUID string) repositories.PatchAppEnvVarsMessage

func (AppPatchEnvVars) Validate added in v0.8.0 

func (p AppPatchEnvVars) Validate() error

type AppRelationships 

type AppRelationships struct {
	Space *Relationship `json:"space"`
}

func (AppRelationships) Validate added in v0.8.0 

func (r AppRelationships) Validate() error

type AppResource 

type AppResource struct {
	GUID    string                 `json:"guid"`
	Process *DestinationAppProcess `json:"process"`
}

func (AppResource) Validate added in v0.8.0 

func (a AppResource) Validate() error

type AppSetCurrentDroplet 

type AppSetCurrentDroplet struct {
	Relationship `json:",inline"`
}

func (AppSetCurrentDroplet) Validate added in v0.8.0 

func (d AppSetCurrentDroplet) Validate() error

type BuildCreate 

type BuildCreate struct {
	Package         *RelationshipData `json:"package"`
	StagingMemoryMB *int              `json:"staging_memory_in_mb"`
	StagingDiskMB   *int              `json:"staging_disk_in_mb"`
	Lifecycle       *Lifecycle        `json:"lifecycle"`
	Metadata        BuildMetadata     `json:"metadata"`
}

func (*BuildCreate) ToMessage 

func (c *BuildCreate) ToMessage(appRecord repositories.AppRecord) repositories.CreateBuildMessage

func (BuildCreate) Validate added in v0.8.0 

func (b BuildCreate) Validate() error

type BuildMetadata added in v0.7.0 

type BuildMetadata struct {
	Annotations map[string]string `json:"annotations"`
	Labels      map[string]string `json:"labels"`
}

func (BuildMetadata) Validate added in v0.8.0 

func (m BuildMetadata) Validate() error

type BuildpackList 

type BuildpackList struct {
	OrderBy string
}

func (*BuildpackList) DecodeFromURLValues added in v0.6.0 

func (d *BuildpackList) DecodeFromURLValues(values url.Values) error

func (BuildpackList) SupportedKeys added in v0.2.0 

func (d BuildpackList) SupportedKeys() []string

func (BuildpackList) Validate added in v0.8.0 

func (d BuildpackList) Validate() error

type Data 

type Data struct {
	Timeout           *int64  `json:"timeout"`
	Endpoint          *string `json:"endpoint"`
	InvocationTimeout *int64  `json:"invocation_timeout"`
}

type DeploymentCreate added in v0.8.0 

type DeploymentCreate struct {
	Droplet       DropletGUID              `json:"droplet"`
	Relationships *DeploymentRelationships `json:"relationships"`
}

func (*DeploymentCreate) ToMessage added in v0.8.0 

func (c *DeploymentCreate) ToMessage() repositories.CreateDeploymentMessage

func (DeploymentCreate) Validate added in v0.8.0 

func (c DeploymentCreate) Validate() error

type DeploymentRelationships added in v0.8.0 

type DeploymentRelationships struct {
	App *Relationship `json:"app"`
}

func (DeploymentRelationships) Validate added in v0.8.0 

func (r DeploymentRelationships) Validate() error

type DestinationAppProcess 

type DestinationAppProcess struct {
	Type string `json:"type"`
}

func (DestinationAppProcess) Validate added in v0.8.0 

func (p DestinationAppProcess) Validate() error

type DomainCreate added in v0.5.0 

type DomainCreate struct {
	Name          string                  `json:"name"`
	Internal      bool                    `json:"internal"`
	Metadata      Metadata                `json:"metadata"`
	Relationships map[string]Relationship `json:"relationships"`
}

func (*DomainCreate) ToMessage added in v0.5.0 

func (c *DomainCreate) ToMessage() (repositories.CreateDomainMessage, error)

func (DomainCreate) Validate added in v0.8.0 

func (c DomainCreate) Validate() error

type DomainList 

type DomainList struct {
	Names string
}

func (*DomainList) DecodeFromURLValues added in v0.6.0 

func (d *DomainList) DecodeFromURLValues(values url.Values) error

func (*DomainList) SupportedKeys added in v0.2.0 

func (d *DomainList) SupportedKeys() []string

func (*DomainList) ToMessage 

func (d *DomainList) ToMessage() repositories.ListDomainsMessage

type DomainUpdate added in v0.5.0 

type DomainUpdate struct {
	Metadata MetadataPatch `json:"metadata"`
}

func (*DomainUpdate) ToMessage added in v0.5.0 

func (c *DomainUpdate) ToMessage(domainGUID string) repositories.UpdateDomainMessage

func (DomainUpdate) Validate added in v0.8.0 

func (c DomainUpdate) Validate() error

type DropletGUID added in v0.8.0 

type DropletGUID struct {
	Guid string `json:"guid"`
}

type DropletUpdate added in v0.7.0 

type DropletUpdate struct {
	Metadata MetadataPatch `json:"metadata"`
}

func (*DropletUpdate) ToMessage added in v0.7.0 

func (c *DropletUpdate) ToMessage(dropletGUID string) repositories.UpdateDropletMessage

func (DropletUpdate) Validate added in v0.8.0 

func (d DropletUpdate) Validate() error

type HealthCheck 

type HealthCheck struct {
	Type *string `json:"type"`
	Data *Data   `json:"data"`
}

type Lifecycle 

type Lifecycle struct {
	Type string         `json:"type"`
	Data *LifecycleData `json:"data"`
}

func (Lifecycle) Validate added in v0.8.0 

func (l Lifecycle) Validate() error

type LifecycleData 

type LifecycleData struct {
	Buildpacks []string `json:"buildpacks,omitempty"`
	Stack      string   `json:"stack,omitempty"`
}

func (LifecycleData) ValidateBuildpackLifecycleData added in v0.9.0 

func (d LifecycleData) ValidateBuildpackLifecycleData() error

func (LifecycleData) ValidateDockerLifecycleData added in v0.9.0 

func (d LifecycleData) ValidateDockerLifecycleData() error

type LifecycleDataPatch added in v0.8.0 

type LifecycleDataPatch struct {
	Buildpacks *[]string `json:"buildpacks"`
	Stack      string    `json:"stack"`
}

type LifecyclePatch added in v0.8.0 

type LifecyclePatch struct {
	Type string              `json:"type"`
	Data *LifecycleDataPatch `json:"data"`
}

func (LifecyclePatch) Validate added in v0.8.0 

func (p LifecyclePatch) Validate() error

type LogRead 

type LogRead struct {
	StartTime     int64
	EnvelopeTypes []string
	Limit         int64
	Descending    bool
}

func (*LogRead) DecodeFromURLValues added in v0.6.0 

func (l *LogRead) DecodeFromURLValues(values url.Values) error

func (*LogRead) SupportedKeys added in v0.2.0 

func (l *LogRead) SupportedKeys() []string

func (LogRead) Validate added in v0.8.0 

func (l LogRead) Validate() error

type Manifest 

type Manifest struct {
	Version      int                   `yaml:"version"`
	Applications []ManifestApplication `json:"applications" yaml:"applications"`
}

func (Manifest) Validate added in v0.7.0 

func (m Manifest) Validate() error

type ManifestApplication 

type ManifestApplication struct {
	Name         string            `json:"name" yaml:"name"`
	Env          map[string]string `yaml:"env"`
	DefaultRoute bool              `json:"default-route" yaml:"default-route"`
	RandomRoute  bool              `yaml:"random-route"`
	NoRoute      bool              `yaml:"no-route"`
	Command      *string           `yaml:"command"`
	Instances    *int              `json:"instances" yaml:"instances"`
	Memory       *string           `json:"memory" yaml:"memory"`
	DiskQuota    *string           `json:"disk_quota" yaml:"disk_quota"`
	// AltDiskQuota supports `disk-quota` with a hyphen for backwards compatibility.
	// Do not set both DiskQuota and AltDiskQuota.
	//
	// Deprecated: Use DiskQuota instead
	AltDiskQuota                 *string                      `json:"disk-quota" yaml:"disk-quota"`
	HealthCheckHTTPEndpoint      *string                      `yaml:"health-check-http-endpoint"`
	HealthCheckInvocationTimeout *int64                       `json:"health-check-invocation-timeout" yaml:"health-check-invocation-timeout"`
	HealthCheckType              *string                      `json:"health-check-type" yaml:"health-check-type"`
	Timeout                      *int64                       `json:"timeout" yaml:"timeout"`
	Processes                    []ManifestApplicationProcess `json:"processes" yaml:"processes"`
	Routes                       []ManifestRoute              `json:"routes" yaml:"routes"`
	Buildpacks                   []string                     `yaml:"buildpacks"`
	// Deprecated: Use Buildpacks instead
	Buildpack *string                      `json:"buildpack" yaml:"buildpack"`
	Metadata  MetadataPatch                `json:"metadata" yaml:"metadata"`
	Services  []ManifestApplicationService `json:"services" yaml:"services"`
	Docker    any                          `json:"docker,omitempty" yaml:"docker,omitempty"`
}

func (ManifestApplication) ToAppCreateMessage 

func (a ManifestApplication) ToAppCreateMessage(spaceGUID string) repositories.CreateAppMessage

func (ManifestApplication) ToAppPatchMessage added in v0.4.0 

func (a ManifestApplication) ToAppPatchMessage(appGUID, spaceGUID string) repositories.PatchAppMessage

func (ManifestApplication) Validate added in v0.7.0 

func (a ManifestApplication) Validate() error

type ManifestApplicationProcess 

type ManifestApplicationProcess struct {
	Type      string  `json:"type" yaml:"type"`
	Command   *string `yaml:"command"`
	DiskQuota *string `json:"disk_quota" yaml:"disk_quota"`
	// AltDiskQuota supports `disk-quota` with a hyphen for backwards compatibility.
	// Do not set both DiskQuota and AltDiskQuota.
	//
	// Deprecated: Use DiskQuota instead
	AltDiskQuota                 *string `json:"disk-quota" yaml:"disk-quota"`
	HealthCheckHTTPEndpoint      *string `yaml:"health-check-http-endpoint"`
	HealthCheckInvocationTimeout *int64  `json:"health-check-invocation-timeout" yaml:"health-check-invocation-timeout"`
	HealthCheckType              *string `json:"health-check-type" yaml:"health-check-type"`
	Instances                    *int    `json:"instances" yaml:"instances"`
	Memory                       *string `json:"memory" yaml:"memory"`
	Timeout                      *int64  `json:"timeout" yaml:"timeout"`
}

TODO: Why is kebab-case used everywhere anyway and we have a deprecated field that claims to use it for backwards compatibility?

func (ManifestApplicationProcess) ToProcessCreateMessage 

func (p ManifestApplicationProcess) ToProcessCreateMessage(appGUID, spaceGUID string) repositories.CreateProcessMessage

func (ManifestApplicationProcess) ToProcessPatchMessage 

func (p ManifestApplicationProcess) ToProcessPatchMessage(processGUID, spaceGUID string) repositories.PatchProcessMessage

func (ManifestApplicationProcess) Validate added in v0.7.0 

func (p ManifestApplicationProcess) Validate() error

type ManifestApplicationService added in v0.9.0 

type ManifestApplicationService struct {
	Name        string  `json:"name" yaml:"name"`
	BindingName *string `json:"binding_name" yaml:"binding_name"`
}

func (*ManifestApplicationService) UnmarshalYAML added in v0.12.0 

func (s *ManifestApplicationService) UnmarshalYAML(value *yaml.Node) error

func (ManifestApplicationService) Validate added in v0.9.0 

func (s ManifestApplicationService) Validate() error

type ManifestRoute 

type ManifestRoute struct {
	Route *string `json:"route" yaml:"route"`
}

func (ManifestRoute) Validate added in v0.7.0 

func (m ManifestRoute) Validate() error

type Metadata 

type Metadata struct {
	Annotations map[string]string `json:"annotations" yaml:"annotations"`
	Labels      map[string]string `json:"labels"      yaml:"labels"`
}

func (Metadata) Validate added in v0.8.0 

func (m Metadata) Validate() error

type MetadataPatch added in v0.3.0 

type MetadataPatch struct {
	Annotations map[string]*string `json:"annotations"`
	Labels      map[string]*string `json:"labels"`
}

func (MetadataPatch) Validate added in v0.8.0 

func (p MetadataPatch) Validate() error

type OrgCreate 

type OrgCreate struct {
	Name      string   `json:"name"`
	Suspended bool     `json:"suspended"`
	Metadata  Metadata `json:"metadata"`
}

func (OrgCreate) ToMessage 

func (p OrgCreate) ToMessage() repositories.CreateOrgMessage

func (OrgCreate) Validate added in v0.8.0 

func (p OrgCreate) Validate() error

type OrgList added in v0.8.0 

type OrgList struct {
	Names string
}

func (*OrgList) DecodeFromURLValues added in v0.8.0 

func (d *OrgList) DecodeFromURLValues(values url.Values) error

func (*OrgList) SupportedKeys added in v0.8.0 

func (d *OrgList) SupportedKeys() []string

func (*OrgList) ToMessage added in v0.8.0 

func (d *OrgList) ToMessage() repositories.ListOrgsMessage

type OrgPatch added in v0.3.0 

type OrgPatch struct {
	Metadata MetadataPatch `json:"metadata"`
}

func (OrgPatch) ToMessage added in v0.3.0 

func (p OrgPatch) ToMessage(orgGUID string) repositories.PatchOrgMetadataMessage

func (OrgPatch) Validate added in v0.8.0 

func (p OrgPatch) Validate() error

type PackageCreate 

type PackageCreate struct {
	Type          string                `json:"type"`
	Relationships *PackageRelationships `json:"relationships"`
	Metadata      Metadata              `json:"metadata"`
	Data          *PackageData          `json:"data"`
}

func (PackageCreate) ToMessage 

func (c PackageCreate) ToMessage(record repositories.AppRecord) repositories.CreatePackageMessage

func (PackageCreate) Validate added in v0.8.0 

func (c PackageCreate) Validate() error

type PackageData added in v0.9.0 

type PackageData struct {
	Image    string  `json:"image"`
	Username *string `json:"username"`
	Password *string `json:"password"`
}

func (PackageData) Validate added in v0.9.0 

func (d PackageData) Validate() error

type PackageList added in v0.8.0 

type PackageList struct {
	GUIDs    string
	AppGUIDs string
	States   string
	OrderBy  string
}

func (*PackageList) DecodeFromURLValues added in v0.8.0 

func (p *PackageList) DecodeFromURLValues(values url.Values) error

func (*PackageList) SupportedKeys added in v0.8.0 

func (p *PackageList) SupportedKeys() []string

func (*PackageList) ToMessage added in v0.8.0 

func (p *PackageList) ToMessage() repositories.ListPackagesMessage

func (PackageList) Validate added in v0.8.0 

func (p PackageList) Validate() error

type PackageListDroplets added in v0.8.0 

type PackageListDroplets struct{}

func (*PackageListDroplets) DecodeFromURLValues added in v0.8.0 

func (p *PackageListDroplets) DecodeFromURLValues(values url.Values) error

func (*PackageListDroplets) SupportedKeys added in v0.8.0 

func (p *PackageListDroplets) SupportedKeys() []string

func (*PackageListDroplets) ToMessage added in v0.8.0 

func (p *PackageListDroplets) ToMessage(packageGUIDs []string) repositories.ListDropletsMessage

type PackageRelationships 

type PackageRelationships struct {
	App *Relationship `json:"app"`
}

func (PackageRelationships) Validate added in v0.8.0 

func (r PackageRelationships) Validate() error

type PackageUpdate added in v0.5.0 

type PackageUpdate struct {
	Metadata MetadataPatch `json:"metadata"`
}

func (*PackageUpdate) ToMessage added in v0.5.0 

func (u *PackageUpdate) ToMessage(packageGUID string) repositories.UpdatePackageMessage

func (PackageUpdate) Validate added in v0.8.0 

func (p PackageUpdate) Validate() error

type ProcessList 

type ProcessList struct {
	AppGUIDs string
}

func (*ProcessList) DecodeFromURLValues added in v0.6.0 

func (p *ProcessList) DecodeFromURLValues(values url.Values) error

func (*ProcessList) SupportedKeys added in v0.2.0 

func (p *ProcessList) SupportedKeys() []string

func (*ProcessList) ToMessage 

func (p *ProcessList) ToMessage() repositories.ListProcessesMessage

type ProcessPatch 

type ProcessPatch struct {
	Metadata    *MetadataPatch `json:"metadata"`
	Command     *string        `json:"command"`
	HealthCheck *HealthCheck   `json:"health_check"`
}

func (ProcessPatch) ToProcessPatchMessage 

func (p ProcessPatch) ToProcessPatchMessage(processGUID, spaceGUID string) repositories.PatchProcessMessage

type ProcessScale 

type ProcessScale struct {
	Instances *int   `json:"instances"`
	MemoryMB  *int64 `json:"memory_in_mb"`
	DiskMB    *int64 `json:"disk_in_mb"`
}

func (ProcessScale) ToRecord 

func (p ProcessScale) ToRecord() repositories.ProcessScaleValues

func (ProcessScale) Validate added in v0.8.0 

func (p ProcessScale) Validate() error

type Relationship 

type Relationship struct {
	Data *RelationshipData `json:"data"`
}

func (Relationship) Validate added in v0.8.0 

func (r Relationship) Validate() error

type RelationshipData 

type RelationshipData struct {
	GUID string `json:"guid"`
}

func (RelationshipData) Validate added in v0.8.0 

func (r RelationshipData) Validate() error

type RoleCreate 

type RoleCreate struct {
	Type          string            `json:"type"`
	Relationships RoleRelationships `json:"relationships"`
}

func (RoleCreate) ToMessage 

func (p RoleCreate) ToMessage() repositories.CreateRoleMessage

func (RoleCreate) Validate added in v0.8.0 

func (p RoleCreate) Validate() error

type RoleList added in v0.8.0 

type RoleList struct {
	GUIDs      map[string]bool
	Types      map[string]bool
	SpaceGUIDs map[string]bool
	OrgGUIDs   map[string]bool
	UserGUIDs  map[string]bool
	OrderBy    string
}

func (*RoleList) DecodeFromURLValues added in v0.8.0 

func (r *RoleList) DecodeFromURLValues(values url.Values) error

func (RoleList) SupportedKeys added in v0.8.0 

func (r RoleList) SupportedKeys() []string

func (RoleList) Validate added in v0.8.0 

func (r RoleList) Validate() error

type RoleRelationships 

type RoleRelationships struct {
	User         UserRelationship `json:"user"`
	Space        *Relationship    `json:"space"`
	Organization *Relationship    `json:"organization"`
}

func (RoleRelationships) ValidateWithContext added in v0.8.0 

func (r RoleRelationships) ValidateWithContext(ctx context.Context) error

type RouteCreate 

type RouteCreate struct {
	Host          string              `json:"host"`
	Path          string              `json:"path"`
	Relationships *RouteRelationships `json:"relationships"`
	Metadata      Metadata            `json:"metadata"`
}

func (RouteCreate) ToMessage 

func (p RouteCreate) ToMessage(domainNamespace, domainName string) repositories.CreateRouteMessage

func (RouteCreate) Validate added in v0.8.0 

func (p RouteCreate) Validate() error

type RouteDestination added in v0.8.0 

type RouteDestination struct {
	App      AppResource `json:"app"`
	Port     *int        `json:"port"`
	Protocol *string     `json:"protocol"`
}

func (RouteDestination) Validate added in v0.8.0 

func (r RouteDestination) Validate() error

type RouteDestinationCreate added in v0.8.0 

type RouteDestinationCreate struct {
	Destinations []RouteDestination `json:"destinations"`
}

func (RouteDestinationCreate) ToMessage added in v0.8.0 

func (dc RouteDestinationCreate) ToMessage(routeRecord repositories.RouteRecord) repositories.AddDestinationsToRouteMessage

func (RouteDestinationCreate) Validate added in v0.8.0 

func (r RouteDestinationCreate) Validate() error

type RouteList 

type RouteList struct {
	AppGUIDs    string
	SpaceGUIDs  string
	DomainGUIDs string
	Hosts       string
	Paths       string
}

func (*RouteList) DecodeFromURLValues added in v0.6.0 

func (p *RouteList) DecodeFromURLValues(values url.Values) error

func (RouteList) SupportedKeys added in v0.2.0 

func (p RouteList) SupportedKeys() []string

func (RouteList) ToMessage 

func (p RouteList) ToMessage() repositories.ListRoutesMessage

type RoutePatch added in v0.5.0 

type RoutePatch struct {
	Metadata MetadataPatch `json:"metadata"`
}

func (RoutePatch) ToMessage added in v0.5.0 

func (p RoutePatch) ToMessage(routeGUID, spaceGUID string) repositories.PatchRouteMetadataMessage

func (RoutePatch) Validate added in v0.8.0 

func (p RoutePatch) Validate() error

type RouteRelationships 

type RouteRelationships struct {
	Domain Relationship `json:"domain"`
	Space  Relationship `json:"space"`
}

func (RouteRelationships) Validate added in v0.8.0 

func (r RouteRelationships) Validate() error

type ServiceBindingCreate 

type ServiceBindingCreate struct {
	Relationships *ServiceBindingRelationships `json:"relationships"`
	Type          string                       `json:"type"`
	Name          *string                      `json:"name"`
}

func (ServiceBindingCreate) ToMessage 

func (p ServiceBindingCreate) ToMessage(spaceGUID string) repositories.CreateServiceBindingMessage

func (ServiceBindingCreate) Validate added in v0.8.0 

func (p ServiceBindingCreate) Validate() error

type ServiceBindingList 

type ServiceBindingList struct {
	AppGUIDs             string
	ServiceInstanceGUIDs string
	Include              string
	LabelSelector        string
}

func (*ServiceBindingList) DecodeFromURLValues added in v0.6.0 

func (l *ServiceBindingList) DecodeFromURLValues(values url.Values) error

func (*ServiceBindingList) SupportedKeys added in v0.2.0 

func (l *ServiceBindingList) SupportedKeys() []string

func (*ServiceBindingList) ToMessage 

func (l *ServiceBindingList) ToMessage() repositories.ListServiceBindingsMessage

type ServiceBindingRelationships 

type ServiceBindingRelationships struct {
	App             *Relationship `json:"app"`
	ServiceInstance *Relationship `json:"service_instance"`
}

func (ServiceBindingRelationships) Validate added in v0.8.0 

func (r ServiceBindingRelationships) Validate() error

type ServiceBindingUpdate added in v0.7.0 

type ServiceBindingUpdate struct {
	Metadata MetadataPatch `json:"metadata"`
}

func (*ServiceBindingUpdate) ToMessage added in v0.7.0 

func (c *ServiceBindingUpdate) ToMessage(serviceBindingGUID string) repositories.UpdateServiceBindingMessage

func (ServiceBindingUpdate) Validate added in v0.8.0 

func (u ServiceBindingUpdate) Validate() error

type ServiceInstanceCreate 

type ServiceInstanceCreate struct {
	Name          string                        `json:"name"`
	Type          string                        `json:"type"`
	Tags          []string                      `json:"tags"`
	Credentials   map[string]any                `json:"credentials"`
	Relationships *ServiceInstanceRelationships `json:"relationships"`
	Metadata      Metadata                      `json:"metadata"`
}

func (ServiceInstanceCreate) ToServiceInstanceCreateMessage 

func (p ServiceInstanceCreate) ToServiceInstanceCreateMessage() repositories.CreateServiceInstanceMessage

func (ServiceInstanceCreate) Validate added in v0.8.0 

func (c ServiceInstanceCreate) Validate() error

type ServiceInstanceList 

type ServiceInstanceList struct {
	Names         string
	GUIDs         string
	SpaceGUIDs    string
	OrderBy       string
	LabelSelector string
}

func (*ServiceInstanceList) DecodeFromURLValues added in v0.6.0 

func (l *ServiceInstanceList) DecodeFromURLValues(values url.Values) error

func (*ServiceInstanceList) IgnoredKeys added in v0.8.0 

func (l *ServiceInstanceList) IgnoredKeys() []*regexp.Regexp

func (*ServiceInstanceList) SupportedKeys added in v0.2.0 

func (l *ServiceInstanceList) SupportedKeys() []string

func (*ServiceInstanceList) ToMessage 

func (l *ServiceInstanceList) ToMessage() repositories.ListServiceInstanceMessage

func (ServiceInstanceList) Validate added in v0.8.0 

func (l ServiceInstanceList) Validate() error

type ServiceInstancePatch added in v0.7.0 

type ServiceInstancePatch struct {
	Name        *string         `json:"name,omitempty"`
	Tags        *[]string       `json:"tags,omitempty"`
	Credentials *map[string]any `json:"credentials,omitempty"`
	Metadata    MetadataPatch   `json:"metadata"`
}

func (ServiceInstancePatch) ToServiceInstancePatchMessage added in v0.7.0 

func (p ServiceInstancePatch) ToServiceInstancePatchMessage(spaceGUID, appGUID string) repositories.PatchServiceInstanceMessage

func (*ServiceInstancePatch) UnmarshalJSON added in v0.7.0 

func (p *ServiceInstancePatch) UnmarshalJSON(data []byte) error

func (ServiceInstancePatch) Validate added in v0.8.0 

func (p ServiceInstancePatch) Validate() error

type ServiceInstanceRelationships 

type ServiceInstanceRelationships struct {
	Space *Relationship `json:"space"`
}

func (ServiceInstanceRelationships) Validate added in v0.8.0 

func (r ServiceInstanceRelationships) Validate() error

type SpaceCreate 

type SpaceCreate struct {
	Name          string              `json:"name"`
	Relationships *SpaceRelationships `json:"relationships"`
	Metadata      Metadata            `json:"metadata"`
}

func (SpaceCreate) ToMessage 

func (p SpaceCreate) ToMessage() repositories.CreateSpaceMessage

func (SpaceCreate) Validate added in v0.8.0 

func (c SpaceCreate) Validate() error

type SpaceList added in v0.8.0 

type SpaceList struct {
	Names             string
	GUIDs             string
	OrganizationGUIDs string
}

func (*SpaceList) DecodeFromURLValues added in v0.8.0 

func (l *SpaceList) DecodeFromURLValues(values url.Values) error

func (*SpaceList) SupportedKeys added in v0.8.0 

func (l *SpaceList) SupportedKeys() []string

func (*SpaceList) ToMessage added in v0.8.0 

func (l *SpaceList) ToMessage() repositories.ListSpacesMessage

type SpacePatch added in v0.3.0 

type SpacePatch struct {
	Metadata MetadataPatch `json:"metadata"`
}

func (SpacePatch) ToMessage added in v0.3.0 

func (p SpacePatch) ToMessage(spaceGUID, orgGUID string) repositories.PatchSpaceMetadataMessage

func (SpacePatch) Validate added in v0.8.0 

func (p SpacePatch) Validate() error

type SpaceRelationships 

type SpaceRelationships struct {
	Org *Relationship `json:"organization"`
}

func (SpaceRelationships) Validate added in v0.8.0 

func (r SpaceRelationships) Validate() error

type TaskCreate added in v0.2.0 

type TaskCreate struct {
	Command  string   `json:"command"`
	Metadata Metadata `json:"metadata"`
}

func (TaskCreate) ToMessage added in v0.2.0 

func (p TaskCreate) ToMessage(appRecord repositories.AppRecord) repositories.CreateTaskMessage

func (TaskCreate) Validate added in v0.8.0 

func (c TaskCreate) Validate() error

type TaskList added in v0.2.0 

type TaskList struct {
	SequenceIDs []int64
}

func (*TaskList) DecodeFromURLValues added in v0.6.0 

func (a *TaskList) DecodeFromURLValues(values url.Values) error

func (*TaskList) SupportedKeys added in v0.2.0 

func (t *TaskList) SupportedKeys() []string

func (*TaskList) ToMessage added in v0.2.0 

func (t *TaskList) ToMessage() repositories.ListTaskMessage

type TaskUpdate added in v0.7.0 

type TaskUpdate struct {
	Metadata MetadataPatch `json:"metadata"`
}

func (*TaskUpdate) ToMessage added in v0.7.0 

func (u *TaskUpdate) ToMessage(taskGUID, spaceGUID string) repositories.PatchTaskMetadataMessage

func (TaskUpdate) Validate added in v0.8.0 

func (u TaskUpdate) Validate() error

type UserRelationship 

type UserRelationship struct {
	Data UserRelationshipData `json:"data"`
}

type UserRelationshipData 

type UserRelationshipData struct {
	Username string `json:"username"`
	GUID     string `json:"guid"`
}

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.