projectv1

package
v0.2.2 Latest Latest
Warning

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

 Go to latest Published: Mar 9, 2024 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 (
	LastActionWithSummary_Result_Failed = "failed"
	LastActionWithSummary_Result_Passed = "passed"
)

Constants associated with the LastActionWithSummary.Result property. The result of the last action.

View Source 
const (
	LastMonitoringActionWithSummary_Result_Failed = "failed"
	LastMonitoringActionWithSummary_Result_Passed = "passed"
)

Constants associated with the LastMonitoringActionWithSummary.Result property. The result of the last action.

View Source 
const (
	LastValidatedActionWithSummary_Result_Failed = "failed"
	LastValidatedActionWithSummary_Result_Passed = "passed"
)

Constants associated with the LastValidatedActionWithSummary.Result property. The result of the last action.

View Source 
const (
	Project_State_Deleting       = "deleting"
	Project_State_DeletingFailed = "deleting_failed"
	Project_State_Ready          = "ready"
)

Constants associated with the Project.State property. The project status value.

View Source 
const (
	ProjectConfig_State_Applied           = "applied"
	ProjectConfig_State_ApplyFailed       = "apply_failed"
	ProjectConfig_State_Approved          = "approved"
	ProjectConfig_State_Deleted           = "deleted"
	ProjectConfig_State_Deleting          = "deleting"
	ProjectConfig_State_DeletingFailed    = "deleting_failed"
	ProjectConfig_State_Deployed          = "deployed"
	ProjectConfig_State_Deploying         = "deploying"
	ProjectConfig_State_DeployingFailed   = "deploying_failed"
	ProjectConfig_State_Discarded         = "discarded"
	ProjectConfig_State_Draft             = "draft"
	ProjectConfig_State_Superseded        = "superseded"
	ProjectConfig_State_Undeploying       = "undeploying"
	ProjectConfig_State_UndeployingFailed = "undeploying_failed"
	ProjectConfig_State_Validated         = "validated"
	ProjectConfig_State_Validating        = "validating"
	ProjectConfig_State_ValidatingFailed  = "validating_failed"
)

Constants associated with the ProjectConfig.State property. The state of the configuration.

View Source 
const (
	ProjectConfigAuth_Method_ApiKey         = "api_key"
	ProjectConfigAuth_Method_TrustedProfile = "trusted_profile"
)

Constants associated with the ProjectConfigAuth.Method property. The authorization method. You can authorize by using a trusted profile or an API key in Secrets Manager.

View Source 
const (
	ProjectConfigMetadataCodeRiskAnalyzerLogs_Status_Failed = "failed"
	ProjectConfigMetadataCodeRiskAnalyzerLogs_Status_Passed = "passed"
)

Constants associated with the ProjectConfigMetadataCodeRiskAnalyzerLogs.Status property. The status of the Code Risk Analyzer logs of the configuration.

View Source 
const (
	ProjectConfigSummary_State_Applied           = "applied"
	ProjectConfigSummary_State_ApplyFailed       = "apply_failed"
	ProjectConfigSummary_State_Approved          = "approved"
	ProjectConfigSummary_State_Deleted           = "deleted"
	ProjectConfigSummary_State_Deleting          = "deleting"
	ProjectConfigSummary_State_DeletingFailed    = "deleting_failed"
	ProjectConfigSummary_State_Deployed          = "deployed"
	ProjectConfigSummary_State_Deploying         = "deploying"
	ProjectConfigSummary_State_DeployingFailed   = "deploying_failed"
	ProjectConfigSummary_State_Discarded         = "discarded"
	ProjectConfigSummary_State_Draft             = "draft"
	ProjectConfigSummary_State_Superseded        = "superseded"
	ProjectConfigSummary_State_Undeploying       = "undeploying"
	ProjectConfigSummary_State_UndeployingFailed = "undeploying_failed"
	ProjectConfigSummary_State_Validated         = "validated"
	ProjectConfigSummary_State_Validating        = "validating"
	ProjectConfigSummary_State_ValidatingFailed  = "validating_failed"
)

Constants associated with the ProjectConfigSummary.State property. The state of the configuration.

View Source 
const (
	ProjectConfigSummary_DeploymentModel_ProjectDeployed = "project_deployed"
	ProjectConfigSummary_DeploymentModel_UserDeployed    = "user_deployed"
)

Constants associated with the ProjectConfigSummary.DeploymentModel property. The configuration type.

View Source 
const (
	ProjectConfigVersion_State_Applied           = "applied"
	ProjectConfigVersion_State_ApplyFailed       = "apply_failed"
	ProjectConfigVersion_State_Approved          = "approved"
	ProjectConfigVersion_State_Deleted           = "deleted"
	ProjectConfigVersion_State_Deleting          = "deleting"
	ProjectConfigVersion_State_DeletingFailed    = "deleting_failed"
	ProjectConfigVersion_State_Deployed          = "deployed"
	ProjectConfigVersion_State_Deploying         = "deploying"
	ProjectConfigVersion_State_DeployingFailed   = "deploying_failed"
	ProjectConfigVersion_State_Discarded         = "discarded"
	ProjectConfigVersion_State_Draft             = "draft"
	ProjectConfigVersion_State_Superseded        = "superseded"
	ProjectConfigVersion_State_Undeploying       = "undeploying"
	ProjectConfigVersion_State_UndeployingFailed = "undeploying_failed"
	ProjectConfigVersion_State_Validated         = "validated"
	ProjectConfigVersion_State_Validating        = "validating"
	ProjectConfigVersion_State_ValidatingFailed  = "validating_failed"
)

Constants associated with the ProjectConfigVersion.State property. The state of the configuration.

View Source 
const (
	ProjectConfigVersionSummary_State_Applied           = "applied"
	ProjectConfigVersionSummary_State_ApplyFailed       = "apply_failed"
	ProjectConfigVersionSummary_State_Approved          = "approved"
	ProjectConfigVersionSummary_State_Deleted           = "deleted"
	ProjectConfigVersionSummary_State_Deleting          = "deleting"
	ProjectConfigVersionSummary_State_DeletingFailed    = "deleting_failed"
	ProjectConfigVersionSummary_State_Deployed          = "deployed"
	ProjectConfigVersionSummary_State_Deploying         = "deploying"
	ProjectConfigVersionSummary_State_DeployingFailed   = "deploying_failed"
	ProjectConfigVersionSummary_State_Discarded         = "discarded"
	ProjectConfigVersionSummary_State_Draft             = "draft"
	ProjectConfigVersionSummary_State_Superseded        = "superseded"
	ProjectConfigVersionSummary_State_Undeploying       = "undeploying"
	ProjectConfigVersionSummary_State_UndeployingFailed = "undeploying_failed"
	ProjectConfigVersionSummary_State_Validated         = "validated"
	ProjectConfigVersionSummary_State_Validating        = "validating"
	ProjectConfigVersionSummary_State_ValidatingFailed  = "validating_failed"
)

Constants associated with the ProjectConfigVersionSummary.State property. The state of the configuration.

View Source 
const (
	ProjectResourceSummary_ResourceType_ProjectDeployed = "project_deployed"
	ProjectResourceSummary_ResourceType_UserDeployed    = "user_deployed"
)

Constants associated with the ProjectResourceSummary.ResourceType property. The resource type.

View Source 
const (
	ProjectSummary_State_Deleting       = "deleting"
	ProjectSummary_State_DeletingFailed = "deleting_failed"
	ProjectSummary_State_Ready          = "ready"
)

Constants associated with the ProjectSummary.State property. The project status value.

View Source 
const (
	ProjectConfigMetadataCodeRiskAnalyzerLogsVersion204_Status_Failed = "failed"
	ProjectConfigMetadataCodeRiskAnalyzerLogsVersion204_Status_Passed = "passed"
)

Constants associated with the ProjectConfigMetadataCodeRiskAnalyzerLogsVersion204.Status property. The status of the Code Risk Analyzer logs of the configuration.

View Source 
const DefaultServiceName = "project"

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

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

DefaultServiceURL is the default URL to make service requests to.

Variables

This section is empty.

Functions

func GetServiceURLForRegion 

func GetServiceURLForRegion(region string) (string, error)

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

func UnmarshalActionJobApplyMessagesSummary added in v0.0.95 

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

UnmarshalActionJobApplyMessagesSummary unmarshals an instance of ActionJobApplyMessagesSummary from the specified map of raw messages.

func UnmarshalActionJobApplySummary added in v0.0.95 

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

UnmarshalActionJobApplySummary unmarshals an instance of ActionJobApplySummary from the specified map of raw messages.

func UnmarshalActionJobDestroyMessagesSummary added in v0.0.95 

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

UnmarshalActionJobDestroyMessagesSummary unmarshals an instance of ActionJobDestroyMessagesSummary from the specified map of raw messages.

func UnmarshalActionJobDestroySummary added in v0.0.95 

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

UnmarshalActionJobDestroySummary unmarshals an instance of ActionJobDestroySummary from the specified map of raw messages.

func UnmarshalActionJobDestroySummaryResources added in v0.0.95 

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

UnmarshalActionJobDestroySummaryResources unmarshals an instance of ActionJobDestroySummaryResources from the specified map of raw messages.

func UnmarshalActionJobMessageSummary added in v0.0.95 

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

UnmarshalActionJobMessageSummary unmarshals an instance of ActionJobMessageSummary from the specified map of raw messages.

func UnmarshalActionJobPlanMessagesSummary added in v0.0.95 

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

UnmarshalActionJobPlanMessagesSummary unmarshals an instance of ActionJobPlanMessagesSummary from the specified map of raw messages.

func UnmarshalActionJobPlanSummary added in v0.0.95 

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

UnmarshalActionJobPlanSummary unmarshals an instance of ActionJobPlanSummary from the specified map of raw messages.

func UnmarshalActionJobSummary added in v0.0.27 

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

UnmarshalActionJobSummary unmarshals an instance of ActionJobSummary from the specified map of raw messages.

func UnmarshalActionJobWithIdAndSummary added in v0.0.27 

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

UnmarshalActionJobWithIdAndSummary unmarshals an instance of ActionJobWithIdAndSummary from the specified map of raw messages.

func UnmarshalCodeRiskAnalyzerLogsSummary added in v0.0.97 

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

UnmarshalCodeRiskAnalyzerLogsSummary unmarshals an instance of CodeRiskAnalyzerLogsSummary 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 UnmarshalEnvironment added in v0.0.90 

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

UnmarshalEnvironment unmarshals an instance of Environment from the specified map of raw messages.

func UnmarshalEnvironmentCollection added in v0.1.0 

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

UnmarshalEnvironmentCollection unmarshals an instance of EnvironmentCollection from the specified map of raw messages.

func UnmarshalEnvironmentDefinitionPropertiesPatch added in v0.1.8 

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

UnmarshalEnvironmentDefinitionPropertiesPatch unmarshals an instance of EnvironmentDefinitionPropertiesPatch from the specified map of raw messages.

func UnmarshalEnvironmentDefinitionRequiredProperties added in v0.0.90 

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

UnmarshalEnvironmentDefinitionRequiredProperties unmarshals an instance of EnvironmentDefinitionRequiredProperties from the specified map of raw messages.

func UnmarshalEnvironmentDefinitionRequiredPropertiesResponse added in v0.2.2 

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

UnmarshalEnvironmentDefinitionRequiredPropertiesResponse unmarshals an instance of EnvironmentDefinitionRequiredPropertiesResponse from the specified map of raw messages.

func UnmarshalEnvironmentDeleteResponse added in v0.0.90 

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

UnmarshalEnvironmentDeleteResponse unmarshals an instance of EnvironmentDeleteResponse from the specified map of raw messages.

func UnmarshalEnvironmentPrototype added in v0.1.5 

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

UnmarshalEnvironmentPrototype unmarshals an instance of EnvironmentPrototype from the specified map of raw messages.

func UnmarshalLastActionWithSummary added in v0.0.27 

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

UnmarshalLastActionWithSummary unmarshals an instance of LastActionWithSummary from the specified map of raw messages.

func UnmarshalLastDriftDetectionJobSummary added in v0.2.1 

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

UnmarshalLastDriftDetectionJobSummary unmarshals an instance of LastDriftDetectionJobSummary from the specified map of raw messages.

func UnmarshalLastMonitoringActionWithSummary added in v0.2.1 

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

UnmarshalLastMonitoringActionWithSummary unmarshals an instance of LastMonitoringActionWithSummary from the specified map of raw messages.

func UnmarshalLastValidatedActionWithSummary added in v0.0.27 

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

UnmarshalLastValidatedActionWithSummary unmarshals an instance of LastValidatedActionWithSummary 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 UnmarshalPrePostActionJobSummary added in v0.1.4 

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

UnmarshalPrePostActionJobSummary unmarshals an instance of PrePostActionJobSummary from the specified map of raw messages.

func UnmarshalPrePostActionJobSystemError added in v0.1.4 

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

UnmarshalPrePostActionJobSystemError unmarshals an instance of PrePostActionJobSystemError from the specified map of raw messages.

func UnmarshalPrePostActionJobWithIdAndSummary added in v0.0.90 

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

UnmarshalPrePostActionJobWithIdAndSummary unmarshals an instance of PrePostActionJobWithIdAndSummary 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 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 UnmarshalProjectComplianceProfile added in v0.0.27 

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

UnmarshalProjectComplianceProfile unmarshals an instance of ProjectComplianceProfile 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 UnmarshalProjectConfigAuth added in v0.0.11 

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

UnmarshalProjectConfigAuth unmarshals an instance of ProjectConfigAuth 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 UnmarshalProjectConfigDefinitionPatch added in v0.2.2 

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

UnmarshalProjectConfigDefinitionPatch unmarshals an instance of ProjectConfigDefinitionPatch from the specified map of raw messages.

func UnmarshalProjectConfigDefinitionPatchDAConfigDefinitionPropertiesPatch added in v0.2.2 

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

UnmarshalProjectConfigDefinitionPatchDAConfigDefinitionPropertiesPatch unmarshals an instance of ProjectConfigDefinitionPatchDAConfigDefinitionPropertiesPatch from the specified map of raw messages.

func UnmarshalProjectConfigDefinitionPatchResourceConfigDefinitionPropertiesPatch added in v0.2.2 

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

UnmarshalProjectConfigDefinitionPatchResourceConfigDefinitionPropertiesPatch unmarshals an instance of ProjectConfigDefinitionPatchResourceConfigDefinitionPropertiesPatch from the specified map of raw messages.

func UnmarshalProjectConfigDefinitionPrototype added in v0.2.2 

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

UnmarshalProjectConfigDefinitionPrototype unmarshals an instance of ProjectConfigDefinitionPrototype from the specified map of raw messages.

func UnmarshalProjectConfigDefinitionPrototypeDAConfigDefinitionPropertiesPrototype added in v0.2.2 

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

UnmarshalProjectConfigDefinitionPrototypeDAConfigDefinitionPropertiesPrototype unmarshals an instance of ProjectConfigDefinitionPrototypeDAConfigDefinitionPropertiesPrototype from the specified map of raw messages.

func UnmarshalProjectConfigDefinitionPrototypeResourceConfigDefinitionPropertiesPrototype added in v0.2.2 

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

UnmarshalProjectConfigDefinitionPrototypeResourceConfigDefinitionPropertiesPrototype unmarshals an instance of ProjectConfigDefinitionPrototypeResourceConfigDefinitionPropertiesPrototype from the specified map of raw messages.

func UnmarshalProjectConfigDefinitionResponse added in v0.2.2 

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

UnmarshalProjectConfigDefinitionResponse unmarshals an instance of ProjectConfigDefinitionResponse from the specified map of raw messages.

func UnmarshalProjectConfigDefinitionResponseDAConfigDefinitionPropertiesResponse added in v0.2.2 

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

UnmarshalProjectConfigDefinitionResponseDAConfigDefinitionPropertiesResponse unmarshals an instance of ProjectConfigDefinitionResponseDAConfigDefinitionPropertiesResponse from the specified map of raw messages.

func UnmarshalProjectConfigDefinitionResponseResourceConfigDefinitionPropertiesResponse added in v0.2.2 

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

UnmarshalProjectConfigDefinitionResponseResourceConfigDefinitionPropertiesResponse unmarshals an instance of ProjectConfigDefinitionResponseResourceConfigDefinitionPropertiesResponse 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 UnmarshalProjectConfigMetadataCodeRiskAnalyzerLogs added in v0.0.97 

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

UnmarshalProjectConfigMetadataCodeRiskAnalyzerLogs unmarshals an instance of ProjectConfigMetadataCodeRiskAnalyzerLogs from the specified map of raw messages.

func UnmarshalProjectConfigMetadataCodeRiskAnalyzerLogsVersion204 added in v0.1.8 

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

UnmarshalProjectConfigMetadataCodeRiskAnalyzerLogsVersion204 unmarshals an instance of ProjectConfigMetadataCodeRiskAnalyzerLogsVersion204 from the specified map of raw messages.

func UnmarshalProjectConfigMetadataCostEstimate added in v0.0.14 

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

UnmarshalProjectConfigMetadataCostEstimate unmarshals an instance of ProjectConfigMetadataCostEstimate from the specified map of raw messages.

func UnmarshalProjectConfigMetadataLastApproved added in v0.0.16 

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

UnmarshalProjectConfigMetadataLastApproved unmarshals an instance of ProjectConfigMetadataLastApproved 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 UnmarshalProjectConfigResource added in v0.0.18 

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

UnmarshalProjectConfigResource unmarshals an instance of ProjectConfigResource from the specified map of raw messages.

func UnmarshalProjectConfigResourceCollection added in v0.0.18 

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

UnmarshalProjectConfigResourceCollection unmarshals an instance of ProjectConfigResourceCollection from the specified map of raw messages.

func UnmarshalProjectConfigSummary added in v0.1.0 

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

UnmarshalProjectConfigSummary unmarshals an instance of ProjectConfigSummary from the specified map of raw messages.

func UnmarshalProjectConfigSummaryDefinition added in v0.1.8 

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

UnmarshalProjectConfigSummaryDefinition unmarshals an instance of ProjectConfigSummaryDefinition from the specified map of raw messages.

func UnmarshalProjectConfigVersion added in v0.0.92 

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

UnmarshalProjectConfigVersion unmarshals an instance of ProjectConfigVersion from the specified map of raw messages.

func UnmarshalProjectConfigVersionDefinitionSummary added in v0.2.2 

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

UnmarshalProjectConfigVersionDefinitionSummary unmarshals an instance of ProjectConfigVersionDefinitionSummary from the specified map of raw messages.

func UnmarshalProjectConfigVersionSummary added in v0.0.27 

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

UnmarshalProjectConfigVersionSummary unmarshals an instance of ProjectConfigVersionSummary from the specified map of raw messages.

func UnmarshalProjectConfigVersionSummaryCollection added in v0.0.27 

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

UnmarshalProjectConfigVersionSummaryCollection unmarshals an instance of ProjectConfigVersionSummaryCollection from the specified map of raw messages.

func UnmarshalProjectDefinitionProperties added in v0.0.27 

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

UnmarshalProjectDefinitionProperties unmarshals an instance of ProjectDefinitionProperties from the specified map of raw messages.

func UnmarshalProjectDefinitionReference added in v0.0.96 

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

UnmarshalProjectDefinitionReference unmarshals an instance of ProjectDefinitionReference from the specified map of raw messages.

func UnmarshalProjectDeleteResponse added in v0.2.1 

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

UnmarshalProjectDeleteResponse unmarshals an instance of ProjectDeleteResponse from the specified map of raw messages.

func UnmarshalProjectEnvironmentSummary added in v0.1.0 

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

UnmarshalProjectEnvironmentSummary unmarshals an instance of ProjectEnvironmentSummary from the specified map of raw messages.

func UnmarshalProjectEnvironmentSummaryDefinition added in v0.1.8 

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

UnmarshalProjectEnvironmentSummaryDefinition unmarshals an instance of ProjectEnvironmentSummaryDefinition from the specified map of raw messages.

func UnmarshalProjectPatchDefinitionBlock added in v0.1.0 

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

UnmarshalProjectPatchDefinitionBlock unmarshals an instance of ProjectPatchDefinitionBlock from the specified map of raw messages.

func UnmarshalProjectPrototypeDefinition added in v0.0.27 

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

UnmarshalProjectPrototypeDefinition unmarshals an instance of ProjectPrototypeDefinition from the specified map of raw messages.

func UnmarshalProjectReference added in v0.0.96 

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

UnmarshalProjectReference unmarshals an instance of ProjectReference from the specified map of raw messages.

func UnmarshalProjectResourceCollection added in v0.2.2 

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

UnmarshalProjectResourceCollection unmarshals an instance of ProjectResourceCollection from the specified map of raw messages.

func UnmarshalProjectResourceSummary added in v0.2.2 

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

UnmarshalProjectResourceSummary unmarshals an instance of ProjectResourceSummary from the specified map of raw messages.

func UnmarshalProjectSummary added in v0.0.16 

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

UnmarshalProjectSummary unmarshals an instance of ProjectSummary from the specified map of raw messages.

func UnmarshalSchematicsMetadata added in v0.1.0 

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

UnmarshalSchematicsMetadata unmarshals an instance of SchematicsMetadata from the specified map of raw messages.

func UnmarshalSchematicsWorkspace added in v0.0.90 

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

UnmarshalSchematicsWorkspace unmarshals an instance of SchematicsWorkspace from the specified map of raw messages.

func UnmarshalScript added in v0.1.0 

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

UnmarshalScript unmarshals an instance of Script from the specified map of raw messages.

func UnmarshalTerraformLogAnalyzerErrorMessage added in v0.1.0 

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

UnmarshalTerraformLogAnalyzerErrorMessage unmarshals an instance of TerraformLogAnalyzerErrorMessage from the specified map of raw messages.

func UnmarshalTerraformLogAnalyzerSuccessMessage added in v0.1.0 

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

UnmarshalTerraformLogAnalyzerSuccessMessage unmarshals an instance of TerraformLogAnalyzerSuccessMessage from the specified map of raw messages.

Types

type ActionJobApplyMessagesSummary added in v0.0.95 

type ActionJobApplyMessagesSummary struct {
	// The collection of error messages. This property is reported only if Schematics triggered a Terraform apply job.
	ErrorMessages []TerraformLogAnalyzerErrorMessage `json:"error_messages,omitempty"`

	// The collection of success messages. This property is reported only if Schematics triggered a Terraform apply job.
	SuccessMessages []TerraformLogAnalyzerSuccessMessage `json:"success_messages,omitempty"`
}

ActionJobApplyMessagesSummary : The messages of apply jobs on the configuration.

type ActionJobApplySummary added in v0.0.95 

type ActionJobApplySummary struct {
	// The number of applied resources. This property is reported only if Schematics triggered a Terraform apply job.
	Success *int64 `json:"success,omitempty"`

	// The number of failed applied resources. This property is reported only if Schematics triggered a Terraform apply
	// job.
	Failed *int64 `json:"failed,omitempty"`

	// The collection of successfully applied resources. This property is reported only if Schematics triggered a Terraform
	// apply job.
	SuccessResources []string `json:"success_resources,omitempty"`

	// The collection of failed applied resources. This property is reported only if Schematics triggered a Terraform apply
	// job.
	FailedResources []string `json:"failed_resources,omitempty"`
}

ActionJobApplySummary : The summary of the apply jobs on the configuration.

type ActionJobDestroyMessagesSummary added in v0.0.95 

type ActionJobDestroyMessagesSummary struct {
	// The collection of error messages. This property is reported only if Schematics triggered a Terraform destroy job.
	ErrorMessages []TerraformLogAnalyzerErrorMessage `json:"error_messages,omitempty"`
}

ActionJobDestroyMessagesSummary : The messages of destroy jobs on the configuration.

type ActionJobDestroySummary added in v0.0.95 

type ActionJobDestroySummary struct {
	// The number of destroyed resources. This property is reported only if Schematics triggered a Terraform destroy job.
	Success *int64 `json:"success,omitempty"`

	// The number of failed resources. This property is reported only if Schematics triggered a Terraform destroy job.
	Failed *int64 `json:"failed,omitempty"`

	// The number of tainted resources. This property is reported only if Schematics triggered a Terraform destroy job.
	Tainted *int64 `json:"tainted,omitempty"`

	// The summary of results from destroyed resources from the job. This property is reported only if Schematics triggered
	// a Terraform destroy job.
	Resources *ActionJobDestroySummaryResources `json:"resources,omitempty"`
}

ActionJobDestroySummary : The summary of the destroy jobs on the configuration.

type ActionJobDestroySummaryResources added in v0.0.95 

type ActionJobDestroySummaryResources struct {
	// The collection of destroyed resources. This property is reported only if Schematics triggered a Terraform destroy
	// job.
	Success []string `json:"success,omitempty"`

	// The collection of failed resources. This property is reported only if Schematics triggered a Terraform destroy job.
	Failed []string `json:"failed,omitempty"`

	// The collection of tainted resources. This property is reported only if Schematics triggered a Terraform destroy job.
	Tainted []string `json:"tainted,omitempty"`
}

ActionJobDestroySummaryResources : The summary of results from destroyed resources from the job. This property is reported only if Schematics triggered a Terraform destroy job.

type ActionJobMessageSummary added in v0.0.95 

type ActionJobMessageSummary struct {
	// The number of information messages. This property is reported only if Schematics triggered a Terraform job.
	Info *int64 `json:"info,omitempty"`

	// The number of debug messages. This property is reported only if Schematics triggered a Terraform job.
	Debug *int64 `json:"debug,omitempty"`

	// The number of error messages. This property is reported only if Schematics triggered a Terraform job.
	Error *int64 `json:"error,omitempty"`
}

ActionJobMessageSummary : The message summaries of jobs on the configuration.

type ActionJobPlanMessagesSummary added in v0.0.95 

type ActionJobPlanMessagesSummary struct {
	// The collection of error messages. This property is reported only if Schematics triggered a Terraform plan job.
	ErrorMessages []TerraformLogAnalyzerErrorMessage `json:"error_messages,omitempty"`

	// The collection of success messages. This property is reported only if Schematics triggered a Terraform plan job.
	SuccessMessages []string `json:"success_messages,omitempty"`

	// The collection of update messages. This property is reported only if Schematics triggered a Terraform plan job.
	UpdateMessages []string `json:"update_messages,omitempty"`

	// The collection of destroy messages. This property is reported only if Schematics triggered a Terraform plan job.
	DestroyMessages []string `json:"destroy_messages,omitempty"`
}

ActionJobPlanMessagesSummary : The plan messages on the configuration.

type ActionJobPlanSummary added in v0.0.95 

type ActionJobPlanSummary struct {
	// The number of resources to be added. This property is reported only if Schematics triggered a terraform plan job.
	Add *int64 `json:"add,omitempty"`

	// The number of resources that failed during the plan job. This property is reported only if Schematics triggered a
	// Terraform plan job.
	Failed *int64 `json:"failed,omitempty"`

	// The number of resources to be updated. This property is reported only if Schematics triggered a Terraform plan job.
	Update *int64 `json:"update,omitempty"`

	// The number of resources to be destroyed. This property is reported only if Schematics triggered a Terraform plan
	// job.
	Destroy *int64 `json:"destroy,omitempty"`

	// The collection of planned added resources. This property is reported only if Schematics triggered a Terraform plan
	// job.
	AddResources []string `json:"add_resources,omitempty"`

	// The collection of failed planned resources. This property is reported only if Schematics triggered a Terraform plan
	// job.
	FailedResources []string `json:"failed_resources,omitempty"`

	// The collection of planned updated resources. This property is reported only if Schematics triggered a Terraform plan
	// job.
	UpdatedResources []string `json:"updated_resources,omitempty"`

	// The collection of planned destroy resources. This property is reported only if Schematics triggered a Terraform plan
	// job.
	DestroyResources []string `json:"destroy_resources,omitempty"`
}

ActionJobPlanSummary : The summary of the plan jobs on the configuration.

type ActionJobSummary added in v0.0.27 

type ActionJobSummary struct {
	// The version of the job summary.
	Version *string `json:"version" validate:"required"`

	// The summary of the plan jobs on the configuration.
	PlanSummary *ActionJobPlanSummary `json:"plan_summary" validate:"required"`

	// The summary of the apply jobs on the configuration.
	ApplySummary *ActionJobApplySummary `json:"apply_summary" validate:"required"`

	// The summary of the destroy jobs on the configuration.
	DestroySummary *ActionJobDestroySummary `json:"destroy_summary" validate:"required"`

	// The message summaries of jobs on the configuration.
	MessageSummary *ActionJobMessageSummary `json:"message_summary" validate:"required"`

	// The plan messages on the configuration.
	PlanMessages *ActionJobPlanMessagesSummary `json:"plan_messages" validate:"required"`

	// The messages of apply jobs on the configuration.
	ApplyMessages *ActionJobApplyMessagesSummary `json:"apply_messages" validate:"required"`

	// The messages of destroy jobs on the configuration.
	DestroyMessages *ActionJobDestroyMessagesSummary `json:"destroy_messages" validate:"required"`
}

ActionJobSummary : The summaries of jobs that were performed on the configuration.

type ActionJobWithIdAndSummary added in v0.0.27 

type ActionJobWithIdAndSummary struct {
	// The unique ID.
	ID *string `json:"id" validate:"required"`

	// The summaries of jobs that were performed on the configuration.
	Summary *ActionJobSummary `json:"summary" validate:"required"`
}

ActionJobWithIdAndSummary : A brief summary of an action.

type ApproveOptions 

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

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

	// Notes on the project draft action. If this action is a force approve on the draft configuration, you must include a
	// nonempty comment.
	Comment *string `json:"comment,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) 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 CodeRiskAnalyzerLogsSummary added in v0.0.97 

type CodeRiskAnalyzerLogsSummary struct {
	// The total number of Code Risk Analyzer rules that were applied in the scan.
	Total *string `json:"total,omitempty"`

	// The number of Code Risk Analyzer rules that passed in the scan.
	Passed *string `json:"passed,omitempty"`

	// The number of Code Risk Analyzer rules that failed in the scan.
	Failed *string `json:"failed,omitempty"`

	// The number of Code Risk Analyzer rules that were skipped in the scan.
	Skipped *string `json:"skipped,omitempty"`
}

CodeRiskAnalyzerLogsSummary : The Code Risk Analyzer logs a summary of the configuration.

type ConfigsPager added in v0.2.2 

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

ConfigsPager can be used to simplify the use of the "ListConfigs" method.

func (*ConfigsPager) GetAll added in v0.2.2 

func (pager *ConfigsPager) GetAll() (allItems []ProjectConfigSummary, err error)

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

func (*ConfigsPager) GetAllWithContext added in v0.2.2 

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

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

func (*ConfigsPager) GetNext added in v0.2.2 

func (pager *ConfigsPager) GetNext() (page []ProjectConfigSummary, err error)

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

func (*ConfigsPager) GetNextWithContext added in v0.2.2 

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

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

func (*ConfigsPager) HasNext added in v0.2.2 

func (pager *ConfigsPager) HasNext() bool

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

type CreateConfigOptions 

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

	Definition ProjectConfigDefinitionPrototypeIntf `json:"definition" validate:"required"`

	// A Schematics workspace to use for deploying this deployable architecture.
	// > If you are importing data from an existing Schematics workspace that is not backed by cart, then you must provide
	// a `locator_id`. If you are using a Schematics workspace that is backed by cart, a `locator_id` is not required
	// because the Schematics workspace has one.
	// >
	// There are 3 scenarios:
	// > 1. If only a `locator_id` is specified, a new Schematics workspace is instantiated with that `locator_id`.
	// > 2. If only a schematics `workspace_crn` is specified, a `400` is returned if a `locator_id` is not found in the
	// existing schematics workspace.
	// > 3. If both a Schematics `workspace_crn` and a `locator_id` are specified, a `400`code  is returned if the
	// specified `locator_id` does not agree with the `locator_id` in the existing Schematics workspace.
	// >
	// For more information, see [Creating workspaces and importing your Terraform
	// template](/docs/schematics?topic=schematics-sch-create-wks).
	Schematics *SchematicsWorkspace `json:"schematics,omitempty"`

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

CreateConfigOptions : The CreateConfig options.

func (*CreateConfigOptions) SetDefinition added in v0.0.27 

func (_options *CreateConfigOptions) SetDefinition(definition ProjectConfigDefinitionPrototypeIntf) *CreateConfigOptions

SetDefinition : Allow user to set Definition

func (*CreateConfigOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*CreateConfigOptions) SetProjectID added in v0.0.8 

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

SetProjectID : Allow user to set ProjectID

func (*CreateConfigOptions) SetSchematics added in v0.0.90 

func (_options *CreateConfigOptions) SetSchematics(schematics *SchematicsWorkspace) *CreateConfigOptions

SetSchematics : Allow user to set Schematics

type CreateProjectEnvironmentOptions added in v0.0.90 

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

	// The environment definition.
	Definition *EnvironmentDefinitionRequiredProperties `json:"definition" validate:"required"`

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

CreateProjectEnvironmentOptions : The CreateProjectEnvironment options.

func (*CreateProjectEnvironmentOptions) SetDefinition added in v0.0.90 

func (_options *CreateProjectEnvironmentOptions) SetDefinition(definition *EnvironmentDefinitionRequiredProperties) *CreateProjectEnvironmentOptions

SetDefinition : Allow user to set Definition

func (*CreateProjectEnvironmentOptions) SetHeaders added in v0.0.90 

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

SetHeaders : Allow user to set Headers

func (*CreateProjectEnvironmentOptions) SetProjectID added in v0.0.90 

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

SetProjectID : Allow user to set ProjectID

type CreateProjectOptions 

type CreateProjectOptions struct {
	// The definition of the project.
	Definition *ProjectPrototypeDefinition `json:"definition" validate:"required"`

	// The IBM Cloud location where a resource is deployed.
	Location *string `json:"location" validate:"required"`

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

	// The project configurations. These configurations are included in the response of creating a project only if a
	// configuration array is specified in the request payload.
	Configs []ProjectConfigPrototype `json:"configs,omitempty"`

	// The project environment. These environments are included in the response of creating a project only if an
	// environment array is specified in the request payload.
	Environments []EnvironmentPrototype `json:"environments,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) SetDefinition added in v0.0.27 

func (_options *CreateProjectOptions) SetDefinition(definition *ProjectPrototypeDefinition) *CreateProjectOptions

SetDefinition : Allow user to set Definition

func (*CreateProjectOptions) SetEnvironments added in v0.1.5 

func (_options *CreateProjectOptions) SetEnvironments(environments []EnvironmentPrototype) *CreateProjectOptions

SetEnvironments : Allow user to set Environments

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

	// A unique ID for this individual event.
	EventID *string `json:"event_id,omitempty"`

	// A unique ID for the configuration.
	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 configuration ID.
	ID *string `json:"id" validate:"required,ne="`

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

DeleteConfigOptions : The DeleteConfig options.

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 DeleteConfigVersionOptions added in v0.0.27 

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

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

	// The configuration version.
	Version *int64 `json:"version" validate:"required"`

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

DeleteConfigVersionOptions : The DeleteConfigVersion options.

func (*DeleteConfigVersionOptions) SetHeaders added in v0.0.27 

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

SetHeaders : Allow user to set Headers

func (*DeleteConfigVersionOptions) SetID added in v0.0.27 

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

SetID : Allow user to set ID

func (*DeleteConfigVersionOptions) SetProjectID added in v0.0.27 

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

SetProjectID : Allow user to set ProjectID

func (*DeleteConfigVersionOptions) SetVersion added in v0.0.27 

func (_options *DeleteConfigVersionOptions) SetVersion(version int64) *DeleteConfigVersionOptions

SetVersion : Allow user to set Version

type DeleteProjectEnvironmentOptions added in v0.0.90 

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

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

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

DeleteProjectEnvironmentOptions : The DeleteProjectEnvironment options.

func (*DeleteProjectEnvironmentOptions) SetHeaders added in v0.0.90 

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

SetHeaders : Allow user to set Headers

func (*DeleteProjectEnvironmentOptions) SetID added in v0.0.90 

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

SetID : Allow user to set ID

func (*DeleteProjectEnvironmentOptions) SetProjectID added in v0.0.90 

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

SetProjectID : Allow user to set ProjectID

type DeleteProjectOptions 

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

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

DeleteProjectOptions : The DeleteProject options.

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 DeployConfigOptions added in v0.0.27 

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

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

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

DeployConfigOptions : The DeployConfig options.

func (*DeployConfigOptions) SetHeaders added in v0.0.27 

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

SetHeaders : Allow user to set Headers

func (*DeployConfigOptions) SetID added in v0.0.27 

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

SetID : Allow user to set ID

func (*DeployConfigOptions) SetProjectID added in v0.0.27 

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

SetProjectID : Allow user to set ProjectID

type Environment added in v0.0.90 

type Environment struct {
	// The environment ID as a friendly name.
	ID *string `json:"id" validate:"required"`

	// The project that is referenced by this resource.
	Project *ProjectReference `json:"project" validate:"required"`

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

	// The target account ID derived from the authentication block values. The target account exists only if the
	// environment currently has an authorization block.
	TargetAccount *string `json:"target_account,omitempty"`

	// A date and time value in the format YYYY-MM-DDTHH:mm:ssZ or YYYY-MM-DDTHH:mm:ss.sssZ to match the date and time
	// format as specified by RFC 3339.
	ModifiedAt *strfmt.DateTime `json:"modified_at" validate:"required"`

	// A URL.
	Href *string `json:"href" validate:"required"`

	// The environment definition.
	Definition *EnvironmentDefinitionRequiredPropertiesResponse `json:"definition" validate:"required"`
}

Environment : The definition of a project environment.

type EnvironmentCollection added in v0.1.0 

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

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

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

	// The environment.
	Environments []Environment `json:"environments,omitempty"`
}

EnvironmentCollection : The list environment response.

func (*EnvironmentCollection) GetNextStart added in v0.2.1 

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

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

type EnvironmentDefinitionPropertiesPatch added in v0.1.8 

type EnvironmentDefinitionPropertiesPatch struct {
	// The description of the environment.
	Description *string `json:"description,omitempty"`

	// The name of the environment. It's unique within the account across projects and regions.
	Name *string `json:"name,omitempty"`

	// The authorization details. You can authorize by using a trusted profile or an API key in Secrets Manager.
	Authorizations *ProjectConfigAuth `json:"authorizations,omitempty"`

	// The input variables that are used for configuration definition and environment.
	Inputs map[string]interface{} `json:"inputs,omitempty"`

	// The profile that is required for compliance.
	ComplianceProfile *ProjectComplianceProfile `json:"compliance_profile,omitempty"`
}

EnvironmentDefinitionPropertiesPatch : The environment definition that is used for updates.

type EnvironmentDefinitionRequiredProperties added in v0.0.90 

type EnvironmentDefinitionRequiredProperties struct {
	// The description of the environment.
	Description *string `json:"description,omitempty"`

	// The name of the environment. It's unique within the account across projects and regions.
	Name *string `json:"name" validate:"required"`

	// The authorization details. You can authorize by using a trusted profile or an API key in Secrets Manager.
	Authorizations *ProjectConfigAuth `json:"authorizations,omitempty"`

	// The input variables that are used for configuration definition and environment.
	Inputs map[string]interface{} `json:"inputs,omitempty"`

	// The profile that is required for compliance.
	ComplianceProfile *ProjectComplianceProfile `json:"compliance_profile,omitempty"`
}

EnvironmentDefinitionRequiredProperties : The environment definition.

type EnvironmentDefinitionRequiredPropertiesResponse added in v0.2.2 

type EnvironmentDefinitionRequiredPropertiesResponse struct {
	// The description of the environment.
	Description *string `json:"description" validate:"required"`

	// The name of the environment. It's unique within the account across projects and regions.
	Name *string `json:"name" validate:"required"`

	// The authorization details. You can authorize by using a trusted profile or an API key in Secrets Manager.
	Authorizations *ProjectConfigAuth `json:"authorizations,omitempty"`

	// The input variables that are used for configuration definition and environment.
	Inputs map[string]interface{} `json:"inputs,omitempty"`

	// The profile that is required for compliance.
	ComplianceProfile *ProjectComplianceProfile `json:"compliance_profile,omitempty"`
}

EnvironmentDefinitionRequiredPropertiesResponse : The environment definition.

type EnvironmentDeleteResponse added in v0.0.90 

type EnvironmentDeleteResponse struct {
	// The environment ID as a friendly name.
	ID *string `json:"id" validate:"required"`
}

EnvironmentDeleteResponse : The response to a request to delete an environment.

type EnvironmentPrototype added in v0.1.5 

type EnvironmentPrototype struct {
	// The environment definition.
	Definition *EnvironmentDefinitionRequiredProperties `json:"definition" validate:"required"`
}

EnvironmentPrototype : The definition of a project environment.

type ForceApproveOptions 

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

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

	// Notes on the project draft action. If this action is a force approve on the draft configuration, you must include a
	// nonempty comment.
	Comment *string `json:"comment" validate:"required"`

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

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

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

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

GetConfigOptions : The GetConfig options.

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

type GetConfigVersionOptions added in v0.0.27 

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

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

	// The configuration version.
	Version *int64 `json:"version" validate:"required"`

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

GetConfigVersionOptions : The GetConfigVersion options.

func (*GetConfigVersionOptions) SetHeaders added in v0.0.27 

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

SetHeaders : Allow user to set Headers

func (*GetConfigVersionOptions) SetID added in v0.0.27 

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

SetID : Allow user to set ID

func (*GetConfigVersionOptions) SetProjectID added in v0.0.27 

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

SetProjectID : Allow user to set ProjectID

func (*GetConfigVersionOptions) SetVersion added in v0.0.27 

func (_options *GetConfigVersionOptions) SetVersion(version int64) *GetConfigVersionOptions

SetVersion : Allow user to set Version

type GetProjectEnvironmentOptions added in v0.0.90 

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

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

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

GetProjectEnvironmentOptions : The GetProjectEnvironment options.

func (*GetProjectEnvironmentOptions) SetHeaders added in v0.0.90 

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

SetHeaders : Allow user to set Headers

func (*GetProjectEnvironmentOptions) SetID added in v0.0.90 

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

SetID : Allow user to set ID

func (*GetProjectEnvironmentOptions) SetProjectID added in v0.0.90 

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

SetProjectID : Allow user to set ProjectID

type GetProjectOptions 

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

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

GetProjectOptions : The GetProject options.

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 LastActionWithSummary added in v0.0.27 

type LastActionWithSummary struct {
	// A URL.
	Href *string `json:"href" validate:"required"`

	// The result of the last action.
	Result *string `json:"result,omitempty"`

	// A brief summary of an action.
	Job *ActionJobWithIdAndSummary `json:"job,omitempty"`

	// A brief summary of a pre- and post-action.
	PreJob *PrePostActionJobWithIdAndSummary `json:"pre_job,omitempty"`

	// A brief summary of a pre- and post-action.
	PostJob *PrePostActionJobWithIdAndSummary `json:"post_job,omitempty"`
}

LastActionWithSummary : The href and results from the last action job that is performed on the project configuration.

type LastDriftDetectionJobSummary added in v0.2.1 

type LastDriftDetectionJobSummary struct {
	// A brief summary of an action.
	Job *ActionJobWithIdAndSummary `json:"job,omitempty"`
}

LastDriftDetectionJobSummary : The summary for drift detection jobs that are performed as part of the last monitoring action.

type LastMonitoringActionWithSummary added in v0.2.1 

type LastMonitoringActionWithSummary struct {
	// A URL.
	Href *string `json:"href" validate:"required"`

	// The result of the last action.
	Result *string `json:"result,omitempty"`

	// The summary for drift detection jobs that are performed as part of the last monitoring action.
	DriftDetection *LastDriftDetectionJobSummary `json:"drift_detection,omitempty"`
}

LastMonitoringActionWithSummary : The summary from the last monitoring action job that is performed on the project configuration.

type LastValidatedActionWithSummary added in v0.0.27 

type LastValidatedActionWithSummary struct {
	// A URL.
	Href *string `json:"href" validate:"required"`

	// The result of the last action.
	Result *string `json:"result,omitempty"`

	// A brief summary of an action.
	Job *ActionJobWithIdAndSummary `json:"job,omitempty"`

	// A brief summary of a pre- and post-action.
	PreJob *PrePostActionJobWithIdAndSummary `json:"pre_job,omitempty"`

	// A brief summary of a pre- and post-action.
	PostJob *PrePostActionJobWithIdAndSummary `json:"post_job,omitempty"`

	// The cost estimate of the configuration.
	// This property exists only after the first configuration validation.
	CostEstimate *ProjectConfigMetadataCostEstimate `json:"cost_estimate,omitempty"`

	// The Code Risk Analyzer logs of the configuration. This property is populated only after the validation step when the
	// Code Risk Analyzer is run. Note: `cra` is the abbreviated form of Code Risk Analyzer.
	CraLogs ProjectConfigMetadataCodeRiskAnalyzerLogsIntf `json:"cra_logs,omitempty"`
}

LastValidatedActionWithSummary : The href and results from the last action job that is performed on the project configuration.

type ListConfigResourcesOptions added in v0.0.18 

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

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

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

ListConfigResourcesOptions : The ListConfigResources options.

func (*ListConfigResourcesOptions) SetHeaders added in v0.0.18 

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

SetHeaders : Allow user to set Headers

func (*ListConfigResourcesOptions) SetID added in v0.0.18 

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

SetID : Allow user to set ID

func (*ListConfigResourcesOptions) SetProjectID added in v0.0.18 

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

SetProjectID : Allow user to set ProjectID

type ListConfigVersionsOptions added in v0.0.27 

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

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

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

ListConfigVersionsOptions : The ListConfigVersions options.

func (*ListConfigVersionsOptions) SetHeaders added in v0.0.27 

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

SetHeaders : Allow user to set Headers

func (*ListConfigVersionsOptions) SetID added in v0.0.27 

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

SetID : Allow user to set ID

func (*ListConfigVersionsOptions) SetProjectID added in v0.0.27 

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

SetProjectID : Allow user to set ProjectID

type ListConfigsOptions 

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

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

	// The maximum number of resources to return. The number of resources that are returned is the same, except for the
	// last page.
	Limit *int64 `json:"limit,omitempty"`

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

ListConfigsOptions : The ListConfigs options.

func (*ListConfigsOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*ListConfigsOptions) SetLimit added in v0.2.2 

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

SetLimit : Allow user to set Limit

func (*ListConfigsOptions) SetProjectID 

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

SetProjectID : Allow user to set ProjectID

func (*ListConfigsOptions) SetStart added in v0.2.2 

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

SetStart : Allow user to set Start

type ListProjectEnvironmentsOptions added in v0.0.90 

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

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

	// The maximum number of resources to return. The number of resources that are returned is the same, except for the
	// last page.
	Limit *int64 `json:"limit,omitempty"`

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

ListProjectEnvironmentsOptions : The ListProjectEnvironments options.

func (*ListProjectEnvironmentsOptions) SetHeaders added in v0.0.90 

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

SetHeaders : Allow user to set Headers

func (*ListProjectEnvironmentsOptions) SetLimit added in v0.2.1 

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

SetLimit : Allow user to set Limit

func (*ListProjectEnvironmentsOptions) SetProjectID added in v0.0.90 

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

SetProjectID : Allow user to set ProjectID

func (*ListProjectEnvironmentsOptions) SetStart added in v0.2.1 

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

SetStart : Allow user to set Start

type ListProjectResourcesOptions added in v0.2.2 

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

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

	// The maximum number of resources to return. The number of resources that are returned is the same, except for the
	// last page.
	Limit *int64 `json:"limit,omitempty"`

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

ListProjectResourcesOptions : The ListProjectResources options.

func (*ListProjectResourcesOptions) SetHeaders added in v0.2.2 

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

SetHeaders : Allow user to set Headers

func (*ListProjectResourcesOptions) SetID added in v0.2.2 

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

SetID : Allow user to set ID

func (*ListProjectResourcesOptions) SetLimit added in v0.2.2 

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

SetLimit : Allow user to set Limit

func (*ListProjectResourcesOptions) SetStart added in v0.2.2 

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

SetStart : Allow user to set Start

type ListProjectsOptions 

type ListProjectsOptions struct {
	// 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"`

	// The maximum number of resources to return. The number of resources that are returned is the same, except for the
	// last page.
	Limit *int64 `json:"limit,omitempty"`

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

ListProjectsOptions : The ListProjects options.

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

	// This property can be any value - a string, number, boolean, array, or object.
	Value map[string]interface{} `json:"value,omitempty"`
}

OutputValue : OutputValue struct 

type PaginationLink struct {
	// A URL.
	Href *string `json:"href" validate:"required"`
}

PaginationLink : A pagination link.

type PrePostActionJobSummary added in v0.1.4 

type PrePostActionJobSummary struct {
	// The ID of the Schematics action job that ran as part of the pre- and post-job.
	JobID *string `json:"job_id" validate:"required"`

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

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

	// The number of tasks that were run in the job.
	Tasks *int64 `json:"tasks,omitempty"`

	// The number of tasks that successfully ran in the job.
	Ok *int64 `json:"ok,omitempty"`

	// The number of tasks that failed in the job.
	Failed *int64 `json:"failed,omitempty"`

	// The number of tasks that were skipped in the job.
	Skipped *int64 `json:"skipped,omitempty"`

	// The number of tasks that were changed in the job.
	Changed *int64 `json:"changed,omitempty"`

	// A system-level error from the pipeline that ran for this specific pre- and post-job.
	ProjectError *PrePostActionJobSystemError `json:"project_error,omitempty"`
}

PrePostActionJobSummary : A brief summary of a pre- and post-action job. This property is populated only after an action is run as part of a validation, deployment, or undeployment.

type PrePostActionJobSystemError added in v0.1.4 

type PrePostActionJobSystemError struct {
	// A date and time value in the format YYYY-MM-DDTHH:mm:ssZ or YYYY-MM-DDTHH:mm:ss.sssZ to match the date and time
	// format as specified by RFC 3339.
	Timestamp *strfmt.DateTime `json:"timestamp" validate:"required"`

	// The ID of the user that triggered the pipeline that ran the pre- and post-job.
	UserID *string `json:"user_id" validate:"required"`

	// The HTTP status code for the error.
	StatusCode *string `json:"status_code" validate:"required"`

	// The summary description of the error.
	Description *string `json:"description" validate:"required"`

	// The detailed message from the source error.
	ErrorResponse *string `json:"error_response,omitempty"`
}

PrePostActionJobSystemError : The system-level error that OS captured in the project pipelines for the pre- and post-job.

type PrePostActionJobWithIdAndSummary added in v0.0.90 

type PrePostActionJobWithIdAndSummary struct {
	// The unique ID.
	ID *string `json:"id" validate:"required"`

	// A brief summary of a pre- and post-action job. This property is populated only after an action is run as part of a
	// validation, deployment, or undeployment.
	Summary *PrePostActionJobSummary `json:"summary" validate:"required"`
}

PrePostActionJobWithIdAndSummary : A brief summary of a pre- and post-action.

type Project 

type Project struct {
	// An IBM Cloud resource name that uniquely identifies a resource.
	Crn *string `json:"crn" validate:"required"`

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

	// The cumulative list of needs attention items for a project. If the view is successfully retrieved, an empty or
	// nonempty array is returned.
	CumulativeNeedsAttentionView []CumulativeNeedsAttention `json:"cumulative_needs_attention_view" validate:"required"`

	// A value of `true` indicates that the fetch of the needs attention items failed. This property only exists if there
	// was an error when you retrieved the cumulative needs attention view.
	CumulativeNeedsAttentionViewError *bool `json:"cumulative_needs_attention_view_error,omitempty"`

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

	// The IBM Cloud location where a resource is deployed.
	Location *string `json:"location" validate:"required"`

	// The resource group ID where the project's data and tools are created.
	ResourceGroupID *string `json:"resource_group_id" validate:"required"`

	// The project status value.
	State *string `json:"state" validate:"required"`

	// A URL.
	Href *string `json:"href" validate:"required"`

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

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

	// The project configurations. These configurations are only included in the response of creating a project if a
	// configuration array is specified in the request payload.
	Configs []ProjectConfigSummary `json:"configs" validate:"required"`

	// The project environment. These environments are only included in the response if project environments were created
	// on the project.
	Environments []ProjectEnvironmentSummary `json:"environments" validate:"required"`

	// The definition of the project.
	Definition *ProjectDefinitionProperties `json:"definition" validate:"required"`
}

Project : The standard schema of a project.

type ProjectCollection 

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

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

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

	// An array of projects.
	Projects []ProjectSummary `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 ProjectComplianceProfile added in v0.0.27 

type ProjectComplianceProfile struct {
	// The unique ID for the compliance profile.
	ID *string `json:"id,omitempty"`

	// A unique ID for the instance of a compliance profile.
	InstanceID *string `json:"instance_id,omitempty"`

	// The location of the compliance instance.
	InstanceLocation *string `json:"instance_location,omitempty"`

	// A unique ID for the attachment to a compliance profile.
	AttachmentID *string `json:"attachment_id,omitempty"`

	// The name of the compliance profile.
	ProfileName *string `json:"profile_name,omitempty"`
}

ProjectComplianceProfile : The profile that is required for compliance.

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" validate:"required"`

	// The version of the configuration.
	Version *int64 `json:"version" validate:"required"`

	// The flag that indicates whether the version of the configuration is draft, or active.
	IsDraft *bool `json:"is_draft" validate:"required"`

	// The needs attention state of a configuration.
	NeedsAttentionState []map[string]interface{} `json:"needs_attention_state" validate:"required"`

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

	// A date and time value in the format YYYY-MM-DDTHH:mm:ssZ or YYYY-MM-DDTHH:mm:ss.sssZ to match the date and time
	// format as specified by RFC 3339.
	ModifiedAt *strfmt.DateTime `json:"modified_at" validate:"required"`

	// The last approved metadata of the configuration.
	LastApproved *ProjectConfigMetadataLastApproved `json:"last_approved,omitempty"`

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

	// The href and results from the last action job that is performed on the project configuration.
	LastValidated *LastValidatedActionWithSummary `json:"last_validated,omitempty"`

	// The href and results from the last action job that is performed on the project configuration.
	LastDeployed *LastActionWithSummary `json:"last_deployed,omitempty"`

	// The href and results from the last action job that is performed on the project configuration.
	LastUndeployed *LastActionWithSummary `json:"last_undeployed,omitempty"`

	// The summary from the last monitoring action job that is performed on the project configuration.
	LastMonitoring *LastMonitoringActionWithSummary `json:"last_monitoring,omitempty"`

	// The outputs of a Schematics template property.
	Outputs []OutputValue `json:"outputs" validate:"required"`

	// The project that is referenced by this resource.
	Project *ProjectReference `json:"project" validate:"required"`

	// The references that are used in the configuration to resolve input values.
	References map[string]interface{} `json:"references,omitempty"`

	// A Schematics workspace that is associated to a project configuration, with scripts.
	Schematics *SchematicsMetadata `json:"schematics,omitempty"`

	// The state of the configuration.
	State *string `json:"state" validate:"required"`

	// The flag that indicates whether a configuration update is available.
	UpdateAvailable *bool `json:"update_available,omitempty"`

	// A URL.
	Href *string `json:"href" validate:"required"`

	Definition ProjectConfigDefinitionResponseIntf `json:"definition" validate:"required"`

	// A summary of a project configuration version.
	ApprovedVersion *ProjectConfigVersionSummary `json:"approved_version,omitempty"`

	// A summary of a project configuration version.
	DeployedVersion *ProjectConfigVersionSummary `json:"deployed_version,omitempty"`
}

ProjectConfig : The standard schema of a project configuration.

type ProjectConfigAuth added in v0.0.11 

type ProjectConfigAuth struct {
	// The trusted profile ID.
	TrustedProfileID *string `json:"trusted_profile_id,omitempty"`

	// The authorization method. You can authorize by using a trusted profile or an API key in Secrets Manager.
	Method *string `json:"method,omitempty"`

	// The IBM Cloud API Key. It can be either raw or pulled from the catalog via a `CRN` or `JSON` blob.
	ApiKey *string `json:"api_key,omitempty"`
}

ProjectConfigAuth : The authorization details. You can authorize by using a trusted profile or an API key in Secrets Manager.

type ProjectConfigCollection 

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

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

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

	// The response schema of the collection list operation that defines the array property with the name `configs`.
	Configs []ProjectConfigSummary `json:"configs,omitempty"`
}

ProjectConfigCollection : The project configuration list.

func (*ProjectConfigCollection) GetNextStart added in v0.2.2 

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

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

type ProjectConfigDefinitionPatch added in v0.2.2 

type ProjectConfigDefinitionPatch struct {
	// The profile that is required for compliance.
	ComplianceProfile *ProjectComplianceProfile `json:"compliance_profile,omitempty"`

	// A unique concatenation of the catalog ID and the version ID that identify the deployable architecture in the
	// catalog. I you're importing from an existing Schematics workspace that is not backed by cart, a `locator_id` is
	// required. If you're using a Schematics workspace that is backed by cart, a `locator_id` is not necessary because the
	// Schematics workspace has one.
	// > There are 3 scenarios:
	// > 1. If only a `locator_id` is specified, a new Schematics workspace is instantiated with that `locator_id`.
	// > 2. If only a schematics `workspace_crn` is specified, a `400` is returned if a `locator_id` is not found in the
	// existing schematics workspace.
	// > 3. If both a Schematics `workspace_crn` and a `locator_id` are specified, a `400` message is returned if the
	// specified `locator_id` does not agree with the `locator_id` in the existing Schematics workspace.
	// > For more information of creating a Schematics workspace, see [Creating workspaces and importing your Terraform
	// template](/docs/schematics?topic=schematics-sch-create-wks).
	LocatorID *string `json:"locator_id,omitempty"`

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

	// The configuration name. It's unique within the account across projects and regions.
	Name *string `json:"name,omitempty"`

	// The ID of the project environment.
	EnvironmentID *string `json:"environment_id,omitempty"`

	// The authorization details. You can authorize by using a trusted profile or an API key in Secrets Manager.
	Authorizations *ProjectConfigAuth `json:"authorizations,omitempty"`

	// The input variables that are used for configuration definition and environment.
	Inputs map[string]interface{} `json:"inputs,omitempty"`

	// The Schematics environment variables to use to deploy the configuration. Settings are only available if they are
	// specified when the configuration is initially created.
	Settings map[string]interface{} `json:"settings,omitempty"`

	// The CRNs of the resources that are associated with this configuration.
	ResourceCrns []string `json:"resource_crns,omitempty"`
}

ProjectConfigDefinitionPatch : ProjectConfigDefinitionPatch struct Models which "extend" this model: - ProjectConfigDefinitionPatchDAConfigDefinitionPropertiesPatch - ProjectConfigDefinitionPatchResourceConfigDefinitionPropertiesPatch

type ProjectConfigDefinitionPatchDAConfigDefinitionPropertiesPatch added in v0.2.2 

type ProjectConfigDefinitionPatchDAConfigDefinitionPropertiesPatch struct {
	// The profile that is required for compliance.
	ComplianceProfile *ProjectComplianceProfile `json:"compliance_profile,omitempty"`

	// A unique concatenation of the catalog ID and the version ID that identify the deployable architecture in the
	// catalog. I you're importing from an existing Schematics workspace that is not backed by cart, a `locator_id` is
	// required. If you're using a Schematics workspace that is backed by cart, a `locator_id` is not necessary because the
	// Schematics workspace has one.
	// > There are 3 scenarios:
	// > 1. If only a `locator_id` is specified, a new Schematics workspace is instantiated with that `locator_id`.
	// > 2. If only a schematics `workspace_crn` is specified, a `400` is returned if a `locator_id` is not found in the
	// existing schematics workspace.
	// > 3. If both a Schematics `workspace_crn` and a `locator_id` are specified, a `400` message is returned if the
	// specified `locator_id` does not agree with the `locator_id` in the existing Schematics workspace.
	// > For more information of creating a Schematics workspace, see [Creating workspaces and importing your Terraform
	// template](/docs/schematics?topic=schematics-sch-create-wks).
	LocatorID *string `json:"locator_id,omitempty"`

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

	// The configuration name. It's unique within the account across projects and regions.
	Name *string `json:"name,omitempty"`

	// The ID of the project environment.
	EnvironmentID *string `json:"environment_id,omitempty"`

	// The authorization details. You can authorize by using a trusted profile or an API key in Secrets Manager.
	Authorizations *ProjectConfigAuth `json:"authorizations,omitempty"`

	// The input variables that are used for configuration definition and environment.
	Inputs map[string]interface{} `json:"inputs,omitempty"`

	// The Schematics environment variables to use to deploy the configuration. Settings are only available if they are
	// specified when the configuration is initially created.
	Settings map[string]interface{} `json:"settings,omitempty"`
}

ProjectConfigDefinitionPatchDAConfigDefinitionPropertiesPatch : The name and description of a project configuration. This model "extends" ProjectConfigDefinitionPatch

type ProjectConfigDefinitionPatchIntf added in v0.2.2 

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

type ProjectConfigDefinitionPatchResourceConfigDefinitionPropertiesPatch added in v0.2.2 

type ProjectConfigDefinitionPatchResourceConfigDefinitionPropertiesPatch struct {
	// The CRNs of the resources that are associated with this configuration.
	ResourceCrns []string `json:"resource_crns,omitempty"`

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

	// The configuration name. It's unique within the account across projects and regions.
	Name *string `json:"name,omitempty"`

	// The ID of the project environment.
	EnvironmentID *string `json:"environment_id,omitempty"`

	// The authorization details. You can authorize by using a trusted profile or an API key in Secrets Manager.
	Authorizations *ProjectConfigAuth `json:"authorizations,omitempty"`

	// The input variables that are used for configuration definition and environment.
	Inputs map[string]interface{} `json:"inputs,omitempty"`

	// The Schematics environment variables to use to deploy the configuration. Settings are only available if they are
	// specified when the configuration is initially created.
	Settings map[string]interface{} `json:"settings,omitempty"`
}

ProjectConfigDefinitionPatchResourceConfigDefinitionPropertiesPatch : The name and description of a project configuration. This model "extends" ProjectConfigDefinitionPatch

type ProjectConfigDefinitionPrototype added in v0.2.2 

type ProjectConfigDefinitionPrototype struct {
	// The profile that is required for compliance.
	ComplianceProfile *ProjectComplianceProfile `json:"compliance_profile,omitempty"`

	// A unique concatenation of the catalog ID and the version ID that identify the deployable architecture in the
	// catalog. I you're importing from an existing Schematics workspace that is not backed by cart, a `locator_id` is
	// required. If you're using a Schematics workspace that is backed by cart, a `locator_id` is not necessary because the
	// Schematics workspace has one.
	// > There are 3 scenarios:
	// > 1. If only a `locator_id` is specified, a new Schematics workspace is instantiated with that `locator_id`.
	// > 2. If only a schematics `workspace_crn` is specified, a `400` is returned if a `locator_id` is not found in the
	// existing schematics workspace.
	// > 3. If both a Schematics `workspace_crn` and a `locator_id` are specified, a `400` message is returned if the
	// specified `locator_id` does not agree with the `locator_id` in the existing Schematics workspace.
	// > For more information of creating a Schematics workspace, see [Creating workspaces and importing your Terraform
	// template](/docs/schematics?topic=schematics-sch-create-wks).
	LocatorID *string `json:"locator_id,omitempty"`

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

	// The configuration name. It's unique within the account across projects and regions.
	Name *string `json:"name,omitempty"`

	// The ID of the project environment.
	EnvironmentID *string `json:"environment_id,omitempty"`

	// The authorization details. You can authorize by using a trusted profile or an API key in Secrets Manager.
	Authorizations *ProjectConfigAuth `json:"authorizations,omitempty"`

	// The input variables that are used for configuration definition and environment.
	Inputs map[string]interface{} `json:"inputs,omitempty"`

	// The Schematics environment variables to use to deploy the configuration. Settings are only available if they are
	// specified when the configuration is initially created.
	Settings map[string]interface{} `json:"settings,omitempty"`

	// The CRNs of the resources that are associated with this configuration.
	ResourceCrns []string `json:"resource_crns,omitempty"`
}

ProjectConfigDefinitionPrototype : ProjectConfigDefinitionPrototype struct Models which "extend" this model: - ProjectConfigDefinitionPrototypeDAConfigDefinitionPropertiesPrototype - ProjectConfigDefinitionPrototypeResourceConfigDefinitionPropertiesPrototype

type ProjectConfigDefinitionPrototypeDAConfigDefinitionPropertiesPrototype added in v0.2.2 

type ProjectConfigDefinitionPrototypeDAConfigDefinitionPropertiesPrototype struct {
	// The profile that is required for compliance.
	ComplianceProfile *ProjectComplianceProfile `json:"compliance_profile,omitempty"`

	// A unique concatenation of the catalog ID and the version ID that identify the deployable architecture in the
	// catalog. I you're importing from an existing Schematics workspace that is not backed by cart, a `locator_id` is
	// required. If you're using a Schematics workspace that is backed by cart, a `locator_id` is not necessary because the
	// Schematics workspace has one.
	// > There are 3 scenarios:
	// > 1. If only a `locator_id` is specified, a new Schematics workspace is instantiated with that `locator_id`.
	// > 2. If only a schematics `workspace_crn` is specified, a `400` is returned if a `locator_id` is not found in the
	// existing schematics workspace.
	// > 3. If both a Schematics `workspace_crn` and a `locator_id` are specified, a `400` message is returned if the
	// specified `locator_id` does not agree with the `locator_id` in the existing Schematics workspace.
	// > For more information of creating a Schematics workspace, see [Creating workspaces and importing your Terraform
	// template](/docs/schematics?topic=schematics-sch-create-wks).
	LocatorID *string `json:"locator_id,omitempty"`

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

	// The configuration name. It's unique within the account across projects and regions.
	Name *string `json:"name" validate:"required"`

	// The ID of the project environment.
	EnvironmentID *string `json:"environment_id,omitempty"`

	// The authorization details. You can authorize by using a trusted profile or an API key in Secrets Manager.
	Authorizations *ProjectConfigAuth `json:"authorizations,omitempty"`

	// The input variables that are used for configuration definition and environment.
	Inputs map[string]interface{} `json:"inputs,omitempty"`

	// The Schematics environment variables to use to deploy the configuration. Settings are only available if they are
	// specified when the configuration is initially created.
	Settings map[string]interface{} `json:"settings,omitempty"`
}

ProjectConfigDefinitionPrototypeDAConfigDefinitionPropertiesPrototype : The description of a project configuration. This model "extends" ProjectConfigDefinitionPrototype

type ProjectConfigDefinitionPrototypeIntf added in v0.2.2 

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

type ProjectConfigDefinitionPrototypeResourceConfigDefinitionPropertiesPrototype added in v0.2.2 

type ProjectConfigDefinitionPrototypeResourceConfigDefinitionPropertiesPrototype struct {
	// The CRNs of the resources that are associated with this configuration.
	ResourceCrns []string `json:"resource_crns,omitempty"`

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

	// The configuration name. It's unique within the account across projects and regions.
	Name *string `json:"name" validate:"required"`

	// The ID of the project environment.
	EnvironmentID *string `json:"environment_id,omitempty"`

	// The authorization details. You can authorize by using a trusted profile or an API key in Secrets Manager.
	Authorizations *ProjectConfigAuth `json:"authorizations,omitempty"`

	// The input variables that are used for configuration definition and environment.
	Inputs map[string]interface{} `json:"inputs,omitempty"`

	// The Schematics environment variables to use to deploy the configuration. Settings are only available if they are
	// specified when the configuration is initially created.
	Settings map[string]interface{} `json:"settings,omitempty"`
}

ProjectConfigDefinitionPrototypeResourceConfigDefinitionPropertiesPrototype : The description of a project configuration. This model "extends" ProjectConfigDefinitionPrototype

type ProjectConfigDefinitionResponse added in v0.2.2 

type ProjectConfigDefinitionResponse struct {
	// The profile that is required for compliance.
	ComplianceProfile *ProjectComplianceProfile `json:"compliance_profile,omitempty"`

	// A unique concatenation of the catalog ID and the version ID that identify the deployable architecture in the
	// catalog. I you're importing from an existing Schematics workspace that is not backed by cart, a `locator_id` is
	// required. If you're using a Schematics workspace that is backed by cart, a `locator_id` is not necessary because the
	// Schematics workspace has one.
	// > There are 3 scenarios:
	// > 1. If only a `locator_id` is specified, a new Schematics workspace is instantiated with that `locator_id`.
	// > 2. If only a schematics `workspace_crn` is specified, a `400` is returned if a `locator_id` is not found in the
	// existing schematics workspace.
	// > 3. If both a Schematics `workspace_crn` and a `locator_id` are specified, a `400` message is returned if the
	// specified `locator_id` does not agree with the `locator_id` in the existing Schematics workspace.
	// > For more information of creating a Schematics workspace, see [Creating workspaces and importing your Terraform
	// template](/docs/schematics?topic=schematics-sch-create-wks).
	LocatorID *string `json:"locator_id,omitempty"`

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

	// The configuration name. It's unique within the account across projects and regions.
	Name *string `json:"name,omitempty"`

	// The ID of the project environment.
	EnvironmentID *string `json:"environment_id,omitempty"`

	// The authorization details. You can authorize by using a trusted profile or an API key in Secrets Manager.
	Authorizations *ProjectConfigAuth `json:"authorizations,omitempty"`

	// The input variables that are used for configuration definition and environment.
	Inputs map[string]interface{} `json:"inputs,omitempty"`

	// The Schematics environment variables to use to deploy the configuration. Settings are only available if they are
	// specified when the configuration is initially created.
	Settings map[string]interface{} `json:"settings,omitempty"`

	// The CRNs of the resources that are associated with this configuration.
	ResourceCrns []string `json:"resource_crns,omitempty"`
}

ProjectConfigDefinitionResponse : ProjectConfigDefinitionResponse struct Models which "extend" this model: - ProjectConfigDefinitionResponseDAConfigDefinitionPropertiesResponse - ProjectConfigDefinitionResponseResourceConfigDefinitionPropertiesResponse

type ProjectConfigDefinitionResponseDAConfigDefinitionPropertiesResponse added in v0.2.2 

type ProjectConfigDefinitionResponseDAConfigDefinitionPropertiesResponse struct {
	// The profile that is required for compliance.
	ComplianceProfile *ProjectComplianceProfile `json:"compliance_profile,omitempty"`

	// A unique concatenation of the catalog ID and the version ID that identify the deployable architecture in the
	// catalog. I you're importing from an existing Schematics workspace that is not backed by cart, a `locator_id` is
	// required. If you're using a Schematics workspace that is backed by cart, a `locator_id` is not necessary because the
	// Schematics workspace has one.
	// > There are 3 scenarios:
	// > 1. If only a `locator_id` is specified, a new Schematics workspace is instantiated with that `locator_id`.
	// > 2. If only a schematics `workspace_crn` is specified, a `400` is returned if a `locator_id` is not found in the
	// existing schematics workspace.
	// > 3. If both a Schematics `workspace_crn` and a `locator_id` are specified, a `400` message is returned if the
	// specified `locator_id` does not agree with the `locator_id` in the existing Schematics workspace.
	// > For more information of creating a Schematics workspace, see [Creating workspaces and importing your Terraform
	// template](/docs/schematics?topic=schematics-sch-create-wks).
	LocatorID *string `json:"locator_id,omitempty"`

	// A project configuration description.
	Description *string `json:"description" validate:"required"`

	// The configuration name. It's unique within the account across projects and regions.
	Name *string `json:"name" validate:"required"`

	// The ID of the project environment.
	EnvironmentID *string `json:"environment_id,omitempty"`

	// The authorization details. You can authorize by using a trusted profile or an API key in Secrets Manager.
	Authorizations *ProjectConfigAuth `json:"authorizations,omitempty"`

	// The input variables that are used for configuration definition and environment.
	Inputs map[string]interface{} `json:"inputs,omitempty"`

	// The Schematics environment variables to use to deploy the configuration. Settings are only available if they are
	// specified when the configuration is initially created.
	Settings map[string]interface{} `json:"settings,omitempty"`
}

ProjectConfigDefinitionResponseDAConfigDefinitionPropertiesResponse : The description of a project configuration. This model "extends" ProjectConfigDefinitionResponse

type ProjectConfigDefinitionResponseIntf added in v0.2.2 

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

type ProjectConfigDefinitionResponseResourceConfigDefinitionPropertiesResponse added in v0.2.2 

type ProjectConfigDefinitionResponseResourceConfigDefinitionPropertiesResponse struct {
	// The CRNs of the resources that are associated with this configuration.
	ResourceCrns []string `json:"resource_crns,omitempty"`

	// A project configuration description.
	Description *string `json:"description" validate:"required"`

	// The configuration name. It's unique within the account across projects and regions.
	Name *string `json:"name" validate:"required"`

	// The ID of the project environment.
	EnvironmentID *string `json:"environment_id,omitempty"`

	// The authorization details. You can authorize by using a trusted profile or an API key in Secrets Manager.
	Authorizations *ProjectConfigAuth `json:"authorizations,omitempty"`

	// The input variables that are used for configuration definition and environment.
	Inputs map[string]interface{} `json:"inputs,omitempty"`

	// The Schematics environment variables to use to deploy the configuration. Settings are only available if they are
	// specified when the configuration is initially created.
	Settings map[string]interface{} `json:"settings,omitempty"`
}

ProjectConfigDefinitionResponseResourceConfigDefinitionPropertiesResponse : The description of a project configuration. This model "extends" ProjectConfigDefinitionResponse

type ProjectConfigDelete 

type ProjectConfigDelete struct {
	// The ID of the deleted project or configuration.
	ID *string `json:"id" validate:"required"`
}

ProjectConfigDelete : The ID of the deleted configuration.

type ProjectConfigMetadataCodeRiskAnalyzerLogs added in v0.0.97 

type ProjectConfigMetadataCodeRiskAnalyzerLogs struct {
	// The version of the Code Risk Analyzer logs of the configuration. The metadata for this schema is specific to Code
	// Risk Analyzer version 2.0.4.
	CraVersion *string `json:"cra_version,omitempty"`

	// The schema version of Code Risk Analyzer logs of the configuration.
	SchemaVersion *string `json:"schema_version,omitempty"`

	// The status of the Code Risk Analyzer logs of the configuration.
	Status *string `json:"status,omitempty"`

	// The Code Risk Analyzer logs a summary of the configuration.
	Summary *CodeRiskAnalyzerLogsSummary `json:"summary,omitempty"`

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

ProjectConfigMetadataCodeRiskAnalyzerLogs : The Code Risk Analyzer logs of the configuration. This property is populated only after the validation step when the Code Risk Analyzer is run. Note: `cra` is the abbreviated form of Code Risk Analyzer. Models which "extend" this model: - ProjectConfigMetadataCodeRiskAnalyzerLogsVersion204

type ProjectConfigMetadataCodeRiskAnalyzerLogsIntf added in v0.1.8 

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

type ProjectConfigMetadataCodeRiskAnalyzerLogsVersion204 added in v0.1.8 

type ProjectConfigMetadataCodeRiskAnalyzerLogsVersion204 struct {
	// The version of the Code Risk Analyzer logs of the configuration. The metadata for this schema is specific to Code
	// Risk Analyzer version 2.0.4.
	CraVersion *string `json:"cra_version,omitempty"`

	// The schema version of Code Risk Analyzer logs of the configuration.
	SchemaVersion *string `json:"schema_version,omitempty"`

	// The status of the Code Risk Analyzer logs of the configuration.
	Status *string `json:"status,omitempty"`

	// The Code Risk Analyzer logs a summary of the configuration.
	Summary *CodeRiskAnalyzerLogsSummary `json:"summary,omitempty"`

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

ProjectConfigMetadataCodeRiskAnalyzerLogsVersion204 : The Code Risk Analyzer logs of the configuration based on Code Risk Analyzer version 2.0.4. This model "extends" ProjectConfigMetadataCodeRiskAnalyzerLogs

type ProjectConfigMetadataCostEstimate added in v0.0.14 

type ProjectConfigMetadataCostEstimate struct {
	// The version of the cost estimate of the configuration.
	Version *string `json:"version,omitempty"`

	// The currency of the cost estimate of the configuration.
	Currency *string `json:"currency,omitempty"`

	// The total hourly cost estimate of the configuration.
	TotalHourlyCost *string `json:"totalHourlyCost,omitempty"`

	// The total monthly cost estimate of the configuration.
	TotalMonthlyCost *string `json:"totalMonthlyCost,omitempty"`

	// The past total hourly cost estimate of the configuration.
	PastTotalHourlyCost *string `json:"pastTotalHourlyCost,omitempty"`

	// The past total monthly cost estimate of the configuration.
	PastTotalMonthlyCost *string `json:"pastTotalMonthlyCost,omitempty"`

	// The difference between the current and past total hourly cost estimates of the configuration.
	DiffTotalHourlyCost *string `json:"diffTotalHourlyCost,omitempty"`

	// The difference between the current and past total monthly cost estimates of the configuration.
	DiffTotalMonthlyCost *string `json:"diffTotalMonthlyCost,omitempty"`

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

	// The unique ID.
	UserID *string `json:"user_id,omitempty"`
}

ProjectConfigMetadataCostEstimate : The cost estimate of the configuration. This property exists only after the first configuration validation.

type ProjectConfigMetadataLastApproved added in v0.0.16 

type ProjectConfigMetadataLastApproved struct {
	// A date and time value in the format YYYY-MM-DDTHH:mm:ssZ or YYYY-MM-DDTHH:mm:ss.sssZ to match the date and time
	// format as specified by RFC 3339.
	At *strfmt.DateTime `json:"at" validate:"required"`

	// The comment that is left by the user who approved the configuration.
	Comment *string `json:"comment,omitempty"`

	// The flag that indicates whether the approval was forced approved.
	IsForced *bool `json:"is_forced" validate:"required"`

	// The unique ID.
	UserID *string `json:"user_id" validate:"required"`
}

ProjectConfigMetadataLastApproved : The last approved metadata of the configuration.

type ProjectConfigPrototype 

type ProjectConfigPrototype struct {
	Definition ProjectConfigDefinitionPrototypeIntf `json:"definition" validate:"required"`

	// A Schematics workspace to use for deploying this deployable architecture.
	// > If you are importing data from an existing Schematics workspace that is not backed by cart, then you must provide
	// a `locator_id`. If you are using a Schematics workspace that is backed by cart, a `locator_id` is not required
	// because the Schematics workspace has one.
	// >
	// There are 3 scenarios:
	// > 1. If only a `locator_id` is specified, a new Schematics workspace is instantiated with that `locator_id`.
	// > 2. If only a schematics `workspace_crn` is specified, a `400` is returned if a `locator_id` is not found in the
	// existing schematics workspace.
	// > 3. If both a Schematics `workspace_crn` and a `locator_id` are specified, a `400`code  is returned if the
	// specified `locator_id` does not agree with the `locator_id` in the existing Schematics workspace.
	// >
	// For more information, see [Creating workspaces and importing your Terraform
	// template](/docs/schematics?topic=schematics-sch-create-wks).
	Schematics *SchematicsWorkspace `json:"schematics,omitempty"`
}

ProjectConfigPrototype : The input of a project configuration.

type ProjectConfigResource added in v0.0.18 

type ProjectConfigResource struct {
	// An IBM Cloud resource name that uniquely identifies a resource.
	ResourceCrn *string `json:"resource_crn,omitempty"`

	// The name of the resource.
	ResourceName *string `json:"resource_name,omitempty"`

	// The resource type.
	ResourceType *string `json:"resource_type,omitempty"`

	// The flag that indicates whether the status of the resource is tainted.
	ResourceTainted *bool `json:"resource_tainted,omitempty"`

	// The resource group of the resource.
	ResourceGroupName *string `json:"resource_group_name,omitempty"`
}

ProjectConfigResource : ProjectConfigResource struct

type ProjectConfigResourceCollection added in v0.0.18 

type ProjectConfigResourceCollection struct {
	// The collection list operation response schema that defines the array property with the name `resources`.
	Resources []ProjectConfigResource `json:"resources" validate:"required"`

	// The total number of resources that are deployed by the configuration.
	ResourcesCount *int64 `json:"resources_count" validate:"required"`
}

ProjectConfigResourceCollection : The project configuration resource list.

type ProjectConfigSummary added in v0.1.0 

type ProjectConfigSummary struct {
	// A summary of a project configuration version.
	ApprovedVersion *ProjectConfigVersionSummary `json:"approved_version,omitempty"`

	// A summary of a project configuration version.
	DeployedVersion *ProjectConfigVersionSummary `json:"deployed_version,omitempty"`

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

	// The version of the configuration.
	Version *int64 `json:"version" validate:"required"`

	// The state of the configuration.
	State *string `json:"state" validate:"required"`

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

	// A date and time value in the format YYYY-MM-DDTHH:mm:ssZ or YYYY-MM-DDTHH:mm:ss.sssZ to match the date and time
	// format as specified by RFC 3339.
	ModifiedAt *strfmt.DateTime `json:"modified_at" validate:"required"`

	// A URL.
	Href *string `json:"href" validate:"required"`

	// The description of a project configuration.
	Definition *ProjectConfigSummaryDefinition `json:"definition" validate:"required"`

	// The project that is referenced by this resource.
	Project *ProjectReference `json:"project" validate:"required"`

	// The configuration type.
	DeploymentModel *string `json:"deployment_model,omitempty"`
}

ProjectConfigSummary : ProjectConfigSummary struct

type ProjectConfigSummaryDefinition added in v0.1.8 

type ProjectConfigSummaryDefinition struct {
	// A project configuration description.
	Description *string `json:"description" validate:"required"`

	// The configuration name. It's unique within the account across projects and regions.
	Name *string `json:"name" validate:"required"`

	// A unique concatenation of the catalog ID and the version ID that identify the deployable architecture in the
	// catalog. I you're importing from an existing Schematics workspace that is not backed by cart, a `locator_id` is
	// required. If you're using a Schematics workspace that is backed by cart, a `locator_id` is not necessary because the
	// Schematics workspace has one.
	// > There are 3 scenarios:
	// > 1. If only a `locator_id` is specified, a new Schematics workspace is instantiated with that `locator_id`.
	// > 2. If only a schematics `workspace_crn` is specified, a `400` is returned if a `locator_id` is not found in the
	// existing schematics workspace.
	// > 3. If both a Schematics `workspace_crn` and a `locator_id` are specified, a `400` message is returned if the
	// specified `locator_id` does not agree with the `locator_id` in the existing Schematics workspace.
	// > For more information of creating a Schematics workspace, see [Creating workspaces and importing your Terraform
	// template](/docs/schematics?topic=schematics-sch-create-wks).
	LocatorID *string `json:"locator_id,omitempty"`
}

ProjectConfigSummaryDefinition : The description of a project configuration.

type ProjectConfigVersion added in v0.0.92 

type ProjectConfigVersion struct {
	// The ID of the configuration. If this parameter is empty, an ID is automatically created for the configuration.
	ID *string `json:"id" validate:"required"`

	// The version of the configuration.
	Version *int64 `json:"version" validate:"required"`

	// The flag that indicates whether the version of the configuration is draft, or active.
	IsDraft *bool `json:"is_draft" validate:"required"`

	// The needs attention state of a configuration.
	NeedsAttentionState []map[string]interface{} `json:"needs_attention_state" validate:"required"`

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

	// A date and time value in the format YYYY-MM-DDTHH:mm:ssZ or YYYY-MM-DDTHH:mm:ss.sssZ to match the date and time
	// format as specified by RFC 3339.
	ModifiedAt *strfmt.DateTime `json:"modified_at" validate:"required"`

	// The last approved metadata of the configuration.
	LastApproved *ProjectConfigMetadataLastApproved `json:"last_approved,omitempty"`

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

	// The href and results from the last action job that is performed on the project configuration.
	LastValidated *LastValidatedActionWithSummary `json:"last_validated,omitempty"`

	// The href and results from the last action job that is performed on the project configuration.
	LastDeployed *LastActionWithSummary `json:"last_deployed,omitempty"`

	// The href and results from the last action job that is performed on the project configuration.
	LastUndeployed *LastActionWithSummary `json:"last_undeployed,omitempty"`

	// The summary from the last monitoring action job that is performed on the project configuration.
	LastMonitoring *LastMonitoringActionWithSummary `json:"last_monitoring,omitempty"`

	// The outputs of a Schematics template property.
	Outputs []OutputValue `json:"outputs" validate:"required"`

	// The project that is referenced by this resource.
	Project *ProjectReference `json:"project" validate:"required"`

	// The references that are used in the configuration to resolve input values.
	References map[string]interface{} `json:"references,omitempty"`

	// A Schematics workspace that is associated to a project configuration, with scripts.
	Schematics *SchematicsMetadata `json:"schematics,omitempty"`

	// The state of the configuration.
	State *string `json:"state" validate:"required"`

	// The flag that indicates whether a configuration update is available.
	UpdateAvailable *bool `json:"update_available,omitempty"`

	// A URL.
	Href *string `json:"href" validate:"required"`

	Definition ProjectConfigDefinitionResponseIntf `json:"definition" validate:"required"`
}

ProjectConfigVersion : A specific version of a project configuration.

type ProjectConfigVersionDefinitionSummary added in v0.2.2 

type ProjectConfigVersionDefinitionSummary struct {
	// The ID of the project environment.
	EnvironmentID *string `json:"environment_id,omitempty"`

	// A unique concatenation of the catalog ID and the version ID that identify the deployable architecture in the
	// catalog. I you're importing from an existing Schematics workspace that is not backed by cart, a `locator_id` is
	// required. If you're using a Schematics workspace that is backed by cart, a `locator_id` is not necessary because the
	// Schematics workspace has one.
	// > There are 3 scenarios:
	// > 1. If only a `locator_id` is specified, a new Schematics workspace is instantiated with that `locator_id`.
	// > 2. If only a schematics `workspace_crn` is specified, a `400` is returned if a `locator_id` is not found in the
	// existing schematics workspace.
	// > 3. If both a Schematics `workspace_crn` and a `locator_id` are specified, a `400` message is returned if the
	// specified `locator_id` does not agree with the `locator_id` in the existing Schematics workspace.
	// > For more information of creating a Schematics workspace, see [Creating workspaces and importing your Terraform
	// template](/docs/schematics?topic=schematics-sch-create-wks).
	LocatorID *string `json:"locator_id,omitempty"`
}

ProjectConfigVersionDefinitionSummary : A summary of the definition in a project configuration version.

type ProjectConfigVersionSummary added in v0.0.27 

type ProjectConfigVersionSummary struct {
	// A summary of the definition in a project configuration version.
	Definition *ProjectConfigVersionDefinitionSummary `json:"definition" validate:"required"`

	// The state of the configuration.
	State *string `json:"state" validate:"required"`

	// The version number of the configuration.
	Version *int64 `json:"version" validate:"required"`

	// A URL.
	Href *string `json:"href" validate:"required"`
}

ProjectConfigVersionSummary : A summary of a project configuration version.

type ProjectConfigVersionSummaryCollection added in v0.0.27 

type ProjectConfigVersionSummaryCollection struct {
	// The collection list operation response schema that defines the array property with the name `versions`.
	Versions []ProjectConfigVersionSummary `json:"versions" validate:"required"`
}

ProjectConfigVersionSummaryCollection : The project configuration version list.

type ProjectDefinitionProperties added in v0.0.27 

type ProjectDefinitionProperties struct {
	// The name of the project.  It's unique within the account across regions.
	Name *string `json:"name" validate:"required"`

	// The policy that indicates whether the resources are destroyed or not when a project is deleted.
	DestroyOnDelete *bool `json:"destroy_on_delete" validate:"required"`

	// A brief explanation of the project's use in the configuration of a deployable architecture. You can create a project
	// without providing a description.
	Description *string `json:"description" validate:"required"`

	// A boolean flag to enable project monitoring.
	MonitoringEnabled *bool `json:"monitoring_enabled,omitempty"`
}

ProjectDefinitionProperties : The definition of the project.

type ProjectDefinitionReference added in v0.0.96 

type ProjectDefinitionReference struct {
	// The name of the project.
	Name *string `json:"name" validate:"required"`
}

ProjectDefinitionReference : The definition of the project reference.

type ProjectDeleteResponse added in v0.2.1 

type ProjectDeleteResponse struct {
	// The ID of the deleted project or configuration.
	ID *string `json:"id" validate:"required"`
}

ProjectDeleteResponse : The ID of the deleted project.

type ProjectEnvironmentSummary added in v0.1.0 

type ProjectEnvironmentSummary struct {
	// The environment ID as a friendly name.
	ID *string `json:"id" validate:"required"`

	// The project that is referenced by this resource.
	Project *ProjectReference `json:"project" validate:"required"`

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

	// A URL.
	Href *string `json:"href" validate:"required"`

	// The environment definition that is used in the project collection.
	Definition *ProjectEnvironmentSummaryDefinition `json:"definition" validate:"required"`
}

ProjectEnvironmentSummary : The environment metadata.

type ProjectEnvironmentSummaryDefinition added in v0.1.8 

type ProjectEnvironmentSummaryDefinition struct {
	// The description of the environment.
	Description *string `json:"description" validate:"required"`

	// The name of the environment. It's unique within the account across projects and regions.
	Name *string `json:"name" validate:"required"`
}

ProjectEnvironmentSummaryDefinition : The environment definition that is used in the project collection.

type ProjectEnvironmentsPager added in v0.2.1 

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

ProjectEnvironmentsPager can be used to simplify the use of the "ListProjectEnvironments" method.

func (*ProjectEnvironmentsPager) GetAll added in v0.2.1 

func (pager *ProjectEnvironmentsPager) GetAll() (allItems []Environment, err error)

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

func (*ProjectEnvironmentsPager) GetAllWithContext added in v0.2.1 

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

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

func (*ProjectEnvironmentsPager) GetNext added in v0.2.1 

func (pager *ProjectEnvironmentsPager) GetNext() (page []Environment, err error)

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

func (*ProjectEnvironmentsPager) GetNextWithContext added in v0.2.1 

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

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

func (*ProjectEnvironmentsPager) HasNext added in v0.2.1 

func (pager *ProjectEnvironmentsPager) HasNext() bool

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

type ProjectPatchDefinitionBlock added in v0.1.0 

type ProjectPatchDefinitionBlock struct {
	// The name of the project.  It's unique within the account across regions.
	Name *string `json:"name,omitempty"`

	// The policy that indicates whether the resources are destroyed or not when a project is deleted.
	DestroyOnDelete *bool `json:"destroy_on_delete,omitempty"`

	// A brief explanation of the project's use in the configuration of a deployable architecture. You can create a project
	// without providing a description.
	Description *string `json:"description,omitempty"`

	// A boolean flag to enable project monitoring.
	MonitoringEnabled *bool `json:"monitoring_enabled,omitempty"`
}

ProjectPatchDefinitionBlock : The definition of the project.

type ProjectPrototypeDefinition added in v0.0.27 

type ProjectPrototypeDefinition struct {
	// The name of the project.  It's unique within the account across regions.
	Name *string `json:"name" validate:"required"`

	// The policy that indicates whether the resources are undeployed or not when a project is deleted.
	DestroyOnDelete *bool `json:"destroy_on_delete,omitempty"`

	// A brief explanation of the project's use in the configuration of a deployable architecture. You can create a project
	// without providing a description.
	Description *string `json:"description,omitempty"`

	// A boolean flag to enable project monitoring.
	MonitoringEnabled *bool `json:"monitoring_enabled,omitempty"`
}

ProjectPrototypeDefinition : The definition of the project.

type ProjectReference added in v0.0.96 

type ProjectReference struct {
	// The unique ID.
	ID *string `json:"id" validate:"required"`

	// A URL.
	Href *string `json:"href" validate:"required"`

	// The definition of the project reference.
	Definition *ProjectDefinitionReference `json:"definition" validate:"required"`

	// An IBM Cloud resource name that uniquely identifies a resource.
	Crn *string `json:"crn" validate:"required"`
}

ProjectReference : The project that is referenced by this resource.

type ProjectResourceCollection added in v0.2.2 

type ProjectResourceCollection struct {
	// The collection list operation response schema that defines the array property with the name `resources`.
	Resources []ProjectResourceSummary `json:"resources" validate:"required"`

	// A pagination token.
	Token *string `json:"token,omitempty"`

	// A pagination link.
	First *PaginationLink `json:"first,omitempty"`

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

ProjectResourceCollection : The project resource list.

func (*ProjectResourceCollection) GetNextStart added in v0.2.2 

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

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

type ProjectResourceSummary added in v0.2.2 

type ProjectResourceSummary struct {
	// An IBM Cloud resource name that uniquely identifies a resource.
	ResourceCrn *string `json:"resource_crn,omitempty"`

	// The name of the resource.
	ResourceName *string `json:"resource_name,omitempty"`

	// The ID of the account owning of the resource.
	AccountID *string `json:"account_id,omitempty"`

	// The location of the resource.
	Location *string `json:"location,omitempty"`

	// The resource type.
	ResourceType *string `json:"resource_type,omitempty"`

	// The status of the resource.
	ResourceStatus *string `json:"resource_status,omitempty"`

	// The ID of the resource's resource group.
	ResourceGroupID *string `json:"resource_group_id,omitempty"`

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

	// The collection of service tags.
	ServiceTags []string `json:"service_tags,omitempty"`
}

ProjectResourceSummary : ProjectResourceSummary struct

type ProjectResourcesPager added in v0.2.2 

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

ProjectResourcesPager can be used to simplify the use of the "ListProjectResources" method.

func (*ProjectResourcesPager) GetAll added in v0.2.2 

func (pager *ProjectResourcesPager) GetAll() (allItems []ProjectResourceSummary, err error)

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

func (*ProjectResourcesPager) GetAllWithContext added in v0.2.2 

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

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

func (*ProjectResourcesPager) GetNext added in v0.2.2 

func (pager *ProjectResourcesPager) GetNext() (page []ProjectResourceSummary, err error)

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

func (*ProjectResourcesPager) GetNextWithContext added in v0.2.2 

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

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

func (*ProjectResourcesPager) HasNext added in v0.2.2 

func (pager *ProjectResourcesPager) HasNext() bool

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

type ProjectSummary added in v0.0.16 

type ProjectSummary struct {
	// An IBM Cloud resource name that uniquely identifies a resource.
	Crn *string `json:"crn" validate:"required"`

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

	// The cumulative list of needs attention items for a project. If the view is successfully retrieved, an empty or
	// nonempty array is returned.
	CumulativeNeedsAttentionView []CumulativeNeedsAttention `json:"cumulative_needs_attention_view" validate:"required"`

	// A value of `true` indicates that the fetch of the needs attention items failed. This property only exists if there
	// was an error when you retrieved the cumulative needs attention view.
	CumulativeNeedsAttentionViewError *bool `json:"cumulative_needs_attention_view_error,omitempty"`

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

	// The IBM Cloud location where a resource is deployed.
	Location *string `json:"location" validate:"required"`

	// The resource group ID where the project's data and tools are created.
	ResourceGroupID *string `json:"resource_group_id" validate:"required"`

	// The project status value.
	State *string `json:"state" validate:"required"`

	// A URL.
	Href *string `json:"href" validate:"required"`

	// The definition of the project.
	Definition *ProjectDefinitionProperties `json:"definition" validate:"required"`
}

ProjectSummary : ProjectSummary struct

type ProjectV1 

type ProjectV1 struct {
	Service *core.BaseService
}

ProjectV1 : 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 *ProjectConfigVersion, 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 *ProjectConfigVersion, response *core.DetailedResponse, err error)

ApproveWithContext is an alternate form of the Approve 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. For more information, see [Creating a project](/docs/secure-enterprise?topic=secure-enterprise-setup-project&interface=ui/docs-draft/secure-enterprise?topic=secure-enterprise-setup-project).

func (*ProjectV1) CreateProjectEnvironment added in v0.0.90 

func (project *ProjectV1) CreateProjectEnvironment(createProjectEnvironmentOptions *CreateProjectEnvironmentOptions) (result *Environment, response *core.DetailedResponse, err error)

CreateProjectEnvironment : Create an environment Create an environment to group related configurations together and share values across them for easier deployment. For more information, see [Creating an environment](/docs/secure-enterprise?topic=secure-enterprise-create-env).

func (*ProjectV1) CreateProjectEnvironmentWithContext added in v0.0.90 

func (project *ProjectV1) CreateProjectEnvironmentWithContext(ctx context.Context, createProjectEnvironmentOptions *CreateProjectEnvironmentOptions) (result *Environment, response *core.DetailedResponse, err error)

CreateProjectEnvironmentWithContext is an alternate form of the CreateProjectEnvironment method which supports a Context parameter

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 Delete a configuration in a project by specifying its ID.

func (*ProjectV1) DeleteConfigVersion added in v0.0.27 

func (project *ProjectV1) DeleteConfigVersion(deleteConfigVersionOptions *DeleteConfigVersionOptions) (result *ProjectConfigDelete, response *core.DetailedResponse, err error)

DeleteConfigVersion : Delete a project configuration version Delete a configuration version by specifying the project ID.

func (*ProjectV1) DeleteConfigVersionWithContext added in v0.0.27 

func (project *ProjectV1) DeleteConfigVersionWithContext(ctx context.Context, deleteConfigVersionOptions *DeleteConfigVersionOptions) (result *ProjectConfigDelete, response *core.DetailedResponse, err error)

DeleteConfigVersionWithContext is an alternate form of the DeleteConfigVersion method which supports a Context parameter

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

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

DeleteProject : Delete a project Delete a project document by specifying the ID. A project can be deleted only after you delete all of its resources.

func (*ProjectV1) DeleteProjectEnvironment added in v0.0.90 

func (project *ProjectV1) DeleteProjectEnvironment(deleteProjectEnvironmentOptions *DeleteProjectEnvironmentOptions) (result *EnvironmentDeleteResponse, response *core.DetailedResponse, err error)

DeleteProjectEnvironment : Delete an environment Delete an environment in a project by specifying its ID.

func (*ProjectV1) DeleteProjectEnvironmentWithContext added in v0.0.90 

func (project *ProjectV1) DeleteProjectEnvironmentWithContext(ctx context.Context, deleteProjectEnvironmentOptions *DeleteProjectEnvironmentOptions) (result *EnvironmentDeleteResponse, response *core.DetailedResponse, err error)

DeleteProjectEnvironmentWithContext is an alternate form of the DeleteProjectEnvironment method which supports a Context parameter

func (*ProjectV1) DeleteProjectWithContext 

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

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

func (*ProjectV1) DeployConfig added in v0.0.27 

func (project *ProjectV1) DeployConfig(deployConfigOptions *DeployConfigOptions) (result *ProjectConfigVersion, response *core.DetailedResponse, err error)

DeployConfig : Deploy a configuration Deploy a project's configuration. This operation is asynchronous and can be tracked by using the get project configuration API with full metadata.

func (*ProjectV1) DeployConfigWithContext added in v0.0.27 

func (project *ProjectV1) DeployConfigWithContext(ctx context.Context, deployConfigOptions *DeployConfigOptions) (result *ProjectConfigVersion, response *core.DetailedResponse, err error)

DeployConfigWithContext is an alternate form of the DeployConfig 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 *ProjectConfigVersion, response *core.DetailedResponse, err error)

ForceApprove : Force approve a 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 *ProjectConfigVersion, 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 Retrieve the specified project configuration in a specific project. For more information about project configurations, see [Monitoring the status of a configuration and its resources](/docs/secure-enterprise?topic=secure-enterprise-monitor-status-projects).

func (*ProjectV1) GetConfigVersion added in v0.0.27 

func (project *ProjectV1) GetConfigVersion(getConfigVersionOptions *GetConfigVersionOptions) (result *ProjectConfigVersion, response *core.DetailedResponse, err error)

GetConfigVersion : Get a specific project configuration version Retrieve a specific version of a configuration in a project.

func (*ProjectV1) GetConfigVersionWithContext added in v0.0.27 

func (project *ProjectV1) GetConfigVersionWithContext(ctx context.Context, getConfigVersionOptions *GetConfigVersionOptions) (result *ProjectConfigVersion, response *core.DetailedResponse, err error)

GetConfigVersionWithContext is an alternate form of the GetConfigVersion 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) GetEnableGzipCompression 

func (project *ProjectV1) GetEnableGzipCompression() bool

GetEnableGzipCompression returns the service's EnableGzipCompression field

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) GetProjectEnvironment added in v0.0.90 

func (project *ProjectV1) GetProjectEnvironment(getProjectEnvironmentOptions *GetProjectEnvironmentOptions) (result *Environment, response *core.DetailedResponse, err error)

GetProjectEnvironment : Get an environment Get an environment. [Learn more](/docs/secure-enterprise?topic=secure-enterprise-create-env).

func (*ProjectV1) GetProjectEnvironmentWithContext added in v0.0.90 

func (project *ProjectV1) GetProjectEnvironmentWithContext(ctx context.Context, getProjectEnvironmentOptions *GetProjectEnvironmentOptions) (result *Environment, response *core.DetailedResponse, err error)

GetProjectEnvironmentWithContext is an alternate form of the GetProjectEnvironment method which supports a Context parameter

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

func (project *ProjectV1) GetServiceURL() string

GetServiceURL returns the service URL

func (*ProjectV1) ListConfigResources added in v0.0.18 

func (project *ProjectV1) ListConfigResources(listConfigResourcesOptions *ListConfigResourcesOptions) (result *ProjectConfigResourceCollection, response *core.DetailedResponse, err error)

ListConfigResources : List all deployed resources List resources that are deployed by a configuration.

func (*ProjectV1) ListConfigResourcesWithContext added in v0.0.18 

func (project *ProjectV1) ListConfigResourcesWithContext(ctx context.Context, listConfigResourcesOptions *ListConfigResourcesOptions) (result *ProjectConfigResourceCollection, response *core.DetailedResponse, err error)

ListConfigResourcesWithContext is an alternate form of the ListConfigResources method which supports a Context parameter

func (*ProjectV1) ListConfigVersions added in v0.0.27 

func (project *ProjectV1) ListConfigVersions(listConfigVersionsOptions *ListConfigVersionsOptions) (result *ProjectConfigVersionSummaryCollection, response *core.DetailedResponse, err error)

ListConfigVersions : Get a list of project configuration versions Retrieve a list of previous and current versions of a project configuration in a specific project.

func (*ProjectV1) ListConfigVersionsWithContext added in v0.0.27 

func (project *ProjectV1) ListConfigVersionsWithContext(ctx context.Context, listConfigVersionsOptions *ListConfigVersionsOptions) (result *ProjectConfigVersionSummaryCollection, response *core.DetailedResponse, err error)

ListConfigVersionsWithContext is an alternate form of the ListConfigVersions 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 Retrieve the collection of configurations.

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) ListProjectEnvironments added in v0.0.90 

func (project *ProjectV1) ListProjectEnvironments(listProjectEnvironmentsOptions *ListProjectEnvironmentsOptions) (result *EnvironmentCollection, response *core.DetailedResponse, err error)

ListProjectEnvironments : List environments List all available environments. For more information, see [Creating an environment](/docs/secure-enterprise?topic=secure-enterprise-create-env).

func (*ProjectV1) ListProjectEnvironmentsWithContext added in v0.0.90 

func (project *ProjectV1) ListProjectEnvironmentsWithContext(ctx context.Context, listProjectEnvironmentsOptions *ListProjectEnvironmentsOptions) (result *EnvironmentCollection, response *core.DetailedResponse, err error)

ListProjectEnvironmentsWithContext is an alternate form of the ListProjectEnvironments method which supports a Context parameter

func (*ProjectV1) ListProjectResources added in v0.2.2 

func (project *ProjectV1) ListProjectResources(listProjectResourcesOptions *ListProjectResourcesOptions) (result *ProjectResourceCollection, response *core.DetailedResponse, err error)

ListProjectResources : List all project resources List resources that are added to a project.

func (*ProjectV1) ListProjectResourcesWithContext added in v0.2.2 

func (project *ProjectV1) ListProjectResourcesWithContext(ctx context.Context, listProjectResourcesOptions *ListProjectResourcesOptions) (result *ProjectResourceCollection, response *core.DetailedResponse, err error)

ListProjectResourcesWithContext is an alternate form of the ListProjectResources 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) NewConfigsPager added in v0.2.2 

func (project *ProjectV1) NewConfigsPager(options *ListConfigsOptions) (pager *ConfigsPager, err error)

NewConfigsPager returns a new ConfigsPager instance.

func (*ProjectV1) NewCreateConfigOptions 

func (*ProjectV1) NewCreateConfigOptions(projectID string, definition ProjectConfigDefinitionPrototypeIntf) *CreateConfigOptions

NewCreateConfigOptions : Instantiate CreateConfigOptions

func (*ProjectV1) NewCreateProjectEnvironmentOptions added in v0.0.90 

func (*ProjectV1) NewCreateProjectEnvironmentOptions(projectID string, definition *EnvironmentDefinitionRequiredProperties) *CreateProjectEnvironmentOptions

NewCreateProjectEnvironmentOptions : Instantiate CreateProjectEnvironmentOptions

func (*ProjectV1) NewCreateProjectOptions 

func (*ProjectV1) NewCreateProjectOptions(definition *ProjectPrototypeDefinition, location string, resourceGroup string) *CreateProjectOptions

NewCreateProjectOptions : Instantiate CreateProjectOptions

func (*ProjectV1) NewDeleteConfigOptions 

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

NewDeleteConfigOptions : Instantiate DeleteConfigOptions

func (*ProjectV1) NewDeleteConfigVersionOptions added in v0.0.27 

func (*ProjectV1) NewDeleteConfigVersionOptions(projectID string, id string, version int64) *DeleteConfigVersionOptions

NewDeleteConfigVersionOptions : Instantiate DeleteConfigVersionOptions

func (*ProjectV1) NewDeleteProjectEnvironmentOptions added in v0.0.90 

func (*ProjectV1) NewDeleteProjectEnvironmentOptions(projectID string, id string) *DeleteProjectEnvironmentOptions

NewDeleteProjectEnvironmentOptions : Instantiate DeleteProjectEnvironmentOptions

func (*ProjectV1) NewDeleteProjectOptions 

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

NewDeleteProjectOptions : Instantiate DeleteProjectOptions

func (*ProjectV1) NewDeployConfigOptions added in v0.0.27 

func (*ProjectV1) NewDeployConfigOptions(projectID string, id string) *DeployConfigOptions

NewDeployConfigOptions : Instantiate DeployConfigOptions

func (*ProjectV1) NewEnvironmentDefinitionRequiredProperties added in v0.0.90 

func (*ProjectV1) NewEnvironmentDefinitionRequiredProperties(name string) (_model *EnvironmentDefinitionRequiredProperties, err error)

NewEnvironmentDefinitionRequiredProperties : Instantiate EnvironmentDefinitionRequiredProperties (Generic Model Constructor)

func (*ProjectV1) NewEnvironmentPrototype added in v0.1.5 

func (*ProjectV1) NewEnvironmentPrototype(definition *EnvironmentDefinitionRequiredProperties) (_model *EnvironmentPrototype, err error)

NewEnvironmentPrototype : Instantiate EnvironmentPrototype (Generic Model Constructor)

func (*ProjectV1) NewForceApproveOptions 

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

NewForceApproveOptions : Instantiate ForceApproveOptions

func (*ProjectV1) NewGetConfigOptions 

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

NewGetConfigOptions : Instantiate GetConfigOptions

func (*ProjectV1) NewGetConfigVersionOptions added in v0.0.27 

func (*ProjectV1) NewGetConfigVersionOptions(projectID string, id string, version int64) *GetConfigVersionOptions

NewGetConfigVersionOptions : Instantiate GetConfigVersionOptions

func (*ProjectV1) NewGetProjectEnvironmentOptions added in v0.0.90 

func (*ProjectV1) NewGetProjectEnvironmentOptions(projectID string, id string) *GetProjectEnvironmentOptions

NewGetProjectEnvironmentOptions : Instantiate GetProjectEnvironmentOptions

func (*ProjectV1) NewGetProjectOptions 

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

NewGetProjectOptions : Instantiate GetProjectOptions

func (*ProjectV1) NewListConfigResourcesOptions added in v0.0.18 

func (*ProjectV1) NewListConfigResourcesOptions(projectID string, id string) *ListConfigResourcesOptions

NewListConfigResourcesOptions : Instantiate ListConfigResourcesOptions

func (*ProjectV1) NewListConfigVersionsOptions added in v0.0.27 

func (*ProjectV1) NewListConfigVersionsOptions(projectID string, id string) *ListConfigVersionsOptions

NewListConfigVersionsOptions : Instantiate ListConfigVersionsOptions

func (*ProjectV1) NewListConfigsOptions 

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

NewListConfigsOptions : Instantiate ListConfigsOptions

func (*ProjectV1) NewListProjectEnvironmentsOptions added in v0.0.90 

func (*ProjectV1) NewListProjectEnvironmentsOptions(projectID string) *ListProjectEnvironmentsOptions

NewListProjectEnvironmentsOptions : Instantiate ListProjectEnvironmentsOptions

func (*ProjectV1) NewListProjectResourcesOptions added in v0.2.2 

func (*ProjectV1) NewListProjectResourcesOptions(id string) *ListProjectResourcesOptions

NewListProjectResourcesOptions : Instantiate ListProjectResourcesOptions

func (*ProjectV1) NewListProjectsOptions 

func (*ProjectV1) NewListProjectsOptions() *ListProjectsOptions

NewListProjectsOptions : Instantiate ListProjectsOptions

func (*ProjectV1) NewProjectConfigDefinitionPrototypeDAConfigDefinitionPropertiesPrototype added in v0.2.2 

func (*ProjectV1) NewProjectConfigDefinitionPrototypeDAConfigDefinitionPropertiesPrototype(name string) (_model *ProjectConfigDefinitionPrototypeDAConfigDefinitionPropertiesPrototype, err error)

NewProjectConfigDefinitionPrototypeDAConfigDefinitionPropertiesPrototype : Instantiate ProjectConfigDefinitionPrototypeDAConfigDefinitionPropertiesPrototype (Generic Model Constructor)

func (*ProjectV1) NewProjectConfigDefinitionPrototypeResourceConfigDefinitionPropertiesPrototype added in v0.2.2 

func (*ProjectV1) NewProjectConfigDefinitionPrototypeResourceConfigDefinitionPropertiesPrototype(name string) (_model *ProjectConfigDefinitionPrototypeResourceConfigDefinitionPropertiesPrototype, err error)

NewProjectConfigDefinitionPrototypeResourceConfigDefinitionPropertiesPrototype : Instantiate ProjectConfigDefinitionPrototypeResourceConfigDefinitionPropertiesPrototype (Generic Model Constructor)

func (*ProjectV1) NewProjectConfigPrototype 

func (*ProjectV1) NewProjectConfigPrototype(definition ProjectConfigDefinitionPrototypeIntf) (_model *ProjectConfigPrototype, err error)

NewProjectConfigPrototype : Instantiate ProjectConfigPrototype (Generic Model Constructor)

func (*ProjectV1) NewProjectEnvironmentsPager added in v0.2.1 

func (project *ProjectV1) NewProjectEnvironmentsPager(options *ListProjectEnvironmentsOptions) (pager *ProjectEnvironmentsPager, err error)

NewProjectEnvironmentsPager returns a new ProjectEnvironmentsPager instance.

func (*ProjectV1) NewProjectPrototypeDefinition added in v0.0.27 

func (*ProjectV1) NewProjectPrototypeDefinition(name string) (_model *ProjectPrototypeDefinition, err error)

NewProjectPrototypeDefinition : Instantiate ProjectPrototypeDefinition (Generic Model Constructor)

func (*ProjectV1) NewProjectResourcesPager added in v0.2.2 

func (project *ProjectV1) NewProjectResourcesPager(options *ListProjectResourcesOptions) (pager *ProjectResourcesPager, err error)

NewProjectResourcesPager returns a new ProjectResourcesPager instance.

func (*ProjectV1) NewProjectsPager 

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

NewProjectsPager returns a new ProjectsPager instance.

func (*ProjectV1) NewSyncConfigOptions added in v0.0.27 

func (*ProjectV1) NewSyncConfigOptions(projectID string, id string) *SyncConfigOptions

NewSyncConfigOptions : Instantiate SyncConfigOptions

func (*ProjectV1) NewUndeployConfigOptions added in v0.0.27 

func (*ProjectV1) NewUndeployConfigOptions(projectID string, id string) *UndeployConfigOptions

NewUndeployConfigOptions : Instantiate UndeployConfigOptions

func (*ProjectV1) NewUpdateConfigOptions 

func (*ProjectV1) NewUpdateConfigOptions(projectID string, id string, definition ProjectConfigDefinitionPatchIntf) *UpdateConfigOptions

NewUpdateConfigOptions : Instantiate UpdateConfigOptions

func (*ProjectV1) NewUpdateProjectEnvironmentOptions added in v0.0.90 

func (*ProjectV1) NewUpdateProjectEnvironmentOptions(projectID string, id string, definition *EnvironmentDefinitionPropertiesPatch) *UpdateProjectEnvironmentOptions

NewUpdateProjectEnvironmentOptions : Instantiate UpdateProjectEnvironmentOptions

func (*ProjectV1) NewUpdateProjectOptions 

func (*ProjectV1) NewUpdateProjectOptions(id string, definition *ProjectPatchDefinitionBlock) *UpdateProjectOptions

NewUpdateProjectOptions : Instantiate UpdateProjectOptions

func (*ProjectV1) NewValidateConfigOptions added in v0.0.27 

func (*ProjectV1) NewValidateConfigOptions(projectID string, id string) *ValidateConfigOptions

NewValidateConfigOptions : Instantiate ValidateConfigOptions

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) SyncConfig added in v0.0.27 

func (project *ProjectV1) SyncConfig(syncConfigOptions *SyncConfigOptions) (response *core.DetailedResponse, err error)

SyncConfig : Sync a project configuration Sync a project configuration by analyzing the associated pipeline runs and Schematics workspace logs to get the configuration back to a working state.

func (*ProjectV1) SyncConfigWithContext added in v0.0.27 

func (project *ProjectV1) SyncConfigWithContext(ctx context.Context, syncConfigOptions *SyncConfigOptions) (response *core.DetailedResponse, err error)

SyncConfigWithContext is an alternate form of the SyncConfig method which supports a Context parameter

func (*ProjectV1) UndeployConfig added in v0.0.27 

func (project *ProjectV1) UndeployConfig(undeployConfigOptions *UndeployConfigOptions) (result *ProjectConfigVersion, response *core.DetailedResponse, err error)

UndeployConfig : Undeploy configuration resources Undeploy a project's configuration resources. The operation undeploys 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) UndeployConfigWithContext added in v0.0.27 

func (project *ProjectV1) UndeployConfigWithContext(ctx context.Context, undeployConfigOptions *UndeployConfigOptions) (result *ProjectConfigVersion, response *core.DetailedResponse, err error)

UndeployConfigWithContext is an alternate form of the UndeployConfig 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 specifying the ID. [Learn more](/docs/secure-enterprise?topic=secure-enterprise-config-project).

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 specifying its ID.

func (*ProjectV1) UpdateProjectEnvironment added in v0.0.90 

func (project *ProjectV1) UpdateProjectEnvironment(updateProjectEnvironmentOptions *UpdateProjectEnvironmentOptions) (result *Environment, response *core.DetailedResponse, err error)

UpdateProjectEnvironment : Update an environment Update an environment by specifying its ID. [Learn more](/docs/secure-enterprise?topic=secure-enterprise-create-env).

func (*ProjectV1) UpdateProjectEnvironmentWithContext added in v0.0.90 

func (project *ProjectV1) UpdateProjectEnvironmentWithContext(ctx context.Context, updateProjectEnvironmentOptions *UpdateProjectEnvironmentOptions) (result *Environment, response *core.DetailedResponse, err error)

UpdateProjectEnvironmentWithContext is an alternate form of the UpdateProjectEnvironment method which supports a Context parameter

func (*ProjectV1) UpdateProjectWithContext 

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

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

func (*ProjectV1) ValidateConfig added in v0.0.27 

func (project *ProjectV1) ValidateConfig(validateConfigOptions *ValidateConfigOptions) (result *ProjectConfigVersion, response *core.DetailedResponse, err error)

ValidateConfig : Run a validation check Run a validation check on a specific configuration in the project. The check includes creating or updating the associated Schematics workspace with a plan job, running the CRA scans, and cost estimation.

func (*ProjectV1) ValidateConfigWithContext added in v0.0.27 

func (project *ProjectV1) ValidateConfigWithContext(ctx context.Context, validateConfigOptions *ValidateConfigOptions) (result *ProjectConfigVersion, response *core.DetailedResponse, err error)

ValidateConfigWithContext is an alternate form of the ValidateConfig 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 []ProjectSummary, err error)

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

func (*ProjectsPager) GetAllWithContext 

func (pager *ProjectsPager) GetAllWithContext(ctx context.Context) (allItems []ProjectSummary, 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 []ProjectSummary, err error)

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

func (*ProjectsPager) GetNextWithContext 

func (pager *ProjectsPager) GetNextWithContext(ctx context.Context) (page []ProjectSummary, 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 SchematicsMetadata added in v0.1.0 

type SchematicsMetadata struct {
	// An IBM Cloud resource name that uniquely identifies a resource.
	WorkspaceCrn *string `json:"workspace_crn,omitempty"`

	// A script to be run as part of a project configuration for a specific stage (pre or post) and action (validate,
	// deploy, or undeploy).
	ValidatePreScript *Script `json:"validate_pre_script,omitempty"`

	// A script to be run as part of a project configuration for a specific stage (pre or post) and action (validate,
	// deploy, or undeploy).
	ValidatePostScript *Script `json:"validate_post_script,omitempty"`

	// A script to be run as part of a project configuration for a specific stage (pre or post) and action (validate,
	// deploy, or undeploy).
	DeployPreScript *Script `json:"deploy_pre_script,omitempty"`

	// A script to be run as part of a project configuration for a specific stage (pre or post) and action (validate,
	// deploy, or undeploy).
	DeployPostScript *Script `json:"deploy_post_script,omitempty"`

	// A script to be run as part of a project configuration for a specific stage (pre or post) and action (validate,
	// deploy, or undeploy).
	UndeployPreScript *Script `json:"undeploy_pre_script,omitempty"`

	// A script to be run as part of a project configuration for a specific stage (pre or post) and action (validate,
	// deploy, or undeploy).
	UndeployPostScript *Script `json:"undeploy_post_script,omitempty"`
}

SchematicsMetadata : A Schematics workspace that is associated to a project configuration, with scripts.

type SchematicsWorkspace added in v0.0.90 

type SchematicsWorkspace struct {
	// An IBM Cloud resource name that uniquely identifies a resource.
	WorkspaceCrn *string `json:"workspace_crn,omitempty"`
}

SchematicsWorkspace : A Schematics workspace to use for deploying this deployable architecture. > If you are importing data from an existing Schematics workspace that is not backed by cart, then you must provide a `locator_id`. If you are using a Schematics workspace that is backed by cart, a `locator_id` is not required because the Schematics workspace has one. > There are 3 scenarios: > 1. If only a `locator_id` is specified, a new Schematics workspace is instantiated with that `locator_id`. > 2. If only a schematics `workspace_crn` is specified, a `400` is returned if a `locator_id` is not found in the existing schematics workspace. > 3. If both a Schematics `workspace_crn` and a `locator_id` are specified, a `400`code is returned if the specified `locator_id` does not agree with the `locator_id` in the existing Schematics workspace. > For more information, see [Creating workspaces and importing your Terraform template](/docs/schematics?topic=schematics-sch-create-wks).

type Script added in v0.1.0 

type Script struct {
	// The type of the script.
	Type *string `json:"type,omitempty"`

	// The path to this script is within the current version source.
	Path *string `json:"path,omitempty"`

	// The short description for this script.
	ShortDescription *string `json:"short_description,omitempty"`
}

Script : A script to be run as part of a project configuration for a specific stage (pre or post) and action (validate, deploy, or undeploy).

type SyncConfigOptions added in v0.0.27 

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

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

	// A Schematics workspace to use for deploying this deployable architecture.
	// > If you are importing data from an existing Schematics workspace that is not backed by cart, then you must provide
	// a `locator_id`. If you are using a Schematics workspace that is backed by cart, a `locator_id` is not required
	// because the Schematics workspace has one.
	// >
	// There are 3 scenarios:
	// > 1. If only a `locator_id` is specified, a new Schematics workspace is instantiated with that `locator_id`.
	// > 2. If only a schematics `workspace_crn` is specified, a `400` is returned if a `locator_id` is not found in the
	// existing schematics workspace.
	// > 3. If both a Schematics `workspace_crn` and a `locator_id` are specified, a `400`code  is returned if the
	// specified `locator_id` does not agree with the `locator_id` in the existing Schematics workspace.
	// >
	// For more information, see [Creating workspaces and importing your Terraform
	// template](/docs/schematics?topic=schematics-sch-create-wks).
	Schematics *SchematicsWorkspace `json:"schematics,omitempty"`

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

SyncConfigOptions : The SyncConfig options.

func (*SyncConfigOptions) SetHeaders added in v0.0.27 

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

SetHeaders : Allow user to set Headers

func (*SyncConfigOptions) SetID added in v0.0.27 

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

SetID : Allow user to set ID

func (*SyncConfigOptions) SetProjectID added in v0.0.27 

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

SetProjectID : Allow user to set ProjectID

func (*SyncConfigOptions) SetSchematics added in v0.0.90 

func (_options *SyncConfigOptions) SetSchematics(schematics *SchematicsWorkspace) *SyncConfigOptions

SetSchematics : Allow user to set Schematics

type TerraformLogAnalyzerErrorMessage added in v0.1.0 

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

TerraformLogAnalyzerErrorMessage : The error message that is parsed by the Terraform log analyzer.

func (*TerraformLogAnalyzerErrorMessage) GetProperties added in v0.1.0 

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

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

func (*TerraformLogAnalyzerErrorMessage) GetProperty added in v0.1.0 

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

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

func (*TerraformLogAnalyzerErrorMessage) MarshalJSON added in v0.1.0 

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

MarshalJSON performs custom serialization for instances of TerraformLogAnalyzerErrorMessage

func (*TerraformLogAnalyzerErrorMessage) SetProperties added in v0.1.0 

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

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

func (*TerraformLogAnalyzerErrorMessage) SetProperty added in v0.1.0 

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

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

type TerraformLogAnalyzerSuccessMessage added in v0.1.0 

type TerraformLogAnalyzerSuccessMessage struct {
	// The resource type.
	ResourceType *string `json:"resource_type,omitempty"`

	// The time that is taken.
	TimeTaken *string `json:"time-taken,omitempty"`

	// The ID.
	ID *string `json:"id,omitempty"`
}

TerraformLogAnalyzerSuccessMessage : The success message that is parsed by the terraform log analyzer.

type UndeployConfigOptions added in v0.0.27 

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

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

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

UndeployConfigOptions : The UndeployConfig options.

func (*UndeployConfigOptions) SetHeaders added in v0.0.27 

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

SetHeaders : Allow user to set Headers

func (*UndeployConfigOptions) SetID added in v0.0.27 

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

SetID : Allow user to set ID

func (*UndeployConfigOptions) SetProjectID added in v0.0.27 

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

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 configuration ID.
	ID *string `json:"id" validate:"required,ne="`

	Definition ProjectConfigDefinitionPatchIntf `json:"definition" validate:"required"`

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

UpdateConfigOptions : The UpdateConfig options.

func (*UpdateConfigOptions) SetDefinition added in v0.0.27 

func (_options *UpdateConfigOptions) SetDefinition(definition ProjectConfigDefinitionPatchIntf) *UpdateConfigOptions

SetDefinition : Allow user to set Definition

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

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

SetProjectID : Allow user to set ProjectID

type UpdateProjectEnvironmentOptions added in v0.0.90 

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

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

	// The environment definition that is used for updates.
	Definition *EnvironmentDefinitionPropertiesPatch `json:"definition" validate:"required"`

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

UpdateProjectEnvironmentOptions : The UpdateProjectEnvironment options.

func (*UpdateProjectEnvironmentOptions) SetDefinition added in v0.0.90 

func (_options *UpdateProjectEnvironmentOptions) SetDefinition(definition *EnvironmentDefinitionPropertiesPatch) *UpdateProjectEnvironmentOptions

SetDefinition : Allow user to set Definition

func (*UpdateProjectEnvironmentOptions) SetHeaders added in v0.0.90 

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

SetHeaders : Allow user to set Headers

func (*UpdateProjectEnvironmentOptions) SetID added in v0.0.90 

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

SetID : Allow user to set ID

func (*UpdateProjectEnvironmentOptions) SetProjectID added in v0.0.90 

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

SetProjectID : Allow user to set ProjectID

type UpdateProjectOptions 

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

	// The definition of the project.
	Definition *ProjectPatchDefinitionBlock `json:"definition" validate:"required"`

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

UpdateProjectOptions : The UpdateProject options.

func (*UpdateProjectOptions) SetDefinition added in v0.0.27 

func (_options *UpdateProjectOptions) SetDefinition(definition *ProjectPatchDefinitionBlock) *UpdateProjectOptions

SetDefinition : Allow user to set Definition

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

type ValidateConfigOptions added in v0.0.27 

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

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

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

ValidateConfigOptions : The ValidateConfig options.

func (*ValidateConfigOptions) SetHeaders added in v0.0.27 

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

SetHeaders : Allow user to set Headers

func (*ValidateConfigOptions) SetID added in v0.0.27 

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

SetID : Allow user to set ID

func (*ValidateConfigOptions) SetProjectID added in v0.0.27 

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

SetProjectID : Allow user to set ProjectID

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.