brokermodel

package
v0.0.0-...-ca399ba Latest Latest
Warning

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

 Go to latest Published: Nov 27, 2018 License: Apache-2.0 Imports: 4 Imported by: 6

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AsyncError 

type AsyncError struct {

	/* description
	 */
	Description string `json:"description,omitempty"`

	/* error
	 */
	Error string `json:"error,omitempty"`
}

AsyncError Async operation not supported error

swagger:model AsyncError

func (*AsyncError) Validate 

func (m *AsyncError) Validate(formats strfmt.Registry) error

Validate validates this async error

type BindResource 

type BindResource struct {

	/* app guid
	 */
	AppGUID string `json:"app_guid,omitempty"`

	/* route
	 */
	Route string `json:"route,omitempty"`
}

BindResource bind resource

swagger:model Bind_resource

func (*BindResource) Validate 

func (m *BindResource) Validate(formats strfmt.Registry) error

Validate validates this bind resource

type Binding 

type Binding struct {

	/* GUID of the application that you want to bind your service to. Will be included when users bind applications to service instances.
	 */
	AppGUID string `json:"app_guid,omitempty"`

	/* bind resource
	 */
	BindResource *BindResource `json:"bind_resource,omitempty"`

	/* parameters
	 */
	Parameters *Parameter `json:"parameters,omitempty"`

	/* ID of the plan from the catalog. While not strictly necessary, some brokers might make use of this ID.
	 */
	PlanID string `json:"plan_id,omitempty"`

	/* ID of the service from the catalog. While not strictly necessary, some brokers might make use of this ID.
	 */
	ServiceID string `json:"service_id,omitempty"`
}

Binding Information to bind the service to an application.

swagger:model Binding

func (*Binding) Validate 

func (m *Binding) Validate(formats strfmt.Registry) error

Validate validates this binding

type BindingResponse 

type BindingResponse struct {

	/* A free-form hash of credentials that the bound application can use to access the service. For more information, [see Binding Credentials](https://docs.cloudfoundry.org/services/binding-credentials.html).
	 */
	Credentials interface{} `json:"credentials,omitempty"`

	/* A URL to which Cloud Foundry should proxy requests for the bound route.
	 */
	RouteServiceURL string `json:"route_service_url,omitempty"`

	/* A URL to which Cloud Foundry should drain logs for the bound application. requires syslog_drain must be declared in the catalog endpoint or Cloud Foundry will consider the response invalid. For details, [see Application Log Streaming](https://docs.cloudfoundry.org/services/app-log-streaming.html).
	 */
	SyslogDrainURL string `json:"syslog_drain_url,omitempty"`
}

BindingResponse Success binding response.

swagger:model BindingResponse

func (*BindingResponse) Validate 

func (m *BindingResponse) Validate(formats strfmt.Registry) error

Validate validates this binding response

type BrokerError 

type BrokerError struct {

	/* An error message explaining why the request failed.  This message will be displayed to the user who  initiated the request.

	Required: true
	*/
	Message *string `json:"message"`
}

BrokerError General error

swagger:model BrokerError

func (*BrokerError) Validate 

func (m *BrokerError) Validate(formats strfmt.Registry) error

Validate validates this broker error

type CatalogService 

type CatalogService struct {

	/* bindable
	 */
	Bindable bool `json:"bindable,omitempty"`

	/* dashboard client
	 */
	DashboardClient *DashboardClient `json:"dashboard_client,omitempty"`

	/* description
	 */
	Description string `json:"description,omitempty"`

	/* id
	 */
	ID string `json:"id,omitempty"`

	/* metadata
	 */
	Metadata MetaData `json:"metadata,omitempty"`

	/* name
	 */
	Name string `json:"name,omitempty"`

	/* plan updateable
	 */
	PlanUpdateable bool `json:"plan_updateable,omitempty"`

	/* A list of plans for this service as stored in the catalog
	 */
	Plans []*Plan `json:"plans,omitempty"`

	/* requires
	 */
	Requires []string `json:"requires,omitempty"`

	/* tags
	 */
	Tags []string `json:"tags,omitempty"`
}

CatalogService Schema of a service object see http://docs.cloudfoundry.org/services/api.html

swagger:model CatalogService

func (*CatalogService) Validate 

func (m *CatalogService) Validate(formats strfmt.Registry) error

Validate validates this catalog service

type CatalogServices 

type CatalogServices struct {

	/* services
	 */
	Services []*CatalogService `json:"services,omitempty"`
}

CatalogServices list of services stored in the catalog

swagger:model CatalogServices

func (*CatalogServices) Validate 

func (m *CatalogServices) Validate(formats strfmt.Registry) error

Validate validates this catalog services

type DashboardClient 

type DashboardClient struct {

	/* The id of the Oauth2 client that the service intends to use. The name may be taken, in which case the API will return an error to the operator
	 */
	ID string `json:"id,omitempty"`

	/* A domain for the service dashboard that will be whitelisted by the UAA to enable SSO
	 */
	RedirectURI string `json:"redirect_uri,omitempty"`

	/* A secret for the dashboard client
	 */
	Secret string `json:"secret,omitempty"`
}

DashboardClient Contains the data necessary to activate the [Dashboard SSO feature](https://docs.cloudfoundry.org/services/dashboard-sso.html) for this service

swagger:model DashboardClient

func (*DashboardClient) Validate 

func (m *DashboardClient) Validate(formats strfmt.Registry) error

Validate validates this dashboard client

type DashboardURL 

type DashboardURL struct {

	/* The URL of a web-based management user interface for the service instance; we refer to this as a service dashboard. The URL should contain enough information for the dashboard to identify the resource being accessed (in the example below). For information on how users can authenticate with service dashboards via SSO, [see Dashboard Single Sign-On](https://docs.cloudfoundry.org/services/dashboard-sso.html).
	 */
	DashboardURL string `json:"dashboard_url,omitempty"`
}

DashboardURL The URL of a web-based management user interface for the service instance; we refer to this as a service dashboard. The URL should contain enough information for the dashboard to identify the resource being accessed ( in the example below). For information on how users can authenticate with service dashboards via SSO, [see Dashboard Single Sign-On](https://docs.cloudfoundry.org/services/dashboard-sso.html).

swagger:model DashboardUrl

func (*DashboardURL) Validate 

func (m *DashboardURL) Validate(formats strfmt.Registry) error

Validate validates this dashboard Url

type DeleteService 

type DeleteService struct {

	/* A value of true indicates that both the Cloud Controller and the requesting client support asynchronous provisioning. If this parameter is not included in the request, and the broker can only provision an instance of the requested plan asynchronously, the broker should reject the request with a 422 as described below
	 */
	AcceptsIncomplete bool `json:"accepts_incomplete,omitempty"`

	/* ID of the plan from the catalog. While not strictly necessary, some brokers might make use of this ID.
	 */
	PlanID string `json:"plan_id,omitempty"`

	/* ID of the service from the catalog. While not strictly necessary, some brokers might make use of this ID.
	 */
	ServiceID string `json:"service_id,omitempty"`
}

DeleteService Parameters needed to unbind a service instance

swagger:model DeleteService

func (*DeleteService) Validate 

func (m *DeleteService) Validate(formats strfmt.Registry) error

Validate validates this delete service

type Empty 

type Empty interface{}

Empty Expected empty response could be {}

swagger:model Empty

type LastOperation 

type LastOperation struct {

	/* description
	 */
	Description string `json:"description,omitempty"`

	/* state
	 */
	State string `json:"state,omitempty"`
}

LastOperation Last operation response.

swagger:model LastOperation

func (*LastOperation) Validate 

func (m *LastOperation) Validate(formats strfmt.Registry) error

Validate validates this last operation

type Listing 

type Listing struct {

	/* blurb
	 */
	Blurb string `json:"blurb,omitempty"`

	/* image URL.
	 */
	ImageURL string `json:"imageUrl,omitempty"`

	/* Long Description
	 */
	LongDescription string `json:"longDescription,omitempty"`
}

Listing Listing.

swagger:model Listing

func (*Listing) Validate 

func (m *Listing) Validate(formats strfmt.Registry) error

Validate validates this listing

type MetaData 

type MetaData map[string]string

MetaData metadata related to the service

swagger:model MetaData

func (MetaData) Validate 

func (m MetaData) Validate(formats strfmt.Registry) error

Validate validates this meta data

type Parameter 

type Parameter struct {

	/* Name of the parameter
	 */
	Name string `json:"name,omitempty"`

	/* value of the parameter
	 */
	Value interface{} `json:"value,omitempty"`
}

Parameter A key value parameters

swagger:model Parameter

func (*Parameter) Validate 

func (m *Parameter) Validate(formats strfmt.Registry) error

Validate validates this parameter

type Plan 

type Plan struct {

	/* A short description of the service that will appear in the catalog.
	 */
	Description string `json:"description,omitempty"`

	/* This field allows the plan to be limited by the non_basic_services_allowed field in a Cloud Foundry Quota, [see Quota Plans](http://docs.cloudfoundry.org/running/managing-cf/quota-plans.html).
	 */
	Free bool `json:"free,omitempty"`

	/* An identifier used to correlate this plan in future requests to the catalog. This must be unique within Cloud Foundry, using a GUID is recommended.
	 */
	ID string `json:"id,omitempty"`

	/* metadata
	 */
	Metadata *PlanMetadata `json:"metadata,omitempty"`

	/* The CLI-friendly name of the plan that will appear in the catalog. All lowercase, no spaces.
	 */
	Name string `json:"name,omitempty"`
}

Plan A plan for the service

swagger:model Plan

func (*Plan) Validate 

func (m *Plan) Validate(formats strfmt.Registry) error

Validate validates this plan

type PlanMetadata 

type PlanMetadata struct {

	/* A description of the service plan to be displayed in a catalog.
	 */
	Description string `json:"description,omitempty"`

	/* Additional non mandatory fields for Plan metadata (e.g. metadata.displayName, metadata.bullets)
	 */
	Metadata interface{} `json:"metadata,omitempty"`

	/* A short name for the service plan to be displayed in a catalog.
	 */
	Name string `json:"name,omitempty"`
}

PlanMetadata A list of metadata for a service plan. For more information, [see Service Metadata](https://docs.cloudfoundry.org/services/catalog-metadata.html).

swagger:model PlanMetadata

func (*PlanMetadata) Validate 

func (m *PlanMetadata) Validate(formats strfmt.Registry) error

Validate validates this plan metadata

type PreviousValues 

type PreviousValues struct {

	/* ID of the organization containing the instance.
	 */
	OrganizationID string `json:"organization_id,omitempty"`

	/* ID of the plan prior to the update.
	 */
	PlanID string `json:"plan_id,omitempty"`

	/* ID of the service for the instance.
	 */
	ServiceID string `json:"service_id,omitempty"`

	/* ID of the space containing the instance.
	 */
	SpaceID string `json:"space_id,omitempty"`
}

PreviousValues Information about the instance prior to the update.

swagger:model PreviousValues

func (*PreviousValues) Validate 

func (m *PreviousValues) Validate(formats strfmt.Registry) error

Validate validates this previous values

type Provider 

type Provider struct {

	/* Provider Name
	 */
	Name string `json:"name,omitempty"`
}

Provider Provider

swagger:model Provider

func (*Provider) Validate 

func (m *Provider) Validate(formats strfmt.Registry) error

Validate validates this provider

type Service 

type Service struct {

	/* A value of true indicates that both the Cloud Controller and the requesting client support asynchronous provisioning. If this parameter is not included in the request, and the broker can only provision an instance of the requested plan asynchronously, the broker should reject the request with a 422 as described below
	 */
	AcceptsIncomplete bool `json:"accepts_incomplete,omitempty"`

	/* The Cloud Controller GUID of the organization under which the service is to be provisioned. Although most brokers will not use this field, it could be helpful in determining data placement or applying custom business rules.
	 */
	OrganizationGUID string `json:"organization_guid,omitempty"`

	/* parameteres
	 */
	Parameteres *Parameter `json:"parameteres,omitempty"`

	/* The ID of the plan within the above service (from the catalog endpoint) that the user would like provisioned. Because plans have identifiers unique to a broker, this is enough information to determine what to provision.
	 */
	PlanID string `json:"plan_id,omitempty"`

	/* The ID of the service within the catalog above. While not strictly necessary, some brokers might make use of this ID.
	 */
	ServiceID string `json:"service_id,omitempty"`

	/* Similar to organization_guid, but for the space.
	 */
	SpaceGUID string `json:"space_guid,omitempty"`
}

Service Service object

swagger:model Service

func (*Service) Validate 

func (m *Service) Validate(formats strfmt.Registry) error

Validate validates this service

type ServicePlan 

type ServicePlan struct {

	/* A value of true indicates that both the Cloud Controller and the requesting client support asynchronous provisioning. If this parameter is not included in the request, and the broker can only provision an instance of the requested plan asynchronously, the broker should reject the request with a 422 as described below
	 */
	AcceptsIncomplete bool `json:"accepts_incomplete,omitempty"`

	/* parameters
	 */
	Parameters *Parameter `json:"parameters,omitempty"`

	/* plan id
	 */
	PlanID string `json:"plan_id,omitempty"`

	/* previous values
	 */
	PreviousValues *PreviousValues `json:"previous_values,omitempty"`

	/* service id
	 */
	ServiceID string `json:"service_id,omitempty"`
}

ServicePlan New Plan to be added to a service.

swagger:model ServicePlan

func (*ServicePlan) Validate 

func (m *ServicePlan) Validate(formats strfmt.Registry) error

Validate validates this service plan

type Services 

type Services struct {

	/* bindable
	 */
	Bindable bool `json:"bindable,omitempty"`

	/* dashboard client
	 */
	DashboardClient *DashboardClient `json:"dashboard_client,omitempty"`

	/* description
	 */
	Description string `json:"description,omitempty"`

	/* id
	 */
	ID string `json:"id,omitempty"`

	/* metadata
	 */
	Metadata *MetaData `json:"metadata,omitempty"`

	/* name
	 */
	Name string `json:"name,omitempty"`

	/* plan updateable
	 */
	PlanUpdateable bool `json:"plan_updateable,omitempty"`

	/* A list of plans for this service
	 */
	Plans []*Plan `json:"plans,omitempty"`

	/* requires
	 */
	Requires []string `json:"requires,omitempty"`

	/* tags
	 */
	Tags []string `json:"tags,omitempty"`
}

Services Schema of a service object

swagger:model Services

func (*Services) Validate 

func (m *Services) Validate(formats strfmt.Registry) error

Validate validates this services

type UnbindParameters 

type UnbindParameters struct {

	/* ID of the plan from the catalog. While not strictly necessary, some brokers might make use of this ID.
	 */
	PlanID string `json:"plan_id,omitempty"`

	/* ID of the service from the catalog. While not strictly necessary, some brokers might make use of this ID.
	 */
	ServiceID string `json:"service_id,omitempty"`
}

UnbindParameters Parameters needed to unbind a service instance

swagger:model UnbindParameters

func (*UnbindParameters) Validate 

func (m *UnbindParameters) Validate(formats strfmt.Registry) error

Validate validates this unbind parameters

Source Files

View all Source files

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.