btpmanagment

package
v0.0.38 Latest Latest
Warning

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

 Go to latest Published: May 25, 2021 License: MPL-2.0 Imports: 9 Imported by: 1

Documentation

Index

Constants

View Source 
const (
	ServiceName = "Service Management V1" // Label of service.
	EndpointsID = "service-manager"       // ID to lookup a service endpoint with.
	ServiceID   = ""                      // ServiceID is a unique identifier of a specific service.
)

Variables

This section is empty.

Functions

This section is empty.

Types

type Basic 

type Basic struct {
	Username string `json:"username,omitempty"`
	Password string `json:"password,omitempty"`
}

type BindingItem 

type BindingItem struct {
	//The ID of the service binding.
	Id string `json:"id,omitempty"`
	//Whether the service binding is ready.
	Ready bool `json:"ready,omitempty"`
	//The name of the service binding.
	Name string `json:"name,omitempty"`
	//The ID of the service instance associated with the binding.
	ServiceInstanceId string `json:"service_instance_id,omitempty"`
	//Contextual data for the resource.
	Context map[string]string `json:"context,omitempty"`
	//Contains the resources associated with the binding.
	BindResource map[string]string `json:"bind_resource,omitempty"`
	//Credentials to access the binding.
	Credentials Credentials `json:"credentials,omitempty"`
	//The time the binding was created.
	//In ISO 8601 format:
	//	YYYY-MM-DDThh:mm:ssTZD
	CreatedAt string `json:"created_at,omitempty"`
	//The last time the binding was updated.
	//In ISO 8601 format.
	UpdatedAt string `json:"updated_at,omitempty"`
	//Additional data associated with the resource entity.
	Labels map[string][]string `json:"labels,omitempty"`
}

type BrokerItem 

type BrokerItem struct {
	//The ID of the service broker.
	Id string `json:"id,omitempty"`
	//Whether the service broker is ready.
	Ready bool `json:"ready,omitempty"`
	//The name of the service broker.
	Name string `json:"name,omitempty"`
	//The description of the service broker.
	Description string `json:"description,omitempty"`
	//The URL of the service broker.
	BrokerUrl string `json:"broker_url,omitempty"`

	//The time the service broker was created.
	//In ISO 8601 format:
	//	YYYY-MM-DDThh:mm:ssTZD
	CreatedAt string `json:"created_at,omitempty"`

	//The last time the service broker was updated.
	//In ISO 8601 format.
	UpdatedAt string `json:"updated_at,omitempty"`

	//Additional data associated with the resource entity.
	Labels map[string][]string `json:"labels,omitempty"`
}

type CreatePlatformInput added in v0.0.38 

type CreatePlatformInput struct {
	//The CLI-friendly name of the platform.
	//A CLI-friendly name is a short string that only contains alphanumeric characters, periods, and hyphens.
	//It can't contain white spaces.
	//The name must not exceed 255 characters, but it is recommended to keep it much shorter, for the convenience
	//of using short names in CLI commands.
	Name string `json:"name,omitempty"`

	//The type of the platform.
	//Possible values:
	//Enum:
	//	[ kubernetes ]
	Type string `json:"type,omitempty"`

	//The description of the platform for customer-facing UIs.
	Description string `json:"description,omitempty"`

	//Additional data associated with the resource entity.
	Labels map[string][]string `json:"labels,omitempty"`
}

POST /v1/platforms Register a platform

type CreatePlatformOutput added in v0.0.38 

type CreatePlatformOutput struct {
	// The ID of the platform.
	//You can use this ID to get details about the platform, to update, or to delete the platform.
	//See the GET, PATCH, and DELETE APIs for the Platforms group.
	Id string `json:"id,omitempty"`

	//Whether the platform is ready for consumption.
	Ready bool `json:"ready,omitempty"`

	//The type of the platform.
	//Possible values:
	//Enum:
	//	[ kubernetes ]
	Type string `json:"type,omitempty"`

	//The technical name of the platform.
	Name string `json:"name,omitempty"`

	//The description of the platform.
	Description string `json:"description,omitempty"`

	//Credentials to authenticate with the SAP Cloud Service Management service.
	Credentials Credentials `json:"credentials,omitempty"`

	//The time the platform was created.
	//In ISO 8601 format:
	//	YYYY-MM-DDThh:mm:ssTZD
	CreatedAt string `json:"created_at,omitempty"`

	//The last time the platform was updated.
	//In ISO 8601 format.
	UpdatedAt string `json:"updated_at,omitempty"`

	//Additional data associated with the resource entity.
	Labels map[string][]string `json:"labels,omitempty"`

	Error
	types.StatusAndBodyFromResponse
}

type CreateServiceBindingInput 

type CreateServiceBindingInput struct {
	//Whether to perform this operation asynchronously.
	Async bool `dest:"querystring" dest-name:"async"`

	//The name of the service binding.
	Name string `json:"name,omitempty"`
	//The id of the service instance associated with the binding.
	ServiceInstanceId string `json:"service_instance_id,omitempty"`
	//Some services support providing of additional configuration parameters during binding creation.
	//Pass these parameters as key-value pairs.
	//For the list of supported configuration parameters, see the documentation of a particular service offering.
	//You can also use the GET /v1/service_bindings/{serviceBindingID}/parameters API later to view the parameters
	//defined during this step.
	Parameters map[string]string `json:"parameters,omitempty"`
	//The bind_resource object contains platform-specific information related to the context in which the service is used.
	//The examples of some common fields to use:
	//app_guid - A string GUID of an application associated with the binding. For credentials bindings.
	//Must be unique within the scope of the platform.
	//app_guid - Represents the scope to which the binding applies within the platform.
	//For example, in Kubernetes it can map to a namespace.
	//The scope of what the platform maps the app_guid to is platform-specific and can vary across binding requests.
	//route - URL of the intermediate application. For route services bindings.
	BindResource map[string]string `json:"bind_resource,omitempty"`
	//Additional data associated with the resource entity.
	Labels map[string][]string `json:"labels,omitempty"`
}

POST /v1/service_bindings Create a service binding

type CreateServiceBindingOutput 

type CreateServiceBindingOutput struct {
	BindingItem

	Error
	types.StatusAndBodyFromResponse
}

type CreateServiceInstanceInput 

type CreateServiceInstanceInput struct {
	//Whether to perform this operation asynchronously.
	Async bool `dest:"querystring" dest-name:"async"`

	//The name of the new service instance.
	//Can't be an empty object.
	Name string `json:"name,omitempty"`

	//The ID of the service plan to use for the service instance.
	ServicePlanId string `json:"service_plan_id,omitempty"`

	//The name of the service offering to use for the service instance.
	ServiceOfferingName string `json:"service_offering_name,omitempty"`
	//The name of the service plan to use for the service instance.
	ServicePlanName string `json:"service_plan_name,omitempty"`

	//Some services support providing of additional configuration parameters during instance creation.
	//Pass these parameters as key-value pairs.
	//For the list of supported configuration parameters, see the documentation of a particular service offering.
	//You can also use the GET /v1/service_instances/{serviceInstanceID}/parameters API later to view the parameters
	//defined during this step.
	Parameters map[string]string `json:"parameters,omitempty"`
	//Additional data associated with the resource entity.
	Labels map[string][]string `json:"labels,omitempty"`
}

POST /v1/service_instances Create a service instance

type CreateServiceInstanceOutput 

type CreateServiceInstanceOutput struct {
	InstanceItem

	Error
	types.StatusAndBodyFromResponse
}

type Credentials 

type Credentials struct {
	Basic Basic `json:"basic,omitempty"`
}

type DeletePlatformInput added in v0.0.38 

type DeletePlatformInput struct {
	//The ID of the platform to unregister.
	PlatformID string `dest:"uri" dest-name:"platformID"`

	//Whether to cascade-delete all the services and bindings that are related to the platform.
	Cascade bool `dest:"querystring" dest-name:"cascade"`
}

DELETE /v1/platforms/{platformID} Unregister a platform

type DeletePlatformOutput added in v0.0.38 

type DeletePlatformOutput struct {
	Error
	types.StatusAndBodyFromResponse
}

type DeleteServiceBindingInput 

type DeleteServiceBindingInput struct {
	//The ID of the service binding to delete.
	ServiceBindingID string `dest:"uri" dest-name:"serviceBindingID"`
	//Whether to perform this operation asynchronously.
	Async string `dest:"querystring" dest-name:"async"`
}

DELETE /v1/service_bindings/{serviceBindingID} Delete a service Binding

type DeleteServiceBindingOutput 

type DeleteServiceBindingOutput struct {
	Error
	types.StatusAndBodyFromResponse
}

type DeleteServiceInstanceInput 

type DeleteServiceInstanceInput struct {
	//The ID of the provisioned service instance to delete.
	ServiceInstanceID string `dest:"uri" dest-name:"serviceInstanceID"`

	//Whether to perform this operation asynchronously.
	Async bool `dest:"querystring" dest-name:"async"`
}

DELETE /v1/service_instances/{serviceInstanceID} Delete a service instance

type DeleteServiceInstanceOutput 

type DeleteServiceInstanceOutput struct {
	Error
	types.StatusAndBodyFromResponse
}

type Error 

type Error struct {
	//The name of the error.
	ErrorMessage string `json:"error,omitempty"`

	//The description of the error.
	ErrorDescription string `json:"description,omitempty"`
}

A response object that contains details about the error.

type GetOperationStatusInput 

type GetOperationStatusInput struct {
	//The type of the SAP Cloud Service Management service resource.
	//Available values : platforms, service_brokers, service_bindings, service_instances
	ResourceType string `dest:"uri" dest-name:"resourceType"`
	//The ID of the previously created entity of the specified resource type.
	ResourceID string `dest:"uri" dest-name:"resourceID"`
	//The ID of the operation for which to get status.
	OperationID string `dest:"uri" dest-name:"operationID"`
}

GET /v1/{resourceType}/{resourceID}/operations/{operationID} Get operation status

type GetOperationStatusOutput 

type GetOperationStatusOutput struct {
	Operation

	Error
	types.StatusAndBodyFromResponse
}

type GetPlatformInput added in v0.0.37 

type GetPlatformInput struct {
	//The ID of the registered platform for which to get details.
	PlatformID string `dest:"uri" dest-name:"platformID"`
}

GET /v1/platforms/{platformID} Get all platforms

type GetPlatformOutput added in v0.0.37 

type GetPlatformOutput struct {
	//The ID of the platform.
	//You can use this ID to update or to delete the platform.
	//See the PATCH and DELETE calls for the Platforms group.
	Id string `json:"id,omitempty"`

	//Whether the platform is ready for consumption.
	Ready bool `json:"ready,omitempty"`

	LastOperation Operation `json:"last_operation,omitempty"`

	//The type of the platform.
	//Possible values:
	//Enum:
	//	[ kubernetes, cloud foundry ]
	Type string `json:"type,omitempty"`

	//The name of the platform.
	Name string `json:"name,omitempty"`

	//The description of the platform.
	Description string `json:"description,omitempty"`

	//The time the platform was created.
	//In ISO 8601 format:
	//	YYYY-MM-DDThh:mm:ssTZD
	CreatedAt string `json:"created_at,omitempty"`

	//The last time the platform was updated.
	//In ISO 8601 format.
	UpdatedAt string `json:"updated_at,omitempty"`

	//Additional data associated with the resource entity.
	Labels map[string][]string `json:"labels,omitempty"`

	Error
	types.StatusAndBodyFromResponse
}

type GetPlatformsInput 

type GetPlatformsInput struct {
	//Filters the response based on the field query.
	//If used, must be a nonempty string.
	//For example:
	//	type eq 'kubernetes'
	FieldQuery string `dest:"querystring" dest-name:"fieldQuery"`

	//Filters the response based on the label query.
	//If used, must be a nonempty string.
	//For example:
	//	environment eq 'dev'
	LabelQuery string `dest:"querystring" dest-name:"labelQuery"`

	//You get this parameter in the response list of the API if the total number of items to return (num_items) is larger
	//than the number of items returned in a single API call (max_items).
	//You get a different token in each response to be used in each consecutive call as long as there are more items to list.
	//Use the returned tokens to get the full list of items associated with your subaccount.
	//If this is the first time you are calling the API, leave this field empty.
	Token string `dest:"querystring" dest-name:"token"`

	//The maximum number of platforms to return in the response.
	MaxItems int64 `dest:"querystring" dest-name:"max_items"`
}

GET /v1/platforms Get all platforms

type GetPlatformsOutput 

type GetPlatformsOutput struct {
	//Use this token when you call the API again to get more platforms associated with your subaccount.
	//The token field indicates that the total number of platforms to view in the list (num_items) is larger than the
	//defined maximum number of platforms to be returned after a single API call (max_items).
	//If the field is not present, either all the platforms were included in the first response, or you have
	//reached the end of the list.
	Token string `json:"token,omitempty"`

	//The number of platforms associated with the subaccount.
	NumItems int64 `json:"num_items,omitempty"`

	//The list of response objects that contains details about the platforms.
	Items []PlatformItem `json:"items,omitempty"`

	Error
	types.StatusAndBodyFromResponse
}

type GetServiceBindingInput added in v0.0.37 

type GetServiceBindingInput struct {
	//The ID of the service binding for which to get details.
	ServiceBindingID string `dest:"uri" dest-name:"serviceBindingID"`
}

GET /v1/service_bindings/{serviceBindingID} Get service Binding details

type GetServiceBindingOutput added in v0.0.37 

type GetServiceBindingOutput struct {
	BindingItem
	LastOperation Operation `json:"last_operation,omitempty"`

	Error
	types.StatusAndBodyFromResponse
}

type GetServiceBindingParametersInput 

type GetServiceBindingParametersInput struct {
	//The ID of the service binding for which to get parameters.
	ServiceBindingID string `dest:"uri" dest-name:"serviceBindingID"`
}

GET /v1/service_bindings/{serviceBindingID}/parameters Get service Binding parameters

type GetServiceBindingParametersOutput 

type GetServiceBindingParametersOutput struct {
	Parameters map[string]string `json:"-,omitempty"`

	Error
	types.StatusAndBodyFromResponse
}

type GetServiceBindingsInput 

type GetServiceBindingsInput struct {
	//Filters the response based on the field query.
	//If used, must be a nonempty string.
	//For example:
	//	ready eq 'true'
	FieldQuery string `dest:"querystring" dest-name:"fieldQuery"`
	//Filters the response based on the label query.
	//If used, must be a nonempty string.
	//For example:
	//	environment eq 'dev'
	LabelQuery string `dest:"querystring" dest-name:"labelQuery"`
	//You get this parameter in the response list of the API if the total number of items to return (num_items) is larger
	//than the number of items returned in a single API call (max_items).
	//You get a different token in each response to be used in each consecutive call as long as there are more items to list.
	//Use the returned tokens to get the full list of resources associated with your subaccount.
	//If this is the first time you are calling the API, leave this field empty.
	Token string `dest:"querystring" dest-name:"token"`
	//The maximum number of service bindings to return in the response.
	MaxItems int64 `dest:"querystring" dest-name:"max_items"`
}

GET /v1/service_bindings Get all service bindings

type GetServiceBindingsOutput 

type GetServiceBindingsOutput struct {
	//Use this token when you call the API again to get more service bindings associated with your subaccount.
	//The token field indicates that the total number of service bindings to view in the list (num_items) is larger
	//than the defined maximum number of service bindings to be returned after a single API call (max_items).
	//If the field is not present, either all the service bindings were included in the first response, or you have
	//reached the end of the list.
	Token string `json:"token,omitempty"`
	//The number of the service bindings associated with the subaccount.
	NumItems int64 `json:"num_items,omitempty"`
	//The list of the response objects that contains details about the service bindings.
	Items []BindingItem `json:"items,omitempty"`

	Error
	types.StatusAndBodyFromResponse
}

type GetServiceBrokerInput added in v0.0.37 

type GetServiceBrokerInput struct {
	//The ID of the service broker for which to get details.
	ServiceBrokerID string `dest:"uri" dest-name:"serviceBrokerID"`
}

GET /v1/service_brokers/{serviceBrokerID} Get service broker details

type GetServiceBrokerOutput added in v0.0.37 

type GetServiceBrokerOutput struct {
	BrokerItem
	LastOperation Operation `json:"last_operation,omitempty"`

	Error
	types.StatusAndBodyFromResponse
}

type GetServiceBrokersInput 

type GetServiceBrokersInput struct {
	//Filters the response based on the field query.
	//If used, must be a nonempty string.
	//For example:
	//name eq 'my service broker'.
	FieldQuery string `dest:"querystring" dest-name:"fieldQuery"`

	//Filters the response based on the label query.
	//If used, must be a nonempty string.
	//For example:
	//environment eq 'dev'.
	LabelQuery string `dest:"querystring" dest-name:"labelQuery"`

	//You get this parameter in the response list of the API if the total number of items to return (num_items) is
	//larger than the number of items returned in a single API call (max_items).
	//You get a different token in each response to be used in each consecutive call as long as there are more items to list.
	//Use the returned tokens to get the full list of resources associated with your subaccount.
	//Leave the field empty if this is the first time you are calling the API.
	Token string `dest:"querystring" dest-name:"token"`

	//The maximum number of service brokers to return in the response.
	MaxItems int64 `dest:"querystring" dest-name:"max_items"`
}

GET /v1/service_brokers Get all service brokers

type GetServiceBrokersOutput 

type GetServiceBrokersOutput struct {
	//Use this token when you call the API again to get more service brokers associated with your subaccount.
	//The token field indicates that the total number of service brokers to view in the list (num_items) is larger than
	//the defined maximum number of service brokers to be returned after a single API call (max_items).
	//If the field is not present, either all the service brokers were included in the first response, or you have
	//reached the end of the list.
	Token string `json:"token,omitempty"`

	//The number of the service brokers associated with the subaccount.
	NumItems int64 `json:"num_items,omitempty"`

	//The list of response objects that contains details about the service brokers.
	Items []BrokerItem `json:"items,omitempty"`

	Error
	types.StatusAndBodyFromResponse
}

type GetServiceInstanceInput added in v0.0.37 

type GetServiceInstanceInput struct {
	//The ID of the provisioned service instance for which to get details.
	ServiceInstanceID string `dest:"uri" dest-name:"serviceInstanceID"`
}

GET /v1/service_instances/{serviceInstanceID} Get service instance details

type GetServiceInstanceOutput added in v0.0.37 

type GetServiceInstanceOutput struct {
	InstanceItem
	LastOperation Operation `json:"last_operation,omitempty"`

	Error
	types.StatusAndBodyFromResponse
}

type GetServiceInstanceParametersInput 

type GetServiceInstanceParametersInput struct {
	//The ID of the provisioned service instance for which to get parameters.
	ServiceInstanceID string `dest:"uri" dest-name:"serviceInstanceID"`
}

GET /v1/service_instances/{serviceInstanceID}/parameters Get service instance parameters

type GetServiceInstanceParametersOutput 

type GetServiceInstanceParametersOutput struct {
	Parameters map[string]string `json:"-,omitempty"`

	Error
	types.StatusAndBodyFromResponse
}

type GetServiceInstancesInput 

type GetServiceInstancesInput struct {
	//Filters the response based on the field query.
	//If used, must be a nonempty string.
	//For example:
	//	usable eq 'true'
	FieldQuery string `dest:"querystring" dest-name:"fieldQuery"`
	//Filters the response based on the label query.
	//If used, must be a nonempty string.
	//For example:
	//	environment eq 'dev'
	LabelQuery string `dest:"querystring" dest-name:"labelQuery"`
	//You get this parameter in the response list of the API if the total number of items to return (num_items) is larger
	//than the number of items returned in a single API call (max_items).
	//You get a different token in each response to be used in each consecutive call as long as there are more items to list.
	//Use the returned tokens to get the full list of resources associated with your subaccount.
	//If this is the first time you are calling the API, leave this field empty.
	Token string `dest:"querystring" dest-name:"token"`
	//The maximum number of service instances to return in the response.
	MaxItems int64 `dest:"querystring" dest-name:"max_items"`
}

GET /v1/service_instances Get all service instances

type GetServiceInstancesOutput 

type GetServiceInstancesOutput struct {
	//Use this token when you call the API again to get more service instances associated with your subaccount.
	//The token field indicates that the total number of service instances to view in the list (num_items) is larger
	//than the defined maximum number of service instances to be returned after a single API call (max_items).
	//If the field is not present, either all the instances were included in the first response, or you have reached the
	//end of the list.
	Token string `json:"token,omitempty"`
	//The number of service instances associated with the subaccount.
	NumItems int64 `json:"num_items,omitempty"`
	//The list of response objects that contains details about the service instances.
	Items []InstanceItem `json:"items,omitempty"`

	Error
	types.StatusAndBodyFromResponse
}

type GetServiceOfferingInput added in v0.0.37 

type GetServiceOfferingInput struct {
	//The ID of the service offering for which to get details.
	ServiceOfferingID string `dest:"uri" dest-name:"serviceOfferingID"`
}

GET /v1/service_offerings/{serviceOfferingID} Get service offering details

type GetServiceOfferingOutput added in v0.0.37 

type GetServiceOfferingOutput struct {
	OfferingItem

	Error
	types.StatusAndBodyFromResponse
}

type GetServiceOfferingsInput 

type GetServiceOfferingsInput struct {
	//Filters the response based on the field query.
	//If used, must be a nonempty string.
	//For example:
	//	ready eq 'true'
	FieldQuery string `dest:"querystring" dest-name:"fieldQuery"`
	//Filters the response based on the label query.
	//If used, must be a nonempty string.
	//For example:
	//	environment eq 'dev'
	LabelQuery string `dest:"querystring" dest-name:"labelQuery"`
	//You get this parameter in the response list of the API if the total number of items to return (num_items) is larger
	//than the number of items returned in a single API call (max_items).
	//You get a different token in each response to be used in each consecutive call as long as there are more items to list.
	//Use the returned tokens to get the full list of resources associated with your subaccount.
	//If this is the first time you are calling the API, leave this field empty.
	Token string `dest:"querystring" dest-name:"token"`
	//The maximum number of service offerings to return in the response.
	MaxItems int64 `dest:"querystring" dest-name:"max_items"`
}

GET /v1/service_offerings Get all service offerings

type GetServiceOfferingsOutput 

type GetServiceOfferingsOutput struct {
	//Use this token when you call the API again to get more service offerings associated with your subaccount.
	//The token field indicates that the total number of service offerings to view in the list (num_items) is larger
	//than the defined maximum number of service offerings to be returned after a single API call (max_items).
	//If the field is not present, either all the service offerings were included in the first response, or you have
	//reached the end of the list.
	Token string `json:"token,omitempty"`
	//The number of service offerings associated with the subaccount.
	NumItems int64 `json:"num_items,omitempty"`
	//The list of the service offerings.
	Items []OfferingItem `json:"items,omitempty"`

	Error
	types.StatusAndBodyFromResponse
}

type GetServicePlanInput added in v0.0.37 

type GetServicePlanInput struct {
	//The ID of the service plan for which to get details.
	ServicePlanID string `dest:"uri" dest-name:"servicePlanID"`
}

GET /v1/service_plans/{servicePlanID} Get service plan details

type GetServicePlanOutput added in v0.0.37 

type GetServicePlanOutput struct {
	PlanItem

	Error
	types.StatusAndBodyFromResponse
}

type GetServicePlansInput 

type GetServicePlansInput struct {
	//Filters the response based on the field query.
	//If used, must be a nonempty string.
	//For example:
	//	ready eq 'true'
	FieldQuery string `dest:"querystring" dest-name:"fieldQuery"`
	//Filters the response based on the label query.
	//If used, must be a nonempty string.
	//For example:
	//	environment eq 'dev'
	LabelQuery string `dest:"querystring" dest-name:"labelQuery"`
	//You get this parameter in the response list of the API if the total number of items to return (num_items) is
	//larger than the number of items returned in a single API call (max_items).
	//You get a different token in each response to be used in each consecutive call as long as there are more items to list.
	//Use the returned tokens to get the full list of resources associated with your subaccount.
	//If this is the first time you are calling this API, leave this field empty.
	Token string `dest:"querystring" dest-name:"token"`
	//The maximum number of service plans to return in the response.
	MaxItems int64 `dest:"querystring" dest-name:"max_items"`
}

GET /v1/service_plans Get all service plans

type GetServicePlansOutput 

type GetServicePlansOutput struct {
	//Use this token when you call the API again to get more service plans associated with your subaccount.
	//The token field indicates that the total number of service plans to view in the list (num_items) is larger than
	//the defined maximum number of ervice plans to be returned after a single API call (max_items).
	//If the field is not present, either all the service plans were included in the first response, or you have reached
	//the end of the list.
	Token string `json:"token,omitempty"`
	//The number of service plans associated with the subaccount.
	NumItems int64 `json:"num_items,omitempty"`
	//The list of the response objects that contain details about the service plans.
	Items []PlanItem `json:"items,omitempty"`

	Error
	types.StatusAndBodyFromResponse
}

type InstanceItem 

type InstanceItem struct {
	//The ID of the service instance.
	Id string `json:"id,omitempty"`
	//Whether the service instance is ready.
	Ready bool `json:"ready,omitempty"`
	//The name of the service instance.
	Name string `json:"name,omitempty"`
	//The ID of the service plan associated with the service instance.
	ServicePlanId string `json:"service_plan_id,omitempty"`
	//The ID of the platform to which the service instance belongs.
	PlatformId string `json:"platform_id,omitempty"`
	//The URL of the web-based management UI for the service instance.
	DashboardUrl string `json:"dashboard_url,omitempty"`
	//Contextual data for the resource.
	Context map[string]string `json:"context,omitempty"`
	//The maintenance information associated with the service instance.
	MaintenanceInfo map[string]string `json:"maintenance_info,omitempty"`
	//Whether the service instance can be used.
	Usable bool `json:"usable,omitempty"`
	//The time the service instance was created.
	//In ISO 8601 format:
	//	YYYY-MM-DDThh:mm:ssTZD
	CreatedAt string `json:"created_at,omitempty"`
	//The last time the service instance was updated.
	//In ISO 8601 format.
	UpdatedAt string `json:"updated_at,omitempty"`
	//Additional data associated with the resource entity.
	Labels map[string][]string `json:"labels,omitempty"`
}

type Label 

type Label struct {
	//The operation to perform on a label.
	//Possible values:
	//Enum:
	//	[ add, remove ]
	Op string `json:"op,omitempty"`

	//The name of the label.
	Key string `json:"key,omitempty"`

	//The list of values for the label
	Values []string `json:"values,omitempty"`
}

type OfferingItem 

type OfferingItem struct {
	//The ID of the service offering.
	Id string `json:"id,omitempty"`
	//Whether the service offering is ready to be advertised.
	Ready bool `json:"ready,omitempty"`
	//The name of the service offering.
	Name string `json:"name,omitempty"`
	//The description of the service offering.
	Description string `json:"description,omitempty"`
	//Whether the service offering is bindable.
	Bindable bool `json:"bindable,omitempty"`
	//Whether the service instances associated with the service offering can be retrieved.
	InstancesRetrievable bool `json:"instances_retrievable,omitempty"`
	//Whether the bindings associated with the service offering can be retrieved.
	BindingsRetrievable bool `json:"bindings_retrievable,omitempty"`
	//Whether the offered plan can be updated.
	PlanUpdateable bool `json:"plan_updateable,omitempty"`
	//Whether the context for the service offering can be updated.
	AllowContextUpdates bool `json:"allow_context_updates,omitempty"`
	//The list of tags for the service offering.
	Tags     []string         `json:"tags,omitempty"`
	Metadata OfferingMetadata `json:"metadata,omitempty"`
	//The ID of the broker that provides the service plan.
	BrokerId string `json:"broker_id,omitempty"`
	//The ID of the service offering as provided by the catalog.
	CatalogId string `json:"catalog_id,omitempty"`
	//The catalog name of the service offering.
	CatalogName string `json:"catalog_name,omitempty"`
	//The time the service offering was created.
	//In ISO 8601 format:
	//	YYYY-MM-DDThh:mm:ssTZD
	CreatedAt string `json:"created_at,omitempty"`
	//The last time the service offering was updated.
	//In ISO 8601 format.
	UpdatedAt string `json:"updated_at,omitempty"`
}

type OfferingMetadata 

type OfferingMetadata struct {
	//The description of the service offering.
	LongDescription string `json:"longDescription,omitempty"`
	//The URL to the associated documentation.
	DocumentationUrl string `json:"documentationUrl,omitempty"`
	//The name of the service offering for customer-facing UIs.
	DisplayName string `json:"displayName,omitempty"`
	//The URL to the associated image.
	ImageUrl string `json:"imageUrl,omitempty"`
	//The support URL for the service offering.
	SupportUrl string `json:"supportUrl,omitempty"`
}

type Operation 

type Operation struct {
	//The ID of the operation.
	Id string `json:"id,omitempty"`

	//Whether the resource is ready.
	Ready bool `json:"ready,omitempty"`

	//The type of the operation.
	//Possible values:
	//Enum:
	//	[ CREATE, UPDATE, DELETE ]
	Type string `json:"type,omitempty"`

	//Valid values are: in progress, succeeded, and failed.
	//While the state is "in progress", the platform should continue polling.
	//The responses: "state": "succeeded" or "state": "failed" must cause the platform to stop polling.
	//Enum:
	//	[ in progress, succeeded, failed ]
	State string `json:"state,omitempty"`

	//Details about the operation for customer-facing UI.
	Description string `json:"description,omitempty"`

	//The ID of the resource.
	//Exists if: "state": "succeeded", and also for PATCH and DELETE requests
	ResourceId string `json:"resource_id,omitempty"`

	TransitiveResources []TransitiveResource `json:"transitive_resources,omitempty"`

	//The type of the resource (e.g. service_brokers, service_instances).
	ResourceType string `json:"resource_type,omitempty"`

	//The ID of the platform associated with the operation.
	PlatformId string `json:"platform_id,omitempty"`

	//The correlation ID received from the request related to this operation.
	CorrelationId string `json:"correlation_id,omitempty"`

	//Whether the operation has reached a checkpoint and can be executed again.
	Reschedule bool `json:"reschedule,omitempty"`

	//The time the resource is scheduled for deletion.
	//In ISO 8601 format:
	//	YYYY-MM-DDThh:mm:ssTZD
	DeletionScheduled string `json:"deletion_scheduled,omitempty"`

	//The time the resource was created.
	//In ISO 8601 format.
	CreatedAt string `json:"created_at,omitempty"`

	//The last time the resource was updated.
	//In ISO 8601 format.
	//Recommended field if "state": "succeeded" or "state": "failed".
	UpdatedAt string `json:"updated_at,omitempty"`

	//The list of the errors if the operation has failed.
	Errors []Error `json:"errors,omitempty"`

	//Additional data associated with the resource entity.
	Labels map[string][]string `json:"labels,omitempty"`
}

type PlanItem 

type PlanItem struct {
	//The ID of the service plan.
	Id string `json:"id,omitempty"`
	//Whether the service plan is ready.
	Ready bool `json:"ready,omitempty"`
	//The name of the service plan.
	Name string `json:"name,omitempty"`
	//The description of the service plan.
	Description string `json:"description,omitempty"`
	//The ID of the service plan in the service broker catalog.
	CatalogId string `json:"catalog_id,omitempty"`
	//The name of the associated service broker catalog.
	CatalogName string `json:"catalog_name,omitempty"`
	//Whether the service plan is free.
	Free bool `json:"free,omitempty"`
	//Whether the service plan is bindable.
	Bindable bool         `json:"bindable,omitempty"`
	Metadata PlanMetadata `json:"metadata,omitempty"`
	//The ID of the service offering.
	ServiceOfferingId string `json:"service_offering_id,omitempty"`
	//The time the service plan was created.
	//In ISO 8601 format:
	//	YYYY-MM-DDThh:mm:ssTZD
	CreatedAt string `json:"created_at,omitempty"`
	//The last time the service plan was updated.
	//In ISO 8601 format.
	UpdatedAt string `json:"updated_at,omitempty"`
}

type PlanMetadata 

type PlanMetadata struct {
	//Platforms supported by the service plan.
	//Enum:
	//	[ kubernetes, cloudfoundry ]
	SupportedPlatforms []string `json:"supportedPlatforms,omitempty"`
	//The earliest supported OSB version.
	SupportedMinOSBVersion string `json:"supportedMinOSBVersion,omitempty"`
	//The latest supported OSB version.
	SupportedMaxOSBVersion string `json:"supportedMaxOSBVersion,omitempty"`
}

type PlatformItem 

type PlatformItem struct {
	//The ID of the platform.
	//You can use this ID to get details about the platform, to update or to delete it.
	//See the GET, PATCH, or DELETE APIs for the Platforms group.
	Id string `json:"id,omitempty"`

	//Whether the platform is ready for consumption.
	Ready bool `json:"ready,omitempty"`

	//The type of the platform.
	//Possible values:
	//Enum:
	//	[ kubernetes, cloud foundry ]
	Type string `json:"type,omitempty"`

	//The name of the platform.
	Name string `json:"name,omitempty"`

	//The description of the platform.
	Description string `json:"description,omitempty"`

	//The time the platform was created.
	//In ISO 8601 format:
	//	YYYY-MM-DDThh:mm:ssTZD
	CreatedAt string `json:"created_at,omitempty"`

	//The last time the platform was updated.
	//In ISO 8601 format.
	UpdatedAt string `json:"updated_at,omitempty"`

	//Additional data associated with the resource entity.
	Labels map[string][]string `json:"labels,omitempty"`
}

type ServiceManagementV1 

type ServiceManagementV1 struct {
	*service.Requester
}

func New 

func New(p service.RequesterConfig) *ServiceManagementV1

func (*ServiceManagementV1) CreatePlatform added in v0.0.38 

func (c *ServiceManagementV1) CreatePlatform(ctx context.Context,
	input *CreatePlatformInput) (*CreatePlatformOutput, error)

func (*ServiceManagementV1) CreateServiceBinding 

func (c *ServiceManagementV1) CreateServiceBinding(ctx context.Context,
	input *CreateServiceBindingInput) (*CreateServiceBindingOutput, error)

func (*ServiceManagementV1) CreateServiceInstance 

func (c *ServiceManagementV1) CreateServiceInstance(ctx context.Context,
	input *CreateServiceInstanceInput) (*CreateServiceInstanceOutput, error)

func (*ServiceManagementV1) DeletePlatform added in v0.0.38 

func (c *ServiceManagementV1) DeletePlatform(ctx context.Context,
	input *DeletePlatformInput) (*DeletePlatformOutput, error)

func (*ServiceManagementV1) DeleteServiceBinding 

func (c *ServiceManagementV1) DeleteServiceBinding(ctx context.Context,
	input *DeleteServiceBindingInput) (*DeleteServiceBindingOutput, error)

func (*ServiceManagementV1) DeleteServiceInstance 

func (c *ServiceManagementV1) DeleteServiceInstance(ctx context.Context,
	input *DeleteServiceInstanceInput) (*DeleteServiceInstanceOutput, error)

func (*ServiceManagementV1) GetOperationStatus 

func (c *ServiceManagementV1) GetOperationStatus(ctx context.Context,
	input *GetOperationStatusInput) (*GetOperationStatusOutput, error)

func (*ServiceManagementV1) GetPlatform added in v0.0.38 

func (c *ServiceManagementV1) GetPlatform(ctx context.Context,
	input *GetPlatformInput) (*GetPlatformOutput, error)

func (*ServiceManagementV1) GetPlatforms 

func (c *ServiceManagementV1) GetPlatforms(ctx context.Context, input *GetPlatformsInput) (*GetPlatformsOutput, error)

func (*ServiceManagementV1) GetServiceBinding added in v0.0.38 

func (c *ServiceManagementV1) GetServiceBinding(ctx context.Context,
	input *GetServiceBindingInput) (*GetServiceBindingOutput, error)

func (*ServiceManagementV1) GetServiceBindingParameters 

func (c *ServiceManagementV1) GetServiceBindingParameters(ctx context.Context,
	input *GetServiceBindingParametersInput) (*GetServiceBindingParametersOutput, error)

func (*ServiceManagementV1) GetServiceBindings 

func (c *ServiceManagementV1) GetServiceBindings(ctx context.Context,
	input *GetServiceBindingsInput) (*GetServiceBindingsOutput, error)

func (*ServiceManagementV1) GetServiceBroker added in v0.0.38 

func (c *ServiceManagementV1) GetServiceBroker(ctx context.Context,
	input *GetServiceBrokerInput) (*GetServiceBrokerOutput, error)

func (*ServiceManagementV1) GetServiceBrokers 

func (c *ServiceManagementV1) GetServiceBrokers(ctx context.Context,
	input *GetServiceBrokersInput) (*GetServiceBrokersOutput, error)

func (*ServiceManagementV1) GetServiceInstance added in v0.0.37 

func (c *ServiceManagementV1) GetServiceInstance(ctx context.Context,
	input *GetServiceInstanceInput) (*GetServiceInstanceOutput, error)

func (*ServiceManagementV1) GetServiceInstanceParameters 

func (c *ServiceManagementV1) GetServiceInstanceParameters(ctx context.Context,
	input *GetServiceInstanceParametersInput) (*GetServiceInstanceParametersOutput, error)

func (*ServiceManagementV1) GetServiceInstances 

func (c *ServiceManagementV1) GetServiceInstances(ctx context.Context,
	input *GetServiceInstancesInput) (*GetServiceInstancesOutput, error)

func (*ServiceManagementV1) GetServiceOffering added in v0.0.38 

func (c *ServiceManagementV1) GetServiceOffering(ctx context.Context,
	input *GetServiceOfferingInput) (*GetServiceOfferingOutput, error)

func (*ServiceManagementV1) GetServiceOfferings 

func (c *ServiceManagementV1) GetServiceOfferings(ctx context.Context,
	input *GetServiceOfferingsInput) (*GetServiceOfferingsOutput, error)

func (*ServiceManagementV1) GetServicePlan added in v0.0.38 

func (c *ServiceManagementV1) GetServicePlan(ctx context.Context,
	input *GetServicePlanInput) (*GetServicePlanOutput, error)

func (*ServiceManagementV1) GetServicePlans 

func (c *ServiceManagementV1) GetServicePlans(ctx context.Context,
	input *GetServicePlansInput) (*GetServicePlansOutput, error)

func (*ServiceManagementV1) UpdatePlatform 

func (c *ServiceManagementV1) UpdatePlatform(ctx context.Context,
	input *UpdatePlatformInput) (*UpdatePlatformOutput, error)

func (*ServiceManagementV1) UpdateServiceInstance 

func (c *ServiceManagementV1) UpdateServiceInstance(ctx context.Context,
	input *UpdateServiceInstanceInput) (*UpdateServiceInstanceOutput, error)

type TransitiveResource 

type TransitiveResource struct {
	//The ID of the resource.
	Id string `json:"id,omitempty"`

	//The type of the resource.
	Type string `json:"type,omitempty"`

	//The type of the operation associated with the resource.
	OperationType string `json:"operation_type,omitempty"`

	//The minimum criteria required to use the resource in the context of the platform.
	Criteria string `json:"criteria,omitempty"`
}

type UpdatePlatformInput 

type UpdatePlatformInput struct {
	//The ID of the registered platform to update.
	PlatformID string `dest:"uri" dest-name:"platformID"`

	//The ID of the platform to update.
	//Platform ID is a globally unique identifier (GUID).
	//GUID must be longer than 50 characters and only contains uppercase and lowercase letters, decimal digits, hyphens, periods, and underscores.
	Id string `json:"id,omitempty"`

	//The CLI-friendly name of the platform to update.
	//A CLI-friendly name is a short string that only contains alphanumeric characters, periods, and hyphens.
	//It can't contain white spaces.
	//The name must not exceed 255 characters, but it is recommended to keep it much shorter, for the convenience of using short names in CLI commands.
	Name string `json:"name,omitempty"`

	//The type of the platform.
	//Possible values:
	//Enum:
	//	[ kubernetes ]
	Type string `json:"type,omitempty"`

	//The description of the platform for customer-facing UIs.
	Description string `json:"description,omitempty"`

	//The list of labels to update for the resource.
	Labels []Label `json:"labels,omitempty"`
}

PATCH /v1/platforms/{platformID} Update a platform

type UpdatePlatformOutput 

type UpdatePlatformOutput struct {
	//The ID of the platform to update.
	//Platform ID is a globally unique identifier (GUID).
	//GUID must be longer than 50 characters and only contains uppercase and lowercase letters, decimal digits, hyphens, periods, and underscores.
	Id string `json:"id,omitempty"`

	//Whether the resource is ready for consumption.
	Ready string `json:"ready,omitempty"`

	//The type of the platform.
	//Possible values:
	//Enum:
	//	[ kubernetes ]
	Type string `json:"type,omitempty"`

	//The technical name of the platform.
	Name string `json:"name,omitempty"`

	//The description of the platform for customer-facing UIs.
	Description string `json:"description,omitempty"`

	//The time the platform was created.
	//In ISO 8601 format:
	//	YYYY-MM-DDThh:mm:ssTZD
	CreatedAt string `json:"created_at,omitempty"`

	//The last time the platform was updated.
	//In ISO 8601 format.
	UpdatedAt string `json:"updated_at,omitempty"`

	//The list of labels to update for the resource.
	Labels map[string][]string `json:"labels,omitempty"`

	Error
	types.StatusAndBodyFromResponse
}

type UpdateServiceInstanceInput 

type UpdateServiceInstanceInput struct {
	//The ID of the provisioned service instance to update.
	ServiceInstanceID string `dest:"uri" dest-name:"serviceInstanceID"`
	//Whether to perform this operation asynchronously.
	Async bool `dest:"querystring" dest-name:"async"`

	//The name of the service instance to update.
	Name string `json:"name,omitempty"`
	//The ID of the service plan for the service instance to update.
	ServicePlanId string `json:"service_plan_id,omitempty"`
	//Some services support providing of additional configuration parameters during instance creation.
	//You can update these parameters.
	//For the list of supported configuration parameters, see the documentation of a particular service offering.
	//You can also use the GET /v1/service_instances/{serviceInstanceID}/parameters API later to view the parameters
	//defined during this step
	Parameters map[string]string `json:"parameters,omitempty"`
	//The list of labels to update for the resource.
	Labels map[string][]string `json:"labels,omitempty"`
}

PATCH /v1/service_instances/{serviceInstanceID} Update a service instance

type UpdateServiceInstanceOutput 

type UpdateServiceInstanceOutput struct {
	Error
	types.StatusAndBodyFromResponse
}

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.