projectv1

package
v0.0.9 Latest Latest
Warning

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

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

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 (
	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.

View Source 
const (
	ProjectConfigPatchRequestProjectConfigManualProperty_Type_Manual = "manual"
)

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

View Source 
const (
	ProjectConfigPatchRequest_Type_Manual = "manual"
)

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

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 

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 UnmarshalCostEstimate 

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 

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 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 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 

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 

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 

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 

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 

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 

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 

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 

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 

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 

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 

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 

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 UnmarshalProjectConfigPatchRequest added in v0.0.9 

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

UnmarshalProjectConfigPatchRequest unmarshals an instance of ProjectConfigPatchRequest from the specified map of raw messages.

func UnmarshalProjectConfigPatchRequestProjectConfigManualProperty added in v0.0.9 

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

UnmarshalProjectConfigPatchRequestProjectConfigManualProperty unmarshals an instance of ProjectConfigPatchRequestProjectConfigManualProperty from the specified map of raw messages.

func UnmarshalProjectConfigPatchRequestProjectConfigPatchSchematicsTemplate added in v0.0.9 

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

UnmarshalProjectConfigPatchRequestProjectConfigPatchSchematicsTemplate unmarshals an instance of ProjectConfigPatchRequestProjectConfigPatchSchematicsTemplate from the specified map of raw messages.

func UnmarshalProjectConfigPrototype 

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 

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 

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

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

Types

type ActionJob 

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 

type ApproveOptions struct {
	// The unique project ID.
	ProjectID *string `json:"project_id" validate:"required,ne="`

	// The unique identifier.
	ID *string `json:"id" validate:"required,ne="`

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

	// Determines whether the metadata should be returned. Only the metadata for the project is 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 

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

SetComment : Allow user to set Comment

func (*ApproveOptions) SetComplete 

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

SetComplete : Allow user to set Complete

func (*ApproveOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*ApproveOptions) SetID 

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

SetID : Allow user to set ID

func (*ApproveOptions) SetProjectID added in v0.0.8 

func (_options *ApproveOptions) SetProjectID(projectID string) *ApproveOptions

SetProjectID : Allow user to set ProjectID

type CheckConfigOptions 

type CheckConfigOptions struct {
	// The unique project ID.
	ProjectID *string `json:"project_id" validate:"required,ne="`

	// The unique identifier.
	ID *string `json:"id" validate:"required,ne="`

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

	// Determines whether the metadata should be returned. Only the metadata for the project is returned.
	Complete *bool `json:"complete,omitempty"`

	// The version of the configuration that the validation check should trigger against.
	Version *string `json:"version,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) 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) SetProjectID added in v0.0.8 

func (_options *CheckConfigOptions) SetProjectID(projectID string) *CheckConfigOptions

SetProjectID : Allow user to set ProjectID

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 

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

CostEstimate : The cost estimate for the given configuration.

func (*CostEstimate) GetProperties 

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 

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

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

func (*CostEstimate) MarshalJSON 

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

MarshalJSON performs custom serialization for instances of CostEstimate

func (*CostEstimate) SetProperties 

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 

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 unique project ID.
	ProjectID *string `json:"project_id" validate:"required,ne="`

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

	// A dotted value of catalogID.versionID.
	LocatorID *string `json:"locator_id" validate:"required"`

	// The ID of the configuration. If this parameter is empty, an ID is automatically created for the configuration.
	ID *string `json:"id,omitempty"`

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

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

	// The input values to use to deploy the configuration.
	Input []ProjectConfigInputVariable `json:"input,omitempty"`

	// Schematics environment variables to use to deploy the configuration.
	Setting []ProjectConfigSettingCollection `json:"setting,omitempty"`

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

CreateConfigOptions : The CreateConfig options.

func (*CreateConfigOptions) SetDescription added in v0.0.8 

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

SetDescription : Allow user to set Description

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) SetInput added in v0.0.8 

func (_options *CreateConfigOptions) SetInput(input []ProjectConfigInputVariable) *CreateConfigOptions

SetInput : Allow user to set Input

func (*CreateConfigOptions) SetLabels added in v0.0.8 

func (_options *CreateConfigOptions) SetLabels(labels []string) *CreateConfigOptions

SetLabels : Allow user to set Labels

func (*CreateConfigOptions) SetLocatorID added in v0.0.8 

func (_options *CreateConfigOptions) SetLocatorID(locatorID string) *CreateConfigOptions

SetLocatorID : Allow user to set LocatorID

func (*CreateConfigOptions) SetName added in v0.0.8 

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

SetName : Allow user to set Name

func (*CreateConfigOptions) SetProjectID added in v0.0.8 

func (_options *CreateConfigOptions) SetProjectID(projectID string) *CreateConfigOptions

SetProjectID : Allow user to set ProjectID

func (*CreateConfigOptions) SetSetting added in v0.0.8 

func (_options *CreateConfigOptions) SetSetting(setting []ProjectConfigSettingCollection) *CreateConfigOptions

SetSetting : Allow user to set Setting

type CreateProjectOptions 

type CreateProjectOptions struct {
	// The resource group where the project's data and tools are created.
	ResourceGroup *string `json:"resource_group" validate:"required"`

	// The location where the project's data and tools are created.
	Location *string `json:"location" validate:"required"`

	// 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"`

	// 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 

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 unique project ID.
	ProjectID *string `json:"project_id" validate:"required,ne="`

	// The unique identifier.
	ID *string `json:"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) 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

func (*DeleteConfigOptions) SetProjectID added in v0.0.8 

func (_options *DeleteConfigOptions) SetProjectID(projectID string) *DeleteConfigOptions

SetProjectID : Allow user to set ProjectID

type DeleteEventNotificationsIntegrationOptions 

type DeleteEventNotificationsIntegrationOptions struct {
	// The unique identifier.
	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 unique identifier.
	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 ForceApproveOptions 

type ForceApproveOptions struct {
	// The unique project ID.
	ProjectID *string `json:"project_id" validate:"required,ne="`

	// The unique identifier.
	ID *string `json:"id" validate:"required,ne="`

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

	// Determines whether the metadata should be returned. Only the metadata for the project is 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 

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

SetComment : Allow user to set Comment

func (*ForceApproveOptions) SetComplete 

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

SetComplete : Allow user to set Complete

func (*ForceApproveOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*ForceApproveOptions) SetID 

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

SetID : Allow user to set ID

func (*ForceApproveOptions) SetProjectID added in v0.0.8 

func (_options *ForceApproveOptions) SetProjectID(projectID string) *ForceApproveOptions

SetProjectID : Allow user to set ProjectID

type GetConfigDiffOptions 

type GetConfigDiffOptions struct {
	// The unique project ID.
	ProjectID *string `json:"project_id" validate:"required,ne="`

	// The unique identifier.
	ID *string `json:"id" validate:"required,ne="`

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

GetConfigDiffOptions : The GetConfigDiff options.

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

func (*GetConfigDiffOptions) SetProjectID added in v0.0.8 

func (_options *GetConfigDiffOptions) SetProjectID(projectID string) *GetConfigDiffOptions

SetProjectID : Allow user to set ProjectID

type GetConfigOptions 

type GetConfigOptions struct {
	// The unique project ID.
	ProjectID *string `json:"project_id" validate:"required,ne="`

	// The unique identifier.
	ID *string `json:"id" validate:"required,ne="`

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

	// Determines whether the metadata should be returned. Only the metadata for the project is 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) 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) SetProjectID added in v0.0.8 

func (_options *GetConfigOptions) SetProjectID(projectID string) *GetConfigOptions

SetProjectID : Allow user to set ProjectID

func (*GetConfigOptions) SetVersion 

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

SetVersion : Allow user to set Version

type GetCostEstimateOptions 

type GetCostEstimateOptions struct {
	// The unique project ID.
	ProjectID *string `json:"project_id" validate:"required,ne="`

	// The unique identifier.
	ID *string `json:"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) 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) SetProjectID added in v0.0.8 

func (_options *GetCostEstimateOptions) SetProjectID(projectID string) *GetCostEstimateOptions

SetProjectID : Allow user to set ProjectID

func (*GetCostEstimateOptions) SetVersion 

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

SetVersion : Allow user to set Version

type GetEventNotificationsIntegrationOptions 

type GetEventNotificationsIntegrationOptions struct {
	// The unique identifier.
	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 GetNotificationsOptions 

type GetNotificationsOptions struct {
	// The unique identifier.
	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 unique identifier.
	ID *string `json:"id" validate:"required,ne="`

	// When set to true, exclude_configs returns only active configurations. Draft configurations are not returned.
	ExcludeConfigs *bool `json:"exclude_configs,omitempty"`

	// Determines whether the metadata should be returned. Only the metadata for the project is 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 unique project ID.
	ProjectID *string `json:"project_id" validate:"required,ne="`

	// The unique identifier.
	ID *string `json:"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) 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) SetProjectID added in v0.0.8 

func (_options *GetSchematicsJobOptions) SetProjectID(projectID string) *GetSchematicsJobOptions

SetProjectID : Allow user to set ProjectID

func (*GetSchematicsJobOptions) SetSince 

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

SetSince : Allow user to set Since

type InputVariable 

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

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

	// Can be any value - a string, number, boolean, array, or object.
	Value interface{} `json:"value,omitempty"`

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

InputVariable : InputVariable struct

type InstallConfigOptions 

type InstallConfigOptions struct {
	// The unique project ID.
	ProjectID *string `json:"project_id" validate:"required,ne="`

	// The unique identifier.
	ID *string `json:"id" validate:"required,ne="`

	// Determines whether the metadata should be returned. Only the metadata for the project is 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) 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

func (*InstallConfigOptions) SetProjectID added in v0.0.8 

func (_options *InstallConfigOptions) SetProjectID(projectID string) *InstallConfigOptions

SetProjectID : Allow user to set ProjectID

type ListConfigsOptions 

type ListConfigsOptions struct {
	// The unique project ID.
	ProjectID *string `json:"project_id" validate:"required,ne="`

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

	// Determines whether the metadata should be returned. Only the metadata for the project is 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) SetProjectID 

func (_options *ListConfigsOptions) SetProjectID(projectID string) *ListConfigsOptions

SetProjectID : Allow user to set ProjectID

func (*ListConfigsOptions) SetVersion 

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

SetVersion : Allow user to set Version

type ListProjectsOptions 

type ListProjectsOptions struct {
	// Marks the last entry that is returned on the page. The server uses this parameter to determine the first entry that
	// is returned on the next page. If this parameter is 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 that are returned is the same, with the
	// exception of the last page.
	Limit *int64 `json:"limit,omitempty"`

	// Determines whether the metadata should be returned. Only the metadata for the project is 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 

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

NotificationsGetResponse : The response from fetching notifications.

type NotificationsIntegrationGetResponse 

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 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 the instance of event.
	Type *string `json:"type,omitempty"`

	// A date and time value in the format YYYY-MM-DDTHH:mm:ssZ or YYYY-MM-DDTHH:mm:ss.sssZ, matching the date and 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 

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 and time value in the format YYYY-MM-DDTHH:mm:ssZ or YYYY-MM-DDTHH:mm:ss.sssZ, matching the date and time
	// format as specified by RFC 3339.
	CreatedAt *strfmt.DateTime `json:"created_at,omitempty"`
}

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

type NotificationsIntegrationTestPostResponse 

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 

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"`

	// Can be any value - a string, number, boolean, array, or object.
	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 

type PostCrnTokenOptions struct {
	// The unique identifier.
	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 

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

SetHeaders : Allow user to set Headers

func (*PostCrnTokenOptions) SetID 

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

SetID : Allow user to set ID

type PostEventNotificationsIntegrationOptions 

type PostEventNotificationsIntegrationOptions struct {
	// The unique identifier.
	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 

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 unique identifier.
	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 

type PostTestEventNotificationOptions struct {
	// The unique identifier.
	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 

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

SetHeaders : Allow user to set Headers

func (*PostTestEventNotificationOptions) SetID 

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

SetID : Allow user to set ID

func (*PostTestEventNotificationOptions) SetIbmendefaultlong 

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

SetIbmendefaultlong : Allow user to set Ibmendefaultlong

func (*PostTestEventNotificationOptions) SetIbmendefaultshort 

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

SetIbmendefaultshort : Allow user to set Ibmendefaultshort

type Project 

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 

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 

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 

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

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

type ProjectCollectionMemberWithMetadata 

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 ID of the configuration. If this parameter is empty, an ID is automatically created for the configuration.
	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"`

	// A dotted value of catalogID.versionID.
	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"`

	// Schematics environment variables to use to deploy the configuration.
	Setting []ProjectConfigSettingCollection `json:"setting,omitempty"`
}

ProjectConfig : The project configuration.

type ProjectConfigCollection 

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 

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"`

	// Can be any value - a string, number, boolean, array, or object.
	Value interface{} `json:"value,omitempty"`
}

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 

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

	// Can be any value - a string, number, boolean, array, or object.
	Value interface{} `json:"value,omitempty"`
}

ProjectConfigInputVariable : ProjectConfigInputVariable struct

type ProjectConfigPatchRequest added in v0.0.9 

type ProjectConfigPatchRequest struct {
	// The configuration name.
	Name *string `json:"name,omitempty"`

	// The configuration labels.
	Labels []string `json:"labels,omitempty"`

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

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

	// The external resource account ID in project configuration.
	ExternalResourcesAccount *string `json:"external_resources_account,omitempty"`

	// A dotted value of catalogID.versionID.
	LocatorID *string `json:"locator_id,omitempty"`

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

	// Schematics environment variables to use to deploy the configuration.
	Setting []ProjectConfigSettingCollection `json:"setting,omitempty"`
}

ProjectConfigPatchRequest : The project configuration input. Models which "extend" this model: - ProjectConfigPatchRequestProjectConfigManualProperty - ProjectConfigPatchRequestProjectConfigPatchSchematicsTemplate

type ProjectConfigPatchRequestIntf added in v0.0.9 

type ProjectConfigPatchRequestIntf interface {
	// contains filtered or unexported methods
}

type ProjectConfigPatchRequestProjectConfigManualProperty added in v0.0.9 

type ProjectConfigPatchRequestProjectConfigManualProperty struct {
	// The configuration name.
	Name *string `json:"name,omitempty"`

	// The configuration labels.
	Labels []string `json:"labels,omitempty"`

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

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

	// The external resource account ID in project configuration.
	ExternalResourcesAccount *string `json:"external_resources_account,omitempty"`
}

ProjectConfigPatchRequestProjectConfigManualProperty : The project configuration manual type. This model "extends" ProjectConfigPatchRequest

type ProjectConfigPatchRequestProjectConfigPatchSchematicsTemplate added in v0.0.9 

type ProjectConfigPatchRequestProjectConfigPatchSchematicsTemplate struct {
	// The configuration name.
	Name *string `json:"name,omitempty"`

	// The configuration labels.
	Labels []string `json:"labels,omitempty"`

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

	// A dotted value of catalogID.versionID.
	LocatorID *string `json:"locator_id,omitempty"`

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

	// Schematics environment variables to use to deploy the configuration.
	Setting []ProjectConfigSettingCollection `json:"setting,omitempty"`
}

ProjectConfigPatchRequestProjectConfigPatchSchematicsTemplate : The Schematics template property. This model "extends" ProjectConfigPatchRequest

type ProjectConfigPrototype 

type ProjectConfigPrototype struct {
	// The ID of the configuration. If this parameter is empty, an ID is automatically created for the configuration.
	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"`

	// A dotted value of catalogID.versionID.
	LocatorID *string `json:"locator_id" validate:"required"`

	// The input values to use to deploy the configuration.
	Input []ProjectConfigInputVariable `json:"input,omitempty"`

	// Schematics environment variables to use to deploy the configuration.
	Setting []ProjectConfigSettingCollection `json:"setting,omitempty"`
}

ProjectConfigPrototype : The input of a project configuration.

type ProjectConfigSettingCollection 

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

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

ProjectConfigSettingCollection : ProjectConfigSettingCollection struct

type ProjectMetadata 

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

	// A date and time value in the format YYYY-MM-DDTHH:mm:ssZ or YYYY-MM-DDTHH:mm:ss.sssZ, matching the date and 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 IBM Cloud location where a resource is deployed.
	Location *string `json:"location,omitempty"`

	// The resource group where the project's data and tools are 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 

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 

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) 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 

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 

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) 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) 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 a project Get information about a project.

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) 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 

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

NewApproveOptions : Instantiate ApproveOptions

func (*ProjectV1) NewCheckConfigOptions 

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

NewCheckConfigOptions : Instantiate CheckConfigOptions

func (*ProjectV1) NewCreateConfigOptions 

func (*ProjectV1) NewCreateConfigOptions(projectID string, name string, locatorID string) *CreateConfigOptions

NewCreateConfigOptions : Instantiate CreateConfigOptions

func (*ProjectV1) NewCreateProjectOptions 

func (*ProjectV1) NewCreateProjectOptions(resourceGroup string, location string, name string) *CreateProjectOptions

NewCreateProjectOptions : Instantiate CreateProjectOptions

func (*ProjectV1) NewDeleteConfigOptions 

func (*ProjectV1) NewDeleteConfigOptions(projectID string, id 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) NewForceApproveOptions 

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

NewForceApproveOptions : Instantiate ForceApproveOptions

func (*ProjectV1) NewGetConfigDiffOptions 

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

NewGetConfigDiffOptions : Instantiate GetConfigDiffOptions

func (*ProjectV1) NewGetConfigOptions 

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

NewGetConfigOptions : Instantiate GetConfigOptions

func (*ProjectV1) NewGetCostEstimateOptions 

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

NewGetCostEstimateOptions : Instantiate GetCostEstimateOptions

func (*ProjectV1) NewGetEventNotificationsIntegrationOptions 

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

NewGetEventNotificationsIntegrationOptions : Instantiate GetEventNotificationsIntegrationOptions

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(projectID string, id string, action string) *GetSchematicsJobOptions

NewGetSchematicsJobOptions : Instantiate GetSchematicsJobOptions

func (*ProjectV1) NewInstallConfigOptions 

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

NewInstallConfigOptions : Instantiate InstallConfigOptions

func (*ProjectV1) NewListConfigsOptions 

func (*ProjectV1) NewListConfigsOptions(projectID 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 

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 

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

NewPostTestEventNotificationOptions : Instantiate PostTestEventNotificationOptions

func (*ProjectV1) NewProjectConfigInputVariable 

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

NewProjectConfigInputVariable : Instantiate ProjectConfigInputVariable (Generic Model Constructor)

func (*ProjectV1) NewProjectConfigPatchRequestProjectConfigManualProperty added in v0.0.9 

func (*ProjectV1) NewProjectConfigPatchRequestProjectConfigManualProperty(typeVar string) (_model *ProjectConfigPatchRequestProjectConfigManualProperty, err error)

NewProjectConfigPatchRequestProjectConfigManualProperty : Instantiate ProjectConfigPatchRequestProjectConfigManualProperty (Generic Model Constructor)

func (*ProjectV1) NewProjectConfigPrototype 

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

NewProjectConfigPrototype : Instantiate ProjectConfigPrototype (Generic Model Constructor)

func (*ProjectV1) NewProjectConfigSettingCollection 

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

NewProjectConfigSettingCollection : Instantiate ProjectConfigSettingCollection (Generic Model Constructor)

func (*ProjectV1) NewProjectsPager 

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

NewProjectsPager returns a new ProjectsPager instance.

func (*ProjectV1) NewUninstallConfigOptions 

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

NewUninstallConfigOptions : Instantiate UninstallConfigOptions

func (*ProjectV1) NewUpdateConfigOptions 

func (*ProjectV1) NewUpdateConfigOptions(projectID string, id string, projectConfig ProjectConfigPatchRequestIntf) *UpdateConfigOptions

NewUpdateConfigOptions : Instantiate UpdateConfigOptions

func (*ProjectV1) NewUpdateProjectOptions 

func (*ProjectV1) NewUpdateProjectOptions(id string) *UpdateProjectOptions

NewUpdateProjectOptions : Instantiate UpdateProjectOptions

func (*ProjectV1) PostCrnToken 

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 

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 

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 

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) 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

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 UninstallConfigOptions 

type UninstallConfigOptions struct {
	// The unique project ID.
	ProjectID *string `json:"project_id" validate:"required,ne="`

	// The unique identifier.
	ID *string `json:"id" validate:"required,ne="`

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

UninstallConfigOptions : The UninstallConfig options.

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

func (*UninstallConfigOptions) SetProjectID added in v0.0.8 

func (_options *UninstallConfigOptions) SetProjectID(projectID string) *UninstallConfigOptions

SetProjectID : Allow user to set ProjectID

type UpdateConfigOptions 

type UpdateConfigOptions struct {
	// The unique project ID.
	ProjectID *string `json:"project_id" validate:"required,ne="`

	// The unique identifier.
	ID *string `json:"id" validate:"required,ne="`

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

	// Determines whether the metadata should be returned. Only the metadata for the project is 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 

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

SetComplete : Allow user to set Complete

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 ProjectConfigPatchRequestIntf) *UpdateConfigOptions

SetProjectConfig : Allow user to set ProjectConfig

func (*UpdateConfigOptions) SetProjectID added in v0.0.8 

func (_options *UpdateConfigOptions) SetProjectID(projectID string) *UpdateConfigOptions

SetProjectID : Allow user to set ProjectID

type UpdateProjectOptions 

type UpdateProjectOptions struct {
	// The unique identifier.
	ID *string `json:"id" validate:"required,ne="`

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

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

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

UpdateProjectOptions : The UpdateProject options.

func (*UpdateProjectOptions) SetDescription added in v0.0.9 

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

SetDescription : Allow user to set Description

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) SetName added in v0.0.9 

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

SetName : Allow user to set Name

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.