btpprovisioning

package
v0.0.44 Latest Latest
Warning

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

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

Documentation

Index

Constants

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

Variables

This section is empty.

Functions

This section is empty.

Types

type AvailableEnvironment 

type AvailableEnvironment struct {
	//The availability level of the environment broker.
	AvailabilityLevel string `json:"availabilityLevel,omitempty"`
	//The create schema of the environment broker.
	CreateSchema string `json:"createSchema,omitempty"`
	//Description of the service plan for the available environment.
	Description string `json:"description,omitempty"`
	//The type of environment that is available (for example: cloudfoundry).
	EnvironmentType string `json:"environmentType,omitempty"`
	//The landscape label of the environment broker.
	LandscapeLabel string `json:"landscapeLabel,omitempty"`
	//Name of the service plan for the available environment.
	PlanName string `json:"planName,omitempty"`
	//Specifies if the consumer can change the plan of an existing instance of the environment.
	PlanUpdatable bool `json:"planUpdatable,omitempty"`
	//The description of the service.
	ServiceDescription string `json:"serviceDescription,omitempty"`
	//The display name of the service.
	ServiceDisplayName string `json:"serviceDisplayName,omitempty"`
	//The URL of the documentation link for the service.
	ServiceDocumentationUrl string `json:"serviceDocumentationUrl,omitempty"`
	//The URL of the image for the service.
	ServiceImageUrl string `json:"serviceImageUrl,omitempty"`
	//The long description of the service.
	ServiceLongDescription string `json:"serviceLongDescription,omitempty"`
	//Name of the service offered in the catalog of the corresponding environment broker (for example, cloudfoundry).
	ServiceName string `json:"serviceName,omitempty"`
	//The URL of the support link for the service.
	ServiceSupportUrl string `json:"serviceSupportUrl,omitempty"`
	//Technical key of the corresponding environment broker.
	TechnicalKey string `json:"technicalKey,omitempty"`
	//The update schema of the environment broker.
	UpdateSchema string `json:"updateSchema,omitempty"`
}

type CreateEnvironmentInstanceInput added in v0.0.26 

type CreateEnvironmentInstanceInput struct {
	//The description of the environment instance.
	Description string `json:"description,omitempty"`
	//Type of the environment instance that is used. Must match the type of the environment instance broker
	//(for example: cloudfoundry). Use GET /provisioning/v1/availableEnvironments to view the valid values.
	EnvironmentType string `json:"environmentType,omitempty"`
	//The name of the landscape within the logged-in region on which to create the environment instance. Only required
	//only if the region has multiple landscapes. To see which landscapes are available for this environment, use the
	//GET /provisioning/v1/availableEnvironments API.
	LandscapeLabel string `json:"landscapeLabel,omitempty"`
	//The name of the created environment instance.
	Name string `json:"name,omitempty"`
	//The origin of the user in case of a custom IdP configuration. This parameter is only required if the
	//OAuth 2.0 client credentials grant flow is used, a user parameter is provided and the target environment supports
	//custom IdP, otherwise it is ignored.
	Origin string `json:"origin,omitempty"`

	//If needed, you can pass environment-specific configuration parameters using a valid embedded JSON object.
	//For a list of supported configuration parameters, see the documentation of the particular environment offering.
	//In this example, additional configuration parameters 'id' and 'email' are specified:
	//{
	//"instance_name": "myOrg"
	//}
	Parameters map[string]interface{} `json:"parameters,omitempty"`
	//Name of the service plan for the environment instance. Must match the name in the corresponding service broker's
	//catalog. (for example: standard)
	PlanName string `json:"planName,omitempty"`
	//The name of service offered in the catalog of the corresponding environment broker. (for example: cloudfoundry)
	ServiceName string `json:"serviceName,omitempty"`
	//Technical key of the corresponding environment broker.
	TechnicalKey string `json:"technicalKey,omitempty"`
	//The e-mail of the user that owns the environment instance. In some environments, this user might be assigned as
	//the initial admin of the provisioned environment. For example, for a Cloud Foundry environment, this user is
	//assigned to the Org Manager role. This parameter is required only when OAuth 2.0 client credentials grant flow
	//is used, otherwise it is ignored.
	User string `json:"user,omitempty"`
}

POST /provisioning/v1/environments Create environment instance

type CreateEnvironmentInstancesOutput 

type CreateEnvironmentInstancesOutput struct {
	//ID of the created environment instance
	Id string `json:"id,omitempty"`

	Error *types.Error `json:"error,omitempty"`
	types.StatusAndBodyFromResponse
}

type DeleteEnvironmentInstanceInput 

type DeleteEnvironmentInstanceInput struct {
	//ID of the environment instance to delete
	EnvironmentInstanceId string `dest:"uri" dest-name:"environmentInstanceId"`
}

DELETE /provisioning/v1/environments/{environmentInstanceId} Delete an environment instance

type DeleteEnvironmentInstanceOutput 

type DeleteEnvironmentInstanceOutput struct {
	EnvironmentInstance

	Error *types.Error `json:"error,omitempty"`
	types.StatusAndBodyFromResponse
}

type DeleteEnvironmentInstancesInput 

type DeleteEnvironmentInstancesInput struct {
}

DELETE /provisioning/v1/environments Delete all environment instances

type DeleteEnvironmentInstancesOutput 

type DeleteEnvironmentInstancesOutput struct {
	//The list of all the environment instances to delete
	Environments []EnvironmentInstance `json:"environmentInstances,omitempty"`

	Error *types.Error `json:"error,omitempty"`
	types.StatusAndBodyFromResponse
}

type EnvironmentInstance 

type EnvironmentInstance struct {
	//The ID of the associated environment broker.
	BrokerId string `json:"brokerId,omitempty"`
	//The commercial type of the environment broker.
	CommercialType string `json:"commercialType,omitempty"`
	//The date the environment instance was created. Dates and times are in UTC format.
	CreatedDate int64 `json:"createdDate,omitempty"`
	//The URL of the service dashboard, which is a web-based management user interface for the service instances.
	DashboardUrl string `json:"dashboardUrl,omitempty"`
	//The description of the environment instance.
	Description string `json:"description,omitempty"`
	//Type of the environment instance that is used.
	//Enum:
	//	[ cloudfoundry, kubernetes, neo ]
	EnvironmentType string `json:"environmentType,omitempty"`
	//The GUID of the global account that is associated with the environment instance.
	GlobalAccountGuid string `json:"globalAccountGUID,omitempty"`
	//Automatically generated unique identifier for the environment instance.
	Id string `json:"id,omitempty"`
	//Broker-specified key-value pairs that specify attributes of a service instance.
	Labels string `json:"labels,omitempty"`
	//The name of the landscape within the logged-in region on which the environment instance is created.
	LandscapeLabel string `json:"landscapeLabel,omitempty"`
	//The last date the environment instance was last modified. Dates and times are in UTC format.
	ModifiedDate int64 `json:"modifiedDate,omitempty"`
	//Name of the environment instance.
	Name string `json:"name,omitempty"`
	//An identifier that represents the last operation. This ID is returned by the environment brokers.
	Operation string `json:"operation,omitempty"`
	//Configuration parameters for the environment instance.
	Parameters string `json:"parameters,omitempty"`
	//ID of the service plan for the environment instance in the corresponding service broker's catalog.
	PlanId string `json:"planId,omitempty"`
	//Name of the service plan for the environment instance in the corresponding service broker's catalog.
	PlanName string `json:"planName,omitempty"`
	//ID of the platform for the environment instance in the corresponding service broker's catalog.
	PlatformId string `json:"platformId,omitempty"`
	//ID of the service for the environment instance in the corresponding service broker's catalog.
	ServiceId string `json:"serviceId,omitempty"`
	//Name of the service for the environment instance in the corresponding service broker's catalog.
	ServiceName string `json:"serviceName,omitempty"`
	//Current state of the environment instance.
	//Enum:
	//	[ CREATING, UPDATING, DELETING, OK, CREATION_FAILED, DELETION_FAILED, UPDATE_FAILED ]
	State string `json:"state,omitempty"`
	//Information about the current state of the environment instance.
	StateMessage string `json:"stateMessage,omitempty"`
	//The GUID of the subaccount associated with the environment instance.
	SubAccountGuid string `json:"subaccountGUID,omitempty"`
	//The ID of the tenant that owns the environment instance.
	TenantId string `json:"tenantId,omitempty"`
	//The last provisioning operation on the environment instance.
	//Provision: Environment instance created.
	//Update: Environment instance changed.
	//Deprovision: Environment instance deleted.
	//Enum:
	//	[ Provision, Update, Deprovision ]
	Type string `json:"type,omitempty"`
}

type GetAvailableEnvironmentsInput 

type GetAvailableEnvironmentsInput struct {
	//Security token that contains authentication declarations of an end user by the authorization server
	//(SAP Identity and Authentication Service).
	XIDToken string `dest:"header" dest-name:"X-ID-Token"`
}

GET /provisioning/v1/availableEnvironments Get available environments

type GetAvailableEnvironmentsOutput 

type GetAvailableEnvironmentsOutput struct {
	Environments []AvailableEnvironment `json:"availableEnvironments,omitempty"`

	Error *types.Error `json:"error,omitempty"`
	types.StatusAndBodyFromResponse
}

type GetEnvironmentInstanceInput 

type GetEnvironmentInstanceInput struct {
	//The ID of the environment instance to view.
	EnvironmentInstanceId string `dest:"uri" dest-name:"environmentInstanceId"`
}

GET /provisioning/v1/environments/{environmentInstanceId} Get an environment instance

type GetEnvironmentInstanceOutput 

type GetEnvironmentInstanceOutput struct {
	EnvironmentInstance

	Error *types.Error `json:"error,omitempty"`
	types.StatusAndBodyFromResponse
}

type GetEnvironmentInstancesInput 

type GetEnvironmentInstancesInput struct {
	//Security token that contains authentication declarations of an end user by the authorization server
	//(SAP Identity and Authentication Service).
	XIDToken string `dest:"header" dest-name:"X-ID-Token"`
}

GET /provisioning/v1/environments Get environment instances

type GetEnvironmentInstancesOutput 

type GetEnvironmentInstancesOutput struct {
	//The list of all the environment instances to delete
	Environments []EnvironmentInstance `json:"environmentInstances,omitempty"`

	Error *types.Error `json:"error,omitempty"`
	types.StatusAndBodyFromResponse
}

type GetJobStatusInput 

type GetJobStatusInput struct {
	//ID of the job for which to get status
	JobId string `dest:"uri" dest-name:"jobInstanceIdOrUniqueId"`
}

GET /jobs-management/v1/jobs/{jobInstanceIdOrUniqueId}/status Get available jobs

type GetJobStatusOutput 

type GetJobStatusOutput struct {
	//A description of the exit status of a job when it ends.
	Description string `json:"description,omitempty"`

	//The current state of the job.
	//
	//IN_PROGRESS: The job is being executed.
	//COMPLETED: The job has completed.
	//FAILED: The job failed and did not complete. The job can be restarted.
	//Enum:
	//	[ IN_PROGRESS, COMPLETED, FAILED ]
	Status string `json:"status,omitempty"`

	Error *types.Error `json:"error,omitempty"`
	types.StatusAndBodyFromResponse
}

type GetServicePlanAssignmentsInput 

type GetServicePlanAssignmentsInput struct {
}

GET /provisioning/v1/servicePlanAssignments Get subaccount quota assignments

type GetServicePlanAssignmentsOutput 

type GetServicePlanAssignmentsOutput struct {
	Quotas []ServicePlanQuotaAssignment `json:"quotas,omitempty"`

	Error *types.Error `json:"error,omitempty"`
	types.StatusAndBodyFromResponse
}

type ProvisioningV1 

type ProvisioningV1 struct {
	*service.Requester
}

func New 

func New(p service.RequesterConfig) *ProvisioningV1

func (*ProvisioningV1) CreateEnvironmentInstance added in v0.0.26 

func (c *ProvisioningV1) CreateEnvironmentInstance(ctx context.Context,
	input *CreateEnvironmentInstanceInput) (*CreateEnvironmentInstancesOutput, error)

func (*ProvisioningV1) DeleteEnvironmentInstance 

func (c *ProvisioningV1) DeleteEnvironmentInstance(ctx context.Context,
	input *DeleteEnvironmentInstanceInput) (*DeleteEnvironmentInstanceOutput, error)

func (*ProvisioningV1) DeleteEnvironmentInstances 

func (c *ProvisioningV1) DeleteEnvironmentInstances(ctx context.Context,
	input *DeleteEnvironmentInstancesInput) (*DeleteEnvironmentInstancesOutput, error)

func (*ProvisioningV1) GetAvailableEnvironments 

func (c *ProvisioningV1) GetAvailableEnvironments(ctx context.Context) (*GetAvailableEnvironmentsOutput, error)

func (*ProvisioningV1) GetEnvironmentInstance 

func (c *ProvisioningV1) GetEnvironmentInstance(ctx context.Context,
	input *GetEnvironmentInstanceInput) (*GetEnvironmentInstanceOutput, error)

func (*ProvisioningV1) GetEnvironmentInstances 

func (c *ProvisioningV1) GetEnvironmentInstances(ctx context.Context) (*GetEnvironmentInstancesOutput, error)

func (*ProvisioningV1) GetJobStatus 

func (c *ProvisioningV1) GetJobStatus(ctx context.Context, input *GetJobStatusInput) (*GetJobStatusOutput, error)

func (*ProvisioningV1) GetServicePlanQuotaAssignments 

func (c *ProvisioningV1) GetServicePlanQuotaAssignments(ctx context.Context) (*GetServicePlanAssignmentsOutput, error)

func (*ProvisioningV1) UpdateEnvironmentInstance 

func (c *ProvisioningV1) UpdateEnvironmentInstance(ctx context.Context,
	input *UpdateEnvironmentInstanceInput) (*UpdateEnvironmentInstanceOutput, error)

type Resource 

type Resource struct {
	//any relevant information about the resource that is not provided by other parameter values.
	AdditionalInfo interface{} `json:"additionalInfo,omitempty"`
	//Description of the resource.
	Description string `json:"description,omitempty"`
	//Descriptive name of the resource for customer-facing UIs.
	DisplayName string `json:"displayName,omitempty"`
	//Data associated with the resource.
	Data interface{} `json:"resourceData,omitempty"`
	//Provider of the requested resource. For example, IaaS provider: AWS.
	Provider string `json:"resourceProvider,omitempty"`
	//Unique technical name of the resource.
	TechnicalName string `json:"resourceTechnicalName,omitempty"`
	//Type of the resource.
	Type string `json:"resourceType,omitempty"`
}

type ServicePlanQuotaAssignment 

type ServicePlanQuotaAssignment struct {
	//The quantity of consumed quota. The service owner can provide a value for the consumed quota if it is different
	//from the provisioned quota calculation.
	ConsumedQuota []string `json:"consumedQuota,omitempty"`
	//Unique ID of the global account associated with the subaccount.
	GlobalAccountGuid string `json:"globalAccountGUID,omitempty"`
	//The ID of the associated global account.
	GlobalAccountId string `json:"globalAccountId,omitempty"`
	//The name of the plan of the provisioned quota.
	Plan string `json:"plan,omitempty"`
	//Enum:
	//	[ SERVICE_BROKER, NONE_REQUIRED, COMMERCIAL_SOLUTION_SCRIPT, GLOBAL_COMMERCIAL_SOLUTION_SCRIPT,
	//	GLOBAL_QUOTA_DOMAIN_DB ]
	ProvisioningMethod string `json:"provisioningMethod,omitempty"`
	//The quantity of provisioned quota.
	Quota     int32      `json:"quota,omitempty"`
	Resources []Resource `json:"resources,omitempty"`
	//The name of the service of the provisioned quota.
	Service string `json:"service,omitempty"`
	//Enum:
	//	[ PLATFORM, SERVICE, ELASTIC_SERVICE, ELASTIC_LIMITED, APPLICATION, QUOTA_BASED_APPLICATION, ENVIRONMENT ]
	ServiceCategory string `json:"serviceCategory,omitempty"`
	//Unique ID of the subaccount for which to get quota.
	SubAccountGuid string `json:"subaccountGUID,omitempty"`
	//The ID of the tenant for the subaccount.
	TenantId string `json:"tenantId,omitempty"`
	//Whether an unlimited quantity of quota can be provisioned.
	Unlimited bool `json:"unlimited,omitempty"`
}

type UpdateEnvironmentInstanceInput 

type UpdateEnvironmentInstanceInput struct {
	//ID of the environment instance to delete
	EnvironmentInstanceId string `dest:"uri" dest-name:"environmentInstanceId"`

	//Name of the service plan for the environment instance. Must match the name in the corresponding service broker's
	//catalog. (for example: Subscription)
	PlanName string `json:"planName,omitempty"`
	//If needed, you can pass environment-specific configuration parameters using a valid embedded JSON object.
	//For a list of supported configuration parameters, see the documentation of the particular environment offering.
	//In this example, additional configuration parameter 'instance_name' is specified:
	//{
	//"instance_name": "myOrg"
	//}
	Parameters map[string]interface{} `json:"parameters,omitempty"`
}

PATCH /provisioning/v1/environments/{environmentInstanceId} Update an environment instance

type UpdateEnvironmentInstanceOutput 

type UpdateEnvironmentInstanceOutput struct {
	EnvironmentInstance

	Error *types.Error `json:"error,omitempty"`
	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.