projectv1

package
v0.0.14 Latest Latest
Warning

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

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

Documentation

Overview

Package projectv1 : Operations and models for the ProjectV1 service

Index

Constants

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

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

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

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

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

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

View Source 
const (
	ProjectConfigGetResponse_Type_SchematicsBlueprint = "schematics_blueprint"
	ProjectConfigGetResponse_Type_TerraformTemplate   = "terraform_template"
)

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

View Source 
const DefaultServiceName = "project"

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

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

DefaultServiceURL is the default URL to make service requests to.

View Source 
const (
	ProjectConfigPatchRequestProjectConfigManualProperty_Type_Manual = "manual"
)

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

View Source 
const (
	ProjectConfigPatchRequest_Type_Manual = "manual"
)

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

Variables

This section is empty.

Functions

func GetServiceURLForRegion 

func GetServiceURLForRegion(region string) (string, error)

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

func UnmarshalCumulativeNeedsAttention 

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

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

func UnmarshalInputVariable 

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

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

func UnmarshalOutputValue 

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

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

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

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

func UnmarshalProject 

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

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

func UnmarshalProjectCollection 

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

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

func UnmarshalProjectCollectionMemberWithMetadata 

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

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

func UnmarshalProjectConfig 

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

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

func 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 UnmarshalProjectConfigAuthTrustedProfile added in v0.0.11 

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

UnmarshalProjectConfigAuthTrustedProfile unmarshals an instance of ProjectConfigAuthTrustedProfile 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 UnmarshalProjectConfigComplianceProfile added in v0.0.11 

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

UnmarshalProjectConfigComplianceProfile unmarshals an instance of ProjectConfigComplianceProfile 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 UnmarshalProjectConfigGetResponse added in v0.0.13 

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

UnmarshalProjectConfigGetResponse unmarshals an instance of ProjectConfigGetResponse from the specified map of raw messages.

func UnmarshalProjectConfigInputVariable 

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

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

func UnmarshalProjectConfigMetadata added in v0.0.13 

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

UnmarshalProjectConfigMetadata unmarshals an instance of ProjectConfigMetadata 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 UnmarshalProjectConfigMetadataCraLogs added in v0.0.14 

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

UnmarshalProjectConfigMetadataCraLogs unmarshals an instance of ProjectConfigMetadataCraLogs from the specified map of raw messages.

func UnmarshalProjectConfigMetadataJobSummary added in v0.0.14 

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

UnmarshalProjectConfigMetadataJobSummary unmarshals an instance of ProjectConfigMetadataJobSummary from the specified map of raw messages.

func UnmarshalProjectConfigPatchRequest added in v0.0.9 

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

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

func UnmarshalProjectConfigPatchRequestProjectConfigManualProperty added in v0.0.9 

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

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

func UnmarshalProjectConfigPatchRequestProjectConfigPatchSchematicsTemplate added in v0.0.9 

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

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

func UnmarshalProjectConfigPrototype 

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

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

func UnmarshalProjectConfigSettingCollection 

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

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

func UnmarshalProjectMetadata 

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

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

Types

type ApproveOptions 

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

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

	// Notes on the project draft action.
	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 CheckConfigOptions 

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

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

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

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

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

CheckConfigOptions : The CheckConfig options.

func (*CheckConfigOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*CheckConfigOptions) SetID 

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

SetID : Allow user to set ID

func (*CheckConfigOptions) SetProjectID added in v0.0.8 

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

SetProjectID : Allow user to set ProjectID

func (*CheckConfigOptions) SetVersion 

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

SetVersion : Allow user to set Version

func (*CheckConfigOptions) SetXAuthRefreshToken 

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

SetXAuthRefreshToken : Allow user to set XAuthRefreshToken

type CreateConfigOptions 

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

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

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

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

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

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

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

	// The profile required for compliance.
	ComplianceProfile *ProjectConfigComplianceProfile `json:"compliance_profile,omitempty"`

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

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

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

CreateConfigOptions : The CreateConfig options.

func (*CreateConfigOptions) SetAuthorizations added in v0.0.11 

func (_options *CreateConfigOptions) SetAuthorizations(authorizations *ProjectConfigAuth) *CreateConfigOptions

SetAuthorizations : Allow user to set Authorizations

func (*CreateConfigOptions) SetComplianceProfile added in v0.0.11 

func (_options *CreateConfigOptions) SetComplianceProfile(complianceProfile *ProjectConfigComplianceProfile) *CreateConfigOptions

SetComplianceProfile : Allow user to set ComplianceProfile

func (*CreateConfigOptions) SetDescription added in v0.0.8 

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

SetDescription : Allow user to set Description

func (*CreateConfigOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*CreateConfigOptions) SetID 

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

SetID : Allow user to set ID

func (*CreateConfigOptions) SetInput added in v0.0.8 

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

SetInput : Allow user to set Input

func (*CreateConfigOptions) SetLabels added in v0.0.8 

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

SetLabels : Allow user to set Labels

func (*CreateConfigOptions) SetLocatorID added in v0.0.8 

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

SetLocatorID : Allow user to set LocatorID

func (*CreateConfigOptions) SetName added in v0.0.8 

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

SetName : Allow user to set Name

func (*CreateConfigOptions) SetProjectID added in v0.0.8 

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

SetProjectID : Allow user to set ProjectID

func (*CreateConfigOptions) SetSetting added in v0.0.8 

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

SetSetting : Allow user to set Setting

type CreateProjectOptions 

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

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

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

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

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

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

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

CreateProjectOptions : The CreateProject options.

func (*CreateProjectOptions) SetConfigs 

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

SetConfigs : Allow user to set Configs

func (*CreateProjectOptions) SetDescription 

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

SetDescription : Allow user to set Description

func (*CreateProjectOptions) SetDestroyOnDelete added in v0.0.11 

func (_options *CreateProjectOptions) SetDestroyOnDelete(destroyOnDelete bool) *CreateProjectOptions

SetDestroyOnDelete : Allow user to set DestroyOnDelete

func (*CreateProjectOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*CreateProjectOptions) SetLocation 

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

SetLocation : Allow user to set Location

func (*CreateProjectOptions) SetName 

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

SetName : Allow user to set Name

func (*CreateProjectOptions) SetResourceGroup 

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

SetResourceGroup : Allow user to set ResourceGroup

type CumulativeNeedsAttention 

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

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

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

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

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

DeleteConfigOptions : The DeleteConfig options.

func (*DeleteConfigOptions) SetDestroy 

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

SetDestroy : Allow user to set Destroy

func (*DeleteConfigOptions) SetDraftOnly 

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

SetDraftOnly : Allow user to set DraftOnly

func (*DeleteConfigOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*DeleteConfigOptions) SetID 

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

SetID : Allow user to set ID

func (*DeleteConfigOptions) SetProjectID added in v0.0.8 

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

SetProjectID : Allow user to set ProjectID

type DeleteProjectOptions 

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

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

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

DeleteProjectOptions : The DeleteProject options.

func (*DeleteProjectOptions) SetDestroy 

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

SetDestroy : Allow user to set Destroy

func (*DeleteProjectOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*DeleteProjectOptions) SetID 

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

SetID : Allow user to set ID

type GetConfigOptions 

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

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

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

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

func (*GetConfigOptions) SetVersion 

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

SetVersion : Allow user to set Version

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 InputVariable 

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

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

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

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

InputVariable : InputVariable struct

type InstallConfigOptions 

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

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

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

InstallConfigOptions : The InstallConfig options.

func (*InstallConfigOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*InstallConfigOptions) SetID 

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

SetID : Allow user to set ID

func (*InstallConfigOptions) SetProjectID added in v0.0.8 

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

SetProjectID : Allow user to set ProjectID

type ListConfigsOptions 

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

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

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

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

SetProjectID : Allow user to set ProjectID

func (*ListConfigsOptions) SetVersion 

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

SetVersion : Allow user to set Version

type ListProjectsOptions 

type ListProjectsOptions struct {
	// Marks the last entry that is returned on the page. The server uses this parameter to determine the first entry that
	// is returned on the next page. If this parameter is not specified, the logical first page is returned.
	Start *string `json:"start,omitempty"`

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

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

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

OutputValue : OutputValue struct 

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

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

PaginationLink : A pagination link.

type Project 

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

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

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

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

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

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

Project : The project returned in the response body.

type ProjectCollection 

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

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

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

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

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

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

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

ProjectCollection : Projects list.

func (*ProjectCollection) GetNextStart 

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

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

type ProjectCollectionMemberWithMetadata 

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

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

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

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

ProjectCollectionMemberWithMetadata : ProjectCollectionMemberWithMetadata struct

type ProjectConfig 

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

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

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

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

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

	// The profile required for compliance.
	ComplianceProfile *ProjectConfigComplianceProfile `json:"compliance_profile,omitempty"`

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

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

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

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

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

ProjectConfig : The project configuration.

type ProjectConfigAuth added in v0.0.11 

type ProjectConfigAuth struct {
	// The trusted profile for authorizations.
	TrustedProfile *ProjectConfigAuthTrustedProfile `json:"trusted_profile,omitempty"`

	// The authorization for a configuration. 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.
	ApiKey *string `json:"api_key,omitempty"`
}

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

type ProjectConfigAuthTrustedProfile added in v0.0.11 

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

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

ProjectConfigAuthTrustedProfile : The trusted profile for authorizations.

type ProjectConfigCollection 

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

ProjectConfigCollection : The project configuration list.

type ProjectConfigComplianceProfile added in v0.0.11 

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

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

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

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

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

ProjectConfigComplianceProfile : The profile required for compliance.

type ProjectConfigDelete 

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

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

ProjectConfigDelete : Deletes the configuration response.

type ProjectConfigGetResponse added in v0.0.13 

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

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

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

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

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

	// The profile required for compliance.
	ComplianceProfile *ProjectConfigComplianceProfile `json:"compliance_profile,omitempty"`

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

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

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

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

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

	// The configuration metadata.
	Metadata *ProjectConfigMetadata `json:"metadata,omitempty"`
}

ProjectConfigGetResponse : The project configuration.

type ProjectConfigInputVariable 

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

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

ProjectConfigInputVariable : ProjectConfigInputVariable struct

type ProjectConfigMetadata added in v0.0.13 

type ProjectConfigMetadata struct {
	// The unique ID of a project.
	ProjectID *string `json:"project_id,omitempty"`

	// The version of the configuration.
	Version *int64 `json:"version,omitempty"`

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

	// The needs attention state of a configuration.
	NeedsAttentionState []interface{} `json:"needs_attention_state,omitempty"`

	// The state of a configuration.
	State *string `json:"state,omitempty"`

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

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

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

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

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

	// The summaries of jobs that were performed on the configuration.
	JobSummary *ProjectConfigMetadataJobSummary `json:"job_summary,omitempty"`

	// The Code Risk Analyzer logs of the configuration.
	CraLogs *ProjectConfigMetadataCraLogs `json:"cra_logs,omitempty"`

	// The cost estimate of the configuration.
	CostEstimate *ProjectConfigMetadataCostEstimate `json:"cost_estimate,omitempty"`
}

ProjectConfigMetadata : The configuration metadata.

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 current and past total hourly cost estimates of the configuration.
	DiffTotalHourlyCost *string `json:"diffTotalHourlyCost,omitempty"`

	// The difference between 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, matching the date and time
	// format as specified by RFC 3339.
	TimeGenerated *strfmt.DateTime `json:"timeGenerated,omitempty"`

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

ProjectConfigMetadataCostEstimate : The cost estimate of the configuration.

type ProjectConfigMetadataCraLogs added in v0.0.14 

type ProjectConfigMetadataCraLogs struct {
	// The version of the Code Risk Analyzer logs of the configuration.
	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 summary of the Code Risk Analyzer logs of the configuration.
	Summary map[string]interface{} `json:"summary,omitempty"`

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

ProjectConfigMetadataCraLogs : The Code Risk Analyzer logs of the configuration.

type ProjectConfigMetadataJobSummary added in v0.0.14 

type ProjectConfigMetadataJobSummary struct {
	// The summary of the plan jobs on the configuration.
	PlanSummary map[string]interface{} `json:"plan_summary,omitempty"`

	// The summary of the apply jobs on the configuration.
	ApplySummary map[string]interface{} `json:"apply_summary,omitempty"`

	// The summary of the destroy jobs on the configuration.
	DestroySummary map[string]interface{} `json:"destroy_summary,omitempty"`

	// The message summaries of jobs on the configuration.
	MessageSummary map[string]interface{} `json:"message_summary,omitempty"`

	// The messages of plan jobs on the configuration.
	PlanMessages map[string]interface{} `json:"plan_messages,omitempty"`

	// The messages of apply jobs on the configuration.
	ApplyMessages map[string]interface{} `json:"apply_messages,omitempty"`

	// The messages of destroy jobs on the configuration.
	DestroyMessages map[string]interface{} `json:"destroy_messages,omitempty"`
}

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

type ProjectConfigPatchRequest added in v0.0.9 

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

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

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

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

	// The profile required for compliance.
	ComplianceProfile *ProjectConfigComplianceProfile `json:"compliance_profile,omitempty"`

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

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

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

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

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

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

type ProjectConfigPatchRequestIntf added in v0.0.9 

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

type ProjectConfigPatchRequestProjectConfigManualProperty added in v0.0.9 

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

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

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

	Authorizations *ProjectConfigAuth `json:"authorizations,omitempty"`

	ComplianceProfile *ProjectConfigComplianceProfile `json:"compliance_profile,omitempty"`

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

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

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

type ProjectConfigPatchRequestProjectConfigPatchSchematicsTemplate added in v0.0.9 

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

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

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

	Authorizations *ProjectConfigAuth `json:"authorizations,omitempty"`

	ComplianceProfile *ProjectConfigComplianceProfile `json:"compliance_profile,omitempty"`

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

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

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

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

type ProjectConfigPrototype 

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

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

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

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

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

	// The profile required for compliance.
	ComplianceProfile *ProjectConfigComplianceProfile `json:"compliance_profile,omitempty"`

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

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

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

ProjectConfigPrototype : The input of a project configuration.

type ProjectConfigSettingCollection 

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

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

ProjectConfigSettingCollection : ProjectConfigSettingCollection struct

type ProjectMetadata 

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

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

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

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

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

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

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

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

ProjectMetadata : The metadata of the project.

type ProjectV1 

type ProjectV1 struct {
	Service *core.BaseService
}

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

API Version: 1.0.0

func NewProjectV1 

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

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

func NewProjectV1UsingExternalConfig 

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

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

func (*ProjectV1) Approve 

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

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

func (*ProjectV1) ApproveWithContext 

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

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

func (*ProjectV1) CheckConfig 

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

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

func (*ProjectV1) CheckConfigWithContext 

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

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

func (*ProjectV1) Clone 

func (project *ProjectV1) Clone() *ProjectV1

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

func (*ProjectV1) CreateConfig 

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

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

func (*ProjectV1) CreateConfigWithContext 

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

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

func (*ProjectV1) CreateProject 

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

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

func (*ProjectV1) CreateProjectWithContext 

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

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

func (*ProjectV1) DeleteConfig 

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

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

func (*ProjectV1) DeleteConfigWithContext 

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

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

func (*ProjectV1) DeleteProject 

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

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

func (*ProjectV1) DeleteProjectWithContext 

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

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

func (*ProjectV1) DisableRetries 

func (project *ProjectV1) DisableRetries()

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

func (*ProjectV1) EnableRetries 

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

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

func (*ProjectV1) GetConfig 

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

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

func (*ProjectV1) GetConfigWithContext 

func (project *ProjectV1) GetConfigWithContext(ctx context.Context, getConfigOptions *GetConfigOptions) (result *ProjectConfigGetResponse, 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) 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) InstallConfig 

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

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

func (*ProjectV1) InstallConfigWithContext 

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

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

func (*ProjectV1) ListConfigs 

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

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

func (*ProjectV1) ListConfigsWithContext 

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

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

func (*ProjectV1) ListProjects 

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

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

func (*ProjectV1) ListProjectsWithContext 

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

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

func (*ProjectV1) NewApproveOptions 

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

NewApproveOptions : Instantiate ApproveOptions

func (*ProjectV1) NewCheckConfigOptions 

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

NewCheckConfigOptions : Instantiate CheckConfigOptions

func (*ProjectV1) NewCreateConfigOptions 

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

NewCreateConfigOptions : Instantiate CreateConfigOptions

func (*ProjectV1) NewCreateProjectOptions 

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

NewCreateProjectOptions : Instantiate CreateProjectOptions

func (*ProjectV1) NewDeleteConfigOptions 

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

NewDeleteConfigOptions : Instantiate DeleteConfigOptions

func (*ProjectV1) NewDeleteProjectOptions 

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

NewDeleteProjectOptions : Instantiate DeleteProjectOptions

func (*ProjectV1) NewGetConfigOptions 

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

NewGetConfigOptions : Instantiate GetConfigOptions

func (*ProjectV1) NewGetProjectOptions 

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

NewGetProjectOptions : Instantiate GetProjectOptions

func (*ProjectV1) NewInstallConfigOptions 

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

NewInstallConfigOptions : Instantiate InstallConfigOptions

func (*ProjectV1) NewListConfigsOptions 

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

NewListConfigsOptions : Instantiate ListConfigsOptions

func (*ProjectV1) NewListProjectsOptions 

func (*ProjectV1) NewListProjectsOptions() *ListProjectsOptions

NewListProjectsOptions : Instantiate ListProjectsOptions

func (*ProjectV1) NewProjectConfigInputVariable 

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

NewProjectConfigInputVariable : Instantiate ProjectConfigInputVariable (Generic Model Constructor)

func (*ProjectV1) NewProjectConfigPatchRequestProjectConfigManualProperty added in v0.0.9 

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

NewProjectConfigPatchRequestProjectConfigManualProperty : Instantiate ProjectConfigPatchRequestProjectConfigManualProperty (Generic Model Constructor)

func (*ProjectV1) NewProjectConfigPrototype 

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

NewProjectConfigPrototype : Instantiate ProjectConfigPrototype (Generic Model Constructor)

func (*ProjectV1) NewProjectConfigSettingCollection 

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

NewProjectConfigSettingCollection : Instantiate ProjectConfigSettingCollection (Generic Model Constructor)

func (*ProjectV1) NewProjectsPager 

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

NewProjectsPager returns a new ProjectsPager instance.

func (*ProjectV1) NewUninstallConfigOptions 

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

NewUninstallConfigOptions : Instantiate UninstallConfigOptions

func (*ProjectV1) NewUpdateConfigOptions 

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

NewUpdateConfigOptions : Instantiate UpdateConfigOptions

func (*ProjectV1) SetDefaultHeaders 

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

SetDefaultHeaders sets HTTP headers to be sent in every request

func (*ProjectV1) SetEnableGzipCompression 

func (project *ProjectV1) SetEnableGzipCompression(enableGzip bool)

SetEnableGzipCompression sets the service's EnableGzipCompression field

func (*ProjectV1) SetServiceURL 

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

SetServiceURL sets the service URL

func (*ProjectV1) UninstallConfig 

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

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

func (*ProjectV1) UninstallConfigWithContext 

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

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

func (*ProjectV1) UpdateConfig 

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

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

func (*ProjectV1) UpdateConfigWithContext 

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

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

type ProjectV1Options 

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

ProjectV1Options : Service options

type ProjectsPager 

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

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

func (*ProjectsPager) GetAll 

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

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

func (*ProjectsPager) GetAllWithContext 

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

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

func (*ProjectsPager) GetNext 

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

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

func (*ProjectsPager) GetNextWithContext 

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

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

func (*ProjectsPager) HasNext 

func (pager *ProjectsPager) HasNext() bool

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

type UninstallConfigOptions 

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

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

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

UninstallConfigOptions : The UninstallConfig options.

func (*UninstallConfigOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*UninstallConfigOptions) SetID 

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

SetID : Allow user to set ID

func (*UninstallConfigOptions) SetProjectID added in v0.0.8 

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

SetProjectID : Allow user to set ProjectID

type UpdateConfigOptions 

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

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

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

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

UpdateConfigOptions : The UpdateConfig options.

func (*UpdateConfigOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*UpdateConfigOptions) SetID 

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

SetID : Allow user to set ID

func (*UpdateConfigOptions) SetProjectConfig 

func (_options *UpdateConfigOptions) SetProjectConfig(projectConfig ProjectConfigPatchRequestIntf) *UpdateConfigOptions

SetProjectConfig : Allow user to set ProjectConfig

func (*UpdateConfigOptions) SetProjectID added in v0.0.8 

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

SetProjectID : Allow user to set ProjectID

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.