projectv1

package
v1.5.0 Latest Latest
Warning

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

 Go to latest Published: Apr 6, 2023 License: Apache-2.0 Imports: 9 Imported by: 0

Documentation

Overview

Package projectv1 : Operations and models for the ProjectV1 service

Index

Constants

View Source 
const (
	GetSchematicsJobOptions_Action_Install   = "install"
	GetSchematicsJobOptions_Action_Plan      = "plan"
	GetSchematicsJobOptions_Action_Uninstall = "uninstall"
)

Constants associated with the GetSchematicsJobOptions.Action property. The triggered action.

View Source 
const (
	InputVariable_Type_Array    = "array"
	InputVariable_Type_Boolean  = "boolean"
	InputVariable_Type_Float    = "float"
	InputVariable_Type_Int      = "int"
	InputVariable_Type_Number   = "number"
	InputVariable_Type_Object   = "object"
	InputVariable_Type_Password = "password"
	InputVariable_Type_String   = "string"
)

Constants associated with the InputVariable.Type property. The variable type.

View Source 
const (
	JSONPatchOperation_Op_Add     = "add"
	JSONPatchOperation_Op_Copy    = "copy"
	JSONPatchOperation_Op_Move    = "move"
	JSONPatchOperation_Op_Remove  = "remove"
	JSONPatchOperation_Op_Replace = "replace"
	JSONPatchOperation_Op_Test    = "test"
)

Constants associated with the JSONPatchOperation.Op property. The operation to be performed.

View Source 
const (
	ListConfigsOptions_Version_Active = "active"
	ListConfigsOptions_Version_Draft  = "draft"
	ListConfigsOptions_Version_Mixed  = "mixed"
)

Constants associated with the ListConfigsOptions.Version property. The version of configuration to return.

View Source 
const (
	ProjectConfig_Type_SchematicsBlueprint = "schematics_blueprint"
	ProjectConfig_Type_TerraformTemplate   = "terraform_template"
)

Constants associated with the ProjectConfig.Type property. The type of a project configuration manual property.

View Source 
const (
	ProjectConfigDiffInputVariable_Type_Array    = "array"
	ProjectConfigDiffInputVariable_Type_Boolean  = "boolean"
	ProjectConfigDiffInputVariable_Type_Float    = "float"
	ProjectConfigDiffInputVariable_Type_Int      = "int"
	ProjectConfigDiffInputVariable_Type_Number   = "number"
	ProjectConfigDiffInputVariable_Type_Object   = "object"
	ProjectConfigDiffInputVariable_Type_Password = "password"
	ProjectConfigDiffInputVariable_Type_String   = "string"
)

Constants associated with the ProjectConfigDiffInputVariable.Type property. The variable type.

View Source 
const DefaultServiceName = "project"

DefaultServiceName is the default key used to find external configuration information.

View Source 
const DefaultServiceURL = "https://projects.api.cloud.ibm.com"

DefaultServiceURL is the default URL to make service requests to.

Variables

This section is empty.

Functions

func GetServiceURLForRegion 

func GetServiceURLForRegion(region string) (string, error)

GetServiceURLForRegion returns the service URL to be used for the specified region

func UnmarshalActionJob added in v1.2.0 

func UnmarshalActionJob(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalActionJob unmarshals an instance of ActionJob from the specified map of raw messages.

func UnmarshalCatalogResponse 

func UnmarshalCatalogResponse(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalCatalogResponse unmarshals an instance of CatalogResponse from the specified map of raw messages.

func UnmarshalCatalogResponseServices 

func UnmarshalCatalogResponseServices(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalCatalogResponseServices unmarshals an instance of CatalogResponseServices from the specified map of raw messages.

func UnmarshalCatalogResponseServicesMetadata 

func UnmarshalCatalogResponseServicesMetadata(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalCatalogResponseServicesMetadata unmarshals an instance of CatalogResponseServicesMetadata from the specified map of raw messages.

func UnmarshalCatalogResponseServicesPlans 

func UnmarshalCatalogResponseServicesPlans(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalCatalogResponseServicesPlans unmarshals an instance of CatalogResponseServicesPlans from the specified map of raw messages.

func UnmarshalCatalogResponseServicesPlansMetadata 

func UnmarshalCatalogResponseServicesPlansMetadata(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalCatalogResponseServicesPlansMetadata unmarshals an instance of CatalogResponseServicesPlansMetadata from the specified map of raw messages.

func UnmarshalCostEstimate added in v1.2.0 

func UnmarshalCostEstimate(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalCostEstimate unmarshals an instance of CostEstimate from the specified map of raw messages.

func UnmarshalCumulativeNeedsAttention added in v1.0.2 

func UnmarshalCumulativeNeedsAttention(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalCumulativeNeedsAttention unmarshals an instance of CumulativeNeedsAttention from the specified map of raw messages.

func UnmarshalHealth 

func UnmarshalHealth(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalHealth unmarshals an instance of Health from the specified map of raw messages.

func UnmarshalInputVariable 

func UnmarshalInputVariable(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalInputVariable unmarshals an instance of InputVariable from the specified map of raw messages.

func UnmarshalJSONPatchOperation added in v0.88.0 

func UnmarshalJSONPatchOperation(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalJSONPatchOperation unmarshals an instance of JSONPatchOperation from the specified map of raw messages.

func UnmarshalNotificationEvent 

func UnmarshalNotificationEvent(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalNotificationEvent unmarshals an instance of NotificationEvent from the specified map of raw messages.

func UnmarshalNotificationEventWithID 

func UnmarshalNotificationEventWithID(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalNotificationEventWithID unmarshals an instance of NotificationEventWithID from the specified map of raw messages.

func UnmarshalNotificationEventWithStatus 

func UnmarshalNotificationEventWithStatus(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalNotificationEventWithStatus unmarshals an instance of NotificationEventWithStatus from the specified map of raw messages.

func UnmarshalNotificationsGetResponse added in v1.2.0 

func UnmarshalNotificationsGetResponse(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalNotificationsGetResponse unmarshals an instance of NotificationsGetResponse from the specified map of raw messages.

func UnmarshalNotificationsIntegrationGetResponse added in v1.2.0 

func UnmarshalNotificationsIntegrationGetResponse(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalNotificationsIntegrationGetResponse unmarshals an instance of NotificationsIntegrationGetResponse from the specified map of raw messages.

func UnmarshalNotificationsIntegrationPostResponse added in v1.2.0 

func UnmarshalNotificationsIntegrationPostResponse(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalNotificationsIntegrationPostResponse unmarshals an instance of NotificationsIntegrationPostResponse from the specified map of raw messages.

func UnmarshalNotificationsIntegrationTestPostResponse added in v1.2.0 

func UnmarshalNotificationsIntegrationTestPostResponse(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalNotificationsIntegrationTestPostResponse unmarshals an instance of NotificationsIntegrationTestPostResponse from the specified map of raw messages.

func UnmarshalNotificationsPrototypePostResponse added in v1.2.0 

func UnmarshalNotificationsPrototypePostResponse(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalNotificationsPrototypePostResponse unmarshals an instance of NotificationsPrototypePostResponse from the specified map of raw messages.

func UnmarshalOutputValue 

func UnmarshalOutputValue(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalOutputValue unmarshals an instance of OutputValue from the specified map of raw messages. 

func UnmarshalPaginationLink(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalPaginationLink unmarshals an instance of PaginationLink from the specified map of raw messages.

func UnmarshalProject added in v1.2.0 

func UnmarshalProject(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalProject unmarshals an instance of Project from the specified map of raw messages.

func UnmarshalProjectCRNTokenResponse added in v1.0.9 

func UnmarshalProjectCRNTokenResponse(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalProjectCRNTokenResponse unmarshals an instance of ProjectCRNTokenResponse from the specified map of raw messages.

func UnmarshalProjectCollection added in v1.2.0 

func UnmarshalProjectCollection(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalProjectCollection unmarshals an instance of ProjectCollection from the specified map of raw messages.

func UnmarshalProjectCollectionMemberWithMetadata added in v1.2.0 

func UnmarshalProjectCollectionMemberWithMetadata(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalProjectCollectionMemberWithMetadata unmarshals an instance of ProjectCollectionMemberWithMetadata from the specified map of raw messages.

func UnmarshalProjectConfig 

func UnmarshalProjectConfig(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalProjectConfig unmarshals an instance of ProjectConfig from the specified map of raw messages.

func UnmarshalProjectConfigCollection added in v1.2.0 

func UnmarshalProjectConfigCollection(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalProjectConfigCollection unmarshals an instance of ProjectConfigCollection from the specified map of raw messages.

func UnmarshalProjectConfigDelete added in v1.2.0 

func UnmarshalProjectConfigDelete(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalProjectConfigDelete unmarshals an instance of ProjectConfigDelete from the specified map of raw messages.

func UnmarshalProjectConfigDiff 

func UnmarshalProjectConfigDiff(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalProjectConfigDiff unmarshals an instance of ProjectConfigDiff from the specified map of raw messages.

func UnmarshalProjectConfigDiffAdded 

func UnmarshalProjectConfigDiffAdded(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalProjectConfigDiffAdded unmarshals an instance of ProjectConfigDiffAdded from the specified map of raw messages.

func UnmarshalProjectConfigDiffChanged 

func UnmarshalProjectConfigDiffChanged(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalProjectConfigDiffChanged unmarshals an instance of ProjectConfigDiffChanged from the specified map of raw messages.

func UnmarshalProjectConfigDiffInputVariable 

func UnmarshalProjectConfigDiffInputVariable(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalProjectConfigDiffInputVariable unmarshals an instance of ProjectConfigDiffInputVariable from the specified map of raw messages.

func UnmarshalProjectConfigDiffRemoved 

func UnmarshalProjectConfigDiffRemoved(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalProjectConfigDiffRemoved unmarshals an instance of ProjectConfigDiffRemoved from the specified map of raw messages.

func UnmarshalProjectConfigInputVariable added in v1.2.0 

func UnmarshalProjectConfigInputVariable(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalProjectConfigInputVariable unmarshals an instance of ProjectConfigInputVariable from the specified map of raw messages.

func UnmarshalProjectConfigPrototype added in v1.2.0 

func UnmarshalProjectConfigPrototype(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalProjectConfigPrototype unmarshals an instance of ProjectConfigPrototype from the specified map of raw messages.

func UnmarshalProjectConfigSettingCollection added in v1.2.0 

func UnmarshalProjectConfigSettingCollection(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalProjectConfigSettingCollection unmarshals an instance of ProjectConfigSettingCollection from the specified map of raw messages.

func UnmarshalProjectMetadata added in v0.88.0 

func UnmarshalProjectMetadata(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalProjectMetadata unmarshals an instance of ProjectMetadata from the specified map of raw messages.

func UnmarshalPulsarEventPrototypeCollection added in v1.2.0 

func UnmarshalPulsarEventPrototypeCollection(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalPulsarEventPrototypeCollection unmarshals an instance of PulsarEventPrototypeCollection from the specified map of raw messages.

func UnmarshalResourceCreateResponse added in v1.2.0 

func UnmarshalResourceCreateResponse(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalResourceCreateResponse unmarshals an instance of ResourceCreateResponse from the specified map of raw messages.

func UnmarshalResourceDeleteResponse added in v1.2.0 

func UnmarshalResourceDeleteResponse(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalResourceDeleteResponse unmarshals an instance of ResourceDeleteResponse from the specified map of raw messages.

func UnmarshalResourceLastOperationGetResponse added in v1.2.0 

func UnmarshalResourceLastOperationGetResponse(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalResourceLastOperationGetResponse unmarshals an instance of ResourceLastOperationGetResponse from the specified map of raw messages.

func UnmarshalResourceStateResponse added in v1.2.0 

func UnmarshalResourceStateResponse(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalResourceStateResponse unmarshals an instance of ResourceStateResponse from the specified map of raw messages.

func UnmarshalResourceUpdateResult added in v1.2.0 

func UnmarshalResourceUpdateResult(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalResourceUpdateResult unmarshals an instance of ResourceUpdateResult from the specified map of raw messages.

Types

type ActionJob added in v1.2.0 

type ActionJob struct {
	// The unique ID of a project.
	ID *string `json:"id,omitempty"`
}

ActionJob : The response of a fetching an action job.

type ApproveOptions added in v1.0.9 

type ApproveOptions struct {
	// The ID of the project, which uniquely identifies it.
	ID *string `json:"id" validate:"required,ne="`

	// The ID of the configuration, which uniquely identifies it.
	ConfigID *string `json:"config_id" validate:"required,ne="`

	// Notes on the project draft action.
	Comment *string `json:"comment,omitempty"`

	// The flag to determine if full metadata should be returned.
	Complete *bool `json:"complete,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

ApproveOptions : The Approve options.

func (*ApproveOptions) SetComment added in v1.0.9 

func (_options *ApproveOptions) SetComment(comment string) *ApproveOptions

SetComment : Allow user to set Comment

func (*ApproveOptions) SetComplete added in v1.0.9 

func (_options *ApproveOptions) SetComplete(complete bool) *ApproveOptions

SetComplete : Allow user to set Complete

func (*ApproveOptions) SetConfigID added in v1.0.9 

func (_options *ApproveOptions) SetConfigID(configID string) *ApproveOptions

SetConfigID : Allow user to set ConfigID

func (*ApproveOptions) SetHeaders added in v1.0.9 

func (options *ApproveOptions) SetHeaders(param map[string]string) *ApproveOptions

SetHeaders : Allow user to set Headers

func (*ApproveOptions) SetID added in v1.0.9 

func (_options *ApproveOptions) SetID(id string) *ApproveOptions

SetID : Allow user to set ID

type CatalogResponse 

type CatalogResponse struct {
	// The collection of catalog services.
	Services []CatalogResponseServices `json:"services,omitempty"`
}

CatalogResponse : Response from fetching the catalog metadata stored within the broker.

type CatalogResponseServices 

type CatalogResponseServices struct {
	// Specifies if your service can be bound to applications in IBM Cloud. If a service is bindable, it must be able to
	// return API endpoints and credentials to your service users.
	Bindable *bool `json:"bindable,omitempty"`

	// A short description of the service. It must be a non-empty string. This description is not displayed by the IBM
	// Cloud console or the IBM Cloud CLI.
	Description *string `json:"description,omitempty"`

	// An identifier used to correlate this service in future requests to the broker. This must be globally unique within
	// the IBM Cloud platform. It must be a non-empty string, and using a GUID is recommended. If you define your service
	// in the Resource Management Console, RMC generates a globally unique GUID service ID that you can use in your service
	// broker.".
	ID *string `json:"id,omitempty"`

	// The catalog service metadata.
	Metadata *CatalogResponseServicesMetadata `json:"metadata,omitempty"`

	// This service name isn't your display name. Your service name must meet the following criteria: It must be all
	// lowercase. It can't include spaces but can include hyphens (-). It must be less than 32 characters. Your service
	// name should include your company name. If your company has more then one offering, your service name should include
	// both the company and offering as part of the name. For example, the Compose company has offerings for Redis and
	// Elasticsearch. Sample service names on IBM Cloud for these offerings would be 'compose-redis' and
	// 'compose-elasticsearch'. Both service names have associated display names that are shown in the IBM Cloud catalog:
	// Compose Redis and Compose Elasticsearch. Another company (e.g. FastJetMail) might only have the single JetMail
	// offering, in which case the service name should be 'fastjetmail'. If you define your service in the Resource
	// Management Console, you can export a catalog.j-son that includes the service name you defined within the RMC.
	Name *string `json:"name,omitempty"`

	// The default is false. This specifies if your support plan changes for provisioned instances. If your offering
	// supports multiple plans, and you want users to be able to change plans for a provisioned instance, you must enable
	// the ability for users to update their service instances by using /v2/service_instances/{instance_id} PATCH.
	PlanUpdateable *bool `json:"plan_updateable,omitempty"`

	// The collection of catalog service tags.
	Tags []string `json:"tags,omitempty"`

	// A list of plans for this service that must contain at least one plan.
	Plans []CatalogResponseServicesPlans `json:"plans,omitempty"`
}

CatalogResponseServices : Catalog service structure.

type CatalogResponseServicesMetadata 

type CatalogResponseServicesMetadata struct {
	// The catalog service name.
	DisplayName *string `json:"display_name,omitempty"`

	// The catalog service documentation URL.
	DocumentationURL *string `json:"documentation_url,omitempty"`

	// The catalog service image URL.
	ImageURL *string `json:"image_url,omitempty"`

	// The catalog service instructions URL.
	InstructionsURL *string `json:"instructions_url,omitempty"`

	// The catalog service long description.
	LongDescription *string `json:"long_description,omitempty"`

	// The catalog service provider display name.
	ProviderDisplayName *string `json:"provider_display_name,omitempty"`

	// The catalog service support URL.
	SupportURL *string `json:"support_url,omitempty"`

	// The catalog service terms URL.
	TermsURL *string `json:"terms_url,omitempty"`
}

CatalogResponseServicesMetadata : The catalog service metadata.

type CatalogResponseServicesPlans 

type CatalogResponseServicesPlans struct {
	// The catalog service plan description.
	Description *string `json:"description,omitempty"`

	// The catalog service plan subscription level.
	Free *bool `json:"free,omitempty"`

	// The catalog service plan subscription ID.
	ID *string `json:"id,omitempty"`

	// The catalog service plan metadata.
	Metadata *CatalogResponseServicesPlansMetadata `json:"metadata,omitempty"`

	// The catalog service plan name.
	Name *string `json:"name,omitempty"`
}

CatalogResponseServicesPlans : The catalog service plan.

type CatalogResponseServicesPlansMetadata 

type CatalogResponseServicesPlansMetadata struct {
	// The catalog service plan metadata bullets.
	Bullets []string `json:"bullets,omitempty"`

	// The catalog service plan metadata name.
	DisplayName *string `json:"display_name,omitempty"`
}

CatalogResponseServicesPlansMetadata : The catalog service plan metadata.

type CheckConfigOptions 

type CheckConfigOptions struct {
	// The ID of the project, which uniquely identifies it.
	ID *string `json:"id" validate:"required,ne="`

	// The ID of the configuration to trigger a validation check.
	ConfigID *string `json:"config_id" validate:"required,ne="`

	// The IAM refresh token.
	XAuthRefreshToken *string `json:"X-Auth-Refresh-Token,omitempty"`

	// The version of the configuration that the validation check should trigger against.
	Version *string `json:"version,omitempty"`

	// The flag to determine if full metadata should be returned.
	Complete *bool `json:"complete,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

CheckConfigOptions : The CheckConfig options.

func (*CheckConfigOptions) SetComplete 

func (_options *CheckConfigOptions) SetComplete(complete bool) *CheckConfigOptions

SetComplete : Allow user to set Complete

func (*CheckConfigOptions) SetConfigID 

func (_options *CheckConfigOptions) SetConfigID(configID string) *CheckConfigOptions

SetConfigID : Allow user to set ConfigID

func (*CheckConfigOptions) SetHeaders 

func (options *CheckConfigOptions) SetHeaders(param map[string]string) *CheckConfigOptions

SetHeaders : Allow user to set Headers

func (*CheckConfigOptions) SetID 

func (_options *CheckConfigOptions) SetID(id string) *CheckConfigOptions

SetID : Allow user to set ID

func (*CheckConfigOptions) SetVersion 

func (_options *CheckConfigOptions) SetVersion(version string) *CheckConfigOptions

SetVersion : Allow user to set Version

func (*CheckConfigOptions) SetXAuthRefreshToken 

func (_options *CheckConfigOptions) SetXAuthRefreshToken(xAuthRefreshToken string) *CheckConfigOptions

SetXAuthRefreshToken : Allow user to set XAuthRefreshToken

type CostEstimate added in v1.2.0 

type CostEstimate struct {
	// contains filtered or unexported fields
}

CostEstimate : The cost estimate for the given configuration.

func (*CostEstimate) GetProperties added in v1.2.0 

func (o *CostEstimate) GetProperties() map[string]interface{}

GetProperties allows the user to retrieve the map of arbitrary properties from an instance of CostEstimate

func (*CostEstimate) GetProperty added in v1.2.0 

func (o *CostEstimate) GetProperty(key string) interface{}

GetProperty allows the user to retrieve an arbitrary property from an instance of CostEstimate

func (*CostEstimate) MarshalJSON added in v1.2.0 

func (o *CostEstimate) MarshalJSON() (buffer []byte, err error)

MarshalJSON performs custom serialization for instances of CostEstimate

func (*CostEstimate) SetProperties added in v1.2.0 

func (o *CostEstimate) SetProperties(m map[string]interface{})

SetProperties allows the user to set a map of arbitrary properties on an instance of CostEstimate

func (*CostEstimate) SetProperty added in v1.2.0 

func (o *CostEstimate) SetProperty(key string, value interface{})

SetProperty allows the user to set an arbitrary property on an instance of CostEstimate

type CreateConfigOptions 

type CreateConfigOptions struct {
	// The ID of the project, which uniquely identifies it.
	ID *string `json:"-" validate:"required,ne="`

	// The configuration name.
	NewName *string `json:"name" validate:"required"`

	// The location ID of a project configuration manual property.
	NewLocatorID *string `json:"locator_id" validate:"required"`

	// The unique ID of a project.
	NewID *string `json:"id,omitempty"`

	// A collection of configuration labels.
	NewLabels []string `json:"labels,omitempty"`

	// The project configuration description.
	NewDescription *string `json:"description,omitempty"`

	// The inputs of a Schematics template property.
	NewInput []ProjectConfigInputVariable `json:"input,omitempty"`

	// An optional setting object that's passed to the cart API.
	NewSetting []ProjectConfigSettingCollection `json:"setting,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

CreateConfigOptions : The CreateConfig options.

func (*CreateConfigOptions) SetHeaders 

func (options *CreateConfigOptions) SetHeaders(param map[string]string) *CreateConfigOptions

SetHeaders : Allow user to set Headers

func (*CreateConfigOptions) SetID 

func (_options *CreateConfigOptions) SetID(id string) *CreateConfigOptions

SetID : Allow user to set ID

func (*CreateConfigOptions) SetNewDescription 

func (_options *CreateConfigOptions) SetNewDescription(newDescription string) *CreateConfigOptions

SetNewDescription : Allow user to set NewDescription

func (*CreateConfigOptions) SetNewID 

func (_options *CreateConfigOptions) SetNewID(newID string) *CreateConfigOptions

SetNewID : Allow user to set NewID

func (*CreateConfigOptions) SetNewInput 

func (_options *CreateConfigOptions) SetNewInput(newInput []ProjectConfigInputVariable) *CreateConfigOptions

SetNewInput : Allow user to set NewInput

func (*CreateConfigOptions) SetNewLabels 

func (_options *CreateConfigOptions) SetNewLabels(newLabels []string) *CreateConfigOptions

SetNewLabels : Allow user to set NewLabels

func (*CreateConfigOptions) SetNewLocatorID 

func (_options *CreateConfigOptions) SetNewLocatorID(newLocatorID string) *CreateConfigOptions

SetNewLocatorID : Allow user to set NewLocatorID

func (*CreateConfigOptions) SetNewName 

func (_options *CreateConfigOptions) SetNewName(newName string) *CreateConfigOptions

SetNewName : Allow user to set NewName

func (*CreateConfigOptions) SetNewSetting 

func (_options *CreateConfigOptions) SetNewSetting(newSetting []ProjectConfigSettingCollection) *CreateConfigOptions

SetNewSetting : Allow user to set NewSetting

type CreateProjectOptions 

type CreateProjectOptions struct {
	// The project name.
	Name *string `json:"name" validate:"required"`

	// A project's descriptive text.
	Description *string `json:"description,omitempty"`

	// The project configurations.
	Configs []ProjectConfigPrototype `json:"configs,omitempty"`

	// Group name of the customized collection of resources.
	ResourceGroup *string `json:"resource_group,omitempty"`

	// Data center locations for resource deployment.
	Location *string `json:"location,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

CreateProjectOptions : The CreateProject options.

func (*CreateProjectOptions) SetConfigs 

func (_options *CreateProjectOptions) SetConfigs(configs []ProjectConfigPrototype) *CreateProjectOptions

SetConfigs : Allow user to set Configs

func (*CreateProjectOptions) SetDescription 

func (_options *CreateProjectOptions) SetDescription(description string) *CreateProjectOptions

SetDescription : Allow user to set Description

func (*CreateProjectOptions) SetHeaders 

func (options *CreateProjectOptions) SetHeaders(param map[string]string) *CreateProjectOptions

SetHeaders : Allow user to set Headers

func (*CreateProjectOptions) SetLocation 

func (_options *CreateProjectOptions) SetLocation(location string) *CreateProjectOptions

SetLocation : Allow user to set Location

func (*CreateProjectOptions) SetName 

func (_options *CreateProjectOptions) SetName(name string) *CreateProjectOptions

SetName : Allow user to set Name

func (*CreateProjectOptions) SetResourceGroup 

func (_options *CreateProjectOptions) SetResourceGroup(resourceGroup string) *CreateProjectOptions

SetResourceGroup : Allow user to set ResourceGroup

type CumulativeNeedsAttention added in v1.0.2 

type CumulativeNeedsAttention struct {
	// The event name.
	Event *string `json:"event,omitempty"`

	// The unique ID of a project.
	EventID *string `json:"event_id,omitempty"`

	// The unique ID of a project.
	ConfigID *string `json:"config_id,omitempty"`

	// The version number of the configuration.
	ConfigVersion *int64 `json:"config_version,omitempty"`
}

CumulativeNeedsAttention : CumulativeNeedsAttention struct

type DeleteConfigOptions 

type DeleteConfigOptions struct {
	// The ID of the project, which uniquely identifies it.
	ID *string `json:"id" validate:"required,ne="`

	// The ID of the configuration, which uniquely identifies it.
	ConfigID *string `json:"config_id" validate:"required,ne="`

	// The flag to determine if only the draft version should be deleted.
	DraftOnly *bool `json:"draft_only,omitempty"`

	// The flag that indicates if the resources deployed by schematics should be destroyed.
	Destroy *bool `json:"destroy,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

DeleteConfigOptions : The DeleteConfig options.

func (*DeleteConfigOptions) SetConfigID 

func (_options *DeleteConfigOptions) SetConfigID(configID string) *DeleteConfigOptions

SetConfigID : Allow user to set ConfigID

func (*DeleteConfigOptions) SetDestroy 

func (_options *DeleteConfigOptions) SetDestroy(destroy bool) *DeleteConfigOptions

SetDestroy : Allow user to set Destroy

func (*DeleteConfigOptions) SetDraftOnly 

func (_options *DeleteConfigOptions) SetDraftOnly(draftOnly bool) *DeleteConfigOptions

SetDraftOnly : Allow user to set DraftOnly

func (*DeleteConfigOptions) SetHeaders 

func (options *DeleteConfigOptions) SetHeaders(param map[string]string) *DeleteConfigOptions

SetHeaders : Allow user to set Headers

func (*DeleteConfigOptions) SetID 

func (_options *DeleteConfigOptions) SetID(id string) *DeleteConfigOptions

SetID : Allow user to set ID

type DeleteEventNotificationsIntegrationOptions 

type DeleteEventNotificationsIntegrationOptions struct {
	// The ID of the project, which uniquely identifies it.
	ID *string `json:"id" validate:"required,ne="`

	// Allows users to set headers on API requests
	Headers map[string]string
}

DeleteEventNotificationsIntegrationOptions : The DeleteEventNotificationsIntegration options.

func (*DeleteEventNotificationsIntegrationOptions) SetHeaders 

func (options *DeleteEventNotificationsIntegrationOptions) SetHeaders(param map[string]string) *DeleteEventNotificationsIntegrationOptions

SetHeaders : Allow user to set Headers

func (*DeleteEventNotificationsIntegrationOptions) SetID 

func (_options *DeleteEventNotificationsIntegrationOptions) SetID(id string) *DeleteEventNotificationsIntegrationOptions

SetID : Allow user to set ID

type DeleteProjectOptions 

type DeleteProjectOptions struct {
	// The ID of the project, which uniquely identifies it.
	ID *string `json:"id" validate:"required,ne="`

	// The flag that indicates if the resources deployed by schematics should be destroyed.
	Destroy *bool `json:"destroy,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

DeleteProjectOptions : The DeleteProject options.

func (*DeleteProjectOptions) SetDestroy 

func (_options *DeleteProjectOptions) SetDestroy(destroy bool) *DeleteProjectOptions

SetDestroy : Allow user to set Destroy

func (*DeleteProjectOptions) SetHeaders 

func (options *DeleteProjectOptions) SetHeaders(param map[string]string) *DeleteProjectOptions

SetHeaders : Allow user to set Headers

func (*DeleteProjectOptions) SetID 

func (_options *DeleteProjectOptions) SetID(id string) *DeleteProjectOptions

SetID : Allow user to set ID

type DeleteServiceInstanceOptions 

type DeleteServiceInstanceOptions struct {
	// The ID of a previously provisioned service instance.
	InstanceID *string `json:"instance_id" validate:"required,ne="`

	// The ID of the plan for which the service instance has been requested, which is stored in the catalog.json of your
	// broker. This value should be a GUID. It MUST be a non-empty string.
	PlanID *string `json:"plan_id" validate:"required"`

	// The ID of the service stored in the catalog.json of your broker. This value should be a GUID. It MUST be a non-empty
	// string.
	ServiceID *string `json:"service_id" validate:"required"`

	// Broker Api Version.
	XBrokerApiVersion *string `json:"X-Broker-Api-Version,omitempty"`

	// Broker Api Originating Identity.
	XBrokerApiOriginatingIdentity *string `json:"X-Broker-Api-Originating-Identity,omitempty"`

	// A value of true indicates that both the IBM Cloud platform and the requesting client support asynchronous
	// deprovisioning. If this parameter is not included in the request, and the broker can only deprovision a service
	// instance of the requested plan asynchronously, the broker MUST reject the request with a 422 Unprocessable Entity.
	AcceptsIncomplete *bool `json:"accepts_incomplete,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

DeleteServiceInstanceOptions : The DeleteServiceInstance options.

func (*DeleteServiceInstanceOptions) SetAcceptsIncomplete 

func (_options *DeleteServiceInstanceOptions) SetAcceptsIncomplete(acceptsIncomplete bool) *DeleteServiceInstanceOptions

SetAcceptsIncomplete : Allow user to set AcceptsIncomplete

func (*DeleteServiceInstanceOptions) SetHeaders 

func (options *DeleteServiceInstanceOptions) SetHeaders(param map[string]string) *DeleteServiceInstanceOptions

SetHeaders : Allow user to set Headers

func (*DeleteServiceInstanceOptions) SetInstanceID 

func (_options *DeleteServiceInstanceOptions) SetInstanceID(instanceID string) *DeleteServiceInstanceOptions

SetInstanceID : Allow user to set InstanceID

func (*DeleteServiceInstanceOptions) SetPlanID 

func (_options *DeleteServiceInstanceOptions) SetPlanID(planID string) *DeleteServiceInstanceOptions

SetPlanID : Allow user to set PlanID

func (*DeleteServiceInstanceOptions) SetServiceID 

func (_options *DeleteServiceInstanceOptions) SetServiceID(serviceID string) *DeleteServiceInstanceOptions

SetServiceID : Allow user to set ServiceID

func (*DeleteServiceInstanceOptions) SetXBrokerApiOriginatingIdentity 

func (_options *DeleteServiceInstanceOptions) SetXBrokerApiOriginatingIdentity(xBrokerApiOriginatingIdentity string) *DeleteServiceInstanceOptions

SetXBrokerApiOriginatingIdentity : Allow user to set XBrokerApiOriginatingIdentity

func (*DeleteServiceInstanceOptions) SetXBrokerApiVersion 

func (_options *DeleteServiceInstanceOptions) SetXBrokerApiVersion(xBrokerApiVersion string) *DeleteServiceInstanceOptions

SetXBrokerApiVersion : Allow user to set XBrokerApiVersion

type ForceApproveOptions added in v1.0.9 

type ForceApproveOptions struct {
	// The ID of the project, which uniquely identifies it.
	ID *string `json:"id" validate:"required,ne="`

	// The ID of the configuration, which uniquely identifies it.
	ConfigID *string `json:"config_id" validate:"required,ne="`

	// Notes on the project draft action.
	Comment *string `json:"comment,omitempty"`

	// The flag to determine if full metadata should be returned.
	Complete *bool `json:"complete,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

ForceApproveOptions : The ForceApprove options.

func (*ForceApproveOptions) SetComment added in v1.0.9 

func (_options *ForceApproveOptions) SetComment(comment string) *ForceApproveOptions

SetComment : Allow user to set Comment

func (*ForceApproveOptions) SetComplete added in v1.0.9 

func (_options *ForceApproveOptions) SetComplete(complete bool) *ForceApproveOptions

SetComplete : Allow user to set Complete

func (*ForceApproveOptions) SetConfigID added in v1.0.9 

func (_options *ForceApproveOptions) SetConfigID(configID string) *ForceApproveOptions

SetConfigID : Allow user to set ConfigID

func (*ForceApproveOptions) SetHeaders added in v1.0.9 

func (options *ForceApproveOptions) SetHeaders(param map[string]string) *ForceApproveOptions

SetHeaders : Allow user to set Headers

func (*ForceApproveOptions) SetID added in v1.0.9 

func (_options *ForceApproveOptions) SetID(id string) *ForceApproveOptions

SetID : Allow user to set ID

type GetCatalogOptions 

type GetCatalogOptions struct {
	// Broker API Version.
	XBrokerApiVersion *string `json:"X-Broker-Api-Version,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

GetCatalogOptions : The GetCatalog options.

func (*GetCatalogOptions) SetHeaders 

func (options *GetCatalogOptions) SetHeaders(param map[string]string) *GetCatalogOptions

SetHeaders : Allow user to set Headers

func (*GetCatalogOptions) SetXBrokerApiVersion 

func (_options *GetCatalogOptions) SetXBrokerApiVersion(xBrokerApiVersion string) *GetCatalogOptions

SetXBrokerApiVersion : Allow user to set XBrokerApiVersion

type GetConfigDiffOptions 

type GetConfigDiffOptions struct {
	// The ID of the project, which uniquely identifies it.
	ID *string `json:"id" validate:"required,ne="`

	// The ID of the configuration, which uniquely identifies it.
	ConfigID *string `json:"config_id" validate:"required,ne="`

	// Allows users to set headers on API requests
	Headers map[string]string
}

GetConfigDiffOptions : The GetConfigDiff options.

func (*GetConfigDiffOptions) SetConfigID 

func (_options *GetConfigDiffOptions) SetConfigID(configID string) *GetConfigDiffOptions

SetConfigID : Allow user to set ConfigID

func (*GetConfigDiffOptions) SetHeaders 

func (options *GetConfigDiffOptions) SetHeaders(param map[string]string) *GetConfigDiffOptions

SetHeaders : Allow user to set Headers

func (*GetConfigDiffOptions) SetID 

func (_options *GetConfigDiffOptions) SetID(id string) *GetConfigDiffOptions

SetID : Allow user to set ID

type GetConfigOptions 

type GetConfigOptions struct {
	// The ID of the project, which uniquely identifies it.
	ID *string `json:"id" validate:"required,ne="`

	// The ID of the configuration, which uniquely identifies it.
	ConfigID *string `json:"config_id" validate:"required,ne="`

	// The version of the configuration to return.
	Version *string `json:"version,omitempty"`

	// The flag to determine if full metadata should be returned.
	Complete *bool `json:"complete,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

GetConfigOptions : The GetConfig options.

func (*GetConfigOptions) SetComplete 

func (_options *GetConfigOptions) SetComplete(complete bool) *GetConfigOptions

SetComplete : Allow user to set Complete

func (*GetConfigOptions) SetConfigID 

func (_options *GetConfigOptions) SetConfigID(configID string) *GetConfigOptions

SetConfigID : Allow user to set ConfigID

func (*GetConfigOptions) SetHeaders 

func (options *GetConfigOptions) SetHeaders(param map[string]string) *GetConfigOptions

SetHeaders : Allow user to set Headers

func (*GetConfigOptions) SetID 

func (_options *GetConfigOptions) SetID(id string) *GetConfigOptions

SetID : Allow user to set ID

func (*GetConfigOptions) SetVersion 

func (_options *GetConfigOptions) SetVersion(version string) *GetConfigOptions

SetVersion : Allow user to set Version

type GetCostEstimateOptions 

type GetCostEstimateOptions struct {
	// The ID of the project, which uniquely identifies it.
	ID *string `json:"id" validate:"required,ne="`

	// The ID of the configuration of the cost estimate to fetch.
	ConfigID *string `json:"config_id" validate:"required,ne="`

	// The version of the configuration that the cost estimate will fetch.
	Version *string `json:"version,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

GetCostEstimateOptions : The GetCostEstimate options.

func (*GetCostEstimateOptions) SetConfigID 

func (_options *GetCostEstimateOptions) SetConfigID(configID string) *GetCostEstimateOptions

SetConfigID : Allow user to set ConfigID

func (*GetCostEstimateOptions) SetHeaders 

func (options *GetCostEstimateOptions) SetHeaders(param map[string]string) *GetCostEstimateOptions

SetHeaders : Allow user to set Headers

func (*GetCostEstimateOptions) SetID 

func (_options *GetCostEstimateOptions) SetID(id string) *GetCostEstimateOptions

SetID : Allow user to set ID

func (*GetCostEstimateOptions) SetVersion 

func (_options *GetCostEstimateOptions) SetVersion(version string) *GetCostEstimateOptions

SetVersion : Allow user to set Version

type GetEventNotificationsIntegrationOptions 

type GetEventNotificationsIntegrationOptions struct {
	// The ID of the project, which uniquely identifies it.
	ID *string `json:"id" validate:"required,ne="`

	// Allows users to set headers on API requests
	Headers map[string]string
}

GetEventNotificationsIntegrationOptions : The GetEventNotificationsIntegration options.

func (*GetEventNotificationsIntegrationOptions) SetHeaders 

func (options *GetEventNotificationsIntegrationOptions) SetHeaders(param map[string]string) *GetEventNotificationsIntegrationOptions

SetHeaders : Allow user to set Headers

func (*GetEventNotificationsIntegrationOptions) SetID 

func (_options *GetEventNotificationsIntegrationOptions) SetID(id string) *GetEventNotificationsIntegrationOptions

SetID : Allow user to set ID

type GetHealthOptions 

type GetHealthOptions struct {
	// Set this parameter if you want to get the version information in the output response.
	Info *bool `json:"info,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

GetHealthOptions : The GetHealth options.

func (*GetHealthOptions) SetHeaders 

func (options *GetHealthOptions) SetHeaders(param map[string]string) *GetHealthOptions

SetHeaders : Allow user to set Headers

func (*GetHealthOptions) SetInfo 

func (_options *GetHealthOptions) SetInfo(info bool) *GetHealthOptions

SetInfo : Allow user to set Info

type GetLastOperationOptions 

type GetLastOperationOptions struct {
	// The unique instance ID generated during provisioning by the IBM Cloud platform.
	InstanceID *string `json:"instance_id" validate:"required,ne="`

	// Broker Api Version.
	XBrokerApiVersion *string `json:"X-Broker-Api-Version,omitempty"`

	// A broker-provided identifier for the operation.
	Operation *string `json:"operation,omitempty"`

	// ID of the plan from the catalog.json in your broker.
	PlanID *string `json:"plan_id,omitempty"`

	// ID of the service from the catalog.json in your service broker.
	ServiceID *string `json:"service_id,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

GetLastOperationOptions : The GetLastOperation options.

func (*GetLastOperationOptions) SetHeaders 

func (options *GetLastOperationOptions) SetHeaders(param map[string]string) *GetLastOperationOptions

SetHeaders : Allow user to set Headers

func (*GetLastOperationOptions) SetInstanceID 

func (_options *GetLastOperationOptions) SetInstanceID(instanceID string) *GetLastOperationOptions

SetInstanceID : Allow user to set InstanceID

func (*GetLastOperationOptions) SetOperation 

func (_options *GetLastOperationOptions) SetOperation(operation string) *GetLastOperationOptions

SetOperation : Allow user to set Operation

func (*GetLastOperationOptions) SetPlanID 

func (_options *GetLastOperationOptions) SetPlanID(planID string) *GetLastOperationOptions

SetPlanID : Allow user to set PlanID

func (*GetLastOperationOptions) SetServiceID 

func (_options *GetLastOperationOptions) SetServiceID(serviceID string) *GetLastOperationOptions

SetServiceID : Allow user to set ServiceID

func (*GetLastOperationOptions) SetXBrokerApiVersion 

func (_options *GetLastOperationOptions) SetXBrokerApiVersion(xBrokerApiVersion string) *GetLastOperationOptions

SetXBrokerApiVersion : Allow user to set XBrokerApiVersion

type GetNotificationsOptions 

type GetNotificationsOptions struct {
	// The ID of the project, which uniquely identifies it.
	ID *string `json:"id" validate:"required,ne="`

	// Allows users to set headers on API requests
	Headers map[string]string
}

GetNotificationsOptions : The GetNotifications options.

func (*GetNotificationsOptions) SetHeaders 

func (options *GetNotificationsOptions) SetHeaders(param map[string]string) *GetNotificationsOptions

SetHeaders : Allow user to set Headers

func (*GetNotificationsOptions) SetID 

func (_options *GetNotificationsOptions) SetID(id string) *GetNotificationsOptions

SetID : Allow user to set ID

type GetProjectOptions 

type GetProjectOptions struct {
	// The ID of the project, which uniquely identifies it.
	ID *string `json:"id" validate:"required,ne="`

	// Only return with the active configuration, no drafts.
	ExcludeConfigs *bool `json:"exclude_configs,omitempty"`

	// The flag to determine if full metadata should be returned.
	Complete *bool `json:"complete,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

GetProjectOptions : The GetProject options.

func (*GetProjectOptions) SetComplete 

func (_options *GetProjectOptions) SetComplete(complete bool) *GetProjectOptions

SetComplete : Allow user to set Complete

func (*GetProjectOptions) SetExcludeConfigs 

func (_options *GetProjectOptions) SetExcludeConfigs(excludeConfigs bool) *GetProjectOptions

SetExcludeConfigs : Allow user to set ExcludeConfigs

func (*GetProjectOptions) SetHeaders 

func (options *GetProjectOptions) SetHeaders(param map[string]string) *GetProjectOptions

SetHeaders : Allow user to set Headers

func (*GetProjectOptions) SetID 

func (_options *GetProjectOptions) SetID(id string) *GetProjectOptions

SetID : Allow user to set ID

type GetSchematicsJobOptions 

type GetSchematicsJobOptions struct {
	// The ID of the project, which uniquely identifies it.
	ID *string `json:"id" validate:"required,ne="`

	// The ID of the configuration that triggered the action.
	ConfigID *string `json:"config_id" validate:"required,ne="`

	// The triggered action.
	Action *string `json:"action" validate:"required,ne="`

	// The timestamp of when the action was triggered.
	Since *int64 `json:"since,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

GetSchematicsJobOptions : The GetSchematicsJob options.

func (*GetSchematicsJobOptions) SetAction 

func (_options *GetSchematicsJobOptions) SetAction(action string) *GetSchematicsJobOptions

SetAction : Allow user to set Action

func (*GetSchematicsJobOptions) SetConfigID 

func (_options *GetSchematicsJobOptions) SetConfigID(configID string) *GetSchematicsJobOptions

SetConfigID : Allow user to set ConfigID

func (*GetSchematicsJobOptions) SetHeaders 

func (options *GetSchematicsJobOptions) SetHeaders(param map[string]string) *GetSchematicsJobOptions

SetHeaders : Allow user to set Headers

func (*GetSchematicsJobOptions) SetID 

func (_options *GetSchematicsJobOptions) SetID(id string) *GetSchematicsJobOptions

SetID : Allow user to set ID

func (*GetSchematicsJobOptions) SetSince 

func (_options *GetSchematicsJobOptions) SetSince(since int64) *GetSchematicsJobOptions

SetSince : Allow user to set Since

type GetServiceInstanceOptions 

type GetServiceInstanceOptions struct {
	// The ID of a previously provisioned service instance.
	InstanceID *string `json:"instance_id" validate:"required,ne="`

	// Broker API Version.
	XBrokerApiVersion *string `json:"X-Broker-Api-Version,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

GetServiceInstanceOptions : The GetServiceInstance options.

func (*GetServiceInstanceOptions) SetHeaders 

func (options *GetServiceInstanceOptions) SetHeaders(param map[string]string) *GetServiceInstanceOptions

SetHeaders : Allow user to set Headers

func (*GetServiceInstanceOptions) SetInstanceID 

func (_options *GetServiceInstanceOptions) SetInstanceID(instanceID string) *GetServiceInstanceOptions

SetInstanceID : Allow user to set InstanceID

func (*GetServiceInstanceOptions) SetXBrokerApiVersion 

func (_options *GetServiceInstanceOptions) SetXBrokerApiVersion(xBrokerApiVersion string) *GetServiceInstanceOptions

SetXBrokerApiVersion : Allow user to set XBrokerApiVersion

type Health 

type Health struct {
	// The name of the service.
	Name *string `json:"name,omitempty"`

	// The running version of the service.
	Version *string `json:"version,omitempty"`

	// The status of service dependencies.
	Dependencies map[string]interface{} `json:"dependencies,omitempty"`
}

Health : Response data from a health check request.

type InputVariable 

type InputVariable struct {
	// The variable name.
	Name *string `json:"name" validate:"required"`

	// The variable type.
	Type *string `json:"type" validate:"required"`

	// Whether the variable is required or not.
	Required *bool `json:"required,omitempty"`
}

InputVariable : InputVariable struct

type InstallConfigOptions 

type InstallConfigOptions struct {
	// The ID of the project, which uniquely identifies it.
	ID *string `json:"id" validate:"required,ne="`

	// The ID of the configuration to install.
	ConfigID *string `json:"config_id" validate:"required,ne="`

	// The flag to determine if full metadata should be returned.
	Complete *bool `json:"complete,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

InstallConfigOptions : The InstallConfig options.

func (*InstallConfigOptions) SetComplete 

func (_options *InstallConfigOptions) SetComplete(complete bool) *InstallConfigOptions

SetComplete : Allow user to set Complete

func (*InstallConfigOptions) SetConfigID 

func (_options *InstallConfigOptions) SetConfigID(configID string) *InstallConfigOptions

SetConfigID : Allow user to set ConfigID

func (*InstallConfigOptions) SetHeaders 

func (options *InstallConfigOptions) SetHeaders(param map[string]string) *InstallConfigOptions

SetHeaders : Allow user to set Headers

func (*InstallConfigOptions) SetID 

func (_options *InstallConfigOptions) SetID(id string) *InstallConfigOptions

SetID : Allow user to set ID

type JSONPatchOperation added in v0.88.0 

type JSONPatchOperation struct {
	// The operation to be performed.
	Op *string `json:"op" validate:"required"`

	// The JSON Pointer that identifies the field that is the target of the operation.
	Path *string `json:"path" validate:"required"`

	// The JSON Pointer that identifies the field that is the source of the operation.
	From *string `json:"from,omitempty"`

	// The value to be used within the operation.
	Value interface{} `json:"value,omitempty"`
}

JSONPatchOperation : This model represents an individual patch operation to be performed on a JSON document, as defined by RFC 6902.

type ListConfigsOptions 

type ListConfigsOptions struct {
	// The ID of the project, which uniquely identifies it.
	ID *string `json:"id" validate:"required,ne="`

	// The version of configuration to return.
	Version *string `json:"version,omitempty"`

	// The flag to determine if full metadata should be returned.
	Complete *bool `json:"complete,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

ListConfigsOptions : The ListConfigs options.

func (*ListConfigsOptions) SetComplete 

func (_options *ListConfigsOptions) SetComplete(complete bool) *ListConfigsOptions

SetComplete : Allow user to set Complete

func (*ListConfigsOptions) SetHeaders 

func (options *ListConfigsOptions) SetHeaders(param map[string]string) *ListConfigsOptions

SetHeaders : Allow user to set Headers

func (*ListConfigsOptions) SetID 

func (_options *ListConfigsOptions) SetID(id string) *ListConfigsOptions

SetID : Allow user to set ID

func (*ListConfigsOptions) SetVersion 

func (_options *ListConfigsOptions) SetVersion(version string) *ListConfigsOptions

SetVersion : Allow user to set Version

type ListProjectsOptions 

type ListProjectsOptions struct {
	// Page token query parameter that is used to determine what resource to start the page after. If not specified, the
	// logical first page is returned.
	Start *string `json:"start,omitempty"`

	// Determine the maximum number of resources to return. The number of resources returned is the same, with exception of
	// the last page.
	Limit *int64 `json:"limit,omitempty"`

	// The flag to determine if full metadata should be returned.
	Complete *bool `json:"complete,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

ListProjectsOptions : The ListProjects options.

func (*ListProjectsOptions) SetComplete 

func (_options *ListProjectsOptions) SetComplete(complete bool) *ListProjectsOptions

SetComplete : Allow user to set Complete

func (*ListProjectsOptions) SetHeaders 

func (options *ListProjectsOptions) SetHeaders(param map[string]string) *ListProjectsOptions

SetHeaders : Allow user to set Headers

func (*ListProjectsOptions) SetLimit 

func (_options *ListProjectsOptions) SetLimit(limit int64) *ListProjectsOptions

SetLimit : Allow user to set Limit

func (*ListProjectsOptions) SetStart 

func (_options *ListProjectsOptions) SetStart(start string) *ListProjectsOptions

SetStart : Allow user to set Start

type NotificationEvent 

type NotificationEvent struct {
	// The type of event.
	Event *string `json:"event" validate:"required"`

	// The target of the event.
	Target *string `json:"target" validate:"required"`

	// The source of the event.
	Source *string `json:"source,omitempty"`

	// The user that triggered the flow that posted the event.
	TriggeredBy *string `json:"triggered_by,omitempty"`

	// An actionable URL that users can access in response to the event.
	ActionURL *string `json:"action_url,omitempty"`

	// Any relevant metadata to be stored.
	Data map[string]interface{} `json:"data,omitempty"`
}

NotificationEvent : NotificationEvent struct

type NotificationEventWithID 

type NotificationEventWithID struct {
	// The type of event.
	Event *string `json:"event" validate:"required"`

	// The target of the event.
	Target *string `json:"target" validate:"required"`

	// The source of the event.
	Source *string `json:"source,omitempty"`

	// The user that triggered the flow that posted the event.
	TriggeredBy *string `json:"triggered_by,omitempty"`

	// An actionable URL that users can access in response to the event.
	ActionURL *string `json:"action_url,omitempty"`

	// Any relevant metadata to be stored.
	Data map[string]interface{} `json:"data,omitempty"`

	// The unique ID of a project.
	ID *string `json:"id" validate:"required"`
}

NotificationEventWithID : NotificationEventWithID struct

type NotificationEventWithStatus 

type NotificationEventWithStatus struct {
	// The type of event.
	Event *string `json:"event" validate:"required"`

	// The target of the event.
	Target *string `json:"target" validate:"required"`

	// The source of the event.
	Source *string `json:"source,omitempty"`

	// The user that triggered the flow that posted the event.
	TriggeredBy *string `json:"triggered_by,omitempty"`

	// An actionable URL that users can access in response to the event.
	ActionURL *string `json:"action_url,omitempty"`

	// Any relevant metadata to be stored.
	Data map[string]interface{} `json:"data,omitempty"`

	// The unique ID of a project.
	ID *string `json:"id" validate:"required"`

	// Whether or not the event successfully posted.
	Status *string `json:"status,omitempty"`

	// The reasons for the status of an event.
	Reasons []map[string]interface{} `json:"reasons,omitempty"`
}

NotificationEventWithStatus : NotificationEventWithStatus struct

type NotificationsGetResponse added in v1.2.0 

type NotificationsGetResponse struct {
	// Collection of the notification events with an ID.
	Notifications []NotificationEventWithID `json:"notifications,omitempty"`
}

NotificationsGetResponse : The response from fetching notifications.

type NotificationsIntegrationGetResponse added in v1.2.0 

type NotificationsIntegrationGetResponse struct {
	// A description of the instance of the event.
	Description *string `json:"description,omitempty"`

	// The name of the instance of the event.
	Name *string `json:"name,omitempty"`

	// The status of instance of the event.
	Enabled *bool `json:"enabled,omitempty"`

	// A unique ID of the instance of the event.
	ID *string `json:"id,omitempty"`

	// The type of the instance of event.
	Type *string `json:"type,omitempty"`

	// A date/time value in the format YYYY-MM-DDTHH:mm:ssZ or YYYY-MM-DDTHH:mm:ss.sssZ, matching the date-time format as
	// specified by RFC 3339.
	UpdatedAt *strfmt.DateTime `json:"updated_at,omitempty"`

	// The topic count of the instance of the event.
	TopicCount *int64 `json:"topic_count,omitempty"`

	// The topic names of the instance of the event.
	TopicNames []string `json:"topic_names,omitempty"`
}

NotificationsIntegrationGetResponse : The resulting response of getting the source details of the event notifications integration.

type NotificationsIntegrationPostResponse added in v1.2.0 

type NotificationsIntegrationPostResponse struct {
	// A description of the instance of the event.
	Description *string `json:"description,omitempty"`

	// A name of the instance of the event.
	Name *string `json:"name,omitempty"`

	// A status of the instance of the event.
	Enabled *bool `json:"enabled,omitempty"`

	// A unique ID of the instance of the event.
	ID *string `json:"id,omitempty"`

	// The type of instance of the event.
	Type *string `json:"type,omitempty"`

	// A date/time value in the format YYYY-MM-DDTHH:mm:ssZ or YYYY-MM-DDTHH:mm:ss.sssZ, matching the date-time format as
	// specified by RFC 3339.
	CreatedAt *strfmt.DateTime `json:"created_at,omitempty"`
}

NotificationsIntegrationPostResponse : The resulting response of connecting a project to a event notifications instance.

type NotificationsIntegrationTestPostResponse added in v1.2.0 

type NotificationsIntegrationTestPostResponse struct {
	// The data content type of the instance of the event.
	Datacontenttype *string `json:"datacontenttype,omitempty"`

	// The IBM default long message for the instance of the event.
	Ibmendefaultlong *string `json:"ibmendefaultlong,omitempty"`

	// The IBM default short message for the instance of the event.
	Ibmendefaultshort *string `json:"ibmendefaultshort,omitempty"`

	// The IBM source ID for the instance of the event.
	Ibmensourceid *string `json:"ibmensourceid,omitempty"`

	// A unique ID of the instance of the event.
	ID *string `json:"id" validate:"required"`

	// The source of the instance of the event.
	Source *string `json:"source" validate:"required"`

	// The spec version of the instance of the event.
	Specversion *string `json:"specversion,omitempty"`

	// The type of instance of the event.
	Type *string `json:"type,omitempty"`
}

NotificationsIntegrationTestPostResponse : The response for posting a test notification to the event notifications instance.

type NotificationsPrototypePostResponse added in v1.2.0 

type NotificationsPrototypePostResponse struct {
	// The collection of the notification events with status.
	Notifications []NotificationEventWithStatus `json:"notifications,omitempty"`
}

NotificationsPrototypePostResponse : The result of a notification post.

type OutputValue 

type OutputValue struct {
	// The variable name.
	Name *string `json:"name" validate:"required"`

	// A short explanation of the output value.
	Description *string `json:"description,omitempty"`

	// The output value.
	Value []interface{} `json:"value,omitempty"`
}

OutputValue : OutputValue struct 

type PaginationLink struct {
	// The URL of the pull request, which uniquely identifies it.
	Href *string `json:"href" validate:"required"`

	// A pagination token.
	Start *string `json:"start,omitempty"`
}

PaginationLink : A pagination link.

type PostCrnTokenOptions added in v1.0.9 

type PostCrnTokenOptions struct {
	// The ID of the project, which uniquely identifies it.
	ID *string `json:"id" validate:"required,ne="`

	// Allows users to set headers on API requests
	Headers map[string]string
}

PostCrnTokenOptions : The PostCrnToken options.

func (*PostCrnTokenOptions) SetHeaders added in v1.0.9 

func (options *PostCrnTokenOptions) SetHeaders(param map[string]string) *PostCrnTokenOptions

SetHeaders : Allow user to set Headers

func (*PostCrnTokenOptions) SetID added in v1.0.9 

func (_options *PostCrnTokenOptions) SetID(id string) *PostCrnTokenOptions

SetID : Allow user to set ID

type PostEventNotificationsIntegrationOptions 

type PostEventNotificationsIntegrationOptions struct {
	// The ID of the project, which uniquely identifies it.
	ID *string `json:"id" validate:"required,ne="`

	// A CRN of the instance of the event.
	InstanceCrn *string `json:"instance_crn" validate:"required"`

	// A description of the instance of the event.
	Description *string `json:"description,omitempty"`

	// The name of the project source for the event notifications instance.
	EventNotificationsSourceName *string `json:"event_notifications_source_name,omitempty"`

	// A status of the instance of the event.
	Enabled *bool `json:"enabled,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

PostEventNotificationsIntegrationOptions : The PostEventNotificationsIntegration options.

func (*PostEventNotificationsIntegrationOptions) SetDescription 

func (_options *PostEventNotificationsIntegrationOptions) SetDescription(description string) *PostEventNotificationsIntegrationOptions

SetDescription : Allow user to set Description

func (*PostEventNotificationsIntegrationOptions) SetEnabled 

func (_options *PostEventNotificationsIntegrationOptions) SetEnabled(enabled bool) *PostEventNotificationsIntegrationOptions

SetEnabled : Allow user to set Enabled

func (*PostEventNotificationsIntegrationOptions) SetEventNotificationsSourceName added in v0.88.0 

func (_options *PostEventNotificationsIntegrationOptions) SetEventNotificationsSourceName(eventNotificationsSourceName string) *PostEventNotificationsIntegrationOptions

SetEventNotificationsSourceName : Allow user to set EventNotificationsSourceName

func (*PostEventNotificationsIntegrationOptions) SetHeaders 

func (options *PostEventNotificationsIntegrationOptions) SetHeaders(param map[string]string) *PostEventNotificationsIntegrationOptions

SetHeaders : Allow user to set Headers

func (*PostEventNotificationsIntegrationOptions) SetID 

func (_options *PostEventNotificationsIntegrationOptions) SetID(id string) *PostEventNotificationsIntegrationOptions

SetID : Allow user to set ID

func (*PostEventNotificationsIntegrationOptions) SetInstanceCrn 

func (_options *PostEventNotificationsIntegrationOptions) SetInstanceCrn(instanceCrn string) *PostEventNotificationsIntegrationOptions

SetInstanceCrn : Allow user to set InstanceCrn

type PostNotificationOptions 

type PostNotificationOptions struct {
	// The ID of the project, which uniquely identifies it.
	ID *string `json:"id" validate:"required,ne="`

	// Collection of the notification events to post.
	Notifications []NotificationEvent `json:"notifications,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

PostNotificationOptions : The PostNotification options.

func (*PostNotificationOptions) SetHeaders 

func (options *PostNotificationOptions) SetHeaders(param map[string]string) *PostNotificationOptions

SetHeaders : Allow user to set Headers

func (*PostNotificationOptions) SetID 

func (_options *PostNotificationOptions) SetID(id string) *PostNotificationOptions

SetID : Allow user to set ID

func (*PostNotificationOptions) SetNotifications 

func (_options *PostNotificationOptions) SetNotifications(notifications []NotificationEvent) *PostNotificationOptions

SetNotifications : Allow user to set Notifications

type PostTestEventNotificationOptions added in v0.88.0 

type PostTestEventNotificationOptions struct {
	// The ID of the project, which uniquely identifies it.
	ID *string `json:"id" validate:"required,ne="`

	// The IBM default long message for the instance of an event.
	Ibmendefaultlong *string `json:"ibmendefaultlong,omitempty"`

	// The IBM default long message for the instance of an event.
	Ibmendefaultshort *string `json:"ibmendefaultshort,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

PostTestEventNotificationOptions : The PostTestEventNotification options.

func (*PostTestEventNotificationOptions) SetHeaders added in v0.88.0 

func (options *PostTestEventNotificationOptions) SetHeaders(param map[string]string) *PostTestEventNotificationOptions

SetHeaders : Allow user to set Headers

func (*PostTestEventNotificationOptions) SetID added in v0.88.0 

func (_options *PostTestEventNotificationOptions) SetID(id string) *PostTestEventNotificationOptions

SetID : Allow user to set ID

func (*PostTestEventNotificationOptions) SetIbmendefaultlong added in v0.88.0 

func (_options *PostTestEventNotificationOptions) SetIbmendefaultlong(ibmendefaultlong string) *PostTestEventNotificationOptions

SetIbmendefaultlong : Allow user to set Ibmendefaultlong

func (*PostTestEventNotificationOptions) SetIbmendefaultshort added in v0.88.0 

func (_options *PostTestEventNotificationOptions) SetIbmendefaultshort(ibmendefaultshort string) *PostTestEventNotificationOptions

SetIbmendefaultshort : Allow user to set Ibmendefaultshort

type Project added in v1.2.0 

type Project struct {
	// The project name.
	Name *string `json:"name" validate:"required"`

	// A project descriptive text.
	Description *string `json:"description,omitempty"`

	// The unique ID of a project.
	ID *string `json:"id,omitempty"`

	// An IBM Cloud resource name, which uniquely identifies a resource.
	Crn *string `json:"crn,omitempty"`

	// The project configurations.
	Configs []ProjectConfig `json:"configs,omitempty"`

	// The metadata of the project.
	Metadata *ProjectMetadata `json:"metadata,omitempty"`
}

Project : The project returned in the response body.

type ProjectCRNTokenResponse added in v1.0.9 

type ProjectCRNTokenResponse struct {
	// The IAM access token.
	AccesToken *string `json:"acces_token,omitempty"`

	// Number of seconds counted since January 1st, 1970, until the IAM access token will expire.
	Expiration *int64 `json:"expiration,omitempty"`
}

ProjectCRNTokenResponse : The project CRN token.

type ProjectCollection added in v1.2.0 

type ProjectCollection struct {
	// A pagination limit.
	Limit *int64 `json:"limit" validate:"required"`

	// Get the occurrencies of the total projects.
	TotalCount *int64 `json:"total_count" validate:"required"`

	// A pagination link.
	First *PaginationLink `json:"first" validate:"required"`

	// A pagination link.
	Last *PaginationLink `json:"last,omitempty"`

	// A pagination link.
	Previous *PaginationLink `json:"previous,omitempty"`

	// A pagination link.
	Next *PaginationLink `json:"next,omitempty"`

	// An array of projects.
	Projects []ProjectCollectionMemberWithMetadata `json:"projects,omitempty"`
}

ProjectCollection : Projects list.

func (*ProjectCollection) GetNextStart added in v1.2.0 

func (resp *ProjectCollection) GetNextStart() (*string, error)

Retrieve the value to be passed to a request to access the next page of results

type ProjectCollectionMemberWithMetadata added in v1.2.0 

type ProjectCollectionMemberWithMetadata struct {
	// The unique ID of a project.
	ID *string `json:"id,omitempty"`

	// The project name.
	Name *string `json:"name,omitempty"`

	// The project description.
	Description *string `json:"description,omitempty"`

	// The metadata of the project.
	Metadata *ProjectMetadata `json:"metadata,omitempty"`
}

ProjectCollectionMemberWithMetadata : ProjectCollectionMemberWithMetadata struct

type ProjectConfig 

type ProjectConfig struct {
	// The unique ID of a project.
	ID *string `json:"id,omitempty"`

	// The configuration name.
	Name *string `json:"name" validate:"required"`

	// A collection of configuration labels.
	Labels []string `json:"labels,omitempty"`

	// The project configuration description.
	Description *string `json:"description,omitempty"`

	// The location ID of a project configuration manual property.
	LocatorID *string `json:"locator_id" validate:"required"`

	// The type of a project configuration manual property.
	Type *string `json:"type" validate:"required"`

	// The outputs of a Schematics template property.
	Input []InputVariable `json:"input,omitempty"`

	// The outputs of a Schematics template property.
	Output []OutputValue `json:"output,omitempty"`

	// An optional setting object that's passed to the cart API.
	Setting []ProjectConfigSettingCollection `json:"setting,omitempty"`
}

ProjectConfig : The project configuration.

type ProjectConfigCollection added in v1.2.0 

type ProjectConfigCollection struct {
	// The collection list operation response schema that should define the array property with the name "configs".
	Configs []ProjectConfig `json:"configs,omitempty"`
}

ProjectConfigCollection : The project configuration list.

type ProjectConfigDelete added in v1.2.0 

type ProjectConfigDelete struct {
	// The unique ID of a project.
	ID *string `json:"id,omitempty"`

	// The name of the configuration being deleted.
	Name *string `json:"name,omitempty"`
}

ProjectConfigDelete : Deletes the configuration response.

type ProjectConfigDiff 

type ProjectConfigDiff struct {
	// The additions to configurations in the diff summary.
	Added *ProjectConfigDiffAdded `json:"added,omitempty"`

	// The changes to configurations in the diff summary.
	Changed *ProjectConfigDiffChanged `json:"changed,omitempty"`

	// The deletions to configurations in the diff summary.
	Removed *ProjectConfigDiffRemoved `json:"removed,omitempty"`
}

ProjectConfigDiff : The project configuration diff summary.

type ProjectConfigDiffAdded 

type ProjectConfigDiffAdded struct {
	// The collection of additions to the configurations in the diff summary.
	Input []ProjectConfigDiffInputVariable `json:"input,omitempty"`
}

ProjectConfigDiffAdded : The additions to configurations in the diff summary.

type ProjectConfigDiffChanged 

type ProjectConfigDiffChanged struct {
	// The collection of changes to configurations in the diff summary.
	Input []ProjectConfigDiffInputVariable `json:"input,omitempty"`
}

ProjectConfigDiffChanged : The changes to configurations in the diff summary.

type ProjectConfigDiffInputVariable 

type ProjectConfigDiffInputVariable struct {
	// The variable name.
	Name *string `json:"name" validate:"required"`

	// The variable type.
	Type *string `json:"type" validate:"required"`
}

ProjectConfigDiffInputVariable : ProjectConfigDiffInputVariable struct

type ProjectConfigDiffRemoved 

type ProjectConfigDiffRemoved struct {
	// The collection of deletions to configurations in the diff summary.
	Input []ProjectConfigDiffInputVariable `json:"input,omitempty"`
}

ProjectConfigDiffRemoved : The deletions to configurations in the diff summary.

type ProjectConfigInputVariable added in v1.2.0 

type ProjectConfigInputVariable struct {
	// The variable name.
	Name *string `json:"name" validate:"required"`
}

ProjectConfigInputVariable : ProjectConfigInputVariable struct

type ProjectConfigPrototype added in v1.2.0 

type ProjectConfigPrototype struct {
	// The unique ID of a project.
	ID *string `json:"id,omitempty"`

	// The configuration name.
	Name *string `json:"name" validate:"required"`

	// A collection of configuration labels.
	Labels []string `json:"labels,omitempty"`

	// The project configuration description.
	Description *string `json:"description,omitempty"`

	// The location ID of a project configuration manual property.
	LocatorID *string `json:"locator_id" validate:"required"`

	// The inputs of a Schematics template property.
	Input []ProjectConfigInputVariable `json:"input,omitempty"`

	// An optional setting object that's passed to the cart API.
	Setting []ProjectConfigSettingCollection `json:"setting,omitempty"`
}

ProjectConfigPrototype : The input of a project configuration.

type ProjectConfigSettingCollection added in v1.2.0 

type ProjectConfigSettingCollection struct {
	// The name of the configuration setting.
	Name *string `json:"name" validate:"required"`

	// The value of a the configuration setting.
	Value *string `json:"value" validate:"required"`
}

ProjectConfigSettingCollection : ProjectConfigSettingCollection struct

type ProjectMetadata added in v0.88.0 

type ProjectMetadata struct {
	// An IBM Cloud resource name, which uniquely identifies a resource.
	Crn *string `json:"crn,omitempty"`

	// A date/time value in the format YYYY-MM-DDTHH:mm:ssZ or YYYY-MM-DDTHH:mm:ss.sssZ, matching the date-time format as
	// specified by RFC 3339.
	CreatedAt *strfmt.DateTime `json:"created_at,omitempty"`

	// The cumulative list of needs attention items for a project.
	CumulativeNeedsAttentionView []CumulativeNeedsAttention `json:"cumulative_needs_attention_view,omitempty"`

	// "True" indicates that the fetch of the needs attention items failed.
	CumulativeNeedsAttentionViewErr *string `json:"cumulative_needs_attention_view_err,omitempty"`

	// The location where the project was created.
	Location *string `json:"location,omitempty"`

	// The resource group where the project was created.
	ResourceGroup *string `json:"resource_group,omitempty"`

	// The project status value.
	State *string `json:"state,omitempty"`

	// The CRN of the event notifications instance if one is connected to this project.
	EventNotificationsCrn *string `json:"event_notifications_crn,omitempty"`
}

ProjectMetadata : The metadata of the project.

type ProjectV1 

type ProjectV1 struct {
	Service *core.BaseService
}

ProjectV1 : This document is the **REST API specification** for the Projects Service. The Projects service provides the capability to manage Infrastructure as Code in IBM Cloud.

API Version: 1.0.0

func NewProjectV1 

func NewProjectV1(options *ProjectV1Options) (service *ProjectV1, err error)

NewProjectV1 : constructs an instance of ProjectV1 with passed in options.

func NewProjectV1UsingExternalConfig 

func NewProjectV1UsingExternalConfig(options *ProjectV1Options) (project *ProjectV1, err error)

NewProjectV1UsingExternalConfig : constructs an instance of ProjectV1 with passed in options and external configuration.

func (*ProjectV1) Approve added in v1.0.9 

func (project *ProjectV1) Approve(approveOptions *ApproveOptions) (result *ProjectConfig, response *core.DetailedResponse, err error)

Approve : Approve and merge a configuration draft Approve and merge configuration edits to the main configuration.

func (*ProjectV1) ApproveWithContext added in v1.0.9 

func (project *ProjectV1) ApproveWithContext(ctx context.Context, approveOptions *ApproveOptions) (result *ProjectConfig, response *core.DetailedResponse, err error)

ApproveWithContext is an alternate form of the Approve method which supports a Context parameter

func (*ProjectV1) CheckConfig 

func (project *ProjectV1) CheckConfig(checkConfigOptions *CheckConfigOptions) (result *ProjectConfig, response *core.DetailedResponse, err error)

CheckConfig : Run a validation check Run a validation check on a given configuration in project. The check includes creating or updating the associated schematics workspace with a plan job, running the CRA scans, and cost estimatation.

func (*ProjectV1) CheckConfigWithContext 

func (project *ProjectV1) CheckConfigWithContext(ctx context.Context, checkConfigOptions *CheckConfigOptions) (result *ProjectConfig, response *core.DetailedResponse, err error)

CheckConfigWithContext is an alternate form of the CheckConfig method which supports a Context parameter

func (*ProjectV1) Clone 

func (project *ProjectV1) Clone() *ProjectV1

Clone makes a copy of "project" suitable for processing requests.

func (*ProjectV1) CreateConfig 

func (project *ProjectV1) CreateConfig(createConfigOptions *CreateConfigOptions) (result *ProjectConfig, response *core.DetailedResponse, err error)

CreateConfig : Add a new configuration Add a new configuration to a project.

func (*ProjectV1) CreateConfigWithContext 

func (project *ProjectV1) CreateConfigWithContext(ctx context.Context, createConfigOptions *CreateConfigOptions) (result *ProjectConfig, response *core.DetailedResponse, err error)

CreateConfigWithContext is an alternate form of the CreateConfig method which supports a Context parameter

func (*ProjectV1) CreateProject 

func (project *ProjectV1) CreateProject(createProjectOptions *CreateProjectOptions) (result *Project, response *core.DetailedResponse, err error)

CreateProject : Create a project Create a new project and asynchronously setup the tools to manage it. Add a deployable architecture by customizing the configuration. After the changes are validated and approved, deploy the resources that the project configures.

func (*ProjectV1) CreateProjectWithContext 

func (project *ProjectV1) CreateProjectWithContext(ctx context.Context, createProjectOptions *CreateProjectOptions) (result *Project, response *core.DetailedResponse, err error)

CreateProjectWithContext is an alternate form of the CreateProject method which supports a Context parameter

func (*ProjectV1) DeleteConfig 

func (project *ProjectV1) DeleteConfig(deleteConfigOptions *DeleteConfigOptions) (result *ProjectConfigDelete, response *core.DetailedResponse, err error)

DeleteConfig : Delete a configuration in a project by ID Delete a configuration in a project. Deleting the configuration will also destroy all the resources deployed by the configuration if the query parameter destroy is specified.

func (*ProjectV1) DeleteConfigWithContext 

func (project *ProjectV1) DeleteConfigWithContext(ctx context.Context, deleteConfigOptions *DeleteConfigOptions) (result *ProjectConfigDelete, response *core.DetailedResponse, err error)

DeleteConfigWithContext is an alternate form of the DeleteConfig method which supports a Context parameter

func (*ProjectV1) DeleteEventNotificationsIntegration 

func (project *ProjectV1) DeleteEventNotificationsIntegration(deleteEventNotificationsIntegrationOptions *DeleteEventNotificationsIntegrationOptions) (response *core.DetailedResponse, err error)

DeleteEventNotificationsIntegration : Delete an event notifications connection Deletes the event notifications integration if that is where the project was onboarded to.

func (*ProjectV1) DeleteEventNotificationsIntegrationWithContext 

func (project *ProjectV1) DeleteEventNotificationsIntegrationWithContext(ctx context.Context, deleteEventNotificationsIntegrationOptions *DeleteEventNotificationsIntegrationOptions) (response *core.DetailedResponse, err error)

DeleteEventNotificationsIntegrationWithContext is an alternate form of the DeleteEventNotificationsIntegration method which supports a Context parameter

func (*ProjectV1) DeleteProject 

func (project *ProjectV1) DeleteProject(deleteProjectOptions *DeleteProjectOptions) (response *core.DetailedResponse, err error)

DeleteProject : Delete a project Delete a project document by the ID. A project can only be deleted after deleting all of its artifacts.

func (*ProjectV1) DeleteProjectWithContext 

func (project *ProjectV1) DeleteProjectWithContext(ctx context.Context, deleteProjectOptions *DeleteProjectOptions) (response *core.DetailedResponse, err error)

DeleteProjectWithContext is an alternate form of the DeleteProject method which supports a Context parameter

func (*ProjectV1) DeleteServiceInstance 

func (project *ProjectV1) DeleteServiceInstance(deleteServiceInstanceOptions *DeleteServiceInstanceOptions) (result *ResourceDeleteResponse, response *core.DetailedResponse, err error)

DeleteServiceInstance : Delete a project service instance Delete (deprovision) a project service instance by GUID. When a service broker receives a delete request from the IBM Cloud platform, it MUST delete any resources it created during the provision. Usually this means that all resources are immediately reclaimed for future provisions.

func (*ProjectV1) DeleteServiceInstanceWithContext 

func (project *ProjectV1) DeleteServiceInstanceWithContext(ctx context.Context, deleteServiceInstanceOptions *DeleteServiceInstanceOptions) (result *ResourceDeleteResponse, response *core.DetailedResponse, err error)

DeleteServiceInstanceWithContext is an alternate form of the DeleteServiceInstance method which supports a Context parameter

func (*ProjectV1) DisableRetries 

func (project *ProjectV1) DisableRetries()

DisableRetries disables automatic retries for requests invoked for this service instance.

func (*ProjectV1) EnableRetries 

func (project *ProjectV1) EnableRetries(maxRetries int, maxRetryInterval time.Duration)

EnableRetries enables automatic retries for requests invoked for this service instance. If either parameter is specified as 0, then a default value is used instead.

func (*ProjectV1) ForceApprove added in v1.0.9 

func (project *ProjectV1) ForceApprove(forceApproveOptions *ForceApproveOptions) (result *ProjectConfig, response *core.DetailedResponse, err error)

ForceApprove : Force approve project configuration Force approve configuration edits to the main configuration with an approving comment.

func (*ProjectV1) ForceApproveWithContext added in v1.0.9 

func (project *ProjectV1) ForceApproveWithContext(ctx context.Context, forceApproveOptions *ForceApproveOptions) (result *ProjectConfig, response *core.DetailedResponse, err error)

ForceApproveWithContext is an alternate form of the ForceApprove method which supports a Context parameter

func (*ProjectV1) GetCatalog 

func (project *ProjectV1) GetCatalog(getCatalogOptions *GetCatalogOptions) (result *CatalogResponse, response *core.DetailedResponse, err error)

GetCatalog : Get the catalog metadata Fetch the catalog metadata that's stored within the broker.

func (*ProjectV1) GetCatalogWithContext 

func (project *ProjectV1) GetCatalogWithContext(ctx context.Context, getCatalogOptions *GetCatalogOptions) (result *CatalogResponse, response *core.DetailedResponse, err error)

GetCatalogWithContext is an alternate form of the GetCatalog method which supports a Context parameter

func (*ProjectV1) GetConfig 

func (project *ProjectV1) GetConfig(getConfigOptions *GetConfigOptions) (result *ProjectConfig, response *core.DetailedResponse, err error)

GetConfig : Get a project configuration Returns the specified project configuration in a specific project.

func (*ProjectV1) GetConfigDiff 

func (project *ProjectV1) GetConfigDiff(getConfigDiffOptions *GetConfigDiffOptions) (result *ProjectConfigDiff, response *core.DetailedResponse, err error)

GetConfigDiff : Get a diff summary of a project configuration Returns a diff summary of the specified project configuration between its current draft and active version of a specific project.

func (*ProjectV1) GetConfigDiffWithContext 

func (project *ProjectV1) GetConfigDiffWithContext(ctx context.Context, getConfigDiffOptions *GetConfigDiffOptions) (result *ProjectConfigDiff, response *core.DetailedResponse, err error)

GetConfigDiffWithContext is an alternate form of the GetConfigDiff method which supports a Context parameter

func (*ProjectV1) GetConfigWithContext 

func (project *ProjectV1) GetConfigWithContext(ctx context.Context, getConfigOptions *GetConfigOptions) (result *ProjectConfig, response *core.DetailedResponse, err error)

GetConfigWithContext is an alternate form of the GetConfig method which supports a Context parameter

func (*ProjectV1) GetCostEstimate 

func (project *ProjectV1) GetCostEstimate(getCostEstimateOptions *GetCostEstimateOptions) (result *CostEstimate, response *core.DetailedResponse, err error)

GetCostEstimate : Get the cost estimate Retrieve the cost estimate for a configuraton.

func (*ProjectV1) GetCostEstimateWithContext 

func (project *ProjectV1) GetCostEstimateWithContext(ctx context.Context, getCostEstimateOptions *GetCostEstimateOptions) (result *CostEstimate, response *core.DetailedResponse, err error)

GetCostEstimateWithContext is an alternate form of the GetCostEstimate method which supports a Context parameter

func (*ProjectV1) GetEnableGzipCompression 

func (project *ProjectV1) GetEnableGzipCompression() bool

GetEnableGzipCompression returns the service's EnableGzipCompression field

func (*ProjectV1) GetEventNotificationsIntegration 

func (project *ProjectV1) GetEventNotificationsIntegration(getEventNotificationsIntegrationOptions *GetEventNotificationsIntegrationOptions) (result *NotificationsIntegrationGetResponse, response *core.DetailedResponse, err error)

GetEventNotificationsIntegration : Get event notification source details by project ID Gets the source details of the project from the connect event notifications instance.

func (*ProjectV1) GetEventNotificationsIntegrationWithContext 

func (project *ProjectV1) GetEventNotificationsIntegrationWithContext(ctx context.Context, getEventNotificationsIntegrationOptions *GetEventNotificationsIntegrationOptions) (result *NotificationsIntegrationGetResponse, response *core.DetailedResponse, err error)

GetEventNotificationsIntegrationWithContext is an alternate form of the GetEventNotificationsIntegration method which supports a Context parameter

func (*ProjectV1) GetHealth 

func (project *ProjectV1) GetHealth(getHealthOptions *GetHealthOptions) (result *Health, response *core.DetailedResponse, err error)

GetHealth : Get service health information Get service health information.

func (*ProjectV1) GetHealthWithContext 

func (project *ProjectV1) GetHealthWithContext(ctx context.Context, getHealthOptions *GetHealthOptions) (result *Health, response *core.DetailedResponse, err error)

GetHealthWithContext is an alternate form of the GetHealth method which supports a Context parameter

func (*ProjectV1) GetLastOperation 

func (project *ProjectV1) GetLastOperation(getLastOperationOptions *GetLastOperationOptions) (result *ResourceLastOperationGetResponse, response *core.DetailedResponse, err error)

GetLastOperation : Get last_operation for instance by GUID Retrieve previous operation for service instance by GUID (for asynchronous provision calls).

func (*ProjectV1) GetLastOperationWithContext 

func (project *ProjectV1) GetLastOperationWithContext(ctx context.Context, getLastOperationOptions *GetLastOperationOptions) (result *ResourceLastOperationGetResponse, response *core.DetailedResponse, err error)

GetLastOperationWithContext is an alternate form of the GetLastOperation method which supports a Context parameter

func (*ProjectV1) GetNotifications 

func (project *ProjectV1) GetNotifications(getNotificationsOptions *GetNotificationsOptions) (result *NotificationsGetResponse, response *core.DetailedResponse, err error)

GetNotifications : Get events by project ID Get all the notification events from a specific project ID.

func (*ProjectV1) GetNotificationsWithContext 

func (project *ProjectV1) GetNotificationsWithContext(ctx context.Context, getNotificationsOptions *GetNotificationsOptions) (result *NotificationsGetResponse, response *core.DetailedResponse, err error)

GetNotificationsWithContext is an alternate form of the GetNotifications method which supports a Context parameter

func (*ProjectV1) GetProject 

func (project *ProjectV1) GetProject(getProjectOptions *GetProjectOptions) (result *Project, response *core.DetailedResponse, err error)

GetProject : Get project by ID Get a project instance by ID.

func (*ProjectV1) GetProjectWithContext 

func (project *ProjectV1) GetProjectWithContext(ctx context.Context, getProjectOptions *GetProjectOptions) (result *Project, response *core.DetailedResponse, err error)

GetProjectWithContext is an alternate form of the GetProject method which supports a Context parameter

func (*ProjectV1) GetSchematicsJob 

func (project *ProjectV1) GetSchematicsJob(getSchematicsJobOptions *GetSchematicsJobOptions) (result *ActionJob, response *core.DetailedResponse, err error)

GetSchematicsJob : View the latest schematics job Fetch and find the latest schematics job that corresponds to a plan, deploy, or destroy configuration resource action.

func (*ProjectV1) GetSchematicsJobWithContext 

func (project *ProjectV1) GetSchematicsJobWithContext(ctx context.Context, getSchematicsJobOptions *GetSchematicsJobOptions) (result *ActionJob, response *core.DetailedResponse, err error)

GetSchematicsJobWithContext is an alternate form of the GetSchematicsJob method which supports a Context parameter

func (*ProjectV1) GetServiceInstance 

func (project *ProjectV1) GetServiceInstance(getServiceInstanceOptions *GetServiceInstanceOptions) (result *ResourceStateResponse, response *core.DetailedResponse, err error)

GetServiceInstance : Get the current state information Retrieve the current state for the specified service instance.

func (*ProjectV1) GetServiceInstanceWithContext 

func (project *ProjectV1) GetServiceInstanceWithContext(ctx context.Context, getServiceInstanceOptions *GetServiceInstanceOptions) (result *ResourceStateResponse, response *core.DetailedResponse, err error)

GetServiceInstanceWithContext is an alternate form of the GetServiceInstance method which supports a Context parameter

func (*ProjectV1) GetServiceURL 

func (project *ProjectV1) GetServiceURL() string

GetServiceURL returns the service URL

func (*ProjectV1) InstallConfig 

func (project *ProjectV1) InstallConfig(installConfigOptions *InstallConfigOptions) (result *ProjectConfig, response *core.DetailedResponse, err error)

InstallConfig : Deploy a configuration Deploy a project's configuration. It's an asynchronous operation that can be tracked using the get project configuration API with full metadata.

func (*ProjectV1) InstallConfigWithContext 

func (project *ProjectV1) InstallConfigWithContext(ctx context.Context, installConfigOptions *InstallConfigOptions) (result *ProjectConfig, response *core.DetailedResponse, err error)

InstallConfigWithContext is an alternate form of the InstallConfig method which supports a Context parameter

func (*ProjectV1) ListConfigs 

func (project *ProjectV1) ListConfigs(listConfigsOptions *ListConfigsOptions) (result *ProjectConfigCollection, response *core.DetailedResponse, err error)

ListConfigs : List all project configurations The collection of configurations that are returned.

func (*ProjectV1) ListConfigsWithContext 

func (project *ProjectV1) ListConfigsWithContext(ctx context.Context, listConfigsOptions *ListConfigsOptions) (result *ProjectConfigCollection, response *core.DetailedResponse, err error)

ListConfigsWithContext is an alternate form of the ListConfigs method which supports a Context parameter

func (*ProjectV1) ListProjects 

func (project *ProjectV1) ListProjects(listProjectsOptions *ListProjectsOptions) (result *ProjectCollection, response *core.DetailedResponse, err error)

ListProjects : List projects List existing projects. Projects are sorted by ID.

func (*ProjectV1) ListProjectsWithContext 

func (project *ProjectV1) ListProjectsWithContext(ctx context.Context, listProjectsOptions *ListProjectsOptions) (result *ProjectCollection, response *core.DetailedResponse, err error)

ListProjectsWithContext is an alternate form of the ListProjects method which supports a Context parameter

func (*ProjectV1) NewApproveOptions added in v1.0.9 

func (*ProjectV1) NewApproveOptions(id string, configID string) *ApproveOptions

NewApproveOptions : Instantiate ApproveOptions

func (*ProjectV1) NewCheckConfigOptions 

func (*ProjectV1) NewCheckConfigOptions(id string, configID string) *CheckConfigOptions

NewCheckConfigOptions : Instantiate CheckConfigOptions

func (*ProjectV1) NewCreateConfigOptions 

func (*ProjectV1) NewCreateConfigOptions(id string, newName string, newLocatorID string) *CreateConfigOptions

NewCreateConfigOptions : Instantiate CreateConfigOptions

func (*ProjectV1) NewCreateProjectOptions 

func (*ProjectV1) NewCreateProjectOptions(name string) *CreateProjectOptions

NewCreateProjectOptions : Instantiate CreateProjectOptions

func (*ProjectV1) NewDeleteConfigOptions 

func (*ProjectV1) NewDeleteConfigOptions(id string, configID string) *DeleteConfigOptions

NewDeleteConfigOptions : Instantiate DeleteConfigOptions

func (*ProjectV1) NewDeleteEventNotificationsIntegrationOptions 

func (*ProjectV1) NewDeleteEventNotificationsIntegrationOptions(id string) *DeleteEventNotificationsIntegrationOptions

NewDeleteEventNotificationsIntegrationOptions : Instantiate DeleteEventNotificationsIntegrationOptions

func (*ProjectV1) NewDeleteProjectOptions 

func (*ProjectV1) NewDeleteProjectOptions(id string) *DeleteProjectOptions

NewDeleteProjectOptions : Instantiate DeleteProjectOptions

func (*ProjectV1) NewDeleteServiceInstanceOptions 

func (*ProjectV1) NewDeleteServiceInstanceOptions(instanceID string, planID string, serviceID string) *DeleteServiceInstanceOptions

NewDeleteServiceInstanceOptions : Instantiate DeleteServiceInstanceOptions

func (*ProjectV1) NewForceApproveOptions added in v1.0.9 

func (*ProjectV1) NewForceApproveOptions(id string, configID string) *ForceApproveOptions

NewForceApproveOptions : Instantiate ForceApproveOptions

func (*ProjectV1) NewGetCatalogOptions 

func (*ProjectV1) NewGetCatalogOptions() *GetCatalogOptions

NewGetCatalogOptions : Instantiate GetCatalogOptions

func (*ProjectV1) NewGetConfigDiffOptions 

func (*ProjectV1) NewGetConfigDiffOptions(id string, configID string) *GetConfigDiffOptions

NewGetConfigDiffOptions : Instantiate GetConfigDiffOptions

func (*ProjectV1) NewGetConfigOptions 

func (*ProjectV1) NewGetConfigOptions(id string, configID string) *GetConfigOptions

NewGetConfigOptions : Instantiate GetConfigOptions

func (*ProjectV1) NewGetCostEstimateOptions 

func (*ProjectV1) NewGetCostEstimateOptions(id string, configID string) *GetCostEstimateOptions

NewGetCostEstimateOptions : Instantiate GetCostEstimateOptions

func (*ProjectV1) NewGetEventNotificationsIntegrationOptions 

func (*ProjectV1) NewGetEventNotificationsIntegrationOptions(id string) *GetEventNotificationsIntegrationOptions

NewGetEventNotificationsIntegrationOptions : Instantiate GetEventNotificationsIntegrationOptions

func (*ProjectV1) NewGetHealthOptions 

func (*ProjectV1) NewGetHealthOptions() *GetHealthOptions

NewGetHealthOptions : Instantiate GetHealthOptions

func (*ProjectV1) NewGetLastOperationOptions 

func (*ProjectV1) NewGetLastOperationOptions(instanceID string) *GetLastOperationOptions

NewGetLastOperationOptions : Instantiate GetLastOperationOptions

func (*ProjectV1) NewGetNotificationsOptions 

func (*ProjectV1) NewGetNotificationsOptions(id string) *GetNotificationsOptions

NewGetNotificationsOptions : Instantiate GetNotificationsOptions

func (*ProjectV1) NewGetProjectOptions 

func (*ProjectV1) NewGetProjectOptions(id string) *GetProjectOptions

NewGetProjectOptions : Instantiate GetProjectOptions

func (*ProjectV1) NewGetSchematicsJobOptions 

func (*ProjectV1) NewGetSchematicsJobOptions(id string, configID string, action string) *GetSchematicsJobOptions

NewGetSchematicsJobOptions : Instantiate GetSchematicsJobOptions

func (*ProjectV1) NewGetServiceInstanceOptions 

func (*ProjectV1) NewGetServiceInstanceOptions(instanceID string) *GetServiceInstanceOptions

NewGetServiceInstanceOptions : Instantiate GetServiceInstanceOptions

func (*ProjectV1) NewInstallConfigOptions 

func (*ProjectV1) NewInstallConfigOptions(id string, configID string) *InstallConfigOptions

NewInstallConfigOptions : Instantiate InstallConfigOptions

func (*ProjectV1) NewJSONPatchOperation added in v0.88.0 

func (*ProjectV1) NewJSONPatchOperation(op string, path string) (_model *JSONPatchOperation, err error)

NewJSONPatchOperation : Instantiate JSONPatchOperation (Generic Model Constructor)

func (*ProjectV1) NewListConfigsOptions 

func (*ProjectV1) NewListConfigsOptions(id string) *ListConfigsOptions

NewListConfigsOptions : Instantiate ListConfigsOptions

func (*ProjectV1) NewListProjectsOptions 

func (*ProjectV1) NewListProjectsOptions() *ListProjectsOptions

NewListProjectsOptions : Instantiate ListProjectsOptions

func (*ProjectV1) NewNotificationEvent 

func (*ProjectV1) NewNotificationEvent(event string, target string) (_model *NotificationEvent, err error)

NewNotificationEvent : Instantiate NotificationEvent (Generic Model Constructor)

func (*ProjectV1) NewPostCrnTokenOptions added in v1.0.9 

func (*ProjectV1) NewPostCrnTokenOptions(id string) *PostCrnTokenOptions

NewPostCrnTokenOptions : Instantiate PostCrnTokenOptions

func (*ProjectV1) NewPostEventNotificationsIntegrationOptions 

func (*ProjectV1) NewPostEventNotificationsIntegrationOptions(id string, instanceCrn string) *PostEventNotificationsIntegrationOptions

NewPostEventNotificationsIntegrationOptions : Instantiate PostEventNotificationsIntegrationOptions

func (*ProjectV1) NewPostNotificationOptions 

func (*ProjectV1) NewPostNotificationOptions(id string) *PostNotificationOptions

NewPostNotificationOptions : Instantiate PostNotificationOptions

func (*ProjectV1) NewPostTestEventNotificationOptions added in v0.88.0 

func (*ProjectV1) NewPostTestEventNotificationOptions(id string) *PostTestEventNotificationOptions

NewPostTestEventNotificationOptions : Instantiate PostTestEventNotificationOptions

func (*ProjectV1) NewProjectConfigInputVariable added in v1.2.0 

func (*ProjectV1) NewProjectConfigInputVariable(name string) (_model *ProjectConfigInputVariable, err error)

NewProjectConfigInputVariable : Instantiate ProjectConfigInputVariable (Generic Model Constructor)

func (*ProjectV1) NewProjectConfigPatch added in v0.88.0 

func (*ProjectV1) NewProjectConfigPatch(projectConfig *ProjectConfig) (_patch []JSONPatchOperation)

func (*ProjectV1) NewProjectConfigPrototype added in v1.2.0 

func (*ProjectV1) NewProjectConfigPrototype(name string, locatorID string) (_model *ProjectConfigPrototype, err error)

NewProjectConfigPrototype : Instantiate ProjectConfigPrototype (Generic Model Constructor)

func (*ProjectV1) NewProjectConfigSettingCollection added in v1.2.0 

func (*ProjectV1) NewProjectConfigSettingCollection(name string, value string) (_model *ProjectConfigSettingCollection, err error)

NewProjectConfigSettingCollection : Instantiate ProjectConfigSettingCollection (Generic Model Constructor)

func (*ProjectV1) NewProjectPatch added in v1.2.0 

func (*ProjectV1) NewProjectPatch(project *Project) (_patch []JSONPatchOperation)

func (*ProjectV1) NewProjectsPager 

func (project *ProjectV1) NewProjectsPager(options *ListProjectsOptions) (pager *ProjectsPager, err error)

NewProjectsPager returns a new ProjectsPager instance.

func (*ProjectV1) NewPulsarEventPrototypeCollection added in v1.2.0 

func (*ProjectV1) NewPulsarEventPrototypeCollection(eventType string, timestamp *strfmt.DateTime, publisher string, accountID string, version string) (_model *PulsarEventPrototypeCollection, err error)

NewPulsarEventPrototypeCollection : Instantiate PulsarEventPrototypeCollection (Generic Model Constructor)

func (*ProjectV1) NewReceivePulsarCatalogEventsOptions 

func (*ProjectV1) NewReceivePulsarCatalogEventsOptions(pulsarCatalogEvents []PulsarEventPrototypeCollection) *ReceivePulsarCatalogEventsOptions

NewReceivePulsarCatalogEventsOptions : Instantiate ReceivePulsarCatalogEventsOptions

func (*ProjectV1) NewReceivePulsarEventNotificationEventsOptions added in v1.3.0 

func (*ProjectV1) NewReceivePulsarEventNotificationEventsOptions(pulsarEventNotificationEvents []PulsarEventPrototypeCollection) *ReceivePulsarEventNotificationEventsOptions

NewReceivePulsarEventNotificationEventsOptions : Instantiate ReceivePulsarEventNotificationEventsOptions

func (*ProjectV1) NewReplaceServiceInstanceOptions 

func (*ProjectV1) NewReplaceServiceInstanceOptions(instanceID string, serviceID string, planID string) *ReplaceServiceInstanceOptions

NewReplaceServiceInstanceOptions : Instantiate ReplaceServiceInstanceOptions

func (*ProjectV1) NewReplaceServiceInstanceStateOptions 

func (*ProjectV1) NewReplaceServiceInstanceStateOptions(instanceID string, enabled bool) *ReplaceServiceInstanceStateOptions

NewReplaceServiceInstanceStateOptions : Instantiate ReplaceServiceInstanceStateOptions

func (*ProjectV1) NewResourceUpdateResultPatch added in v1.2.0 

func (*ProjectV1) NewResourceUpdateResultPatch(resourceUpdateResult *ResourceUpdateResult) (_patch []JSONPatchOperation)

func (*ProjectV1) NewUninstallConfigOptions 

func (*ProjectV1) NewUninstallConfigOptions(id string, configID string) *UninstallConfigOptions

NewUninstallConfigOptions : Instantiate UninstallConfigOptions

func (*ProjectV1) NewUpdateConfigOptions 

func (*ProjectV1) NewUpdateConfigOptions(id string, configID string, projectConfig []JSONPatchOperation) *UpdateConfigOptions

NewUpdateConfigOptions : Instantiate UpdateConfigOptions

func (*ProjectV1) NewUpdateProjectOptions 

func (*ProjectV1) NewUpdateProjectOptions(id string, jsonPatchOperation []JSONPatchOperation) *UpdateProjectOptions

NewUpdateProjectOptions : Instantiate UpdateProjectOptions

func (*ProjectV1) NewUpdateServiceInstanceOptions 

func (*ProjectV1) NewUpdateServiceInstanceOptions(instanceID string, jsonPatchOperation []JSONPatchOperation) *UpdateServiceInstanceOptions

NewUpdateServiceInstanceOptions : Instantiate UpdateServiceInstanceOptions

func (*ProjectV1) PostCrnToken added in v1.0.9 

func (project *ProjectV1) PostCrnToken(postCrnTokenOptions *PostCrnTokenOptions) (result *ProjectCRNTokenResponse, response *core.DetailedResponse, err error)

PostCrnToken : Creates a project CRN token Refreshes a project CRN token by creating a new one.

func (*ProjectV1) PostCrnTokenWithContext added in v1.0.9 

func (project *ProjectV1) PostCrnTokenWithContext(ctx context.Context, postCrnTokenOptions *PostCrnTokenOptions) (result *ProjectCRNTokenResponse, response *core.DetailedResponse, err error)

PostCrnTokenWithContext is an alternate form of the PostCrnToken method which supports a Context parameter

func (*ProjectV1) PostEventNotificationsIntegration 

func (project *ProjectV1) PostEventNotificationsIntegration(postEventNotificationsIntegrationOptions *PostEventNotificationsIntegrationOptions) (result *NotificationsIntegrationPostResponse, response *core.DetailedResponse, err error)

PostEventNotificationsIntegration : Connect to a event notifications instance Connects a project instance to an event notifications instance.

func (*ProjectV1) PostEventNotificationsIntegrationWithContext 

func (project *ProjectV1) PostEventNotificationsIntegrationWithContext(ctx context.Context, postEventNotificationsIntegrationOptions *PostEventNotificationsIntegrationOptions) (result *NotificationsIntegrationPostResponse, response *core.DetailedResponse, err error)

PostEventNotificationsIntegrationWithContext is an alternate form of the PostEventNotificationsIntegration method which supports a Context parameter

func (*ProjectV1) PostNotification 

func (project *ProjectV1) PostNotification(postNotificationOptions *PostNotificationOptions) (result *NotificationsPrototypePostResponse, response *core.DetailedResponse, err error)

PostNotification : Add notifications Creates a notification event to be stored on the project definition.

func (*ProjectV1) PostNotificationWithContext 

func (project *ProjectV1) PostNotificationWithContext(ctx context.Context, postNotificationOptions *PostNotificationOptions) (result *NotificationsPrototypePostResponse, response *core.DetailedResponse, err error)

PostNotificationWithContext is an alternate form of the PostNotification method which supports a Context parameter

func (*ProjectV1) PostTestEventNotification added in v0.88.0 

func (project *ProjectV1) PostTestEventNotification(postTestEventNotificationOptions *PostTestEventNotificationOptions) (result *NotificationsIntegrationTestPostResponse, response *core.DetailedResponse, err error)

PostTestEventNotification : Send notification to event notifications instance Sends a notification to the event notifications instance.

func (*ProjectV1) PostTestEventNotificationWithContext added in v0.88.0 

func (project *ProjectV1) PostTestEventNotificationWithContext(ctx context.Context, postTestEventNotificationOptions *PostTestEventNotificationOptions) (result *NotificationsIntegrationTestPostResponse, response *core.DetailedResponse, err error)

PostTestEventNotificationWithContext is an alternate form of the PostTestEventNotification method which supports a Context parameter

func (*ProjectV1) ReceivePulsarCatalogEvents 

func (project *ProjectV1) ReceivePulsarCatalogEvents(receivePulsarCatalogEventsOptions *ReceivePulsarCatalogEventsOptions) (response *core.DetailedResponse, err error)

ReceivePulsarCatalogEvents : Webhook for catalog events This is a webhook for pulsar catalog events.

func (*ProjectV1) ReceivePulsarCatalogEventsWithContext 

func (project *ProjectV1) ReceivePulsarCatalogEventsWithContext(ctx context.Context, receivePulsarCatalogEventsOptions *ReceivePulsarCatalogEventsOptions) (response *core.DetailedResponse, err error)

ReceivePulsarCatalogEventsWithContext is an alternate form of the ReceivePulsarCatalogEvents method which supports a Context parameter

func (*ProjectV1) ReceivePulsarEventNotificationEvents added in v1.3.0 

func (project *ProjectV1) ReceivePulsarEventNotificationEvents(receivePulsarEventNotificationEventsOptions *ReceivePulsarEventNotificationEventsOptions) (response *core.DetailedResponse, err error)

ReceivePulsarEventNotificationEvents : Webhook for event notifications events This is a webhook for event notifications events.

func (*ProjectV1) ReceivePulsarEventNotificationEventsWithContext added in v1.3.0 

func (project *ProjectV1) ReceivePulsarEventNotificationEventsWithContext(ctx context.Context, receivePulsarEventNotificationEventsOptions *ReceivePulsarEventNotificationEventsOptions) (response *core.DetailedResponse, err error)

ReceivePulsarEventNotificationEventsWithContext is an alternate form of the ReceivePulsarEventNotificationEvents method which supports a Context parameter

func (*ProjectV1) ReplaceServiceInstance 

func (project *ProjectV1) ReplaceServiceInstance(replaceServiceInstanceOptions *ReplaceServiceInstanceOptions) (result *ResourceCreateResponse, response *core.DetailedResponse, err error)

ReplaceServiceInstance : Create a new service instance Create a new service instance Create a service instance. When the service broker receives a provision request from the IBM Cloud platform, it MUST take whatever action is necessary to create a new resource. When a user creates a service instance from the IBM Cloud console or the IBM Cloud CLI, the IBM Cloud platform validates that the user has permission to create the service instance by using IBM Cloud IAM. After this validation occurs, your service broker's provision endpoint (PUT /v2/resource_instances/:instance_id) will be invoked. When provisioning occurs, the IBM Cloud platform provides the following values: - The IBM Cloud context is included in the context variable - The X-Broker-API-Originating-Identity will have the IBM IAM ID of the user that initiated the request - The parameters section will include the requested location (and additional parameters required by your service).

func (*ProjectV1) ReplaceServiceInstanceState 

func (project *ProjectV1) ReplaceServiceInstanceState(replaceServiceInstanceStateOptions *ReplaceServiceInstanceStateOptions) (result *ResourceStateResponse, response *core.DetailedResponse, err error)

ReplaceServiceInstanceState : Update the state of a provisioned service instance Update (disable or enable) the state of a provisioned service instance.

func (*ProjectV1) ReplaceServiceInstanceStateWithContext 

func (project *ProjectV1) ReplaceServiceInstanceStateWithContext(ctx context.Context, replaceServiceInstanceStateOptions *ReplaceServiceInstanceStateOptions) (result *ResourceStateResponse, response *core.DetailedResponse, err error)

ReplaceServiceInstanceStateWithContext is an alternate form of the ReplaceServiceInstanceState method which supports a Context parameter

func (*ProjectV1) ReplaceServiceInstanceWithContext 

func (project *ProjectV1) ReplaceServiceInstanceWithContext(ctx context.Context, replaceServiceInstanceOptions *ReplaceServiceInstanceOptions) (result *ResourceCreateResponse, response *core.DetailedResponse, err error)

ReplaceServiceInstanceWithContext is an alternate form of the ReplaceServiceInstance method which supports a Context parameter

func (*ProjectV1) SetDefaultHeaders 

func (project *ProjectV1) SetDefaultHeaders(headers http.Header)

SetDefaultHeaders sets HTTP headers to be sent in every request

func (*ProjectV1) SetEnableGzipCompression 

func (project *ProjectV1) SetEnableGzipCompression(enableGzip bool)

SetEnableGzipCompression sets the service's EnableGzipCompression field

func (*ProjectV1) SetServiceURL 

func (project *ProjectV1) SetServiceURL(url string) error

SetServiceURL sets the service URL

func (*ProjectV1) UninstallConfig 

func (project *ProjectV1) UninstallConfig(uninstallConfigOptions *UninstallConfigOptions) (response *core.DetailedResponse, err error)

UninstallConfig : Destroy configuration resources Destroy a project's configuration resources. The operation destroys all the resources that are deployed with the specific configuration. You can track it by using the get project configuration API with full metadata.

func (*ProjectV1) UninstallConfigWithContext 

func (project *ProjectV1) UninstallConfigWithContext(ctx context.Context, uninstallConfigOptions *UninstallConfigOptions) (response *core.DetailedResponse, err error)

UninstallConfigWithContext is an alternate form of the UninstallConfig method which supports a Context parameter

func (*ProjectV1) UpdateConfig 

func (project *ProjectV1) UpdateConfig(updateConfigOptions *UpdateConfigOptions) (result *ProjectConfig, response *core.DetailedResponse, err error)

UpdateConfig : Update a configuration Update a configuration in a project by the ID.

func (*ProjectV1) UpdateConfigWithContext 

func (project *ProjectV1) UpdateConfigWithContext(ctx context.Context, updateConfigOptions *UpdateConfigOptions) (result *ProjectConfig, response *core.DetailedResponse, err error)

UpdateConfigWithContext is an alternate form of the UpdateConfig method which supports a Context parameter

func (*ProjectV1) UpdateProject 

func (project *ProjectV1) UpdateProject(updateProjectOptions *UpdateProjectOptions) (result *Project, response *core.DetailedResponse, err error)

UpdateProject : Update a project Update a project by the ID.

func (*ProjectV1) UpdateProjectWithContext 

func (project *ProjectV1) UpdateProjectWithContext(ctx context.Context, updateProjectOptions *UpdateProjectOptions) (result *Project, response *core.DetailedResponse, err error)

UpdateProjectWithContext is an alternate form of the UpdateProject method which supports a Context parameter

func (*ProjectV1) UpdateServiceInstance 

func (project *ProjectV1) UpdateServiceInstance(updateServiceInstanceOptions *UpdateServiceInstanceOptions) (result *ResourceUpdateResult, response *core.DetailedResponse, err error)

UpdateServiceInstance : Change of plans and service parameters in a provisioned service instance Allows an update to the plans and service parameters in a provisioned service instance.

func (*ProjectV1) UpdateServiceInstanceWithContext 

func (project *ProjectV1) UpdateServiceInstanceWithContext(ctx context.Context, updateServiceInstanceOptions *UpdateServiceInstanceOptions) (result *ResourceUpdateResult, response *core.DetailedResponse, err error)

UpdateServiceInstanceWithContext is an alternate form of the UpdateServiceInstance method which supports a Context parameter

type ProjectV1Options 

type ProjectV1Options struct {
	ServiceName   string
	URL           string
	Authenticator core.Authenticator
}

ProjectV1Options : Service options

type ProjectsPager 

type ProjectsPager struct {
	// contains filtered or unexported fields
}

ProjectsPager can be used to simplify the use of the "ListProjects" method.

func (*ProjectsPager) GetAll 

func (pager *ProjectsPager) GetAll() (allItems []ProjectCollectionMemberWithMetadata, err error)

GetAll invokes GetAllWithContext() using context.Background() as the Context parameter.

func (*ProjectsPager) GetAllWithContext 

func (pager *ProjectsPager) GetAllWithContext(ctx context.Context) (allItems []ProjectCollectionMemberWithMetadata, err error)

GetAllWithContext returns all results by invoking GetNextWithContext() repeatedly until all pages of results have been retrieved.

func (*ProjectsPager) GetNext 

func (pager *ProjectsPager) GetNext() (page []ProjectCollectionMemberWithMetadata, err error)

GetNext invokes GetNextWithContext() using context.Background() as the Context parameter.

func (*ProjectsPager) GetNextWithContext 

func (pager *ProjectsPager) GetNextWithContext(ctx context.Context) (page []ProjectCollectionMemberWithMetadata, err error)

GetNextWithContext returns the next page of results using the specified Context.

func (*ProjectsPager) HasNext 

func (pager *ProjectsPager) HasNext() bool

HasNext returns true if there are potentially more results to be retrieved.

type PulsarEventPrototypeCollection added in v1.2.0 

type PulsarEventPrototypeCollection struct {
	// The type of the event that is published and written in dot notation.
	EventType *string `json:"event_type" validate:"required"`

	// A date/time value in the format YYYY-MM-DDTHH:mm:ssZ or YYYY-MM-DDTHH:mm:ss.sssZ, matching the date-time format as
	// specified by RFC 3339.
	Timestamp *strfmt.DateTime `json:"timestamp" validate:"required"`

	// The publisher of the events, preferably written as the service's CRN.
	Publisher *string `json:"publisher" validate:"required"`

	// The IBMid that the event is scoped to.
	AccountID *string `json:"account_id" validate:"required"`

	// The version of the payload.
	Version *string `json:"version" validate:"required"`

	// Custom event properties for a specific event.
	EventProperties map[string]interface{} `json:"event_properties,omitempty"`

	// A unique identifier for that individual event.
	EventID *string `json:"event_id,omitempty"`
	// contains filtered or unexported fields
}

PulsarEventPrototypeCollection : PulsarEventPrototypeCollection struct

func (*PulsarEventPrototypeCollection) GetProperties added in v1.2.0 

func (o *PulsarEventPrototypeCollection) GetProperties() map[string]interface{}

GetProperties allows the user to retrieve the map of arbitrary properties from an instance of PulsarEventPrototypeCollection

func (*PulsarEventPrototypeCollection) GetProperty added in v1.2.0 

func (o *PulsarEventPrototypeCollection) GetProperty(key string) interface{}

GetProperty allows the user to retrieve an arbitrary property from an instance of PulsarEventPrototypeCollection

func (*PulsarEventPrototypeCollection) MarshalJSON added in v1.2.0 

func (o *PulsarEventPrototypeCollection) MarshalJSON() (buffer []byte, err error)

MarshalJSON performs custom serialization for instances of PulsarEventPrototypeCollection

func (*PulsarEventPrototypeCollection) SetProperties added in v1.2.0 

func (o *PulsarEventPrototypeCollection) SetProperties(m map[string]interface{})

SetProperties allows the user to set a map of arbitrary properties on an instance of PulsarEventPrototypeCollection

func (*PulsarEventPrototypeCollection) SetProperty added in v1.2.0 

func (o *PulsarEventPrototypeCollection) SetProperty(key string, value interface{})

SetProperty allows the user to set an arbitrary property on an instance of PulsarEventPrototypeCollection

type ReceivePulsarCatalogEventsOptions 

type ReceivePulsarCatalogEventsOptions struct {
	// A pulsar event.
	PulsarCatalogEvents []PulsarEventPrototypeCollection `json:"pulsar_catalog_events" validate:"required"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

ReceivePulsarCatalogEventsOptions : The ReceivePulsarCatalogEvents options.

func (*ReceivePulsarCatalogEventsOptions) SetHeaders 

func (options *ReceivePulsarCatalogEventsOptions) SetHeaders(param map[string]string) *ReceivePulsarCatalogEventsOptions

SetHeaders : Allow user to set Headers

func (*ReceivePulsarCatalogEventsOptions) SetPulsarCatalogEvents 

func (_options *ReceivePulsarCatalogEventsOptions) SetPulsarCatalogEvents(pulsarCatalogEvents []PulsarEventPrototypeCollection) *ReceivePulsarCatalogEventsOptions

SetPulsarCatalogEvents : Allow user to set PulsarCatalogEvents

type ReceivePulsarEventNotificationEventsOptions added in v1.3.0 

type ReceivePulsarEventNotificationEventsOptions struct {
	// A pulsar event.
	PulsarEventNotificationEvents []PulsarEventPrototypeCollection `json:"pulsar_event_notification_events" validate:"required"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

ReceivePulsarEventNotificationEventsOptions : The ReceivePulsarEventNotificationEvents options.

func (*ReceivePulsarEventNotificationEventsOptions) SetHeaders added in v1.3.0 

func (options *ReceivePulsarEventNotificationEventsOptions) SetHeaders(param map[string]string) *ReceivePulsarEventNotificationEventsOptions

SetHeaders : Allow user to set Headers

func (*ReceivePulsarEventNotificationEventsOptions) SetPulsarEventNotificationEvents added in v1.3.0 

func (_options *ReceivePulsarEventNotificationEventsOptions) SetPulsarEventNotificationEvents(pulsarEventNotificationEvents []PulsarEventPrototypeCollection) *ReceivePulsarEventNotificationEventsOptions

SetPulsarEventNotificationEvents : Allow user to set PulsarEventNotificationEvents

type ReplaceServiceInstanceOptions 

type ReplaceServiceInstanceOptions struct {
	// The instance_id of a service instance is provided by the IBM Cloud platform.
	InstanceID *string `json:"instance_id" validate:"required,ne="`

	// The ID of the service stored in the catalog.j-son of your broker. This value should be a GUID and it MUST be a
	// non-empty string.
	ServiceID *string `json:"service_id" validate:"required"`

	// The ID of the plan for which the service instance has been requested, which is stored in the catalog.j-son of your
	// broker.
	PlanID *string `json:"plan_id" validate:"required"`

	// Platform specific contextual information where the service instance will be provisioned.
	Context []string `json:"context,omitempty"`

	// Configuration options for the service instance. An opaque object, controller treats this as a blob. Brokers should
	// ensure that the client has provided valid configuration parameters and values for the operation. If this field is
	// not present in the request message, then the broker MUST NOT change the parameters of the instance as a result of
	// this request.
	Parameters map[string]interface{} `json:"parameters,omitempty"`

	// Information about the service instance prior to the update.
	PreviousValues []string `json:"previous_values,omitempty"`

	// Broker Api Version.
	XBrokerApiVersion *string `json:"X-Broker-Api-Version,omitempty"`

	// Broker Api Originating Identity.
	XBrokerApiOriginatingIdentity *string `json:"X-Broker-Api-Originating-Identity,omitempty"`

	// A value of true indicates that both the IBM Cloud platform and the requesting client support asynchronous
	// deprovisioning. If this parameter is not included in the request, and the broker can only deprovision a service
	// instance of the requested plan asynchronously, the broker MUST reject the request with a 422 Unprocessable Entity.
	AcceptsIncomplete *bool `json:"accepts_incomplete,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

ReplaceServiceInstanceOptions : The ReplaceServiceInstance options.

func (*ReplaceServiceInstanceOptions) SetAcceptsIncomplete 

func (_options *ReplaceServiceInstanceOptions) SetAcceptsIncomplete(acceptsIncomplete bool) *ReplaceServiceInstanceOptions

SetAcceptsIncomplete : Allow user to set AcceptsIncomplete

func (*ReplaceServiceInstanceOptions) SetContext 

func (_options *ReplaceServiceInstanceOptions) SetContext(context []string) *ReplaceServiceInstanceOptions

SetContext : Allow user to set Context

func (*ReplaceServiceInstanceOptions) SetHeaders 

func (options *ReplaceServiceInstanceOptions) SetHeaders(param map[string]string) *ReplaceServiceInstanceOptions

SetHeaders : Allow user to set Headers

func (*ReplaceServiceInstanceOptions) SetInstanceID 

func (_options *ReplaceServiceInstanceOptions) SetInstanceID(instanceID string) *ReplaceServiceInstanceOptions

SetInstanceID : Allow user to set InstanceID

func (*ReplaceServiceInstanceOptions) SetParameters 

func (_options *ReplaceServiceInstanceOptions) SetParameters(parameters map[string]interface{}) *ReplaceServiceInstanceOptions

SetParameters : Allow user to set Parameters

func (*ReplaceServiceInstanceOptions) SetPlanID 

func (_options *ReplaceServiceInstanceOptions) SetPlanID(planID string) *ReplaceServiceInstanceOptions

SetPlanID : Allow user to set PlanID

func (*ReplaceServiceInstanceOptions) SetPreviousValues 

func (_options *ReplaceServiceInstanceOptions) SetPreviousValues(previousValues []string) *ReplaceServiceInstanceOptions

SetPreviousValues : Allow user to set PreviousValues

func (*ReplaceServiceInstanceOptions) SetServiceID 

func (_options *ReplaceServiceInstanceOptions) SetServiceID(serviceID string) *ReplaceServiceInstanceOptions

SetServiceID : Allow user to set ServiceID

func (*ReplaceServiceInstanceOptions) SetXBrokerApiOriginatingIdentity 

func (_options *ReplaceServiceInstanceOptions) SetXBrokerApiOriginatingIdentity(xBrokerApiOriginatingIdentity string) *ReplaceServiceInstanceOptions

SetXBrokerApiOriginatingIdentity : Allow user to set XBrokerApiOriginatingIdentity

func (*ReplaceServiceInstanceOptions) SetXBrokerApiVersion 

func (_options *ReplaceServiceInstanceOptions) SetXBrokerApiVersion(xBrokerApiVersion string) *ReplaceServiceInstanceOptions

SetXBrokerApiVersion : Allow user to set XBrokerApiVersion

type ReplaceServiceInstanceStateOptions 

type ReplaceServiceInstanceStateOptions struct {
	// The instance_id of a service instance is provided by the IBM Cloud platform.
	InstanceID *string `json:"instance_id" validate:"required,ne="`

	// The ID of the service stored in the catalog.j-son of your broker. This value should be a GUID. It MUST be a
	// non-empty string.
	Enabled *bool `json:"enabled" validate:"required"`

	// Optional string that shows the user ID that is initiating the call.
	InitiatorID *string `json:"initiator_id,omitempty"`

	// Optional string that states the reason code for the service instance state change. Valid values are
	// IBMCLOUD_ACCT_ACTIVATE, IBMCLOUD_RECLAMATION_RESTORE, or IBMCLOUD_SERVICE_INSTANCE_BELOW_CAP for enable calls;
	// IBMCLOUD_ACCT_SUSPEND, IBMCLOUD_RECLAMATION_SCHEDULE, or IBMCLOUD_SERVICE_INSTANCE_ABOVE_CAP for disable calls; and
	// IBMCLOUD_ADMIN_REQUEST for enable and disable calls.
	ReasonCode map[string]interface{} `json:"reason_code,omitempty"`

	// The ID of the plan for which the service instance has been requested, which is stored in the catalog.j-son of your
	// broker.
	PlanID *string `json:"plan_id,omitempty"`

	// Information about the service instance prior to the update.
	PreviousValues []string `json:"previous_values,omitempty"`

	// Broker Api Version.
	XBrokerApiVersion *string `json:"X-Broker-Api-Version,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

ReplaceServiceInstanceStateOptions : The ReplaceServiceInstanceState options.

func (*ReplaceServiceInstanceStateOptions) SetEnabled 

func (_options *ReplaceServiceInstanceStateOptions) SetEnabled(enabled bool) *ReplaceServiceInstanceStateOptions

SetEnabled : Allow user to set Enabled

func (*ReplaceServiceInstanceStateOptions) SetHeaders 

func (options *ReplaceServiceInstanceStateOptions) SetHeaders(param map[string]string) *ReplaceServiceInstanceStateOptions

SetHeaders : Allow user to set Headers

func (*ReplaceServiceInstanceStateOptions) SetInitiatorID 

func (_options *ReplaceServiceInstanceStateOptions) SetInitiatorID(initiatorID string) *ReplaceServiceInstanceStateOptions

SetInitiatorID : Allow user to set InitiatorID

func (*ReplaceServiceInstanceStateOptions) SetInstanceID 

func (_options *ReplaceServiceInstanceStateOptions) SetInstanceID(instanceID string) *ReplaceServiceInstanceStateOptions

SetInstanceID : Allow user to set InstanceID

func (*ReplaceServiceInstanceStateOptions) SetPlanID 

func (_options *ReplaceServiceInstanceStateOptions) SetPlanID(planID string) *ReplaceServiceInstanceStateOptions

SetPlanID : Allow user to set PlanID

func (*ReplaceServiceInstanceStateOptions) SetPreviousValues 

func (_options *ReplaceServiceInstanceStateOptions) SetPreviousValues(previousValues []string) *ReplaceServiceInstanceStateOptions

SetPreviousValues : Allow user to set PreviousValues

func (*ReplaceServiceInstanceStateOptions) SetReasonCode 

func (_options *ReplaceServiceInstanceStateOptions) SetReasonCode(reasonCode map[string]interface{}) *ReplaceServiceInstanceStateOptions

SetReasonCode : Allow user to set ReasonCode

func (*ReplaceServiceInstanceStateOptions) SetXBrokerApiVersion 

func (_options *ReplaceServiceInstanceStateOptions) SetXBrokerApiVersion(xBrokerApiVersion string) *ReplaceServiceInstanceStateOptions

SetXBrokerApiVersion : Allow user to set XBrokerApiVersion

type ResourceCreateResponse added in v1.2.0 

type ResourceCreateResponse struct {
	// The URL of a web-based management user interface for the service instance. The URL MUST contain enough information
	// for the dashboard to identify the resource being accessed.
	DashboardURL *string `json:"dashboard_url,omitempty"`

	// For asynchronous responses, service brokers can return an identifier representing the operation. The value of this
	// field MUST be provided by the platform with requests to the last_operation endpoint in a URL encoded query
	// parameter. If present, it MUST be a non-empty string.
	Operation *string `json:"operation,omitempty"`
}

ResourceCreateResponse : Result of the provision call.

type ResourceDeleteResponse added in v1.2.0 

type ResourceDeleteResponse struct {
	// contains filtered or unexported fields
}

ResourceDeleteResponse : The result of deprovisioning a service instance.

func (*ResourceDeleteResponse) GetProperties added in v1.2.0 

func (o *ResourceDeleteResponse) GetProperties() map[string]interface{}

GetProperties allows the user to retrieve the map of arbitrary properties from an instance of ResourceDeleteResponse

func (*ResourceDeleteResponse) GetProperty added in v1.2.0 

func (o *ResourceDeleteResponse) GetProperty(key string) interface{}

GetProperty allows the user to retrieve an arbitrary property from an instance of ResourceDeleteResponse

func (*ResourceDeleteResponse) MarshalJSON added in v1.2.0 

func (o *ResourceDeleteResponse) MarshalJSON() (buffer []byte, err error)

MarshalJSON performs custom serialization for instances of ResourceDeleteResponse

func (*ResourceDeleteResponse) SetProperties added in v1.2.0 

func (o *ResourceDeleteResponse) SetProperties(m map[string]interface{})

SetProperties allows the user to set a map of arbitrary properties on an instance of ResourceDeleteResponse

func (*ResourceDeleteResponse) SetProperty added in v1.2.0 

func (o *ResourceDeleteResponse) SetProperty(key string, value interface{})

SetProperty allows the user to set an arbitrary property on an instance of ResourceDeleteResponse

type ResourceLastOperationGetResponse added in v1.2.0 

type ResourceLastOperationGetResponse struct {
	// Valid values are in progress, succeeded, and failed.
	State *string `json:"state,omitempty"`

	// A user-facing message displayed to the platform API client. Can be used to tell the user details about the status of
	// the operation.
	Description *string `json:"description,omitempty"`
}

ResourceLastOperationGetResponse : The result of get_last_operation call.

type ResourceStateResponse added in v1.2.0 

type ResourceStateResponse struct {
	// Indicates whether the service instance is active and is meaningful if enabled is true. The default value is true if
	// not specified.
	Active *string `json:"active,omitempty"`

	// Indicates the current state of the service instance.
	Enabled *string `json:"enabled,omitempty"`

	// Indicates when the service instance was last accessed/modified/etc., and it is meaningful if enabled is true and
	// active is false. Represented as milliseconds since the epoch, but does not need to be accurate to the second/hour.
	LastActive *string `json:"last_active,omitempty"`
}

ResourceStateResponse : The result of Get instance status call.

type ResourceUpdateResult added in v1.2.0 

type ResourceUpdateResult struct {
	// contains filtered or unexported fields
}

ResourceUpdateResult : The result of deprovisioning service instance.

func (*ResourceUpdateResult) GetProperties added in v1.2.0 

func (o *ResourceUpdateResult) GetProperties() map[string]interface{}

GetProperties allows the user to retrieve the map of arbitrary properties from an instance of ResourceUpdateResult

func (*ResourceUpdateResult) GetProperty added in v1.2.0 

func (o *ResourceUpdateResult) GetProperty(key string) interface{}

GetProperty allows the user to retrieve an arbitrary property from an instance of ResourceUpdateResult

func (*ResourceUpdateResult) MarshalJSON added in v1.2.0 

func (o *ResourceUpdateResult) MarshalJSON() (buffer []byte, err error)

MarshalJSON performs custom serialization for instances of ResourceUpdateResult

func (*ResourceUpdateResult) SetProperties added in v1.2.0 

func (o *ResourceUpdateResult) SetProperties(m map[string]interface{})

SetProperties allows the user to set a map of arbitrary properties on an instance of ResourceUpdateResult

func (*ResourceUpdateResult) SetProperty added in v1.2.0 

func (o *ResourceUpdateResult) SetProperty(key string, value interface{})

SetProperty allows the user to set an arbitrary property on an instance of ResourceUpdateResult

type UninstallConfigOptions 

type UninstallConfigOptions struct {
	// The ID of the project, which uniquely identifies it.
	ID *string `json:"id" validate:"required,ne="`

	// The ID of the configuration to destroy configuration resources.
	ConfigID *string `json:"config_id" validate:"required,ne="`

	// Allows users to set headers on API requests
	Headers map[string]string
}

UninstallConfigOptions : The UninstallConfig options.

func (*UninstallConfigOptions) SetConfigID 

func (_options *UninstallConfigOptions) SetConfigID(configID string) *UninstallConfigOptions

SetConfigID : Allow user to set ConfigID

func (*UninstallConfigOptions) SetHeaders 

func (options *UninstallConfigOptions) SetHeaders(param map[string]string) *UninstallConfigOptions

SetHeaders : Allow user to set Headers

func (*UninstallConfigOptions) SetID 

func (_options *UninstallConfigOptions) SetID(id string) *UninstallConfigOptions

SetID : Allow user to set ID

type UpdateConfigOptions 

type UpdateConfigOptions struct {
	// The ID of the project, which uniquely identifies it.
	ID *string `json:"id" validate:"required,ne="`

	// The ID of the configuration, which uniquely identifies it.
	ConfigID *string `json:"config_id" validate:"required,ne="`

	// The change delta of the project configuration to update.
	ProjectConfig []JSONPatchOperation `json:"project_config" validate:"required"`

	// The flag to determine if full metadata should be returned.
	Complete *bool `json:"complete,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

UpdateConfigOptions : The UpdateConfig options.

func (*UpdateConfigOptions) SetComplete added in v0.88.0 

func (_options *UpdateConfigOptions) SetComplete(complete bool) *UpdateConfigOptions

SetComplete : Allow user to set Complete

func (*UpdateConfigOptions) SetConfigID 

func (_options *UpdateConfigOptions) SetConfigID(configID string) *UpdateConfigOptions

SetConfigID : Allow user to set ConfigID

func (*UpdateConfigOptions) SetHeaders 

func (options *UpdateConfigOptions) SetHeaders(param map[string]string) *UpdateConfigOptions

SetHeaders : Allow user to set Headers

func (*UpdateConfigOptions) SetID 

func (_options *UpdateConfigOptions) SetID(id string) *UpdateConfigOptions

SetID : Allow user to set ID

func (*UpdateConfigOptions) SetProjectConfig 

func (_options *UpdateConfigOptions) SetProjectConfig(projectConfig []JSONPatchOperation) *UpdateConfigOptions

SetProjectConfig : Allow user to set ProjectConfig

type UpdateProjectOptions 

type UpdateProjectOptions struct {
	// The ID of the project, which uniquely identifies it.
	ID *string `json:"id" validate:"required,ne="`

	// The new project definition document.
	JSONPatchOperation []JSONPatchOperation `json:"JsonPatchOperation" validate:"required"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

UpdateProjectOptions : The UpdateProject options.

func (*UpdateProjectOptions) SetHeaders 

func (options *UpdateProjectOptions) SetHeaders(param map[string]string) *UpdateProjectOptions

SetHeaders : Allow user to set Headers

func (*UpdateProjectOptions) SetID 

func (_options *UpdateProjectOptions) SetID(id string) *UpdateProjectOptions

SetID : Allow user to set ID

func (*UpdateProjectOptions) SetJSONPatchOperation added in v0.88.0 

func (_options *UpdateProjectOptions) SetJSONPatchOperation(jsonPatchOperation []JSONPatchOperation) *UpdateProjectOptions

SetJSONPatchOperation : Allow user to set JSONPatchOperation

type UpdateServiceInstanceOptions 

type UpdateServiceInstanceOptions struct {
	// The ID of a previously provisioned service instance.
	InstanceID *string `json:"instance_id" validate:"required,ne="`

	// It contains the query filters and the search token that is initally set to null or undefined.
	JSONPatchOperation []JSONPatchOperation `json:"JsonPatchOperation" validate:"required"`

	// Broker API Version.
	XBrokerApiVersion *string `json:"X-Broker-Api-Version,omitempty"`

	// Broker Api Originating Identity.
	XBrokerApiOriginatingIdentity *string `json:"X-Broker-Api-Originating-Identity,omitempty"`

	// A value of true indicates that both the IBM Cloud platform and the requesting client support asynchronous
	// deprovisioning. If this parameter is not included in the request, and the broker can only deprovision a service
	// instance of the requested plan asynchronously, the broker MUST reject the request with a 422 Unprocessable Entity.
	AcceptsIncomplete *bool `json:"accepts_incomplete,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

UpdateServiceInstanceOptions : The UpdateServiceInstance options.

func (*UpdateServiceInstanceOptions) SetAcceptsIncomplete 

func (_options *UpdateServiceInstanceOptions) SetAcceptsIncomplete(acceptsIncomplete bool) *UpdateServiceInstanceOptions

SetAcceptsIncomplete : Allow user to set AcceptsIncomplete

func (*UpdateServiceInstanceOptions) SetHeaders 

func (options *UpdateServiceInstanceOptions) SetHeaders(param map[string]string) *UpdateServiceInstanceOptions

SetHeaders : Allow user to set Headers

func (*UpdateServiceInstanceOptions) SetInstanceID 

func (_options *UpdateServiceInstanceOptions) SetInstanceID(instanceID string) *UpdateServiceInstanceOptions

SetInstanceID : Allow user to set InstanceID

func (*UpdateServiceInstanceOptions) SetJSONPatchOperation added in v0.88.0 

func (_options *UpdateServiceInstanceOptions) SetJSONPatchOperation(jsonPatchOperation []JSONPatchOperation) *UpdateServiceInstanceOptions

SetJSONPatchOperation : Allow user to set JSONPatchOperation

func (*UpdateServiceInstanceOptions) SetXBrokerApiOriginatingIdentity 

func (_options *UpdateServiceInstanceOptions) SetXBrokerApiOriginatingIdentity(xBrokerApiOriginatingIdentity string) *UpdateServiceInstanceOptions

SetXBrokerApiOriginatingIdentity : Allow user to set XBrokerApiOriginatingIdentity

func (*UpdateServiceInstanceOptions) SetXBrokerApiVersion 

func (_options *UpdateServiceInstanceOptions) SetXBrokerApiVersion(xBrokerApiVersion string) *UpdateServiceInstanceOptions

SetXBrokerApiVersion : Allow user to set XBrokerApiVersion

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.