schematicsv1

Documentation

Overview

Package schematicsv1 : Operations and models for the SchematicsV1 service

Index

• Constants
• func GetServiceURLForRegion(region string) (string, error)
• func UnmarshalAction(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalActionList(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalActionLite(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalActionLiteState(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalActionState(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalAgent(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalAgentAssignmentPolicyParameter(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalAgentData(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalAgentDataList(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalAgentDataLite(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalAgentDataRecentDeployJob(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalAgentDataRecentDestroyJob(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalAgentDataRecentHealthJob(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalAgentDataRecentPrsJob(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalAgentDeployJob(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalAgentHealthJob(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalAgentInfo(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalAgentInfrastructure(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalAgentKPIData(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalAgentKPIDataLite(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalAgentList(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalAgentMetadataInfo(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalAgentPRSJob(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalAgentSystemState(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalAgentSystemStatus(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalAgentUserState(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalAgentVersionInfo(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalAgentVersions(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalBastionResourceDefinition(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalCartOrderData(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalCatalogRef(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalCatalogSource(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalCommandsInfo(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalConnectionState(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalCredentialVariableData(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalCredentialVariableMetadata(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalDependencies(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalEncryptionInfo(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalEnvVariableRequestMap(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalEnvVariableResponse(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalEnvironmentValuesMetadata(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalExternalSource(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalGitSource(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalInjectTerraformTemplateInner(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalInjectTerraformTemplateInnerTftParametersItem(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalInventoryResourceRecord(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalInventoryResourceRecordList(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalJob(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalJobData(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalJobDataAction(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalJobDataFlow(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalJobDataSystem(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalJobDataTemplate(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalJobDataWorkItem(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalJobDataWorkItemLastJob(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalJobDataWorkspace(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalJobFileContent(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalJobFileData(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalJobFileDataSummary(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalJobList(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalJobLite(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalJobLog(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalJobLogSummary(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalJobLogSummaryActionJob(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalJobLogSummaryActionJobRecap(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalJobLogSummaryFlowJob(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalJobLogSummaryLogErrors(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalJobLogSummaryRepoDownloadJob(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalJobLogSummarySystemJob(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalJobLogSummaryWorkitems(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalJobLogSummaryWorkspaceJob(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalJobStatus(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalJobStatusAction(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalJobStatusFlow(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalJobStatusSchematicsResources(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalJobStatusSystem(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalJobStatusTemplate(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalJobStatusWorkitem(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalJobStatusWorkspace(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalKMSDiscovery(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalKMSInstances(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalKMSInstancesKeys(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalKMSSettings(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalKMSSettingsPrimaryCrk(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalKMSSettingsSecondaryCrk(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalLastJob(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalLogStoreResponse(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalLogStoreResponseList(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalLogSummary(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalOutputValuesInner(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalPolicy(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalPolicyList(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalPolicyLite(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalPolicyObjectSelector(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalPolicyObjects(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalPolicyParameter(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalResourceGroupResponse(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalResourceQuery(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalResourceQueryParam(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalResourceQueryRecord(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalResourceQueryRecordList(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalResourceQueryResponseRecord(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalResourceQueryResponseRecordQueryOutput(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalResourceQueryResponseRecordResponse(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalSchematicsLocations(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalSchematicsLocationsList(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalSchematicsLocationsLite(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalScopedResource(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalServiceExtensions(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalSharedTargetData(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalSharedTargetDataResponse(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalStateStoreResponse(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalStateStoreResponseList(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalSystemLock(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalTemplateMetaDataResponse(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalTemplateReadme(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalTemplateRepoRequest(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalTemplateRepoResponse(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalTemplateRepoTarUploadResponse(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalTemplateRepoUpdateRequest(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalTemplateResources(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalTemplateRunTimeDataResponse(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalTemplateSourceDataRequest(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalTemplateSourceDataResponse(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalTemplateStateStore(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalTemplateValues(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalTerraformCommand(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalUserState(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalUserValues(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalVariableData(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalVariableMetadata(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalVersionResponse(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalWorkspaceActivities(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalWorkspaceActivity(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalWorkspaceActivityApplyResult(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalWorkspaceActivityCommandResult(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalWorkspaceActivityDestroyResult(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalWorkspaceActivityLogs(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalWorkspaceActivityOptionsTemplate(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalWorkspaceActivityPlanResult(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalWorkspaceActivityRefreshResult(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalWorkspaceActivityTemplate(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalWorkspaceActivityTemplateLogs(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalWorkspaceBulkDeleteResponse(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalWorkspaceJobResponse(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalWorkspaceJobStatusType(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalWorkspaceResponse(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalWorkspaceResponseList(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalWorkspaceStatusMessage(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalWorkspaceStatusRequest(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalWorkspaceStatusResponse(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalWorkspaceStatusUpdateRequest(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalWorkspaceTemplateValuesResponse(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalWorkspaceVariableRequest(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalWorkspaceVariableResponse(m map[string]json.RawMessage, result interface{}) (err error)
• type Action
• type ActionList
• type ActionLite
• type ActionLiteState
• type ActionState
• type Agent
• type AgentAssignmentPolicyParameter
• type AgentData
• type AgentDataList
• type AgentDataLite
• type AgentDataRecentDeployJob
• type AgentDataRecentDestroyJob
• type AgentDataRecentHealthJob
• type AgentDataRecentPrsJob
• type AgentDeployJob
• type AgentHealthJob
• type AgentInfo
• type AgentInfrastructure
• type AgentKPIData
• type AgentKPIDataLite
• type AgentList
• type AgentMetadataInfo
• type AgentPRSJob
• type AgentSystemState
• type AgentSystemStatus
• type AgentUserState
• type AgentVersionInfo
• type AgentVersions
• type ApplyWorkspaceCommandOptions
  • func (_options *ApplyWorkspaceCommandOptions) SetActionOptions(actionOptions *WorkspaceActivityOptionsTemplate) *ApplyWorkspaceCommandOptions
  • func (_options *ApplyWorkspaceCommandOptions) SetDelegatedToken(delegatedToken string) *ApplyWorkspaceCommandOptions
  • func (options *ApplyWorkspaceCommandOptions) SetHeaders(param map[string]string) *ApplyWorkspaceCommandOptions
  • func (_options *ApplyWorkspaceCommandOptions) SetRefreshToken(refreshToken string) *ApplyWorkspaceCommandOptions
  • func (_options *ApplyWorkspaceCommandOptions) SetWID(wID string) *ApplyWorkspaceCommandOptions
• type BastionResourceDefinition
• type CartOrderData
• type CatalogRef
• type CatalogSource
• type CommandsInfo
• type ConnectionState
• type CreateActionOptions
  • func (_options *CreateActionOptions) SetBastion(bastion *BastionResourceDefinition) *CreateActionOptions
  • func (_options *CreateActionOptions) SetBastionConnectionType(bastionConnectionType string) *CreateActionOptions
  • func (_options *CreateActionOptions) SetBastionCredential(bastionCredential *CredentialVariableData) *CreateActionOptions
  • func (_options *CreateActionOptions) SetCommandParameter(commandParameter string) *CreateActionOptions
  • func (_options *CreateActionOptions) SetCredentials(credentials []CredentialVariableData) *CreateActionOptions
  • func (_options *CreateActionOptions) SetDescription(description string) *CreateActionOptions
  • func (options *CreateActionOptions) SetHeaders(param map[string]string) *CreateActionOptions
  • func (_options *CreateActionOptions) SetInputs(inputs []VariableData) *CreateActionOptions
  • func (_options *CreateActionOptions) SetInventory(inventory string) *CreateActionOptions
  • func (_options *CreateActionOptions) SetInventoryConnectionType(inventoryConnectionType string) *CreateActionOptions
  • func (_options *CreateActionOptions) SetLocation(location string) *CreateActionOptions
  • func (_options *CreateActionOptions) SetName(name string) *CreateActionOptions
  • func (_options *CreateActionOptions) SetOutputs(outputs []VariableData) *CreateActionOptions
  • func (_options *CreateActionOptions) SetResourceGroup(resourceGroup string) *CreateActionOptions
  • func (_options *CreateActionOptions) SetSettings(settings []VariableData) *CreateActionOptions
  • func (_options *CreateActionOptions) SetSource(source *ExternalSource) *CreateActionOptions
  • func (_options *CreateActionOptions) SetSourceReadmeURL(sourceReadmeURL string) *CreateActionOptions
  • func (_options *CreateActionOptions) SetSourceType(sourceType string) *CreateActionOptions
  • func (_options *CreateActionOptions) SetTags(tags []string) *CreateActionOptions
  • func (_options *CreateActionOptions) SetTargetsIni(targetsIni string) *CreateActionOptions
  • func (_options *CreateActionOptions) SetUserState(userState *UserState) *CreateActionOptions
  • func (_options *CreateActionOptions) SetXGithubToken(xGithubToken string) *CreateActionOptions
• type CreateAgentDataOptions
  • func (_options *CreateAgentDataOptions) SetAgentInfrastructure(agentInfrastructure *AgentInfrastructure) *CreateAgentDataOptions
  • func (_options *CreateAgentDataOptions) SetAgentInputs(agentInputs []VariableData) *CreateAgentDataOptions
  • func (_options *CreateAgentDataOptions) SetAgentKpi(agentKpi *AgentKPIData) *CreateAgentDataOptions
  • func (_options *CreateAgentDataOptions) SetAgentLocation(agentLocation string) *CreateAgentDataOptions
  • func (_options *CreateAgentDataOptions) SetAgentMetadata(agentMetadata []AgentMetadataInfo) *CreateAgentDataOptions
  • func (_options *CreateAgentDataOptions) SetDescription(description string) *CreateAgentDataOptions
  • func (options *CreateAgentDataOptions) SetHeaders(param map[string]string) *CreateAgentDataOptions
  • func (_options *CreateAgentDataOptions) SetName(name string) *CreateAgentDataOptions
  • func (_options *CreateAgentDataOptions) SetResourceGroup(resourceGroup string) *CreateAgentDataOptions
  • func (_options *CreateAgentDataOptions) SetSchematicsLocation(schematicsLocation string) *CreateAgentDataOptions
  • func (_options *CreateAgentDataOptions) SetTags(tags []string) *CreateAgentDataOptions
  • func (_options *CreateAgentDataOptions) SetUserState(userState *AgentUserState) *CreateAgentDataOptions
  • func (_options *CreateAgentDataOptions) SetVersion(version string) *CreateAgentDataOptions
• type CreateInventoryOptions
  • func (_options *CreateInventoryOptions) SetDescription(description string) *CreateInventoryOptions
  • func (options *CreateInventoryOptions) SetHeaders(param map[string]string) *CreateInventoryOptions
  • func (_options *CreateInventoryOptions) SetInventoriesIni(inventoriesIni string) *CreateInventoryOptions
  • func (_options *CreateInventoryOptions) SetLocation(location string) *CreateInventoryOptions
  • func (_options *CreateInventoryOptions) SetName(name string) *CreateInventoryOptions
  • func (_options *CreateInventoryOptions) SetResourceGroup(resourceGroup string) *CreateInventoryOptions
  • func (_options *CreateInventoryOptions) SetResourceQueries(resourceQueries []string) *CreateInventoryOptions
• type CreateJobOptions
  • func (_options *CreateJobOptions) SetAgent(agent *AgentInfo) *CreateJobOptions
  • func (_options *CreateJobOptions) SetBastion(bastion *BastionResourceDefinition) *CreateJobOptions
  • func (_options *CreateJobOptions) SetCartOrderData(cartOrderData []CartOrderData) *CreateJobOptions
  • func (_options *CreateJobOptions) SetCommandName(commandName string) *CreateJobOptions
  • func (_options *CreateJobOptions) SetCommandObject(commandObject string) *CreateJobOptions
  • func (_options *CreateJobOptions) SetCommandObjectID(commandObjectID string) *CreateJobOptions
  • func (_options *CreateJobOptions) SetCommandOptions(commandOptions []string) *CreateJobOptions
  • func (_options *CreateJobOptions) SetCommandParameter(commandParameter string) *CreateJobOptions
  • func (_options *CreateJobOptions) SetData(data *JobData) *CreateJobOptions
  • func (options *CreateJobOptions) SetHeaders(param map[string]string) *CreateJobOptions
  • func (_options *CreateJobOptions) SetInputs(inputs []VariableData) *CreateJobOptions
  • func (_options *CreateJobOptions) SetLocation(location string) *CreateJobOptions
  • func (_options *CreateJobOptions) SetLogSummary(logSummary *JobLogSummary) *CreateJobOptions
  • func (_options *CreateJobOptions) SetRefreshToken(refreshToken string) *CreateJobOptions
  • func (_options *CreateJobOptions) SetSettings(settings []VariableData) *CreateJobOptions
  • func (_options *CreateJobOptions) SetStatus(status *JobStatus) *CreateJobOptions
  • func (_options *CreateJobOptions) SetTags(tags []string) *CreateJobOptions
• type CreatePolicyOptions
  • func (_options *CreatePolicyOptions) SetDescription(description string) *CreatePolicyOptions
  • func (options *CreatePolicyOptions) SetHeaders(param map[string]string) *CreatePolicyOptions
  • func (_options *CreatePolicyOptions) SetKind(kind string) *CreatePolicyOptions
  • func (_options *CreatePolicyOptions) SetLocation(location string) *CreatePolicyOptions
  • func (_options *CreatePolicyOptions) SetName(name string) *CreatePolicyOptions
  • func (_options *CreatePolicyOptions) SetParameter(parameter *PolicyParameter) *CreatePolicyOptions
  • func (_options *CreatePolicyOptions) SetResourceGroup(resourceGroup string) *CreatePolicyOptions
  • func (_options *CreatePolicyOptions) SetScopedResources(scopedResources []ScopedResource) *CreatePolicyOptions
  • func (_options *CreatePolicyOptions) SetState(state *UserState) *CreatePolicyOptions
  • func (_options *CreatePolicyOptions) SetTags(tags []string) *CreatePolicyOptions
  • func (_options *CreatePolicyOptions) SetTarget(target *PolicyObjects) *CreatePolicyOptions
• type CreateResourceQueryOptions
  • func (options *CreateResourceQueryOptions) SetHeaders(param map[string]string) *CreateResourceQueryOptions
  • func (_options *CreateResourceQueryOptions) SetName(name string) *CreateResourceQueryOptions
  • func (_options *CreateResourceQueryOptions) SetQueries(queries []ResourceQuery) *CreateResourceQueryOptions
  • func (_options *CreateResourceQueryOptions) SetType(typeVar string) *CreateResourceQueryOptions
• type CreateWorkspaceDeletionJobOptions
  • func (options *CreateWorkspaceDeletionJobOptions) SetHeaders(param map[string]string) *CreateWorkspaceDeletionJobOptions
  • func (_options *CreateWorkspaceDeletionJobOptions) SetJob(job string) *CreateWorkspaceDeletionJobOptions
  • func (_options *CreateWorkspaceDeletionJobOptions) SetRefreshToken(refreshToken string) *CreateWorkspaceDeletionJobOptions
  • func (_options *CreateWorkspaceDeletionJobOptions) SetVersion(version string) *CreateWorkspaceDeletionJobOptions
  • func (_options *CreateWorkspaceDeletionJobOptions) SetWorkspaces(workspaces []string) *CreateWorkspaceDeletionJobOptions
• type CreateWorkspaceOptions
  • func (_options *CreateWorkspaceOptions) SetAgentID(agentID string) *CreateWorkspaceOptions
  • func (_options *CreateWorkspaceOptions) SetAppliedShareddataIds(appliedShareddataIds []string) *CreateWorkspaceOptions
  • func (_options *CreateWorkspaceOptions) SetCatalogRef(catalogRef *CatalogRef) *CreateWorkspaceOptions
  • func (_options *CreateWorkspaceOptions) SetDependencies(dependencies *Dependencies) *CreateWorkspaceOptions
  • func (_options *CreateWorkspaceOptions) SetDescription(description string) *CreateWorkspaceOptions
  • func (options *CreateWorkspaceOptions) SetHeaders(param map[string]string) *CreateWorkspaceOptions
  • func (_options *CreateWorkspaceOptions) SetLocation(location string) *CreateWorkspaceOptions
  • func (_options *CreateWorkspaceOptions) SetName(name string) *CreateWorkspaceOptions
  • func (_options *CreateWorkspaceOptions) SetResourceGroup(resourceGroup string) *CreateWorkspaceOptions
  • func (_options *CreateWorkspaceOptions) SetSettings(settings []VariableData) *CreateWorkspaceOptions
  • func (_options *CreateWorkspaceOptions) SetSharedData(sharedData *SharedTargetData) *CreateWorkspaceOptions
  • func (_options *CreateWorkspaceOptions) SetTags(tags []string) *CreateWorkspaceOptions
  • func (_options *CreateWorkspaceOptions) SetTemplateData(templateData []TemplateSourceDataRequest) *CreateWorkspaceOptions
  • func (_options *CreateWorkspaceOptions) SetTemplateRef(templateRef string) *CreateWorkspaceOptions
  • func (_options *CreateWorkspaceOptions) SetTemplateRepo(templateRepo *TemplateRepoRequest) *CreateWorkspaceOptions
  • func (_options *CreateWorkspaceOptions) SetType(typeVar []string) *CreateWorkspaceOptions
  • func (_options *CreateWorkspaceOptions) SetWorkspaceStatus(workspaceStatus *WorkspaceStatusRequest) *CreateWorkspaceOptions
  • func (_options *CreateWorkspaceOptions) SetXGithubToken(xGithubToken string) *CreateWorkspaceOptions
• type CredentialVariableData
• type CredentialVariableMetadata
• type DeleteActionOptions
  • func (_options *DeleteActionOptions) SetActionID(actionID string) *DeleteActionOptions
  • func (_options *DeleteActionOptions) SetForce(force bool) *DeleteActionOptions
  • func (options *DeleteActionOptions) SetHeaders(param map[string]string) *DeleteActionOptions
  • func (_options *DeleteActionOptions) SetPropagate(propagate bool) *DeleteActionOptions
• type DeleteAgentDataOptions
  • func (_options *DeleteAgentDataOptions) SetAgentID(agentID string) *DeleteAgentDataOptions
  • func (_options *DeleteAgentDataOptions) SetForce(force bool) *DeleteAgentDataOptions
  • func (options *DeleteAgentDataOptions) SetHeaders(param map[string]string) *DeleteAgentDataOptions
• type DeleteAgentOptions
  • func (_options *DeleteAgentOptions) SetAgentID(agentID string) *DeleteAgentOptions
  • func (options *DeleteAgentOptions) SetHeaders(param map[string]string) *DeleteAgentOptions
• type DeleteAgentResourcesOptions
  • func (_options *DeleteAgentResourcesOptions) SetAgentID(agentID string) *DeleteAgentResourcesOptions
  • func (options *DeleteAgentResourcesOptions) SetHeaders(param map[string]string) *DeleteAgentResourcesOptions
  • func (_options *DeleteAgentResourcesOptions) SetRefreshToken(refreshToken string) *DeleteAgentResourcesOptions
• type DeleteInventoryOptions
  • func (_options *DeleteInventoryOptions) SetForce(force bool) *DeleteInventoryOptions
  • func (options *DeleteInventoryOptions) SetHeaders(param map[string]string) *DeleteInventoryOptions
  • func (_options *DeleteInventoryOptions) SetInventoryID(inventoryID string) *DeleteInventoryOptions
  • func (_options *DeleteInventoryOptions) SetPropagate(propagate bool) *DeleteInventoryOptions
• type DeleteJobOptions
  • func (_options *DeleteJobOptions) SetForce(force bool) *DeleteJobOptions
  • func (options *DeleteJobOptions) SetHeaders(param map[string]string) *DeleteJobOptions
  • func (_options *DeleteJobOptions) SetJobID(jobID string) *DeleteJobOptions
  • func (_options *DeleteJobOptions) SetPropagate(propagate bool) *DeleteJobOptions
  • func (_options *DeleteJobOptions) SetRefreshToken(refreshToken string) *DeleteJobOptions
• type DeletePolicyOptions
  • func (options *DeletePolicyOptions) SetHeaders(param map[string]string) *DeletePolicyOptions
  • func (_options *DeletePolicyOptions) SetPolicyID(policyID string) *DeletePolicyOptions
• type DeleteResourcesQueryOptions
  • func (_options *DeleteResourcesQueryOptions) SetForce(force bool) *DeleteResourcesQueryOptions
  • func (options *DeleteResourcesQueryOptions) SetHeaders(param map[string]string) *DeleteResourcesQueryOptions
  • func (_options *DeleteResourcesQueryOptions) SetPropagate(propagate bool) *DeleteResourcesQueryOptions
  • func (_options *DeleteResourcesQueryOptions) SetQueryID(queryID string) *DeleteResourcesQueryOptions
• type DeleteWorkspaceActivityOptions
  • func (_options *DeleteWorkspaceActivityOptions) SetActivityID(activityID string) *DeleteWorkspaceActivityOptions
  • func (options *DeleteWorkspaceActivityOptions) SetHeaders(param map[string]string) *DeleteWorkspaceActivityOptions
  • func (_options *DeleteWorkspaceActivityOptions) SetWID(wID string) *DeleteWorkspaceActivityOptions
• type DeleteWorkspaceOptions
  • func (_options *DeleteWorkspaceOptions) SetDestroyResources(destroyResources string) *DeleteWorkspaceOptions
  • func (options *DeleteWorkspaceOptions) SetHeaders(param map[string]string) *DeleteWorkspaceOptions
  • func (_options *DeleteWorkspaceOptions) SetRefreshToken(refreshToken string) *DeleteWorkspaceOptions
  • func (_options *DeleteWorkspaceOptions) SetWID(wID string) *DeleteWorkspaceOptions
• type Dependencies
• type DeployAgentJobOptions
  • func (_options *DeployAgentJobOptions) SetAgentID(agentID string) *DeployAgentJobOptions
  • func (_options *DeployAgentJobOptions) SetForce(force bool) *DeployAgentJobOptions
  • func (options *DeployAgentJobOptions) SetHeaders(param map[string]string) *DeployAgentJobOptions
• type DestroyWorkspaceCommandOptions
  • func (_options *DestroyWorkspaceCommandOptions) SetActionOptions(actionOptions *WorkspaceActivityOptionsTemplate) *DestroyWorkspaceCommandOptions
  • func (_options *DestroyWorkspaceCommandOptions) SetDelegatedToken(delegatedToken string) *DestroyWorkspaceCommandOptions
  • func (options *DestroyWorkspaceCommandOptions) SetHeaders(param map[string]string) *DestroyWorkspaceCommandOptions
  • func (_options *DestroyWorkspaceCommandOptions) SetRefreshToken(refreshToken string) *DestroyWorkspaceCommandOptions
  • func (_options *DestroyWorkspaceCommandOptions) SetWID(wID string) *DestroyWorkspaceCommandOptions
• type EncryptionInfo
• type EnvVariableRequestMap
• type EnvVariableResponse
• type EnvironmentValuesMetadata
• type ExecuteResourceQueryOptions
  • func (options *ExecuteResourceQueryOptions) SetHeaders(param map[string]string) *ExecuteResourceQueryOptions
  • func (_options *ExecuteResourceQueryOptions) SetQueryID(queryID string) *ExecuteResourceQueryOptions
• type ExternalSource
• type GetActionOptions
  • func (_options *GetActionOptions) SetActionID(actionID string) *GetActionOptions
  • func (options *GetActionOptions) SetHeaders(param map[string]string) *GetActionOptions
  • func (_options *GetActionOptions) SetProfile(profile string) *GetActionOptions
• type GetAgentDataOptions
  • func (_options *GetAgentDataOptions) SetAgentID(agentID string) *GetAgentDataOptions
  • func (options *GetAgentDataOptions) SetHeaders(param map[string]string) *GetAgentDataOptions
  • func (_options *GetAgentDataOptions) SetProfile(profile string) *GetAgentDataOptions
• type GetAgentOptions
  • func (_options *GetAgentOptions) SetAgentID(agentID string) *GetAgentOptions
  • func (options *GetAgentOptions) SetHeaders(param map[string]string) *GetAgentOptions
  • func (_options *GetAgentOptions) SetProfile(profile string) *GetAgentOptions
• type GetAgentVersionsOptions
  • func (options *GetAgentVersionsOptions) SetHeaders(param map[string]string) *GetAgentVersionsOptions
• type GetAllWorkspaceInputsOptions
  • func (options *GetAllWorkspaceInputsOptions) SetHeaders(param map[string]string) *GetAllWorkspaceInputsOptions
  • func (_options *GetAllWorkspaceInputsOptions) SetWID(wID string) *GetAllWorkspaceInputsOptions
• type GetDeployAgentJobOptions
  • func (_options *GetDeployAgentJobOptions) SetAgentID(agentID string) *GetDeployAgentJobOptions
  • func (options *GetDeployAgentJobOptions) SetHeaders(param map[string]string) *GetDeployAgentJobOptions
• type GetHealthCheckAgentJobOptions
  • func (_options *GetHealthCheckAgentJobOptions) SetAgentID(agentID string) *GetHealthCheckAgentJobOptions
  • func (options *GetHealthCheckAgentJobOptions) SetHeaders(param map[string]string) *GetHealthCheckAgentJobOptions
• type GetInventoryOptions
  • func (options *GetInventoryOptions) SetHeaders(param map[string]string) *GetInventoryOptions
  • func (_options *GetInventoryOptions) SetInventoryID(inventoryID string) *GetInventoryOptions
  • func (_options *GetInventoryOptions) SetProfile(profile string) *GetInventoryOptions
• type GetJobFilesOptions
  • func (_options *GetJobFilesOptions) SetFileType(fileType string) *GetJobFilesOptions
  • func (options *GetJobFilesOptions) SetHeaders(param map[string]string) *GetJobFilesOptions
  • func (_options *GetJobFilesOptions) SetJobID(jobID string) *GetJobFilesOptions
• type GetJobOptions
  • func (options *GetJobOptions) SetHeaders(param map[string]string) *GetJobOptions
  • func (_options *GetJobOptions) SetJobID(jobID string) *GetJobOptions
  • func (_options *GetJobOptions) SetProfile(profile string) *GetJobOptions
• type GetKmsSettingsOptions
  • func (options *GetKmsSettingsOptions) SetHeaders(param map[string]string) *GetKmsSettingsOptions
  • func (_options *GetKmsSettingsOptions) SetLocation(location string) *GetKmsSettingsOptions
• type GetPolicyOptions
  • func (options *GetPolicyOptions) SetHeaders(param map[string]string) *GetPolicyOptions
  • func (_options *GetPolicyOptions) SetPolicyID(policyID string) *GetPolicyOptions
  • func (_options *GetPolicyOptions) SetProfile(profile string) *GetPolicyOptions
• type GetPrsAgentJobOptions
  • func (_options *GetPrsAgentJobOptions) SetAgentID(agentID string) *GetPrsAgentJobOptions
  • func (options *GetPrsAgentJobOptions) SetHeaders(param map[string]string) *GetPrsAgentJobOptions
• type GetResourcesQueryOptions
  • func (options *GetResourcesQueryOptions) SetHeaders(param map[string]string) *GetResourcesQueryOptions
  • func (_options *GetResourcesQueryOptions) SetQueryID(queryID string) *GetResourcesQueryOptions
• type GetSchematicsVersionOptions
  • func (options *GetSchematicsVersionOptions) SetHeaders(param map[string]string) *GetSchematicsVersionOptions
• type GetTemplateActivityLogOptions
  • func (_options *GetTemplateActivityLogOptions) SetActivityID(activityID string) *GetTemplateActivityLogOptions
  • func (options *GetTemplateActivityLogOptions) SetHeaders(param map[string]string) *GetTemplateActivityLogOptions
  • func (_options *GetTemplateActivityLogOptions) SetLogTfAnsible(logTfAnsible bool) *GetTemplateActivityLogOptions
  • func (_options *GetTemplateActivityLogOptions) SetLogTfCmd(logTfCmd bool) *GetTemplateActivityLogOptions
  • func (_options *GetTemplateActivityLogOptions) SetLogTfNullResource(logTfNullResource bool) *GetTemplateActivityLogOptions
  • func (_options *GetTemplateActivityLogOptions) SetLogTfPrefix(logTfPrefix bool) *GetTemplateActivityLogOptions
  • func (_options *GetTemplateActivityLogOptions) SetTID(tID string) *GetTemplateActivityLogOptions
  • func (_options *GetTemplateActivityLogOptions) SetWID(wID string) *GetTemplateActivityLogOptions
• type GetTemplateLogsOptions
  • func (options *GetTemplateLogsOptions) SetHeaders(param map[string]string) *GetTemplateLogsOptions
  • func (_options *GetTemplateLogsOptions) SetLogTfAnsible(logTfAnsible bool) *GetTemplateLogsOptions
  • func (_options *GetTemplateLogsOptions) SetLogTfCmd(logTfCmd bool) *GetTemplateLogsOptions
  • func (_options *GetTemplateLogsOptions) SetLogTfNullResource(logTfNullResource bool) *GetTemplateLogsOptions
  • func (_options *GetTemplateLogsOptions) SetLogTfPrefix(logTfPrefix bool) *GetTemplateLogsOptions
  • func (_options *GetTemplateLogsOptions) SetTID(tID string) *GetTemplateLogsOptions
  • func (_options *GetTemplateLogsOptions) SetWID(wID string) *GetTemplateLogsOptions
• type GetWorkspaceActivityLogsOptions
  • func (_options *GetWorkspaceActivityLogsOptions) SetActivityID(activityID string) *GetWorkspaceActivityLogsOptions
  • func (options *GetWorkspaceActivityLogsOptions) SetHeaders(param map[string]string) *GetWorkspaceActivityLogsOptions
  • func (_options *GetWorkspaceActivityLogsOptions) SetWID(wID string) *GetWorkspaceActivityLogsOptions
• type GetWorkspaceActivityOptions
  • func (_options *GetWorkspaceActivityOptions) SetActivityID(activityID string) *GetWorkspaceActivityOptions
  • func (options *GetWorkspaceActivityOptions) SetHeaders(param map[string]string) *GetWorkspaceActivityOptions
  • func (_options *GetWorkspaceActivityOptions) SetWID(wID string) *GetWorkspaceActivityOptions
• type GetWorkspaceDeletionJobStatusOptions
  • func (options *GetWorkspaceDeletionJobStatusOptions) SetHeaders(param map[string]string) *GetWorkspaceDeletionJobStatusOptions
  • func (_options *GetWorkspaceDeletionJobStatusOptions) SetWjID(wjID string) *GetWorkspaceDeletionJobStatusOptions
• type GetWorkspaceInputMetadataOptions
  • func (options *GetWorkspaceInputMetadataOptions) SetHeaders(param map[string]string) *GetWorkspaceInputMetadataOptions
  • func (_options *GetWorkspaceInputMetadataOptions) SetTID(tID string) *GetWorkspaceInputMetadataOptions
  • func (_options *GetWorkspaceInputMetadataOptions) SetWID(wID string) *GetWorkspaceInputMetadataOptions
• type GetWorkspaceInputsOptions
  • func (options *GetWorkspaceInputsOptions) SetHeaders(param map[string]string) *GetWorkspaceInputsOptions
  • func (_options *GetWorkspaceInputsOptions) SetTID(tID string) *GetWorkspaceInputsOptions
  • func (_options *GetWorkspaceInputsOptions) SetWID(wID string) *GetWorkspaceInputsOptions
• type GetWorkspaceLogUrlsOptions
  • func (options *GetWorkspaceLogUrlsOptions) SetHeaders(param map[string]string) *GetWorkspaceLogUrlsOptions
  • func (_options *GetWorkspaceLogUrlsOptions) SetWID(wID string) *GetWorkspaceLogUrlsOptions
• type GetWorkspaceOptions
  • func (options *GetWorkspaceOptions) SetHeaders(param map[string]string) *GetWorkspaceOptions
  • func (_options *GetWorkspaceOptions) SetWID(wID string) *GetWorkspaceOptions
• type GetWorkspaceOutputsOptions
  • func (options *GetWorkspaceOutputsOptions) SetHeaders(param map[string]string) *GetWorkspaceOutputsOptions
  • func (_options *GetWorkspaceOutputsOptions) SetWID(wID string) *GetWorkspaceOutputsOptions
• type GetWorkspaceReadmeOptions
  • func (_options *GetWorkspaceReadmeOptions) SetFormatted(formatted string) *GetWorkspaceReadmeOptions
  • func (options *GetWorkspaceReadmeOptions) SetHeaders(param map[string]string) *GetWorkspaceReadmeOptions
  • func (_options *GetWorkspaceReadmeOptions) SetRef(ref string) *GetWorkspaceReadmeOptions
  • func (_options *GetWorkspaceReadmeOptions) SetWID(wID string) *GetWorkspaceReadmeOptions
• type GetWorkspaceResourcesOptions
  • func (options *GetWorkspaceResourcesOptions) SetHeaders(param map[string]string) *GetWorkspaceResourcesOptions
  • func (_options *GetWorkspaceResourcesOptions) SetWID(wID string) *GetWorkspaceResourcesOptions
• type GetWorkspaceStateOptions
  • func (options *GetWorkspaceStateOptions) SetHeaders(param map[string]string) *GetWorkspaceStateOptions
  • func (_options *GetWorkspaceStateOptions) SetWID(wID string) *GetWorkspaceStateOptions
• type GetWorkspaceTemplateStateOptions
  • func (options *GetWorkspaceTemplateStateOptions) SetHeaders(param map[string]string) *GetWorkspaceTemplateStateOptions
  • func (_options *GetWorkspaceTemplateStateOptions) SetTID(tID string) *GetWorkspaceTemplateStateOptions
  • func (_options *GetWorkspaceTemplateStateOptions) SetWID(wID string) *GetWorkspaceTemplateStateOptions
• type GitSource
• type HealthCheckAgentJobOptions
  • func (_options *HealthCheckAgentJobOptions) SetAgentID(agentID string) *HealthCheckAgentJobOptions
  • func (_options *HealthCheckAgentJobOptions) SetForce(force bool) *HealthCheckAgentJobOptions
  • func (options *HealthCheckAgentJobOptions) SetHeaders(param map[string]string) *HealthCheckAgentJobOptions
• type InjectTerraformTemplateInner
• type InjectTerraformTemplateInnerTftParametersItem
• type InventoryResourceRecord
• type InventoryResourceRecordList
• type Job
• type JobData
• type JobDataAction
• type JobDataFlow
• type JobDataSystem
• type JobDataTemplate
• type JobDataWorkItem
• type JobDataWorkItemLastJob
• type JobDataWorkspace
• type JobFileContent
• type JobFileData
• type JobFileDataSummary
• type JobList
• type JobLite
• type JobLog
• type JobLogSummary
• type JobLogSummaryActionJob
• type JobLogSummaryActionJobRecap
• type JobLogSummaryFlowJob
• type JobLogSummaryLogErrors
• type JobLogSummaryRepoDownloadJob
• type JobLogSummarySystemJob
• type JobLogSummaryWorkitems
• type JobLogSummaryWorkspaceJob
• type JobStatus
• type JobStatusAction
• type JobStatusFlow
• type JobStatusSchematicsResources
• type JobStatusSystem
• type JobStatusTemplate
• type JobStatusWorkitem
• type JobStatusWorkspace
• type KMSDiscovery
• type KMSInstances
• type KMSInstancesKeys
• type KMSSettings
• type KMSSettingsPrimaryCrk
• type KMSSettingsSecondaryCrk
• type LastJob
• type ListActionsOptions
  • func (options *ListActionsOptions) SetHeaders(param map[string]string) *ListActionsOptions
  • func (_options *ListActionsOptions) SetLimit(limit int64) *ListActionsOptions
  • func (_options *ListActionsOptions) SetOffset(offset int64) *ListActionsOptions
  • func (_options *ListActionsOptions) SetProfile(profile string) *ListActionsOptions
  • func (_options *ListActionsOptions) SetSort(sort string) *ListActionsOptions
• type ListAgentDataOptions
  • func (_options *ListAgentDataOptions) SetFilter(filter string) *ListAgentDataOptions
  • func (options *ListAgentDataOptions) SetHeaders(param map[string]string) *ListAgentDataOptions
  • func (_options *ListAgentDataOptions) SetLimit(limit int64) *ListAgentDataOptions
  • func (_options *ListAgentDataOptions) SetOffset(offset int64) *ListAgentDataOptions
  • func (_options *ListAgentDataOptions) SetProfile(profile string) *ListAgentDataOptions
• type ListAgentOptions
  • func (_options *ListAgentOptions) SetFilter(filter string) *ListAgentOptions
  • func (options *ListAgentOptions) SetHeaders(param map[string]string) *ListAgentOptions
  • func (_options *ListAgentOptions) SetLimit(limit int64) *ListAgentOptions
  • func (_options *ListAgentOptions) SetOffset(offset int64) *ListAgentOptions
  • func (_options *ListAgentOptions) SetProfile(profile string) *ListAgentOptions
• type ListInventoriesOptions
  • func (options *ListInventoriesOptions) SetHeaders(param map[string]string) *ListInventoriesOptions
  • func (_options *ListInventoriesOptions) SetLimit(limit int64) *ListInventoriesOptions
  • func (_options *ListInventoriesOptions) SetOffset(offset int64) *ListInventoriesOptions
  • func (_options *ListInventoriesOptions) SetProfile(profile string) *ListInventoriesOptions
  • func (_options *ListInventoriesOptions) SetSort(sort string) *ListInventoriesOptions
• type ListJobLogsOptions
  • func (options *ListJobLogsOptions) SetHeaders(param map[string]string) *ListJobLogsOptions
  • func (_options *ListJobLogsOptions) SetJobID(jobID string) *ListJobLogsOptions
• type ListJobsOptions
  • func (_options *ListJobsOptions) SetActionID(actionID string) *ListJobsOptions
  • func (options *ListJobsOptions) SetHeaders(param map[string]string) *ListJobsOptions
  • func (_options *ListJobsOptions) SetLimit(limit int64) *ListJobsOptions
  • func (_options *ListJobsOptions) SetList(list string) *ListJobsOptions
  • func (_options *ListJobsOptions) SetOffset(offset int64) *ListJobsOptions
  • func (_options *ListJobsOptions) SetProfile(profile string) *ListJobsOptions
  • func (_options *ListJobsOptions) SetResource(resource string) *ListJobsOptions
  • func (_options *ListJobsOptions) SetResourceID(resourceID string) *ListJobsOptions
  • func (_options *ListJobsOptions) SetSort(sort string) *ListJobsOptions
  • func (_options *ListJobsOptions) SetWorkspaceID(workspaceID string) *ListJobsOptions
• type ListKmsOptions
  • func (_options *ListKmsOptions) SetEncryptionScheme(encryptionScheme string) *ListKmsOptions
  • func (options *ListKmsOptions) SetHeaders(param map[string]string) *ListKmsOptions
  • func (_options *ListKmsOptions) SetLimit(limit int64) *ListKmsOptions
  • func (_options *ListKmsOptions) SetLocation(location string) *ListKmsOptions
  • func (_options *ListKmsOptions) SetResourceGroup(resourceGroup string) *ListKmsOptions
  • func (_options *ListKmsOptions) SetSort(sort string) *ListKmsOptions
• type ListLocationsOptions
  • func (options *ListLocationsOptions) SetHeaders(param map[string]string) *ListLocationsOptions
• type ListPolicyOptions
  • func (options *ListPolicyOptions) SetHeaders(param map[string]string) *ListPolicyOptions
  • func (_options *ListPolicyOptions) SetLimit(limit int64) *ListPolicyOptions
  • func (_options *ListPolicyOptions) SetOffset(offset int64) *ListPolicyOptions
  • func (_options *ListPolicyOptions) SetProfile(profile string) *ListPolicyOptions
• type ListResourceGroupOptions
  • func (options *ListResourceGroupOptions) SetHeaders(param map[string]string) *ListResourceGroupOptions
• type ListResourceQueryOptions
  • func (options *ListResourceQueryOptions) SetHeaders(param map[string]string) *ListResourceQueryOptions
  • func (_options *ListResourceQueryOptions) SetLimit(limit int64) *ListResourceQueryOptions
  • func (_options *ListResourceQueryOptions) SetOffset(offset int64) *ListResourceQueryOptions
  • func (_options *ListResourceQueryOptions) SetProfile(profile string) *ListResourceQueryOptions
  • func (_options *ListResourceQueryOptions) SetSort(sort string) *ListResourceQueryOptions
• type ListSchematicsLocationOptions
  • func (options *ListSchematicsLocationOptions) SetHeaders(param map[string]string) *ListSchematicsLocationOptions
• type ListWorkspaceActivitiesOptions
  • func (options *ListWorkspaceActivitiesOptions) SetHeaders(param map[string]string) *ListWorkspaceActivitiesOptions
  • func (_options *ListWorkspaceActivitiesOptions) SetLimit(limit int64) *ListWorkspaceActivitiesOptions
  • func (_options *ListWorkspaceActivitiesOptions) SetOffset(offset int64) *ListWorkspaceActivitiesOptions
  • func (_options *ListWorkspaceActivitiesOptions) SetWID(wID string) *ListWorkspaceActivitiesOptions
• type ListWorkspacesOptions
  • func (options *ListWorkspacesOptions) SetHeaders(param map[string]string) *ListWorkspacesOptions
  • func (_options *ListWorkspacesOptions) SetLimit(limit int64) *ListWorkspacesOptions
  • func (_options *ListWorkspacesOptions) SetOffset(offset int64) *ListWorkspacesOptions
  • func (_options *ListWorkspacesOptions) SetProfile(profile string) *ListWorkspacesOptions
  • func (_options *ListWorkspacesOptions) SetResourceGroup(resourceGroup string) *ListWorkspacesOptions
• type LogStoreResponse
• type LogStoreResponseList
• type LogSummary
• type OutputValuesInner
• type PlanWorkspaceCommandOptions
  • func (_options *PlanWorkspaceCommandOptions) SetActionOptions(actionOptions *WorkspaceActivityOptionsTemplate) *PlanWorkspaceCommandOptions
  • func (_options *PlanWorkspaceCommandOptions) SetDelegatedToken(delegatedToken string) *PlanWorkspaceCommandOptions
  • func (options *PlanWorkspaceCommandOptions) SetHeaders(param map[string]string) *PlanWorkspaceCommandOptions
  • func (_options *PlanWorkspaceCommandOptions) SetRefreshToken(refreshToken string) *PlanWorkspaceCommandOptions
  • func (_options *PlanWorkspaceCommandOptions) SetWID(wID string) *PlanWorkspaceCommandOptions
• type Policy
• type PolicyList
• type PolicyLite
• type PolicyObjectSelector
• type PolicyObjects
• type PolicyParameter
• type ProcessTemplateMetaDataOptions
  • func (options *ProcessTemplateMetaDataOptions) SetHeaders(param map[string]string) *ProcessTemplateMetaDataOptions
  • func (_options *ProcessTemplateMetaDataOptions) SetRegion(region string) *ProcessTemplateMetaDataOptions
  • func (_options *ProcessTemplateMetaDataOptions) SetSource(source *ExternalSource) *ProcessTemplateMetaDataOptions
  • func (_options *ProcessTemplateMetaDataOptions) SetSourceType(sourceType string) *ProcessTemplateMetaDataOptions
  • func (_options *ProcessTemplateMetaDataOptions) SetTemplateType(templateType string) *ProcessTemplateMetaDataOptions
  • func (_options *ProcessTemplateMetaDataOptions) SetXGithubToken(xGithubToken string) *ProcessTemplateMetaDataOptions
• type PrsAgentJobOptions
  • func (_options *PrsAgentJobOptions) SetAgentID(agentID string) *PrsAgentJobOptions
  • func (_options *PrsAgentJobOptions) SetForce(force bool) *PrsAgentJobOptions
  • func (options *PrsAgentJobOptions) SetHeaders(param map[string]string) *PrsAgentJobOptions
• type RefreshWorkspaceCommandOptions
  • func (_options *RefreshWorkspaceCommandOptions) SetDelegatedToken(delegatedToken string) *RefreshWorkspaceCommandOptions
  • func (options *RefreshWorkspaceCommandOptions) SetHeaders(param map[string]string) *RefreshWorkspaceCommandOptions
  • func (_options *RefreshWorkspaceCommandOptions) SetRefreshToken(refreshToken string) *RefreshWorkspaceCommandOptions
  • func (_options *RefreshWorkspaceCommandOptions) SetWID(wID string) *RefreshWorkspaceCommandOptions
• type RegisterAgentOptions
  • func (_options *RegisterAgentOptions) SetAgentLocation(agentLocation string) *RegisterAgentOptions
  • func (_options *RegisterAgentOptions) SetDescription(description string) *RegisterAgentOptions
  • func (options *RegisterAgentOptions) SetHeaders(param map[string]string) *RegisterAgentOptions
  • func (_options *RegisterAgentOptions) SetLocation(location string) *RegisterAgentOptions
  • func (_options *RegisterAgentOptions) SetName(name string) *RegisterAgentOptions
  • func (_options *RegisterAgentOptions) SetProfileID(profileID string) *RegisterAgentOptions
  • func (_options *RegisterAgentOptions) SetResourceGroup(resourceGroup string) *RegisterAgentOptions
  • func (_options *RegisterAgentOptions) SetTags(tags []string) *RegisterAgentOptions
  • func (_options *RegisterAgentOptions) SetUserState(userState *AgentUserState) *RegisterAgentOptions
• type ReplaceInventoryOptions
  • func (_options *ReplaceInventoryOptions) SetDescription(description string) *ReplaceInventoryOptions
  • func (options *ReplaceInventoryOptions) SetHeaders(param map[string]string) *ReplaceInventoryOptions
  • func (_options *ReplaceInventoryOptions) SetInventoriesIni(inventoriesIni string) *ReplaceInventoryOptions
  • func (_options *ReplaceInventoryOptions) SetInventoryID(inventoryID string) *ReplaceInventoryOptions
  • func (_options *ReplaceInventoryOptions) SetLocation(location string) *ReplaceInventoryOptions
  • func (_options *ReplaceInventoryOptions) SetName(name string) *ReplaceInventoryOptions
  • func (_options *ReplaceInventoryOptions) SetResourceGroup(resourceGroup string) *ReplaceInventoryOptions
  • func (_options *ReplaceInventoryOptions) SetResourceQueries(resourceQueries []string) *ReplaceInventoryOptions
• type ReplaceResourcesQueryOptions
  • func (options *ReplaceResourcesQueryOptions) SetHeaders(param map[string]string) *ReplaceResourcesQueryOptions
  • func (_options *ReplaceResourcesQueryOptions) SetName(name string) *ReplaceResourcesQueryOptions
  • func (_options *ReplaceResourcesQueryOptions) SetQueries(queries []ResourceQuery) *ReplaceResourcesQueryOptions
  • func (_options *ReplaceResourcesQueryOptions) SetQueryID(queryID string) *ReplaceResourcesQueryOptions
  • func (_options *ReplaceResourcesQueryOptions) SetType(typeVar string) *ReplaceResourcesQueryOptions
• type ReplaceWorkspaceInputsOptions
  • func (_options *ReplaceWorkspaceInputsOptions) SetEnvValues(envValues []map[string]interface{}) *ReplaceWorkspaceInputsOptions
  • func (options *ReplaceWorkspaceInputsOptions) SetHeaders(param map[string]string) *ReplaceWorkspaceInputsOptions
  • func (_options *ReplaceWorkspaceInputsOptions) SetTID(tID string) *ReplaceWorkspaceInputsOptions
  • func (_options *ReplaceWorkspaceInputsOptions) SetValues(values string) *ReplaceWorkspaceInputsOptions
  • func (_options *ReplaceWorkspaceInputsOptions) SetVariablestore(variablestore []WorkspaceVariableRequest) *ReplaceWorkspaceInputsOptions
  • func (_options *ReplaceWorkspaceInputsOptions) SetWID(wID string) *ReplaceWorkspaceInputsOptions
• type ReplaceWorkspaceOptions
  • func (_options *ReplaceWorkspaceOptions) SetAgentID(agentID string) *ReplaceWorkspaceOptions
  • func (_options *ReplaceWorkspaceOptions) SetCatalogRef(catalogRef *CatalogRef) *ReplaceWorkspaceOptions
  • func (_options *ReplaceWorkspaceOptions) SetDependencies(dependencies *Dependencies) *ReplaceWorkspaceOptions
  • func (_options *ReplaceWorkspaceOptions) SetDescription(description string) *ReplaceWorkspaceOptions
  • func (options *ReplaceWorkspaceOptions) SetHeaders(param map[string]string) *ReplaceWorkspaceOptions
  • func (_options *ReplaceWorkspaceOptions) SetName(name string) *ReplaceWorkspaceOptions
  • func (_options *ReplaceWorkspaceOptions) SetSettings(settings []VariableData) *ReplaceWorkspaceOptions
  • func (_options *ReplaceWorkspaceOptions) SetSharedData(sharedData *SharedTargetData) *ReplaceWorkspaceOptions
  • func (_options *ReplaceWorkspaceOptions) SetTags(tags []string) *ReplaceWorkspaceOptions
  • func (_options *ReplaceWorkspaceOptions) SetTemplateData(templateData []TemplateSourceDataRequest) *ReplaceWorkspaceOptions
  • func (_options *ReplaceWorkspaceOptions) SetTemplateRepo(templateRepo *TemplateRepoUpdateRequest) *ReplaceWorkspaceOptions
  • func (_options *ReplaceWorkspaceOptions) SetType(typeVar []string) *ReplaceWorkspaceOptions
  • func (_options *ReplaceWorkspaceOptions) SetWID(wID string) *ReplaceWorkspaceOptions
  • func (_options *ReplaceWorkspaceOptions) SetWorkspaceStatus(workspaceStatus *WorkspaceStatusUpdateRequest) *ReplaceWorkspaceOptions
  • func (_options *ReplaceWorkspaceOptions) SetWorkspaceStatusMsg(workspaceStatusMsg *WorkspaceStatusMessage) *ReplaceWorkspaceOptions
  • func (_options *ReplaceWorkspaceOptions) SetXGithubToken(xGithubToken string) *ReplaceWorkspaceOptions
• type ResourceGroupResponse
• type ResourceQuery
• type ResourceQueryParam
• type ResourceQueryRecord
• type ResourceQueryRecordList
• type ResourceQueryResponseRecord
• type ResourceQueryResponseRecordQueryOutput
• type ResourceQueryResponseRecordResponse
• type RunWorkspaceCommandsOptions
  • func (_options *RunWorkspaceCommandsOptions) SetCommands(commands []TerraformCommand) *RunWorkspaceCommandsOptions
  • func (_options *RunWorkspaceCommandsOptions) SetDescription(description string) *RunWorkspaceCommandsOptions
  • func (options *RunWorkspaceCommandsOptions) SetHeaders(param map[string]string) *RunWorkspaceCommandsOptions
  • func (_options *RunWorkspaceCommandsOptions) SetOperationName(operationName string) *RunWorkspaceCommandsOptions
  • func (_options *RunWorkspaceCommandsOptions) SetRefreshToken(refreshToken string) *RunWorkspaceCommandsOptions
  • func (_options *RunWorkspaceCommandsOptions) SetWID(wID string) *RunWorkspaceCommandsOptions
• type SchematicsLocations
• type SchematicsLocationsList
• type SchematicsLocationsLite
• type SchematicsV1
  • func NewSchematicsV1(options *SchematicsV1Options) (service *SchematicsV1, err error)
  • func NewSchematicsV1UsingExternalConfig(options *SchematicsV1Options) (schematics *SchematicsV1, err error)
  • func (schematics *SchematicsV1) ApplyWorkspaceCommand(applyWorkspaceCommandOptions *ApplyWorkspaceCommandOptions) (result *WorkspaceActivityApplyResult, response *core.DetailedResponse, ...)
  • func (schematics *SchematicsV1) ApplyWorkspaceCommandWithContext(ctx context.Context, ...) (result *WorkspaceActivityApplyResult, response *core.DetailedResponse, ...)
  • func (schematics *SchematicsV1) Clone() *SchematicsV1
  • func (schematics *SchematicsV1) CreateAction(createActionOptions *CreateActionOptions) (result *Action, response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) CreateActionWithContext(ctx context.Context, createActionOptions *CreateActionOptions) (result *Action, response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) CreateAgentData(createAgentDataOptions *CreateAgentDataOptions) (result *AgentData, response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) CreateAgentDataWithContext(ctx context.Context, createAgentDataOptions *CreateAgentDataOptions) (result *AgentData, response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) CreateInventory(createInventoryOptions *CreateInventoryOptions) (result *InventoryResourceRecord, response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) CreateInventoryWithContext(ctx context.Context, createInventoryOptions *CreateInventoryOptions) (result *InventoryResourceRecord, response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) CreateJob(createJobOptions *CreateJobOptions) (result *Job, response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) CreateJobWithContext(ctx context.Context, createJobOptions *CreateJobOptions) (result *Job, response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) CreatePolicy(createPolicyOptions *CreatePolicyOptions) (result *Policy, response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) CreatePolicyWithContext(ctx context.Context, createPolicyOptions *CreatePolicyOptions) (result *Policy, response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) CreateResourceQuery(createResourceQueryOptions *CreateResourceQueryOptions) (result *ResourceQueryRecord, response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) CreateResourceQueryWithContext(ctx context.Context, createResourceQueryOptions *CreateResourceQueryOptions) (result *ResourceQueryRecord, response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) CreateWorkspace(createWorkspaceOptions *CreateWorkspaceOptions) (result *WorkspaceResponse, response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) CreateWorkspaceDeletionJob(createWorkspaceDeletionJobOptions *CreateWorkspaceDeletionJobOptions) (result *WorkspaceBulkDeleteResponse, response *core.DetailedResponse, ...)
  • func (schematics *SchematicsV1) CreateWorkspaceDeletionJobWithContext(ctx context.Context, ...) (result *WorkspaceBulkDeleteResponse, response *core.DetailedResponse, ...)
  • func (schematics *SchematicsV1) CreateWorkspaceWithContext(ctx context.Context, createWorkspaceOptions *CreateWorkspaceOptions) (result *WorkspaceResponse, response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) DeleteAction(deleteActionOptions *DeleteActionOptions) (response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) DeleteActionWithContext(ctx context.Context, deleteActionOptions *DeleteActionOptions) (response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) DeleteAgent(deleteAgentOptions *DeleteAgentOptions) (response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) DeleteAgentData(deleteAgentDataOptions *DeleteAgentDataOptions) (response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) DeleteAgentDataWithContext(ctx context.Context, deleteAgentDataOptions *DeleteAgentDataOptions) (response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) DeleteAgentResources(deleteAgentResourcesOptions *DeleteAgentResourcesOptions) (response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) DeleteAgentResourcesWithContext(ctx context.Context, deleteAgentResourcesOptions *DeleteAgentResourcesOptions) (response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) DeleteAgentWithContext(ctx context.Context, deleteAgentOptions *DeleteAgentOptions) (response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) DeleteInventory(deleteInventoryOptions *DeleteInventoryOptions) (response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) DeleteInventoryWithContext(ctx context.Context, deleteInventoryOptions *DeleteInventoryOptions) (response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) DeleteJob(deleteJobOptions *DeleteJobOptions) (response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) DeleteJobWithContext(ctx context.Context, deleteJobOptions *DeleteJobOptions) (response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) DeletePolicy(deletePolicyOptions *DeletePolicyOptions) (response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) DeletePolicyWithContext(ctx context.Context, deletePolicyOptions *DeletePolicyOptions) (response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) DeleteResourcesQuery(deleteResourcesQueryOptions *DeleteResourcesQueryOptions) (response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) DeleteResourcesQueryWithContext(ctx context.Context, deleteResourcesQueryOptions *DeleteResourcesQueryOptions) (response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) DeleteWorkspace(deleteWorkspaceOptions *DeleteWorkspaceOptions) (result *string, response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) DeleteWorkspaceActivity(deleteWorkspaceActivityOptions *DeleteWorkspaceActivityOptions) (result *WorkspaceActivityApplyResult, response *core.DetailedResponse, ...)
  • func (schematics *SchematicsV1) DeleteWorkspaceActivityWithContext(ctx context.Context, ...) (result *WorkspaceActivityApplyResult, response *core.DetailedResponse, ...)
  • func (schematics *SchematicsV1) DeleteWorkspaceWithContext(ctx context.Context, deleteWorkspaceOptions *DeleteWorkspaceOptions) (result *string, response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) DeployAgentJob(deployAgentJobOptions *DeployAgentJobOptions) (result *AgentDeployJob, response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) DeployAgentJobWithContext(ctx context.Context, deployAgentJobOptions *DeployAgentJobOptions) (result *AgentDeployJob, response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) DestroyWorkspaceCommand(destroyWorkspaceCommandOptions *DestroyWorkspaceCommandOptions) (result *WorkspaceActivityDestroyResult, response *core.DetailedResponse, ...)
  • func (schematics *SchematicsV1) DestroyWorkspaceCommandWithContext(ctx context.Context, ...) (result *WorkspaceActivityDestroyResult, response *core.DetailedResponse, ...)
  • func (schematics *SchematicsV1) DisableRetries()
  • func (schematics *SchematicsV1) EnableRetries(maxRetries int, maxRetryInterval time.Duration)
  • func (schematics *SchematicsV1) ExecuteResourceQuery(executeResourceQueryOptions *ExecuteResourceQueryOptions) (result *ResourceQueryResponseRecord, response *core.DetailedResponse, ...)
  • func (schematics *SchematicsV1) ExecuteResourceQueryWithContext(ctx context.Context, executeResourceQueryOptions *ExecuteResourceQueryOptions) (result *ResourceQueryResponseRecord, response *core.DetailedResponse, ...)
  • func (schematics *SchematicsV1) GetAction(getActionOptions *GetActionOptions) (result *Action, response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) GetActionWithContext(ctx context.Context, getActionOptions *GetActionOptions) (result *Action, response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) GetAgent(getAgentOptions *GetAgentOptions) (result *Agent, response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) GetAgentData(getAgentDataOptions *GetAgentDataOptions) (result *AgentData, response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) GetAgentDataWithContext(ctx context.Context, getAgentDataOptions *GetAgentDataOptions) (result *AgentData, response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) GetAgentVersions(getAgentVersionsOptions *GetAgentVersionsOptions) (result *AgentVersions, response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) GetAgentVersionsWithContext(ctx context.Context, getAgentVersionsOptions *GetAgentVersionsOptions) (result *AgentVersions, response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) GetAgentWithContext(ctx context.Context, getAgentOptions *GetAgentOptions) (result *Agent, response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) GetAllWorkspaceInputs(getAllWorkspaceInputsOptions *GetAllWorkspaceInputsOptions) (result *WorkspaceTemplateValuesResponse, response *core.DetailedResponse, ...)
  • func (schematics *SchematicsV1) GetAllWorkspaceInputsWithContext(ctx context.Context, ...) (result *WorkspaceTemplateValuesResponse, response *core.DetailedResponse, ...)
  • func (schematics *SchematicsV1) GetDeployAgentJob(getDeployAgentJobOptions *GetDeployAgentJobOptions) (result *AgentDeployJob, response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) GetDeployAgentJobWithContext(ctx context.Context, getDeployAgentJobOptions *GetDeployAgentJobOptions) (result *AgentDeployJob, response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) GetEnableGzipCompression() bool
  • func (schematics *SchematicsV1) GetHealthCheckAgentJob(getHealthCheckAgentJobOptions *GetHealthCheckAgentJobOptions) (result *AgentHealthJob, response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) GetHealthCheckAgentJobWithContext(ctx context.Context, ...) (result *AgentHealthJob, response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) GetInventory(getInventoryOptions *GetInventoryOptions) (result *InventoryResourceRecord, response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) GetInventoryWithContext(ctx context.Context, getInventoryOptions *GetInventoryOptions) (result *InventoryResourceRecord, response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) GetJob(getJobOptions *GetJobOptions) (result *Job, response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) GetJobFiles(getJobFilesOptions *GetJobFilesOptions) (result *JobFileData, response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) GetJobFilesWithContext(ctx context.Context, getJobFilesOptions *GetJobFilesOptions) (result *JobFileData, response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) GetJobWithContext(ctx context.Context, getJobOptions *GetJobOptions) (result *Job, response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) GetKmsSettings(getKmsSettingsOptions *GetKmsSettingsOptions) (result *KMSSettings, response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) GetKmsSettingsWithContext(ctx context.Context, getKmsSettingsOptions *GetKmsSettingsOptions) (result *KMSSettings, response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) GetPolicy(getPolicyOptions *GetPolicyOptions) (result *Policy, response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) GetPolicyWithContext(ctx context.Context, getPolicyOptions *GetPolicyOptions) (result *Policy, response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) GetPrsAgentJob(getPrsAgentJobOptions *GetPrsAgentJobOptions) (result *AgentPRSJob, response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) GetPrsAgentJobWithContext(ctx context.Context, getPrsAgentJobOptions *GetPrsAgentJobOptions) (result *AgentPRSJob, response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) GetResourcesQuery(getResourcesQueryOptions *GetResourcesQueryOptions) (result *ResourceQueryRecord, response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) GetResourcesQueryWithContext(ctx context.Context, getResourcesQueryOptions *GetResourcesQueryOptions) (result *ResourceQueryRecord, response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) GetSchematicsVersion(getSchematicsVersionOptions *GetSchematicsVersionOptions) (result *VersionResponse, response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) GetSchematicsVersionWithContext(ctx context.Context, getSchematicsVersionOptions *GetSchematicsVersionOptions) (result *VersionResponse, response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) GetServiceURL() string
  • func (schematics *SchematicsV1) GetTemplateActivityLog(getTemplateActivityLogOptions *GetTemplateActivityLogOptions) (result *string, response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) GetTemplateActivityLogWithContext(ctx context.Context, ...) (result *string, response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) GetTemplateLogs(getTemplateLogsOptions *GetTemplateLogsOptions) (result *string, response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) GetTemplateLogsWithContext(ctx context.Context, getTemplateLogsOptions *GetTemplateLogsOptions) (result *string, response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) GetWorkspace(getWorkspaceOptions *GetWorkspaceOptions) (result *WorkspaceResponse, response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) GetWorkspaceActivity(getWorkspaceActivityOptions *GetWorkspaceActivityOptions) (result *WorkspaceActivity, response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) GetWorkspaceActivityLogs(getWorkspaceActivityLogsOptions *GetWorkspaceActivityLogsOptions) (result *WorkspaceActivityLogs, response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) GetWorkspaceActivityLogsWithContext(ctx context.Context, ...) (result *WorkspaceActivityLogs, response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) GetWorkspaceActivityWithContext(ctx context.Context, getWorkspaceActivityOptions *GetWorkspaceActivityOptions) (result *WorkspaceActivity, response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) GetWorkspaceDeletionJobStatus(getWorkspaceDeletionJobStatusOptions *GetWorkspaceDeletionJobStatusOptions) (result *WorkspaceJobResponse, response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) GetWorkspaceDeletionJobStatusWithContext(ctx context.Context, ...) (result *WorkspaceJobResponse, response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) GetWorkspaceInputMetadata(getWorkspaceInputMetadataOptions *GetWorkspaceInputMetadataOptions) (result []map[string]interface{}, response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) GetWorkspaceInputMetadataWithContext(ctx context.Context, ...) (result []map[string]interface{}, response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) GetWorkspaceInputs(getWorkspaceInputsOptions *GetWorkspaceInputsOptions) (result *TemplateValues, response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) GetWorkspaceInputsWithContext(ctx context.Context, getWorkspaceInputsOptions *GetWorkspaceInputsOptions) (result *TemplateValues, response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) GetWorkspaceLogUrls(getWorkspaceLogUrlsOptions *GetWorkspaceLogUrlsOptions) (result *LogStoreResponseList, response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) GetWorkspaceLogUrlsWithContext(ctx context.Context, getWorkspaceLogUrlsOptions *GetWorkspaceLogUrlsOptions) (result *LogStoreResponseList, response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) GetWorkspaceOutputs(getWorkspaceOutputsOptions *GetWorkspaceOutputsOptions) (result []OutputValuesInner, response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) GetWorkspaceOutputsWithContext(ctx context.Context, getWorkspaceOutputsOptions *GetWorkspaceOutputsOptions) (result []OutputValuesInner, response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) GetWorkspaceReadme(getWorkspaceReadmeOptions *GetWorkspaceReadmeOptions) (result *TemplateReadme, response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) GetWorkspaceReadmeWithContext(ctx context.Context, getWorkspaceReadmeOptions *GetWorkspaceReadmeOptions) (result *TemplateReadme, response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) GetWorkspaceResources(getWorkspaceResourcesOptions *GetWorkspaceResourcesOptions) (result []TemplateResources, response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) GetWorkspaceResourcesWithContext(ctx context.Context, ...) (result []TemplateResources, response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) GetWorkspaceState(getWorkspaceStateOptions *GetWorkspaceStateOptions) (result *StateStoreResponseList, response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) GetWorkspaceStateWithContext(ctx context.Context, getWorkspaceStateOptions *GetWorkspaceStateOptions) (result *StateStoreResponseList, response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) GetWorkspaceTemplateState(getWorkspaceTemplateStateOptions *GetWorkspaceTemplateStateOptions) (result *TemplateStateStore, response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) GetWorkspaceTemplateStateWithContext(ctx context.Context, ...) (result *TemplateStateStore, response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) GetWorkspaceWithContext(ctx context.Context, getWorkspaceOptions *GetWorkspaceOptions) (result *WorkspaceResponse, response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) HealthCheckAgentJob(healthCheckAgentJobOptions *HealthCheckAgentJobOptions) (result *AgentHealthJob, response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) HealthCheckAgentJobWithContext(ctx context.Context, healthCheckAgentJobOptions *HealthCheckAgentJobOptions) (result *AgentHealthJob, response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) ListActions(listActionsOptions *ListActionsOptions) (result *ActionList, response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) ListActionsWithContext(ctx context.Context, listActionsOptions *ListActionsOptions) (result *ActionList, response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) ListAgent(listAgentOptions *ListAgentOptions) (result *AgentList, response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) ListAgentData(listAgentDataOptions *ListAgentDataOptions) (result *AgentDataList, response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) ListAgentDataWithContext(ctx context.Context, listAgentDataOptions *ListAgentDataOptions) (result *AgentDataList, response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) ListAgentWithContext(ctx context.Context, listAgentOptions *ListAgentOptions) (result *AgentList, response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) ListInventories(listInventoriesOptions *ListInventoriesOptions) (result *InventoryResourceRecordList, response *core.DetailedResponse, ...)
  • func (schematics *SchematicsV1) ListInventoriesWithContext(ctx context.Context, listInventoriesOptions *ListInventoriesOptions) (result *InventoryResourceRecordList, response *core.DetailedResponse, ...)
  • func (schematics *SchematicsV1) ListJobLogs(listJobLogsOptions *ListJobLogsOptions) (result *JobLog, response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) ListJobLogsWithContext(ctx context.Context, listJobLogsOptions *ListJobLogsOptions) (result *JobLog, response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) ListJobs(listJobsOptions *ListJobsOptions) (result *JobList, response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) ListJobsWithContext(ctx context.Context, listJobsOptions *ListJobsOptions) (result *JobList, response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) ListKms(listKmsOptions *ListKmsOptions) (result *KMSDiscovery, response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) ListKmsWithContext(ctx context.Context, listKmsOptions *ListKmsOptions) (result *KMSDiscovery, response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) ListLocations(listLocationsOptions *ListLocationsOptions) (result *SchematicsLocationsList, response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) ListLocationsWithContext(ctx context.Context, listLocationsOptions *ListLocationsOptions) (result *SchematicsLocationsList, response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) ListPolicy(listPolicyOptions *ListPolicyOptions) (result *PolicyList, response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) ListPolicyWithContext(ctx context.Context, listPolicyOptions *ListPolicyOptions) (result *PolicyList, response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) ListResourceGroup(listResourceGroupOptions *ListResourceGroupOptions) (result []ResourceGroupResponse, response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) ListResourceGroupWithContext(ctx context.Context, listResourceGroupOptions *ListResourceGroupOptions) (result []ResourceGroupResponse, response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) ListResourceQuery(listResourceQueryOptions *ListResourceQueryOptions) (result *ResourceQueryRecordList, response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) ListResourceQueryWithContext(ctx context.Context, listResourceQueryOptions *ListResourceQueryOptions) (result *ResourceQueryRecordList, response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) ListSchematicsLocation(listSchematicsLocationOptions *ListSchematicsLocationOptions) (result []SchematicsLocations, response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) ListSchematicsLocationWithContext(ctx context.Context, ...) (result []SchematicsLocations, response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) ListWorkspaceActivities(listWorkspaceActivitiesOptions *ListWorkspaceActivitiesOptions) (result *WorkspaceActivities, response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) ListWorkspaceActivitiesWithContext(ctx context.Context, ...) (result *WorkspaceActivities, response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) ListWorkspaces(listWorkspacesOptions *ListWorkspacesOptions) (result *WorkspaceResponseList, response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) ListWorkspacesWithContext(ctx context.Context, listWorkspacesOptions *ListWorkspacesOptions) (result *WorkspaceResponseList, response *core.DetailedResponse, err error)
  • func (*SchematicsV1) NewAgent(name string, agentLocation string, location string, profileID string) (_model *Agent, err error)
  • func (*SchematicsV1) NewAgentData(name string, resourceGroup string, version string, schematicsLocation string, ...) (_model *AgentData, err error)
  • func (*SchematicsV1) NewApplyWorkspaceCommandOptions(wID string, refreshToken string) *ApplyWorkspaceCommandOptions
  • func (*SchematicsV1) NewCreateActionOptions() *CreateActionOptions
  • func (*SchematicsV1) NewCreateAgentDataOptions(name string, resourceGroup string, version string, schematicsLocation string, ...) *CreateAgentDataOptions
  • func (*SchematicsV1) NewCreateInventoryOptions() *CreateInventoryOptions
  • func (*SchematicsV1) NewCreateJobOptions(refreshToken string) *CreateJobOptions
  • func (*SchematicsV1) NewCreatePolicyOptions() *CreatePolicyOptions
  • func (*SchematicsV1) NewCreateResourceQueryOptions() *CreateResourceQueryOptions
  • func (*SchematicsV1) NewCreateWorkspaceDeletionJobOptions(refreshToken string) *CreateWorkspaceDeletionJobOptions
  • func (*SchematicsV1) NewCreateWorkspaceOptions() *CreateWorkspaceOptions
  • func (*SchematicsV1) NewDeleteActionOptions(actionID string) *DeleteActionOptions
  • func (*SchematicsV1) NewDeleteAgentDataOptions(agentID string) *DeleteAgentDataOptions
  • func (*SchematicsV1) NewDeleteAgentOptions(agentID string) *DeleteAgentOptions
  • func (*SchematicsV1) NewDeleteAgentResourcesOptions(agentID string, refreshToken string) *DeleteAgentResourcesOptions
  • func (*SchematicsV1) NewDeleteInventoryOptions(inventoryID string) *DeleteInventoryOptions
  • func (*SchematicsV1) NewDeleteJobOptions(jobID string, refreshToken string) *DeleteJobOptions
  • func (*SchematicsV1) NewDeletePolicyOptions(policyID string) *DeletePolicyOptions
  • func (*SchematicsV1) NewDeleteResourcesQueryOptions(queryID string) *DeleteResourcesQueryOptions
  • func (*SchematicsV1) NewDeleteWorkspaceActivityOptions(wID string, activityID string) *DeleteWorkspaceActivityOptions
  • func (*SchematicsV1) NewDeleteWorkspaceOptions(refreshToken string, wID string) *DeleteWorkspaceOptions
  • func (*SchematicsV1) NewDeployAgentJobOptions(agentID string) *DeployAgentJobOptions
  • func (*SchematicsV1) NewDestroyWorkspaceCommandOptions(wID string, refreshToken string) *DestroyWorkspaceCommandOptions
  • func (*SchematicsV1) NewExecuteResourceQueryOptions(queryID string) *ExecuteResourceQueryOptions
  • func (*SchematicsV1) NewExternalSource(sourceType string) (_model *ExternalSource, err error)
  • func (*SchematicsV1) NewGetActionOptions(actionID string) *GetActionOptions
  • func (*SchematicsV1) NewGetAgentDataOptions(agentID string) *GetAgentDataOptions
  • func (*SchematicsV1) NewGetAgentOptions(agentID string) *GetAgentOptions
  • func (*SchematicsV1) NewGetAgentVersionsOptions() *GetAgentVersionsOptions
  • func (*SchematicsV1) NewGetAllWorkspaceInputsOptions(wID string) *GetAllWorkspaceInputsOptions
  • func (*SchematicsV1) NewGetDeployAgentJobOptions(agentID string) *GetDeployAgentJobOptions
  • func (*SchematicsV1) NewGetHealthCheckAgentJobOptions(agentID string) *GetHealthCheckAgentJobOptions
  • func (*SchematicsV1) NewGetInventoryOptions(inventoryID string) *GetInventoryOptions
  • func (*SchematicsV1) NewGetJobFilesOptions(jobID string, fileType string) *GetJobFilesOptions
  • func (*SchematicsV1) NewGetJobOptions(jobID string) *GetJobOptions
  • func (*SchematicsV1) NewGetKmsSettingsOptions(location string) *GetKmsSettingsOptions
  • func (*SchematicsV1) NewGetPolicyOptions(policyID string) *GetPolicyOptions
  • func (*SchematicsV1) NewGetPrsAgentJobOptions(agentID string) *GetPrsAgentJobOptions
  • func (*SchematicsV1) NewGetResourcesQueryOptions(queryID string) *GetResourcesQueryOptions
  • func (*SchematicsV1) NewGetSchematicsVersionOptions() *GetSchematicsVersionOptions
  • func (*SchematicsV1) NewGetTemplateActivityLogOptions(wID string, tID string, activityID string) *GetTemplateActivityLogOptions
  • func (*SchematicsV1) NewGetTemplateLogsOptions(wID string, tID string) *GetTemplateLogsOptions
  • func (*SchematicsV1) NewGetWorkspaceActivityLogsOptions(wID string, activityID string) *GetWorkspaceActivityLogsOptions
  • func (*SchematicsV1) NewGetWorkspaceActivityOptions(wID string, activityID string) *GetWorkspaceActivityOptions
  • func (*SchematicsV1) NewGetWorkspaceDeletionJobStatusOptions(wjID string) *GetWorkspaceDeletionJobStatusOptions
  • func (*SchematicsV1) NewGetWorkspaceInputMetadataOptions(wID string, tID string) *GetWorkspaceInputMetadataOptions
  • func (*SchematicsV1) NewGetWorkspaceInputsOptions(wID string, tID string) *GetWorkspaceInputsOptions
  • func (*SchematicsV1) NewGetWorkspaceLogUrlsOptions(wID string) *GetWorkspaceLogUrlsOptions
  • func (*SchematicsV1) NewGetWorkspaceOptions(wID string) *GetWorkspaceOptions
  • func (*SchematicsV1) NewGetWorkspaceOutputsOptions(wID string) *GetWorkspaceOutputsOptions
  • func (*SchematicsV1) NewGetWorkspaceReadmeOptions(wID string) *GetWorkspaceReadmeOptions
  • func (*SchematicsV1) NewGetWorkspaceResourcesOptions(wID string) *GetWorkspaceResourcesOptions
  • func (*SchematicsV1) NewGetWorkspaceStateOptions(wID string) *GetWorkspaceStateOptions
  • func (*SchematicsV1) NewGetWorkspaceTemplateStateOptions(wID string, tID string) *GetWorkspaceTemplateStateOptions
  • func (*SchematicsV1) NewHealthCheckAgentJobOptions(agentID string) *HealthCheckAgentJobOptions
  • func (*SchematicsV1) NewJobData(jobType string) (_model *JobData, err error)
  • func (*SchematicsV1) NewListActionsOptions() *ListActionsOptions
  • func (*SchematicsV1) NewListAgentDataOptions() *ListAgentDataOptions
  • func (*SchematicsV1) NewListAgentOptions() *ListAgentOptions
  • func (*SchematicsV1) NewListInventoriesOptions() *ListInventoriesOptions
  • func (*SchematicsV1) NewListJobLogsOptions(jobID string) *ListJobLogsOptions
  • func (*SchematicsV1) NewListJobsOptions() *ListJobsOptions
  • func (*SchematicsV1) NewListKmsOptions(encryptionScheme string, location string) *ListKmsOptions
  • func (*SchematicsV1) NewListLocationsOptions() *ListLocationsOptions
  • func (*SchematicsV1) NewListPolicyOptions() *ListPolicyOptions
  • func (*SchematicsV1) NewListResourceGroupOptions() *ListResourceGroupOptions
  • func (*SchematicsV1) NewListResourceQueryOptions() *ListResourceQueryOptions
  • func (*SchematicsV1) NewListSchematicsLocationOptions() *ListSchematicsLocationOptions
  • func (*SchematicsV1) NewListWorkspaceActivitiesOptions(wID string) *ListWorkspaceActivitiesOptions
  • func (*SchematicsV1) NewListWorkspacesOptions() *ListWorkspacesOptions
  • func (*SchematicsV1) NewPlanWorkspaceCommandOptions(wID string, refreshToken string) *PlanWorkspaceCommandOptions
  • func (*SchematicsV1) NewProcessTemplateMetaDataOptions(templateType string, source *ExternalSource) *ProcessTemplateMetaDataOptions
  • func (*SchematicsV1) NewPrsAgentJobOptions(agentID string) *PrsAgentJobOptions
  • func (*SchematicsV1) NewRefreshWorkspaceCommandOptions(wID string, refreshToken string) *RefreshWorkspaceCommandOptions
  • func (*SchematicsV1) NewRegisterAgentOptions(name string, agentLocation string, location string, profileID string) *RegisterAgentOptions
  • func (*SchematicsV1) NewReplaceInventoryOptions(inventoryID string) *ReplaceInventoryOptions
  • func (*SchematicsV1) NewReplaceResourcesQueryOptions(queryID string) *ReplaceResourcesQueryOptions
  • func (*SchematicsV1) NewReplaceWorkspaceInputsOptions(wID string, tID string) *ReplaceWorkspaceInputsOptions
  • func (*SchematicsV1) NewReplaceWorkspaceOptions(wID string) *ReplaceWorkspaceOptions
  • func (*SchematicsV1) NewRunWorkspaceCommandsOptions(wID string, refreshToken string) *RunWorkspaceCommandsOptions
  • func (*SchematicsV1) NewTemplateRepoUploadOptions(wID string, tID string) *TemplateRepoUploadOptions
  • func (*SchematicsV1) NewUpdateActionOptions(actionID string) *UpdateActionOptions
  • func (*SchematicsV1) NewUpdateAgentDataOptions(agentID string, name string, resourceGroup string, version string, ...) *UpdateAgentDataOptions
  • func (*SchematicsV1) NewUpdateAgentRegistrationOptions(agentID string, name string, agentLocation string, location string, ...) *UpdateAgentRegistrationOptions
  • func (*SchematicsV1) NewUpdateJobOptions(jobID string, refreshToken string) *UpdateJobOptions
  • func (*SchematicsV1) NewUpdateKmsSettingsOptions() *UpdateKmsSettingsOptions
  • func (*SchematicsV1) NewUpdatePolicyOptions(policyID string) *UpdatePolicyOptions
  • func (*SchematicsV1) NewUpdateWorkspaceOptions(wID string) *UpdateWorkspaceOptions
  • func (*SchematicsV1) NewUploadTemplateTarActionOptions(actionID string) *UploadTemplateTarActionOptions
  • func (schematics *SchematicsV1) PlanWorkspaceCommand(planWorkspaceCommandOptions *PlanWorkspaceCommandOptions) (result *WorkspaceActivityPlanResult, response *core.DetailedResponse, ...)
  • func (schematics *SchematicsV1) PlanWorkspaceCommandWithContext(ctx context.Context, planWorkspaceCommandOptions *PlanWorkspaceCommandOptions) (result *WorkspaceActivityPlanResult, response *core.DetailedResponse, ...)
  • func (schematics *SchematicsV1) ProcessTemplateMetaData(processTemplateMetaDataOptions *ProcessTemplateMetaDataOptions) (result *TemplateMetaDataResponse, response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) ProcessTemplateMetaDataWithContext(ctx context.Context, ...) (result *TemplateMetaDataResponse, response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) PrsAgentJob(prsAgentJobOptions *PrsAgentJobOptions) (result *AgentPRSJob, response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) PrsAgentJobWithContext(ctx context.Context, prsAgentJobOptions *PrsAgentJobOptions) (result *AgentPRSJob, response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) RefreshWorkspaceCommand(refreshWorkspaceCommandOptions *RefreshWorkspaceCommandOptions) (result *WorkspaceActivityRefreshResult, response *core.DetailedResponse, ...)
  • func (schematics *SchematicsV1) RefreshWorkspaceCommandWithContext(ctx context.Context, ...) (result *WorkspaceActivityRefreshResult, response *core.DetailedResponse, ...)
  • func (schematics *SchematicsV1) RegisterAgent(registerAgentOptions *RegisterAgentOptions) (result *Agent, response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) RegisterAgentWithContext(ctx context.Context, registerAgentOptions *RegisterAgentOptions) (result *Agent, response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) ReplaceInventory(replaceInventoryOptions *ReplaceInventoryOptions) (result *InventoryResourceRecord, response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) ReplaceInventoryWithContext(ctx context.Context, replaceInventoryOptions *ReplaceInventoryOptions) (result *InventoryResourceRecord, response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) ReplaceResourcesQuery(replaceResourcesQueryOptions *ReplaceResourcesQueryOptions) (result *ResourceQueryRecord, response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) ReplaceResourcesQueryWithContext(ctx context.Context, ...) (result *ResourceQueryRecord, response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) ReplaceWorkspace(replaceWorkspaceOptions *ReplaceWorkspaceOptions) (result *WorkspaceResponse, response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) ReplaceWorkspaceInputs(replaceWorkspaceInputsOptions *ReplaceWorkspaceInputsOptions) (result *UserValues, response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) ReplaceWorkspaceInputsWithContext(ctx context.Context, ...) (result *UserValues, response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) ReplaceWorkspaceWithContext(ctx context.Context, replaceWorkspaceOptions *ReplaceWorkspaceOptions) (result *WorkspaceResponse, response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) RunWorkspaceCommands(runWorkspaceCommandsOptions *RunWorkspaceCommandsOptions) (result *WorkspaceActivityCommandResult, response *core.DetailedResponse, ...)
  • func (schematics *SchematicsV1) RunWorkspaceCommandsWithContext(ctx context.Context, runWorkspaceCommandsOptions *RunWorkspaceCommandsOptions) (result *WorkspaceActivityCommandResult, response *core.DetailedResponse, ...)
  • func (schematics *SchematicsV1) SetDefaultHeaders(headers http.Header)
  • func (schematics *SchematicsV1) SetEnableGzipCompression(enableGzip bool)
  • func (schematics *SchematicsV1) SetServiceURL(url string) error
  • func (schematics *SchematicsV1) TemplateRepoUpload(templateRepoUploadOptions *TemplateRepoUploadOptions) (result *TemplateRepoTarUploadResponse, response *core.DetailedResponse, ...)
  • func (schematics *SchematicsV1) TemplateRepoUploadWithContext(ctx context.Context, templateRepoUploadOptions *TemplateRepoUploadOptions) (result *TemplateRepoTarUploadResponse, response *core.DetailedResponse, ...)
  • func (schematics *SchematicsV1) UpdateAction(updateActionOptions *UpdateActionOptions) (result *Action, response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) UpdateActionWithContext(ctx context.Context, updateActionOptions *UpdateActionOptions) (result *Action, response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) UpdateAgentData(updateAgentDataOptions *UpdateAgentDataOptions) (result *AgentData, response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) UpdateAgentDataWithContext(ctx context.Context, updateAgentDataOptions *UpdateAgentDataOptions) (result *AgentData, response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) UpdateAgentRegistration(updateAgentRegistrationOptions *UpdateAgentRegistrationOptions) (result *Agent, response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) UpdateAgentRegistrationWithContext(ctx context.Context, ...) (result *Agent, response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) UpdateJob(updateJobOptions *UpdateJobOptions) (result *Job, response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) UpdateJobWithContext(ctx context.Context, updateJobOptions *UpdateJobOptions) (result *Job, response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) UpdateKmsSettings(updateKmsSettingsOptions *UpdateKmsSettingsOptions) (result *KMSSettings, response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) UpdateKmsSettingsWithContext(ctx context.Context, updateKmsSettingsOptions *UpdateKmsSettingsOptions) (result *KMSSettings, response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) UpdatePolicy(updatePolicyOptions *UpdatePolicyOptions) (result *Policy, response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) UpdatePolicyWithContext(ctx context.Context, updatePolicyOptions *UpdatePolicyOptions) (result *Policy, response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) UpdateWorkspace(updateWorkspaceOptions *UpdateWorkspaceOptions) (result *WorkspaceResponse, response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) UpdateWorkspaceWithContext(ctx context.Context, updateWorkspaceOptions *UpdateWorkspaceOptions) (result *WorkspaceResponse, response *core.DetailedResponse, err error)
  • func (schematics *SchematicsV1) UploadTemplateTarAction(uploadTemplateTarActionOptions *UploadTemplateTarActionOptions) (result *TemplateRepoTarUploadResponse, response *core.DetailedResponse, ...)
  • func (schematics *SchematicsV1) UploadTemplateTarActionWithContext(ctx context.Context, ...) (result *TemplateRepoTarUploadResponse, response *core.DetailedResponse, ...)
• type SchematicsV1Options
• type ScopedResource
• type ServiceExtensions
• type SharedTargetData
• type SharedTargetDataResponse
• type StateStoreResponse
• type StateStoreResponseList
• type SystemLock
• type TemplateMetaDataResponse
• type TemplateReadme
• type TemplateRepoRequest
• type TemplateRepoResponse
• type TemplateRepoTarUploadResponse
• type TemplateRepoUpdateRequest
• type TemplateRepoUploadOptions
  • func (_options *TemplateRepoUploadOptions) SetFile(file io.ReadCloser) *TemplateRepoUploadOptions
  • func (_options *TemplateRepoUploadOptions) SetFileContentType(fileContentType string) *TemplateRepoUploadOptions
  • func (options *TemplateRepoUploadOptions) SetHeaders(param map[string]string) *TemplateRepoUploadOptions
  • func (_options *TemplateRepoUploadOptions) SetTID(tID string) *TemplateRepoUploadOptions
  • func (_options *TemplateRepoUploadOptions) SetWID(wID string) *TemplateRepoUploadOptions
• type TemplateResources
• type TemplateRunTimeDataResponse
• type TemplateSourceDataRequest
• type TemplateSourceDataResponse
• type TemplateStateStore
• type TemplateValues
• type TerraformCommand
• type UpdateActionOptions
  • func (_options *UpdateActionOptions) SetActionID(actionID string) *UpdateActionOptions
  • func (_options *UpdateActionOptions) SetBastion(bastion *BastionResourceDefinition) *UpdateActionOptions
  • func (_options *UpdateActionOptions) SetBastionConnectionType(bastionConnectionType string) *UpdateActionOptions
  • func (_options *UpdateActionOptions) SetBastionCredential(bastionCredential *CredentialVariableData) *UpdateActionOptions
  • func (_options *UpdateActionOptions) SetCommandParameter(commandParameter string) *UpdateActionOptions
  • func (_options *UpdateActionOptions) SetCredentials(credentials []CredentialVariableData) *UpdateActionOptions
  • func (_options *UpdateActionOptions) SetDescription(description string) *UpdateActionOptions
  • func (options *UpdateActionOptions) SetHeaders(param map[string]string) *UpdateActionOptions
  • func (_options *UpdateActionOptions) SetInputs(inputs []VariableData) *UpdateActionOptions
  • func (_options *UpdateActionOptions) SetInventory(inventory string) *UpdateActionOptions
  • func (_options *UpdateActionOptions) SetInventoryConnectionType(inventoryConnectionType string) *UpdateActionOptions
  • func (_options *UpdateActionOptions) SetLocation(location string) *UpdateActionOptions
  • func (_options *UpdateActionOptions) SetName(name string) *UpdateActionOptions
  • func (_options *UpdateActionOptions) SetOutputs(outputs []VariableData) *UpdateActionOptions
  • func (_options *UpdateActionOptions) SetResourceGroup(resourceGroup string) *UpdateActionOptions
  • func (_options *UpdateActionOptions) SetSettings(settings []VariableData) *UpdateActionOptions
  • func (_options *UpdateActionOptions) SetSource(source *ExternalSource) *UpdateActionOptions
  • func (_options *UpdateActionOptions) SetSourceReadmeURL(sourceReadmeURL string) *UpdateActionOptions
  • func (_options *UpdateActionOptions) SetSourceType(sourceType string) *UpdateActionOptions
  • func (_options *UpdateActionOptions) SetTags(tags []string) *UpdateActionOptions
  • func (_options *UpdateActionOptions) SetTargetsIni(targetsIni string) *UpdateActionOptions
  • func (_options *UpdateActionOptions) SetUserState(userState *UserState) *UpdateActionOptions
  • func (_options *UpdateActionOptions) SetXGithubToken(xGithubToken string) *UpdateActionOptions
• type UpdateAgentDataOptions
  • func (_options *UpdateAgentDataOptions) SetAgentID(agentID string) *UpdateAgentDataOptions
  • func (_options *UpdateAgentDataOptions) SetAgentInfrastructure(agentInfrastructure *AgentInfrastructure) *UpdateAgentDataOptions
  • func (_options *UpdateAgentDataOptions) SetAgentInputs(agentInputs []VariableData) *UpdateAgentDataOptions
  • func (_options *UpdateAgentDataOptions) SetAgentKpi(agentKpi *AgentKPIData) *UpdateAgentDataOptions
  • func (_options *UpdateAgentDataOptions) SetAgentLocation(agentLocation string) *UpdateAgentDataOptions
  • func (_options *UpdateAgentDataOptions) SetAgentMetadata(agentMetadata []AgentMetadataInfo) *UpdateAgentDataOptions
  • func (_options *UpdateAgentDataOptions) SetDescription(description string) *UpdateAgentDataOptions
  • func (options *UpdateAgentDataOptions) SetHeaders(param map[string]string) *UpdateAgentDataOptions
  • func (_options *UpdateAgentDataOptions) SetName(name string) *UpdateAgentDataOptions
  • func (_options *UpdateAgentDataOptions) SetRefreshToken(refreshToken string) *UpdateAgentDataOptions
  • func (_options *UpdateAgentDataOptions) SetResourceGroup(resourceGroup string) *UpdateAgentDataOptions
  • func (_options *UpdateAgentDataOptions) SetSchematicsLocation(schematicsLocation string) *UpdateAgentDataOptions
  • func (_options *UpdateAgentDataOptions) SetTags(tags []string) *UpdateAgentDataOptions
  • func (_options *UpdateAgentDataOptions) SetUserState(userState *AgentUserState) *UpdateAgentDataOptions
  • func (_options *UpdateAgentDataOptions) SetVersion(version string) *UpdateAgentDataOptions
• type UpdateAgentRegistrationOptions
  • func (_options *UpdateAgentRegistrationOptions) SetAgentID(agentID string) *UpdateAgentRegistrationOptions
  • func (_options *UpdateAgentRegistrationOptions) SetAgentLocation(agentLocation string) *UpdateAgentRegistrationOptions
  • func (_options *UpdateAgentRegistrationOptions) SetDescription(description string) *UpdateAgentRegistrationOptions
  • func (options *UpdateAgentRegistrationOptions) SetHeaders(param map[string]string) *UpdateAgentRegistrationOptions
  • func (_options *UpdateAgentRegistrationOptions) SetLocation(location string) *UpdateAgentRegistrationOptions
  • func (_options *UpdateAgentRegistrationOptions) SetName(name string) *UpdateAgentRegistrationOptions
  • func (_options *UpdateAgentRegistrationOptions) SetProfileID(profileID string) *UpdateAgentRegistrationOptions
  • func (_options *UpdateAgentRegistrationOptions) SetResourceGroup(resourceGroup string) *UpdateAgentRegistrationOptions
  • func (_options *UpdateAgentRegistrationOptions) SetTags(tags []string) *UpdateAgentRegistrationOptions
  • func (_options *UpdateAgentRegistrationOptions) SetUserState(userState *AgentUserState) *UpdateAgentRegistrationOptions
• type UpdateJobOptions
  • func (_options *UpdateJobOptions) SetAgent(agent *AgentInfo) *UpdateJobOptions
  • func (_options *UpdateJobOptions) SetBastion(bastion *BastionResourceDefinition) *UpdateJobOptions
  • func (_options *UpdateJobOptions) SetCartOrderData(cartOrderData []CartOrderData) *UpdateJobOptions
  • func (_options *UpdateJobOptions) SetCommandName(commandName string) *UpdateJobOptions
  • func (_options *UpdateJobOptions) SetCommandObject(commandObject string) *UpdateJobOptions
  • func (_options *UpdateJobOptions) SetCommandObjectID(commandObjectID string) *UpdateJobOptions
  • func (_options *UpdateJobOptions) SetCommandOptions(commandOptions []string) *UpdateJobOptions
  • func (_options *UpdateJobOptions) SetCommandParameter(commandParameter string) *UpdateJobOptions
  • func (_options *UpdateJobOptions) SetData(data *JobData) *UpdateJobOptions
  • func (options *UpdateJobOptions) SetHeaders(param map[string]string) *UpdateJobOptions
  • func (_options *UpdateJobOptions) SetInputs(inputs []VariableData) *UpdateJobOptions
  • func (_options *UpdateJobOptions) SetJobID(jobID string) *UpdateJobOptions
  • func (_options *UpdateJobOptions) SetLocation(location string) *UpdateJobOptions
  • func (_options *UpdateJobOptions) SetLogSummary(logSummary *JobLogSummary) *UpdateJobOptions
  • func (_options *UpdateJobOptions) SetRefreshToken(refreshToken string) *UpdateJobOptions
  • func (_options *UpdateJobOptions) SetSettings(settings []VariableData) *UpdateJobOptions
  • func (_options *UpdateJobOptions) SetStatus(status *JobStatus) *UpdateJobOptions
  • func (_options *UpdateJobOptions) SetTags(tags []string) *UpdateJobOptions
• type UpdateKmsSettingsOptions
  • func (_options *UpdateKmsSettingsOptions) SetEncryptionScheme(encryptionScheme string) *UpdateKmsSettingsOptions
  • func (options *UpdateKmsSettingsOptions) SetHeaders(param map[string]string) *UpdateKmsSettingsOptions
  • func (_options *UpdateKmsSettingsOptions) SetLocation(location string) *UpdateKmsSettingsOptions
  • func (_options *UpdateKmsSettingsOptions) SetPrimaryCrk(primaryCrk *KMSSettingsPrimaryCrk) *UpdateKmsSettingsOptions
  • func (_options *UpdateKmsSettingsOptions) SetResourceGroup(resourceGroup string) *UpdateKmsSettingsOptions
  • func (_options *UpdateKmsSettingsOptions) SetSecondaryCrk(secondaryCrk *KMSSettingsSecondaryCrk) *UpdateKmsSettingsOptions
• type UpdatePolicyOptions
  • func (_options *UpdatePolicyOptions) SetDescription(description string) *UpdatePolicyOptions
  • func (options *UpdatePolicyOptions) SetHeaders(param map[string]string) *UpdatePolicyOptions
  • func (_options *UpdatePolicyOptions) SetKind(kind string) *UpdatePolicyOptions
  • func (_options *UpdatePolicyOptions) SetLocation(location string) *UpdatePolicyOptions
  • func (_options *UpdatePolicyOptions) SetName(name string) *UpdatePolicyOptions
  • func (_options *UpdatePolicyOptions) SetParameter(parameter *PolicyParameter) *UpdatePolicyOptions
  • func (_options *UpdatePolicyOptions) SetPolicyID(policyID string) *UpdatePolicyOptions
  • func (_options *UpdatePolicyOptions) SetResourceGroup(resourceGroup string) *UpdatePolicyOptions
  • func (_options *UpdatePolicyOptions) SetScopedResources(scopedResources []ScopedResource) *UpdatePolicyOptions
  • func (_options *UpdatePolicyOptions) SetState(state *UserState) *UpdatePolicyOptions
  • func (_options *UpdatePolicyOptions) SetTags(tags []string) *UpdatePolicyOptions
  • func (_options *UpdatePolicyOptions) SetTarget(target *PolicyObjects) *UpdatePolicyOptions
• type UpdateWorkspaceOptions
  • func (_options *UpdateWorkspaceOptions) SetAgentID(agentID string) *UpdateWorkspaceOptions
  • func (_options *UpdateWorkspaceOptions) SetCatalogRef(catalogRef *CatalogRef) *UpdateWorkspaceOptions
  • func (_options *UpdateWorkspaceOptions) SetDependencies(dependencies *Dependencies) *UpdateWorkspaceOptions
  • func (_options *UpdateWorkspaceOptions) SetDescription(description string) *UpdateWorkspaceOptions
  • func (options *UpdateWorkspaceOptions) SetHeaders(param map[string]string) *UpdateWorkspaceOptions
  • func (_options *UpdateWorkspaceOptions) SetName(name string) *UpdateWorkspaceOptions
  • func (_options *UpdateWorkspaceOptions) SetSettings(settings []VariableData) *UpdateWorkspaceOptions
  • func (_options *UpdateWorkspaceOptions) SetSharedData(sharedData *SharedTargetData) *UpdateWorkspaceOptions
  • func (_options *UpdateWorkspaceOptions) SetTags(tags []string) *UpdateWorkspaceOptions
  • func (_options *UpdateWorkspaceOptions) SetTemplateData(templateData []TemplateSourceDataRequest) *UpdateWorkspaceOptions
  • func (_options *UpdateWorkspaceOptions) SetTemplateRepo(templateRepo *TemplateRepoUpdateRequest) *UpdateWorkspaceOptions
  • func (_options *UpdateWorkspaceOptions) SetType(typeVar []string) *UpdateWorkspaceOptions
  • func (_options *UpdateWorkspaceOptions) SetWID(wID string) *UpdateWorkspaceOptions
  • func (_options *UpdateWorkspaceOptions) SetWorkspaceStatus(workspaceStatus *WorkspaceStatusUpdateRequest) *UpdateWorkspaceOptions
  • func (_options *UpdateWorkspaceOptions) SetWorkspaceStatusMsg(workspaceStatusMsg *WorkspaceStatusMessage) *UpdateWorkspaceOptions
• type UploadTemplateTarActionOptions
  • func (_options *UploadTemplateTarActionOptions) SetActionID(actionID string) *UploadTemplateTarActionOptions
  • func (_options *UploadTemplateTarActionOptions) SetFile(file io.ReadCloser) *UploadTemplateTarActionOptions
  • func (_options *UploadTemplateTarActionOptions) SetFileContentType(fileContentType string) *UploadTemplateTarActionOptions
  • func (options *UploadTemplateTarActionOptions) SetHeaders(param map[string]string) *UploadTemplateTarActionOptions
• type UserState
• type UserValues
• type VariableData
• type VariableMetadata
• type VersionResponse
• type WorkspaceActivities
• type WorkspaceActivity
• type WorkspaceActivityApplyResult
• type WorkspaceActivityCommandResult
• type WorkspaceActivityDestroyResult
• type WorkspaceActivityLogs
• type WorkspaceActivityOptionsTemplate
• type WorkspaceActivityPlanResult
• type WorkspaceActivityRefreshResult
• type WorkspaceActivityTemplate
• type WorkspaceActivityTemplateLogs
• type WorkspaceBulkDeleteResponse
• type WorkspaceJobResponse
• type WorkspaceJobStatusType
• type WorkspaceResponse
• type WorkspaceResponseList
• type WorkspaceStatusMessage
• type WorkspaceStatusRequest
• type WorkspaceStatusResponse
• type WorkspaceStatusUpdateRequest
• type WorkspaceTemplateValuesResponse
• type WorkspaceVariableRequest
• type WorkspaceVariableResponse

Constants

const (
	Action_Location_EuDe    = "eu-de"
	Action_Location_EuGb    = "eu-gb"
	Action_Location_UsEast  = "us-east"
	Action_Location_UsSouth = "us-south"
)

Constants associated with the Action.Location property. List of locations supported by IBM Cloud Schematics service. While creating your workspace or action, choose the right region, since it cannot be changed. Note, this does not limit the location of the IBM Cloud resources, provisioned using Schematics.

const (
	Action_InventoryConnectionType_Ssh   = "ssh"
	Action_InventoryConnectionType_Winrm = "winrm"
)

Constants associated with the Action.InventoryConnectionType property. Type of connection to be used when connecting to remote host. **Note** Currently, WinRM supports only Windows system with the public IPs and do not support Bastion host.

const (
	Action_SourceType_GitHub           = "git_hub"
	Action_SourceType_GitHubEnterprise = "git_hub_enterprise"
	Action_SourceType_GitLab           = "git_lab"
	Action_SourceType_IbmCloudCatalog  = "ibm_cloud_catalog"
	Action_SourceType_IbmGitLab        = "ibm_git_lab"
	Action_SourceType_Local            = "local"
)

Constants associated with the Action.SourceType property. Type of source for the Template.

const (
	ActionLite_Location_EuDe    = "eu-de"
	ActionLite_Location_EuGb    = "eu-gb"
	ActionLite_Location_UsEast  = "us-east"
	ActionLite_Location_UsSouth = "us-south"
)

Constants associated with the ActionLite.Location property. List of locations supported by IBM Cloud Schematics service. While creating your workspace or action, choose the right region, since it cannot be changed. Note, this does not limit the location of the IBM Cloud resources, provisioned using Schematics.

const (
	ActionLiteState_StatusCode_Critical = "critical"
	ActionLiteState_StatusCode_Disabled = "disabled"
	ActionLiteState_StatusCode_Normal   = "normal"
	ActionLiteState_StatusCode_Pending  = "pending"
)

Constants associated with the ActionLiteState.StatusCode property. Status of automation (workspace or action).

const (
	ActionState_StatusCode_Critical = "critical"
	ActionState_StatusCode_Disabled = "disabled"
	ActionState_StatusCode_Normal   = "normal"
	ActionState_StatusCode_Pending  = "pending"
)

Constants associated with the ActionState.StatusCode property. Status of automation (workspace or action).

const (
	Agent_Location_EuDe    = "eu-de"
	Agent_Location_EuGb    = "eu-gb"
	Agent_Location_UsEast  = "us-east"
	Agent_Location_UsSouth = "us-south"
)

Constants associated with the Agent.Location property. List of locations supported by IBM Cloud Schematics service. While creating your workspace or action, choose the right region, since it cannot be changed. Note, this does not limit the location of the IBM Cloud resources, provisioned using Schematics.

const (
	AgentAssignmentPolicyParameter_SelectorKind_Ids    = "ids"
	AgentAssignmentPolicyParameter_SelectorKind_Scoped = "scoped"
)

Constants associated with the AgentAssignmentPolicyParameter.SelectorKind property. Types of schematics object selector.

const (
	AgentData_SchematicsLocation_EuDe    = "eu-de"
	AgentData_SchematicsLocation_EuGb    = "eu-gb"
	AgentData_SchematicsLocation_UsEast  = "us-east"
	AgentData_SchematicsLocation_UsSouth = "us-south"
)

Constants associated with the AgentData.SchematicsLocation property. List of locations supported by IBM Cloud Schematics service. While creating your workspace or action, choose the right region, since it cannot be changed. Note, this does not limit the location of the IBM Cloud resources, provisioned using Schematics.

const (
	AgentDataLite_SchematicsLocation_EuDe    = "eu-de"
	AgentDataLite_SchematicsLocation_EuGb    = "eu-gb"
	AgentDataLite_SchematicsLocation_UsEast  = "us-east"
	AgentDataLite_SchematicsLocation_UsSouth = "us-south"
)

Constants associated with the AgentDataLite.SchematicsLocation property. List of locations supported by IBM Cloud Schematics service. While creating your workspace or action, choose the right region, since it cannot be changed. Note, this does not limit the location of the IBM Cloud resources, provisioned using Schematics.

const (
	AgentDataRecentDeployJob_StatusCode_JobCancelled      = "job_cancelled"
	AgentDataRecentDeployJob_StatusCode_JobFailed         = "job_failed"
	AgentDataRecentDeployJob_StatusCode_JobFinished       = "job_finished"
	AgentDataRecentDeployJob_StatusCode_JobInProgress     = "job_in_progress"
	AgentDataRecentDeployJob_StatusCode_JobPending        = "job_pending"
	AgentDataRecentDeployJob_StatusCode_JobReadyToExecute = "job_ready_to_execute"
	AgentDataRecentDeployJob_StatusCode_JobStopInProgress = "job_stop_in_progress"
	AgentDataRecentDeployJob_StatusCode_JobStopped        = "job_stopped"
)

Constants associated with the AgentDataRecentDeployJob.StatusCode property. Status of Jobs.

const (
	AgentDataRecentDestroyJob_StatusCode_JobCancelled      = "job_cancelled"
	AgentDataRecentDestroyJob_StatusCode_JobFailed         = "job_failed"
	AgentDataRecentDestroyJob_StatusCode_JobFinished       = "job_finished"
	AgentDataRecentDestroyJob_StatusCode_JobInProgress     = "job_in_progress"
	AgentDataRecentDestroyJob_StatusCode_JobPending        = "job_pending"
	AgentDataRecentDestroyJob_StatusCode_JobReadyToExecute = "job_ready_to_execute"
	AgentDataRecentDestroyJob_StatusCode_JobStopInProgress = "job_stop_in_progress"
	AgentDataRecentDestroyJob_StatusCode_JobStopped        = "job_stopped"
)

Constants associated with the AgentDataRecentDestroyJob.StatusCode property. Status of Jobs.

const (
	AgentDataRecentHealthJob_StatusCode_JobCancelled      = "job_cancelled"
	AgentDataRecentHealthJob_StatusCode_JobFailed         = "job_failed"
	AgentDataRecentHealthJob_StatusCode_JobFinished       = "job_finished"
	AgentDataRecentHealthJob_StatusCode_JobInProgress     = "job_in_progress"
	AgentDataRecentHealthJob_StatusCode_JobPending        = "job_pending"
	AgentDataRecentHealthJob_StatusCode_JobReadyToExecute = "job_ready_to_execute"
	AgentDataRecentHealthJob_StatusCode_JobStopInProgress = "job_stop_in_progress"
	AgentDataRecentHealthJob_StatusCode_JobStopped        = "job_stopped"
)

Constants associated with the AgentDataRecentHealthJob.StatusCode property. Status of Jobs.

const (
	AgentDataRecentPrsJob_StatusCode_JobCancelled      = "job_cancelled"
	AgentDataRecentPrsJob_StatusCode_JobFailed         = "job_failed"
	AgentDataRecentPrsJob_StatusCode_JobFinished       = "job_finished"
	AgentDataRecentPrsJob_StatusCode_JobInProgress     = "job_in_progress"
	AgentDataRecentPrsJob_StatusCode_JobPending        = "job_pending"
	AgentDataRecentPrsJob_StatusCode_JobReadyToExecute = "job_ready_to_execute"
	AgentDataRecentPrsJob_StatusCode_JobStopInProgress = "job_stop_in_progress"
	AgentDataRecentPrsJob_StatusCode_JobStopped        = "job_stopped"
)

Constants associated with the AgentDataRecentPrsJob.StatusCode property. Status of Jobs.

const (
	AgentDeployJob_StatusCode_JobCancelled      = "job_cancelled"
	AgentDeployJob_StatusCode_JobFailed         = "job_failed"
	AgentDeployJob_StatusCode_JobFinished       = "job_finished"
	AgentDeployJob_StatusCode_JobInProgress     = "job_in_progress"
	AgentDeployJob_StatusCode_JobPending        = "job_pending"
	AgentDeployJob_StatusCode_JobReadyToExecute = "job_ready_to_execute"
	AgentDeployJob_StatusCode_JobStopInProgress = "job_stop_in_progress"
	AgentDeployJob_StatusCode_JobStopped        = "job_stopped"
)

Constants associated with the AgentDeployJob.StatusCode property. Status of Jobs.

const (
	AgentHealthJob_StatusCode_JobCancelled      = "job_cancelled"
	AgentHealthJob_StatusCode_JobFailed         = "job_failed"
	AgentHealthJob_StatusCode_JobFinished       = "job_finished"
	AgentHealthJob_StatusCode_JobInProgress     = "job_in_progress"
	AgentHealthJob_StatusCode_JobPending        = "job_pending"
	AgentHealthJob_StatusCode_JobReadyToExecute = "job_ready_to_execute"
	AgentHealthJob_StatusCode_JobStopInProgress = "job_stop_in_progress"
	AgentHealthJob_StatusCode_JobStopped        = "job_stopped"
)

Constants associated with the AgentHealthJob.StatusCode property. Status of Jobs.

const (
	AgentInfrastructure_InfraType_IbmKubernetes = "ibm_kubernetes"
	AgentInfrastructure_InfraType_IbmOpenshift  = "ibm_openshift"
	AgentInfrastructure_InfraType_IbmSatellite  = "ibm_satellite"
)

Constants associated with the AgentInfrastructure.InfraType property. Type of target agent infrastructure.

const (
	AgentKPIData_AvailabilityIndicator_Available   = "available"
	AgentKPIData_AvailabilityIndicator_Error       = "error"
	AgentKPIData_AvailabilityIndicator_Unavailable = "unavailable"
)

Constants associated with the AgentKPIData.AvailabilityIndicator property. Overall availability indicator reported by the agent.

const (
	AgentKPIData_LifecycleIndicator_Consistent   = "consistent"
	AgentKPIData_LifecycleIndicator_Inconsistent = "inconsistent"
	AgentKPIData_LifecycleIndicator_Obselete     = "obselete"
)

Constants associated with the AgentKPIData.LifecycleIndicator property. Overall lifecycle indicator reported by the agents.

const (
	AgentKPIDataLite_AvailabilityIndicator_Available   = "available"
	AgentKPIDataLite_AvailabilityIndicator_Error       = "error"
	AgentKPIDataLite_AvailabilityIndicator_Unavailable = "unavailable"
)

Constants associated with the AgentKPIDataLite.AvailabilityIndicator property. Overall availability indicator reported by the agent.

const (
	AgentKPIDataLite_LifecycleIndicator_Consistent   = "consistent"
	AgentKPIDataLite_LifecycleIndicator_Inconsistent = "inconsistent"
	AgentKPIDataLite_LifecycleIndicator_Obselete     = "obselete"
)

Constants associated with the AgentKPIDataLite.LifecycleIndicator property. Overall lifecycle indicator reported by the agents.

const (
	AgentPRSJob_StatusCode_JobCancelled      = "job_cancelled"
	AgentPRSJob_StatusCode_JobFailed         = "job_failed"
	AgentPRSJob_StatusCode_JobFinished       = "job_finished"
	AgentPRSJob_StatusCode_JobInProgress     = "job_in_progress"
	AgentPRSJob_StatusCode_JobPending        = "job_pending"
	AgentPRSJob_StatusCode_JobReadyToExecute = "job_ready_to_execute"
	AgentPRSJob_StatusCode_JobStopInProgress = "job_stop_in_progress"
	AgentPRSJob_StatusCode_JobStopped        = "job_stopped"
)

Constants associated with the AgentPRSJob.StatusCode property. Status of Jobs.

const (
	AgentSystemStatus_StatusCode_Draft      = "draft"
	AgentSystemStatus_StatusCode_Error      = "error"
	AgentSystemStatus_StatusCode_InProgress = "in_progress"
	AgentSystemStatus_StatusCode_Normal     = "normal"
	AgentSystemStatus_StatusCode_Pending    = "pending"
)

Constants associated with the AgentSystemStatus.StatusCode property. Agent Status.

const (
	AgentUserState_State_Disable = "disable"
	AgentUserState_State_Enable  = "enable"
)

Constants associated with the AgentUserState.State property. User-defined states

• `enable` Agent is enabled by the user.
• `disable` Agent is disbaled by the user.

const (
	AgentSystemState_State_Draft      = "draft"
	AgentSystemState_State_Error      = "error"
	AgentSystemState_State_InProgress = "in_progress"
	AgentSystemState_State_Normal     = "normal"
	AgentSystemState_State_Pending    = "pending"
)

Constants associated with the AgentSystemState.State property. Agent Status.

const (
	ConnectionState_State_Connected    = "Connected"
	ConnectionState_State_Disconnected = "Disconnected"
)

Constants associated with the ConnectionState.State property. Agent Connection Status

• `Connected` When Schematics is able to connect to the agent.
• `Disconnected` When Schematics is able not connect to the agent.

const (
	CreateActionOptions_Location_EuDe    = "eu-de"
	CreateActionOptions_Location_EuGb    = "eu-gb"
	CreateActionOptions_Location_UsEast  = "us-east"
	CreateActionOptions_Location_UsSouth = "us-south"
)

Constants associated with the CreateActionOptions.Location property. List of locations supported by IBM Cloud Schematics service. While creating your workspace or action, choose the right region, since it cannot be changed. Note, this does not limit the location of the IBM Cloud resources, provisioned using Schematics.

const (
	CreateActionOptions_InventoryConnectionType_Ssh   = "ssh"
	CreateActionOptions_InventoryConnectionType_Winrm = "winrm"
)

Constants associated with the CreateActionOptions.InventoryConnectionType property. Type of connection to be used when connecting to remote host. **Note** Currently, WinRM supports only Windows system with the public IPs and do not support Bastion host.

const (
	CreateActionOptions_SourceType_GitHub           = "git_hub"
	CreateActionOptions_SourceType_GitHubEnterprise = "git_hub_enterprise"
	CreateActionOptions_SourceType_GitLab           = "git_lab"
	CreateActionOptions_SourceType_IbmCloudCatalog  = "ibm_cloud_catalog"
	CreateActionOptions_SourceType_IbmGitLab        = "ibm_git_lab"
	CreateActionOptions_SourceType_Local            = "local"
)

Constants associated with the CreateActionOptions.SourceType property. Type of source for the Template.

const (
	CreateAgentDataOptions_SchematicsLocation_EuDe    = "eu-de"
	CreateAgentDataOptions_SchematicsLocation_EuGb    = "eu-gb"
	CreateAgentDataOptions_SchematicsLocation_UsEast  = "us-east"
	CreateAgentDataOptions_SchematicsLocation_UsSouth = "us-south"
)

Constants associated with the CreateAgentDataOptions.SchematicsLocation property. List of locations supported by IBM Cloud Schematics service. While creating your workspace or action, choose the right region, since it cannot be changed. Note, this does not limit the location of the IBM Cloud resources, provisioned using Schematics.

const (
	CreateInventoryOptions_Location_EuDe    = "eu-de"
	CreateInventoryOptions_Location_EuGb    = "eu-gb"
	CreateInventoryOptions_Location_UsEast  = "us-east"
	CreateInventoryOptions_Location_UsSouth = "us-south"
)

Constants associated with the CreateInventoryOptions.Location property. List of locations supported by IBM Cloud Schematics service. While creating your workspace or action, choose the right region, since it cannot be changed. Note, this does not limit the location of the IBM Cloud resources, provisioned using Schematics.

const (
	CreateJobOptions_CommandObject_Action      = "action"
	CreateJobOptions_CommandObject_Environment = "environment"
	CreateJobOptions_CommandObject_System      = "system"
	CreateJobOptions_CommandObject_Workspace   = "workspace"
)

Constants associated with the CreateJobOptions.CommandObject property. Name of the Schematics automation resource.

const (
	CreateJobOptions_CommandName_AnsiblePlaybookCheck = "ansible_playbook_check"
	CreateJobOptions_CommandName_AnsiblePlaybookRun   = "ansible_playbook_run"
	CreateJobOptions_CommandName_CreateAction         = "create_action"
	CreateJobOptions_CommandName_CreateCart           = "create_cart"
	CreateJobOptions_CommandName_CreateWorkspace      = "create_workspace"
	CreateJobOptions_CommandName_DeleteAction         = "delete_action"
	CreateJobOptions_CommandName_DeleteWorkspace      = "delete_workspace"
	CreateJobOptions_CommandName_PatchAction          = "patch_action"
	CreateJobOptions_CommandName_PatchWorkspace       = "patch_workspace"
	CreateJobOptions_CommandName_PutAction            = "put_action"
	CreateJobOptions_CommandName_PutWorkspace         = "put_workspace"
	CreateJobOptions_CommandName_RepositoryProcess    = "repository_process"
	CreateJobOptions_CommandName_SystemKeyDelete      = "system_key_delete"
	CreateJobOptions_CommandName_SystemKeyDisable     = "system_key_disable"
	CreateJobOptions_CommandName_SystemKeyEnable      = "system_key_enable"
	CreateJobOptions_CommandName_SystemKeyRestore     = "system_key_restore"
	CreateJobOptions_CommandName_SystemKeyRotate      = "system_key_rotate"
	CreateJobOptions_CommandName_TerraformCommands    = "terraform_commands"
	CreateJobOptions_CommandName_WorkspaceApply       = "workspace_apply"
	CreateJobOptions_CommandName_WorkspaceDestroy     = "workspace_destroy"
	CreateJobOptions_CommandName_WorkspacePlan        = "workspace_plan"
	CreateJobOptions_CommandName_WorkspaceRefresh     = "workspace_refresh"
)

Constants associated with the CreateJobOptions.CommandName property. Schematics job command name.

const (
	CreateJobOptions_Location_EuDe    = "eu-de"
	CreateJobOptions_Location_EuGb    = "eu-gb"
	CreateJobOptions_Location_UsEast  = "us-east"
	CreateJobOptions_Location_UsSouth = "us-south"
)

Constants associated with the CreateJobOptions.Location property. List of locations supported by IBM Cloud Schematics service. While creating your workspace or action, choose the right region, since it cannot be changed. Note, this does not limit the location of the IBM Cloud resources, provisioned using Schematics.

const (
	CreatePolicyOptions_Location_EuDe    = "eu-de"
	CreatePolicyOptions_Location_EuGb    = "eu-gb"
	CreatePolicyOptions_Location_UsEast  = "us-east"
	CreatePolicyOptions_Location_UsSouth = "us-south"
)

Constants associated with the CreatePolicyOptions.Location property. List of locations supported by IBM Cloud Schematics service. While creating your workspace or action, choose the right region, since it cannot be changed. Note, this does not limit the location of the IBM Cloud resources, provisioned using Schematics.

const (
	CredentialVariableMetadata_Type_Link   = "link"
	CredentialVariableMetadata_Type_String = "string"
)

Constants associated with the CredentialVariableMetadata.Type property. Type of the variable.

const (
	CredentialVariableMetadata_LinkStatus_Broken = "broken"
	CredentialVariableMetadata_LinkStatus_Normal = "normal"
)

Constants associated with the CredentialVariableMetadata.LinkStatus property. The status of the link.

const (
	ExternalSource_SourceType_GitHub           = "git_hub"
	ExternalSource_SourceType_GitHubEnterprise = "git_hub_enterprise"
	ExternalSource_SourceType_GitLab           = "git_lab"
	ExternalSource_SourceType_IbmCloudCatalog  = "ibm_cloud_catalog"
	ExternalSource_SourceType_IbmGitLab        = "ibm_git_lab"
	ExternalSource_SourceType_Local            = "local"
)

Constants associated with the ExternalSource.SourceType property. Type of source for the Template.

const (
	GetActionOptions_Profile_Detailed = "detailed"
	GetActionOptions_Profile_Ids      = "ids"
	GetActionOptions_Profile_Summary  = "summary"
)

Constants associated with the GetActionOptions.Profile property. Level of details returned by the get method.

const (
	GetAgentDataOptions_Profile_Detailed = "detailed"
	GetAgentDataOptions_Profile_Ids      = "ids"
	GetAgentDataOptions_Profile_Summary  = "summary"
)

Constants associated with the GetAgentDataOptions.Profile property. Level of details returned by the get method.

const (
	GetAgentOptions_Profile_Detailed = "detailed"
	GetAgentOptions_Profile_Ids      = "ids"
	GetAgentOptions_Profile_Summary  = "summary"
)

Constants associated with the GetAgentOptions.Profile property. Level of details returned by the get method.

const (
	GetInventoryOptions_Profile_Detailed = "detailed"
	GetInventoryOptions_Profile_Ids      = "ids"
	GetInventoryOptions_Profile_Summary  = "summary"
)

Constants associated with the GetInventoryOptions.Profile property. Level of details returned by the get method.

const (
	GetJobFilesOptions_FileType_LogFile      = "log_file"
	GetJobFilesOptions_FileType_PlanJSON     = "plan_json"
	GetJobFilesOptions_FileType_ReadmeFile   = "readme_file"
	GetJobFilesOptions_FileType_StateFile    = "state_file"
	GetJobFilesOptions_FileType_TemplateRepo = "template_repo"
)

Constants associated with the GetJobFilesOptions.FileType property. The type of file you want to download eg.state_file, plan_json.

const (
	GetJobOptions_Profile_Detailed = "detailed"
	GetJobOptions_Profile_Ids      = "ids"
	GetJobOptions_Profile_Summary  = "summary"
)

Constants associated with the GetJobOptions.Profile property. Level of details returned by the get method.

const (
	GetPolicyOptions_Profile_Detailed = "detailed"
	GetPolicyOptions_Profile_Ids      = "ids"
	GetPolicyOptions_Profile_Summary  = "summary"
)

Constants associated with the GetPolicyOptions.Profile property. Level of details returned by the get method.

const (
	GetWorkspaceReadmeOptions_Formatted_HTML     = "html"
	GetWorkspaceReadmeOptions_Formatted_Markdown = "markdown"
)

Constants associated with the GetWorkspaceReadmeOptions.Formatted property. The format of the readme file. Value ”markdown” will give markdown, otherwise html.

const (
	InventoryResourceRecord_Location_EuDe    = "eu-de"
	InventoryResourceRecord_Location_EuGb    = "eu-gb"
	InventoryResourceRecord_Location_UsEast  = "us-east"
	InventoryResourceRecord_Location_UsSouth = "us-south"
)

Constants associated with the InventoryResourceRecord.Location property. List of locations supported by IBM Cloud Schematics service. While creating your workspace or action, choose the right region, since it cannot be changed. Note, this does not limit the location of the IBM Cloud resources, provisioned using Schematics.

const (
	Job_CommandObject_Action      = "action"
	Job_CommandObject_Environment = "environment"
	Job_CommandObject_System      = "system"
	Job_CommandObject_Workspace   = "workspace"
)

Constants associated with the Job.CommandObject property. Name of the Schematics automation resource.

const (
	Job_CommandName_AnsiblePlaybookCheck = "ansible_playbook_check"
	Job_CommandName_AnsiblePlaybookRun   = "ansible_playbook_run"
	Job_CommandName_CreateAction         = "create_action"
	Job_CommandName_CreateCart           = "create_cart"
	Job_CommandName_CreateWorkspace      = "create_workspace"
	Job_CommandName_DeleteAction         = "delete_action"
	Job_CommandName_DeleteWorkspace      = "delete_workspace"
	Job_CommandName_PatchAction          = "patch_action"
	Job_CommandName_PatchWorkspace       = "patch_workspace"
	Job_CommandName_PutAction            = "put_action"
	Job_CommandName_PutWorkspace         = "put_workspace"
	Job_CommandName_RepositoryProcess    = "repository_process"
	Job_CommandName_SystemKeyDelete      = "system_key_delete"
	Job_CommandName_SystemKeyDisable     = "system_key_disable"
	Job_CommandName_SystemKeyEnable      = "system_key_enable"
	Job_CommandName_SystemKeyRestore     = "system_key_restore"
	Job_CommandName_SystemKeyRotate      = "system_key_rotate"
	Job_CommandName_TerraformCommands    = "terraform_commands"
	Job_CommandName_WorkspaceApply       = "workspace_apply"
	Job_CommandName_WorkspaceDestroy     = "workspace_destroy"
	Job_CommandName_WorkspacePlan        = "workspace_plan"
	Job_CommandName_WorkspaceRefresh     = "workspace_refresh"
)

Constants associated with the Job.CommandName property. Schematics job command name.

const (
	Job_Location_EuDe    = "eu-de"
	Job_Location_EuGb    = "eu-gb"
	Job_Location_UsEast  = "us-east"
	Job_Location_UsSouth = "us-south"
)

Constants associated with the Job.Location property. List of locations supported by IBM Cloud Schematics service. While creating your workspace or action, choose the right region, since it cannot be changed. Note, this does not limit the location of the IBM Cloud resources, provisioned using Schematics.

const (
	JobData_JobType_ActionJob       = "action_job"
	JobData_JobType_FlowJob         = "flow-job"
	JobData_JobType_RepoDownloadJob = "repo_download_job"
	JobData_JobType_SystemJob       = "system_job"
	JobData_JobType_WorkspaceJob    = "workspace_job"
)

Constants associated with the JobData.JobType property. Type of Job.

const (
	JobDataWorkItem_SourceType_GitHub           = "git_hub"
	JobDataWorkItem_SourceType_GitHubEnterprise = "git_hub_enterprise"
	JobDataWorkItem_SourceType_GitLab           = "git_lab"
	JobDataWorkItem_SourceType_IbmCloudCatalog  = "ibm_cloud_catalog"
	JobDataWorkItem_SourceType_IbmGitLab        = "ibm_git_lab"
	JobDataWorkItem_SourceType_Local            = "local"
)

Constants associated with the JobDataWorkItem.SourceType property. Type of source for the Template.

const (
	JobDataWorkItemLastJob_CommandObject_Action      = "action"
	JobDataWorkItemLastJob_CommandObject_Environment = "environment"
	JobDataWorkItemLastJob_CommandObject_System      = "system"
	JobDataWorkItemLastJob_CommandObject_Workspace   = "workspace"
)

Constants associated with the JobDataWorkItemLastJob.CommandObject property. Name of the Schematics automation resource.

const (
	JobDataWorkItemLastJob_CommandName_AnsiblePlaybookCheck = "ansible_playbook_check"
	JobDataWorkItemLastJob_CommandName_AnsiblePlaybookRun   = "ansible_playbook_run"
	JobDataWorkItemLastJob_CommandName_CreateAction         = "create_action"
	JobDataWorkItemLastJob_CommandName_CreateCart           = "create_cart"
	JobDataWorkItemLastJob_CommandName_CreateWorkspace      = "create_workspace"
	JobDataWorkItemLastJob_CommandName_DeleteAction         = "delete_action"
	JobDataWorkItemLastJob_CommandName_DeleteWorkspace      = "delete_workspace"
	JobDataWorkItemLastJob_CommandName_PatchAction          = "patch_action"
	JobDataWorkItemLastJob_CommandName_PatchWorkspace       = "patch_workspace"
	JobDataWorkItemLastJob_CommandName_PutAction            = "put_action"
	JobDataWorkItemLastJob_CommandName_PutWorkspace         = "put_workspace"
	JobDataWorkItemLastJob_CommandName_RepositoryProcess    = "repository_process"
	JobDataWorkItemLastJob_CommandName_SystemKeyDelete      = "system_key_delete"
	JobDataWorkItemLastJob_CommandName_SystemKeyDisable     = "system_key_disable"
	JobDataWorkItemLastJob_CommandName_SystemKeyEnable      = "system_key_enable"
	JobDataWorkItemLastJob_CommandName_SystemKeyRestore     = "system_key_restore"
	JobDataWorkItemLastJob_CommandName_SystemKeyRotate      = "system_key_rotate"
	JobDataWorkItemLastJob_CommandName_TerraformCommands    = "terraform_commands"
	JobDataWorkItemLastJob_CommandName_WorkspaceApply       = "workspace_apply"
	JobDataWorkItemLastJob_CommandName_WorkspaceDestroy     = "workspace_destroy"
	JobDataWorkItemLastJob_CommandName_WorkspacePlan        = "workspace_plan"
	JobDataWorkItemLastJob_CommandName_WorkspaceRefresh     = "workspace_refresh"
)

Constants associated with the JobDataWorkItemLastJob.CommandName property. Schematics job command name.

const (
	JobDataWorkItemLastJob_JobStatus_JobCancelled      = "job_cancelled"
	JobDataWorkItemLastJob_JobStatus_JobFailed         = "job_failed"
	JobDataWorkItemLastJob_JobStatus_JobFinished       = "job_finished"
	JobDataWorkItemLastJob_JobStatus_JobInProgress     = "job_in_progress"
	JobDataWorkItemLastJob_JobStatus_JobPending        = "job_pending"
	JobDataWorkItemLastJob_JobStatus_JobReadyToExecute = "job_ready_to_execute"
	JobDataWorkItemLastJob_JobStatus_JobStopInProgress = "job_stop_in_progress"
	JobDataWorkItemLastJob_JobStatus_JobStopped        = "job_stopped"
)

Constants associated with the JobDataWorkItemLastJob.JobStatus property. Status of Jobs.

const (
	JobFileData_FileType_CostJSON        = "cost_json"
	JobFileData_FileType_DraftPlanJSON   = "draft_plan_json"
	JobFileData_FileType_GitFiles        = "git_files"
	JobFileData_FileType_LogInsightsFile = "log_insights_file"
	JobFileData_FileType_PlanJSON        = "plan_json"
	JobFileData_FileType_QuoteJSON       = "quote_json"
	JobFileData_FileType_StateFile       = "state_file"
)

Constants associated with the JobFileData.FileType property. The type of output file generated by the Job.

const (
	JobFileDataSummary_Type_Number = "number"
	JobFileDataSummary_Type_String = "string"
)

Constants associated with the JobFileDataSummary.Type property. Summary feature type.

const (
	JobLite_CommandObject_Action      = "action"
	JobLite_CommandObject_Environment = "environment"
	JobLite_CommandObject_System      = "system"
	JobLite_CommandObject_Workspace   = "workspace"
)

Constants associated with the JobLite.CommandObject property. Name of the Schematics automation resource.

const (
	JobLite_CommandName_AnsiblePlaybookCheck = "ansible_playbook_check"
	JobLite_CommandName_AnsiblePlaybookRun   = "ansible_playbook_run"
	JobLite_CommandName_CreateAction         = "create_action"
	JobLite_CommandName_CreateCart           = "create_cart"
	JobLite_CommandName_CreateWorkspace      = "create_workspace"
	JobLite_CommandName_DeleteAction         = "delete_action"
	JobLite_CommandName_DeleteWorkspace      = "delete_workspace"
	JobLite_CommandName_PatchAction          = "patch_action"
	JobLite_CommandName_PatchWorkspace       = "patch_workspace"
	JobLite_CommandName_PutAction            = "put_action"
	JobLite_CommandName_PutWorkspace         = "put_workspace"
	JobLite_CommandName_RepositoryProcess    = "repository_process"
	JobLite_CommandName_SystemKeyDelete      = "system_key_delete"
	JobLite_CommandName_SystemKeyDisable     = "system_key_disable"
	JobLite_CommandName_SystemKeyEnable      = "system_key_enable"
	JobLite_CommandName_SystemKeyRestore     = "system_key_restore"
	JobLite_CommandName_SystemKeyRotate      = "system_key_rotate"
	JobLite_CommandName_TerraformCommands    = "terraform_commands"
	JobLite_CommandName_WorkspaceApply       = "workspace_apply"
	JobLite_CommandName_WorkspaceDestroy     = "workspace_destroy"
	JobLite_CommandName_WorkspacePlan        = "workspace_plan"
	JobLite_CommandName_WorkspaceRefresh     = "workspace_refresh"
)

Constants associated with the JobLite.CommandName property. Schematics job command name.

const (
	JobLite_Location_EuDe    = "eu-de"
	JobLite_Location_EuGb    = "eu-gb"
	JobLite_Location_UsEast  = "us-east"
	JobLite_Location_UsSouth = "us-south"
)

Constants associated with the JobLite.Location property. List of locations supported by IBM Cloud Schematics service. While creating your workspace or action, choose the right region, since it cannot be changed. Note, this does not limit the location of the IBM Cloud resources, provisioned using Schematics.

const (
	JobLog_Format_HTML     = "html"
	JobLog_Format_JSON     = "json"
	JobLog_Format_Markdown = "markdown"
	JobLog_Format_Rtf      = "rtf"
)

Constants associated with the JobLog.Format property. Format of the Log text.

const (
	JobLogSummary_JobType_ActionJob       = "action_job"
	JobLogSummary_JobType_FlowJob         = "flow_job"
	JobLogSummary_JobType_RepoDownloadJob = "repo_download_job"
	JobLogSummary_JobType_SystemJob       = "system_job"
	JobLogSummary_JobType_WorkspaceJob    = "workspace_job"
)

Constants associated with the JobLogSummary.JobType property. Type of Job.

const (
	JobStatusAction_StatusCode_JobCancelled      = "job_cancelled"
	JobStatusAction_StatusCode_JobFailed         = "job_failed"
	JobStatusAction_StatusCode_JobFinished       = "job_finished"
	JobStatusAction_StatusCode_JobInProgress     = "job_in_progress"
	JobStatusAction_StatusCode_JobPending        = "job_pending"
	JobStatusAction_StatusCode_JobReadyToExecute = "job_ready_to_execute"
	JobStatusAction_StatusCode_JobStopInProgress = "job_stop_in_progress"
	JobStatusAction_StatusCode_JobStopped        = "job_stopped"
)

Constants associated with the JobStatusAction.StatusCode property. Status of Jobs.

const (
	JobStatusAction_BastionStatusCode_Error      = "error"
	JobStatusAction_BastionStatusCode_None       = "none"
	JobStatusAction_BastionStatusCode_Processing = "processing"
	JobStatusAction_BastionStatusCode_Ready      = "ready"
)

Constants associated with the JobStatusAction.BastionStatusCode property. Status of Resources.

const (
	JobStatusAction_TargetsStatusCode_Error      = "error"
	JobStatusAction_TargetsStatusCode_None       = "none"
	JobStatusAction_TargetsStatusCode_Processing = "processing"
	JobStatusAction_TargetsStatusCode_Ready      = "ready"
)

Constants associated with the JobStatusAction.TargetsStatusCode property. Status of Resources.

const (
	JobStatusFlow_StatusCode_JobCancelled      = "job_cancelled"
	JobStatusFlow_StatusCode_JobFailed         = "job_failed"
	JobStatusFlow_StatusCode_JobFinished       = "job_finished"
	JobStatusFlow_StatusCode_JobInProgress     = "job_in_progress"
	JobStatusFlow_StatusCode_JobPending        = "job_pending"
	JobStatusFlow_StatusCode_JobReadyToExecute = "job_ready_to_execute"
	JobStatusFlow_StatusCode_JobStopInProgress = "job_stop_in_progress"
	JobStatusFlow_StatusCode_JobStopped        = "job_stopped"
)

Constants associated with the JobStatusFlow.StatusCode property. Status of Jobs.

const (
	JobStatusSchematicsResources_StatusCode_JobCancelled      = "job_cancelled"
	JobStatusSchematicsResources_StatusCode_JobFailed         = "job_failed"
	JobStatusSchematicsResources_StatusCode_JobFinished       = "job_finished"
	JobStatusSchematicsResources_StatusCode_JobInProgress     = "job_in_progress"
	JobStatusSchematicsResources_StatusCode_JobPending        = "job_pending"
	JobStatusSchematicsResources_StatusCode_JobReadyToExecute = "job_ready_to_execute"
	JobStatusSchematicsResources_StatusCode_JobStopInProgress = "job_stop_in_progress"
	JobStatusSchematicsResources_StatusCode_JobStopped        = "job_stopped"
)

Constants associated with the JobStatusSchematicsResources.StatusCode property. Status of Jobs.

const (
	JobStatusSystem_SystemStatusCode_JobCancelled      = "job_cancelled"
	JobStatusSystem_SystemStatusCode_JobFailed         = "job_failed"
	JobStatusSystem_SystemStatusCode_JobFinished       = "job_finished"
	JobStatusSystem_SystemStatusCode_JobInProgress     = "job_in_progress"
	JobStatusSystem_SystemStatusCode_JobPending        = "job_pending"
	JobStatusSystem_SystemStatusCode_JobReadyToExecute = "job_ready_to_execute"
	JobStatusSystem_SystemStatusCode_JobStopInProgress = "job_stop_in_progress"
	JobStatusSystem_SystemStatusCode_JobStopped        = "job_stopped"
)

Constants associated with the JobStatusSystem.SystemStatusCode property. Status of Jobs.

const (
	JobStatusTemplate_StatusCode_JobCancelled      = "job_cancelled"
	JobStatusTemplate_StatusCode_JobFailed         = "job_failed"
	JobStatusTemplate_StatusCode_JobFinished       = "job_finished"
	JobStatusTemplate_StatusCode_JobInProgress     = "job_in_progress"
	JobStatusTemplate_StatusCode_JobPending        = "job_pending"
	JobStatusTemplate_StatusCode_JobReadyToExecute = "job_ready_to_execute"
	JobStatusTemplate_StatusCode_JobStopInProgress = "job_stop_in_progress"
	JobStatusTemplate_StatusCode_JobStopped        = "job_stopped"
)

Constants associated with the JobStatusTemplate.StatusCode property. Status of Jobs.

const (
	JobStatusWorkitem_StatusCode_JobCancelled      = "job_cancelled"
	JobStatusWorkitem_StatusCode_JobFailed         = "job_failed"
	JobStatusWorkitem_StatusCode_JobFinished       = "job_finished"
	JobStatusWorkitem_StatusCode_JobInProgress     = "job_in_progress"
	JobStatusWorkitem_StatusCode_JobPending        = "job_pending"
	JobStatusWorkitem_StatusCode_JobReadyToExecute = "job_ready_to_execute"
	JobStatusWorkitem_StatusCode_JobStopInProgress = "job_stop_in_progress"
	JobStatusWorkitem_StatusCode_JobStopped        = "job_stopped"
)

Constants associated with the JobStatusWorkitem.StatusCode property. Status of Jobs.

const (
	JobStatusWorkspace_StatusCode_JobCancelled      = "job_cancelled"
	JobStatusWorkspace_StatusCode_JobFailed         = "job_failed"
	JobStatusWorkspace_StatusCode_JobFinished       = "job_finished"
	JobStatusWorkspace_StatusCode_JobInProgress     = "job_in_progress"
	JobStatusWorkspace_StatusCode_JobPending        = "job_pending"
	JobStatusWorkspace_StatusCode_JobReadyToExecute = "job_ready_to_execute"
	JobStatusWorkspace_StatusCode_JobStopInProgress = "job_stop_in_progress"
	JobStatusWorkspace_StatusCode_JobStopped        = "job_stopped"
)

Constants associated with the JobStatusWorkspace.StatusCode property. Status of Jobs.

const (
	ListActionsOptions_Profile_Ids     = "ids"
	ListActionsOptions_Profile_Summary = "summary"
)

Constants associated with the ListActionsOptions.Profile property. Level of details returned by the get method.

const (
	ListAgentDataOptions_Profile_Detailed = "detailed"
	ListAgentDataOptions_Profile_Ids      = "ids"
	ListAgentDataOptions_Profile_Summary  = "summary"
)

Constants associated with the ListAgentDataOptions.Profile property. Level of details returned by the get method.

const (
	ListAgentDataOptions_Filter_All   = "all"
	ListAgentDataOptions_Filter_New   = "new"
	ListAgentDataOptions_Filter_Saved = "saved"
)

Constants associated with the ListAgentDataOptions.Filter property. Use `new` to get all unregistered agents; use `saved` to get all registered agents.

const (
	ListAgentOptions_Profile_Detailed = "detailed"
	ListAgentOptions_Profile_Ids      = "ids"
	ListAgentOptions_Profile_Summary  = "summary"
)

Constants associated with the ListAgentOptions.Profile property. Level of details returned by the get method.

const (
	ListAgentOptions_Filter_All   = "all"
	ListAgentOptions_Filter_New   = "new"
	ListAgentOptions_Filter_Saved = "saved"
)

Constants associated with the ListAgentOptions.Filter property. Use `new` to get all unregistered agents; use `saved` to get all registered agents.

const (
	ListInventoriesOptions_Profile_Ids     = "ids"
	ListInventoriesOptions_Profile_Summary = "summary"
)

Constants associated with the ListInventoriesOptions.Profile property. Level of details returned by the get method.

const (
	ListJobsOptions_Profile_Ids     = "ids"
	ListJobsOptions_Profile_Summary = "summary"
)

Constants associated with the ListJobsOptions.Profile property. Level of details returned by the get method.

const (
	ListJobsOptions_Resource_Action      = "action"
	ListJobsOptions_Resource_Actions     = "actions"
	ListJobsOptions_Resource_Environment = "environment"
	ListJobsOptions_Resource_Workspaces  = "workspaces"
)

Constants associated with the ListJobsOptions.Resource property. Name of the resource (workspaces, actions, environment or controls).

const (
	ListPolicyOptions_Profile_Detailed = "detailed"
	ListPolicyOptions_Profile_Ids      = "ids"
	ListPolicyOptions_Profile_Summary  = "summary"
)

Constants associated with the ListPolicyOptions.Profile property. Level of details returned by the get method.

const (
	ListResourceQueryOptions_Profile_Ids     = "ids"
	ListResourceQueryOptions_Profile_Summary = "summary"
)

Constants associated with the ListResourceQueryOptions.Profile property. Level of details returned by the get method.

const (
	ListWorkspacesOptions_Profile_Ids     = "ids"
	ListWorkspacesOptions_Profile_Summary = "summary"
)

Constants associated with the ListWorkspacesOptions.Profile property. Level of details returned by the get method.

const (
	Policy_Location_EuDe    = "eu-de"
	Policy_Location_EuGb    = "eu-gb"
	Policy_Location_UsEast  = "us-east"
	Policy_Location_UsSouth = "us-south"
)

Constants associated with the Policy.Location property. List of locations supported by IBM Cloud Schematics service. While creating your workspace or action, choose the right region, since it cannot be changed. Note, this does not limit the location of the IBM Cloud resources, provisioned using Schematics.

const (
	PolicyLite_Location_EuDe    = "eu-de"
	PolicyLite_Location_EuGb    = "eu-gb"
	PolicyLite_Location_UsEast  = "us-east"
	PolicyLite_Location_UsSouth = "us-south"
)

Constants associated with the PolicyLite.Location property. List of locations supported by IBM Cloud Schematics service. While creating your workspace or action, choose the right region, since it cannot be changed. Note, this does not limit the location of the IBM Cloud resources, provisioned using Schematics.

const (
	PolicyObjectSelector_Kind_Action      = "action"
	PolicyObjectSelector_Kind_Environment = "environment"
	PolicyObjectSelector_Kind_System      = "system"
	PolicyObjectSelector_Kind_Workspace   = "workspace"
)

Constants associated with the PolicyObjectSelector.Kind property. Name of the Schematics automation resource.

const (
	PolicyObjectSelector_Locations_EuDe    = "eu-de"
	PolicyObjectSelector_Locations_EuGb    = "eu-gb"
	PolicyObjectSelector_Locations_UsEast  = "us-east"
	PolicyObjectSelector_Locations_UsSouth = "us-south"
)

Constants associated with the PolicyObjectSelector.Locations property. List of locations supported by IBM Cloud Schematics service. While creating your workspace or action, choose the right region, since it cannot be changed. Note, this does not limit the location of the IBM Cloud resources, provisioned using Schematics.

const (
	PolicyObjects_SelectorKind_Ids    = "ids"
	PolicyObjects_SelectorKind_Scoped = "scoped"
)

Constants associated with the PolicyObjects.SelectorKind property. Types of schematics object selector.

const (
	ProcessTemplateMetaDataOptions_SourceType_GitHub           = "git_hub"
	ProcessTemplateMetaDataOptions_SourceType_GitHubEnterprise = "git_hub_enterprise"
	ProcessTemplateMetaDataOptions_SourceType_GitLab           = "git_lab"
	ProcessTemplateMetaDataOptions_SourceType_IbmCloudCatalog  = "ibm_cloud_catalog"
	ProcessTemplateMetaDataOptions_SourceType_IbmGitLab        = "ibm_git_lab"
	ProcessTemplateMetaDataOptions_SourceType_Local            = "local"
)

Constants associated with the ProcessTemplateMetaDataOptions.SourceType property. Type of source for the Template.

const (
	RegisterAgentOptions_Location_EuDe    = "eu-de"
	RegisterAgentOptions_Location_EuGb    = "eu-gb"
	RegisterAgentOptions_Location_UsEast  = "us-east"
	RegisterAgentOptions_Location_UsSouth = "us-south"
)

Constants associated with the RegisterAgentOptions.Location property. List of locations supported by IBM Cloud Schematics service. While creating your workspace or action, choose the right region, since it cannot be changed. Note, this does not limit the location of the IBM Cloud resources, provisioned using Schematics.

const (
	ReplaceInventoryOptions_Location_EuDe    = "eu-de"
	ReplaceInventoryOptions_Location_EuGb    = "eu-gb"
	ReplaceInventoryOptions_Location_UsEast  = "us-east"
	ReplaceInventoryOptions_Location_UsSouth = "us-south"
)

Constants associated with the ReplaceInventoryOptions.Location property. List of locations supported by IBM Cloud Schematics service. While creating your workspace or action, choose the right region, since it cannot be changed. Note, this does not limit the location of the IBM Cloud resources, provisioned using Schematics.

const (
	ScopedResource_Kind_Action      = "action"
	ScopedResource_Kind_Environment = "environment"
	ScopedResource_Kind_System      = "system"
	ScopedResource_Kind_Workspace   = "workspace"
)

Constants associated with the ScopedResource.Kind property. Name of the Schematics automation resource.

const (
	UpdateActionOptions_Location_EuDe    = "eu-de"
	UpdateActionOptions_Location_EuGb    = "eu-gb"
	UpdateActionOptions_Location_UsEast  = "us-east"
	UpdateActionOptions_Location_UsSouth = "us-south"
)

Constants associated with the UpdateActionOptions.Location property. List of locations supported by IBM Cloud Schematics service. While creating your workspace or action, choose the right region, since it cannot be changed. Note, this does not limit the location of the IBM Cloud resources, provisioned using Schematics.

const (
	UpdateActionOptions_InventoryConnectionType_Ssh   = "ssh"
	UpdateActionOptions_InventoryConnectionType_Winrm = "winrm"
)

Constants associated with the UpdateActionOptions.InventoryConnectionType property. Type of connection to be used when connecting to remote host. **Note** Currently, WinRM supports only Windows system with the public IPs and do not support Bastion host.

const (
	UpdateActionOptions_SourceType_GitHub           = "git_hub"
	UpdateActionOptions_SourceType_GitHubEnterprise = "git_hub_enterprise"
	UpdateActionOptions_SourceType_GitLab           = "git_lab"
	UpdateActionOptions_SourceType_IbmCloudCatalog  = "ibm_cloud_catalog"
	UpdateActionOptions_SourceType_IbmGitLab        = "ibm_git_lab"
	UpdateActionOptions_SourceType_Local            = "local"
)

Constants associated with the UpdateActionOptions.SourceType property. Type of source for the Template.

const (
	UpdateAgentDataOptions_SchematicsLocation_EuDe    = "eu-de"
	UpdateAgentDataOptions_SchematicsLocation_EuGb    = "eu-gb"
	UpdateAgentDataOptions_SchematicsLocation_UsEast  = "us-east"
	UpdateAgentDataOptions_SchematicsLocation_UsSouth = "us-south"
)

Constants associated with the UpdateAgentDataOptions.SchematicsLocation property. List of locations supported by IBM Cloud Schematics service. While creating your workspace or action, choose the right region, since it cannot be changed. Note, this does not limit the location of the IBM Cloud resources, provisioned using Schematics.

const (
	UpdateAgentRegistrationOptions_Location_EuDe    = "eu-de"
	UpdateAgentRegistrationOptions_Location_EuGb    = "eu-gb"
	UpdateAgentRegistrationOptions_Location_UsEast  = "us-east"
	UpdateAgentRegistrationOptions_Location_UsSouth = "us-south"
)

Constants associated with the UpdateAgentRegistrationOptions.Location property. List of locations supported by IBM Cloud Schematics service. While creating your workspace or action, choose the right region, since it cannot be changed. Note, this does not limit the location of the IBM Cloud resources, provisioned using Schematics.

const (
	UpdateJobOptions_CommandObject_Action      = "action"
	UpdateJobOptions_CommandObject_Environment = "environment"
	UpdateJobOptions_CommandObject_System      = "system"
	UpdateJobOptions_CommandObject_Workspace   = "workspace"
)

Constants associated with the UpdateJobOptions.CommandObject property. Name of the Schematics automation resource.

const (
	UpdateJobOptions_CommandName_AnsiblePlaybookCheck = "ansible_playbook_check"
	UpdateJobOptions_CommandName_AnsiblePlaybookRun   = "ansible_playbook_run"
	UpdateJobOptions_CommandName_CreateAction         = "create_action"
	UpdateJobOptions_CommandName_CreateCart           = "create_cart"
	UpdateJobOptions_CommandName_CreateWorkspace      = "create_workspace"
	UpdateJobOptions_CommandName_DeleteAction         = "delete_action"
	UpdateJobOptions_CommandName_DeleteWorkspace      = "delete_workspace"
	UpdateJobOptions_CommandName_PatchAction          = "patch_action"
	UpdateJobOptions_CommandName_PatchWorkspace       = "patch_workspace"
	UpdateJobOptions_CommandName_PutAction            = "put_action"
	UpdateJobOptions_CommandName_PutWorkspace         = "put_workspace"
	UpdateJobOptions_CommandName_RepositoryProcess    = "repository_process"
	UpdateJobOptions_CommandName_SystemKeyDelete      = "system_key_delete"
	UpdateJobOptions_CommandName_SystemKeyDisable     = "system_key_disable"
	UpdateJobOptions_CommandName_SystemKeyEnable      = "system_key_enable"
	UpdateJobOptions_CommandName_SystemKeyRestore     = "system_key_restore"
	UpdateJobOptions_CommandName_SystemKeyRotate      = "system_key_rotate"
	UpdateJobOptions_CommandName_TerraformCommands    = "terraform_commands"
	UpdateJobOptions_CommandName_WorkspaceApply       = "workspace_apply"
	UpdateJobOptions_CommandName_WorkspaceDestroy     = "workspace_destroy"
	UpdateJobOptions_CommandName_WorkspacePlan        = "workspace_plan"
	UpdateJobOptions_CommandName_WorkspaceRefresh     = "workspace_refresh"
)

Constants associated with the UpdateJobOptions.CommandName property. Schematics job command name.

const (
	UpdateJobOptions_Location_EuDe    = "eu-de"
	UpdateJobOptions_Location_EuGb    = "eu-gb"
	UpdateJobOptions_Location_UsEast  = "us-east"
	UpdateJobOptions_Location_UsSouth = "us-south"
)

Constants associated with the UpdateJobOptions.Location property. List of locations supported by IBM Cloud Schematics service. While creating your workspace or action, choose the right region, since it cannot be changed. Note, this does not limit the location of the IBM Cloud resources, provisioned using Schematics.

const (
	UpdatePolicyOptions_Location_EuDe    = "eu-de"
	UpdatePolicyOptions_Location_EuGb    = "eu-gb"
	UpdatePolicyOptions_Location_UsEast  = "us-east"
	UpdatePolicyOptions_Location_UsSouth = "us-south"
)

Constants associated with the UpdatePolicyOptions.Location property. List of locations supported by IBM Cloud Schematics service. While creating your workspace or action, choose the right region, since it cannot be changed. Note, this does not limit the location of the IBM Cloud resources, provisioned using Schematics.

const (
	UserState_State_Disable = "disable"
	UserState_State_Draft   = "draft"
	UserState_State_Live    = "live"
	UserState_State_Locked  = "locked"
)

Constants associated with the UserState.State property. User-defined states

• `draft` Object can be modified; can be used by Jobs run by the author, during execution
• `live` Object can be modified; can be used by Jobs during execution
• `locked` Object cannot be modified; can be used by Jobs during execution
• `disable` Object can be modified. cannot be used by Jobs during execution.

const (
	VariableMetadata_Type_Array   = "array"
	VariableMetadata_Type_Boolean = "boolean"
	VariableMetadata_Type_Complex = "complex"
	VariableMetadata_Type_Date    = "date"
	VariableMetadata_Type_Integer = "integer"
	VariableMetadata_Type_Link    = "link"
	VariableMetadata_Type_List    = "list"
	VariableMetadata_Type_Map     = "map"
	VariableMetadata_Type_String  = "string"
)

Constants associated with the VariableMetadata.Type property. Type of the variable.

const (
	VariableMetadata_LinkStatus_Broken = "broken"
	VariableMetadata_LinkStatus_Normal = "normal"
)

Constants associated with the VariableMetadata.LinkStatus property. The status of the link.

const (
	Action_BastionConnectionType_Ssh = "ssh"
)

Constants associated with the Action.BastionConnectionType property. Type of connection to be used when connecting to bastion host. If the `inventory_connection_type=winrm`, then `bastion_connection_type` is not supported.

const (
	CartOrderData_UsageKind_Servicetags = "servicetags"
)

Constants associated with the CartOrderData.UsageKind property. Options how the cart order data can be used.

const (
	CreateActionOptions_BastionConnectionType_Ssh = "ssh"
)

Constants associated with the CreateActionOptions.BastionConnectionType property. Type of connection to be used when connecting to bastion host. If the `inventory_connection_type=winrm`, then `bastion_connection_type` is not supported.

const (
	CreatePolicyOptions_Kind_AgentAssignmentPolicy = "agent_assignment_policy"
)

Constants associated with the CreatePolicyOptions.Kind property. Policy kind or categories for managing and deriving policy decision

• `agent_assignment_policy` Agent assignment policy for job execution.

const (
	CreateResourceQueryOptions_Type_Vsi = "vsi"
)

Constants associated with the CreateResourceQueryOptions.Type property. Resource type (cluster, vsi, icd, vpc).

const DefaultServiceName = "schematics"

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

const DefaultServiceURL = "https://schematics.cloud.ibm.com"

DefaultServiceURL is the default URL to make service requests to.

const (
	ListJobsOptions_List_All = "all"
)

Constants associated with the ListJobsOptions.List property. list jobs.

const (
	PolicyLite_PolicyKind_AgentAssignmentPolicy = "agent_assignment_policy"
)

Constants associated with the PolicyLite.PolicyKind property. Policy kind or categories for managing and deriving policy decision

• `agent_assignment_policy` Agent assignment policy for job execution.

const (
	Policy_Kind_AgentAssignmentPolicy = "agent_assignment_policy"
)

Constants associated with the Policy.Kind property. Policy kind or categories for managing and deriving policy decision

• `agent_assignment_policy` Agent assignment policy for job execution.

const (
	ReplaceResourcesQueryOptions_Type_Vsi = "vsi"
)

Constants associated with the ReplaceResourcesQueryOptions.Type property. Resource type (cluster, vsi, icd, vpc).

const (
	ResourceQueryRecord_Type_Vsi = "vsi"
)

Constants associated with the ResourceQueryRecord.Type property. Resource type (cluster, vsi, icd, vpc).

const (
	ResourceQueryResponseRecordResponse_QueryType_Workspaces = "workspaces"
)

Constants associated with the ResourceQueryResponseRecordResponse.QueryType property. Type of the query(workspaces).

const (
	ResourceQuery_QueryType_Workspaces = "workspaces"
)

Constants associated with the ResourceQuery.QueryType property. Type of the query(workspaces).

const (
	UpdateActionOptions_BastionConnectionType_Ssh = "ssh"
)

Constants associated with the UpdateActionOptions.BastionConnectionType property. Type of connection to be used when connecting to bastion host. If the `inventory_connection_type=winrm`, then `bastion_connection_type` is not supported.

const (
	UpdatePolicyOptions_Kind_AgentAssignmentPolicy = "agent_assignment_policy"
)

Constants associated with the UpdatePolicyOptions.Kind property. Policy kind or categories for managing and deriving policy decision

• `agent_assignment_policy` Agent assignment policy for job execution.

Functions

func GetServiceURLForRegion

func GetServiceURLForRegion(region string) (string, error)

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

func UnmarshalAction

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

UnmarshalAction unmarshals an instance of Action from the specified map of raw messages.

func UnmarshalActionList

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

UnmarshalActionList unmarshals an instance of ActionList from the specified map of raw messages.

func UnmarshalActionLite

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

UnmarshalActionLite unmarshals an instance of ActionLite from the specified map of raw messages.

func UnmarshalActionLiteState

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

UnmarshalActionLiteState unmarshals an instance of ActionLiteState from the specified map of raw messages.

func UnmarshalActionState

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

UnmarshalActionState unmarshals an instance of ActionState from the specified map of raw messages.

func UnmarshalAgent

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

UnmarshalAgent unmarshals an instance of Agent from the specified map of raw messages.

func UnmarshalAgentAssignmentPolicyParameter

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

UnmarshalAgentAssignmentPolicyParameter unmarshals an instance of AgentAssignmentPolicyParameter from the specified map of raw messages.

func UnmarshalAgentData

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

UnmarshalAgentData unmarshals an instance of AgentData from the specified map of raw messages.

func UnmarshalAgentDataList

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

UnmarshalAgentDataList unmarshals an instance of AgentDataList from the specified map of raw messages.

func UnmarshalAgentDataLite

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

UnmarshalAgentDataLite unmarshals an instance of AgentDataLite from the specified map of raw messages.

func UnmarshalAgentDataRecentDeployJob

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

UnmarshalAgentDataRecentDeployJob unmarshals an instance of AgentDataRecentDeployJob from the specified map of raw messages.

func UnmarshalAgentDataRecentDestroyJob

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

UnmarshalAgentDataRecentDestroyJob unmarshals an instance of AgentDataRecentDestroyJob from the specified map of raw messages.

func UnmarshalAgentDataRecentHealthJob

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

UnmarshalAgentDataRecentHealthJob unmarshals an instance of AgentDataRecentHealthJob from the specified map of raw messages.

func UnmarshalAgentDataRecentPrsJob

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

UnmarshalAgentDataRecentPrsJob unmarshals an instance of AgentDataRecentPrsJob from the specified map of raw messages.

func UnmarshalAgentDeployJob

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

UnmarshalAgentDeployJob unmarshals an instance of AgentDeployJob from the specified map of raw messages.

func UnmarshalAgentHealthJob

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

UnmarshalAgentHealthJob unmarshals an instance of AgentHealthJob from the specified map of raw messages.

func UnmarshalAgentInfo

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

UnmarshalAgentInfo unmarshals an instance of AgentInfo from the specified map of raw messages.

func UnmarshalAgentInfrastructure

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

UnmarshalAgentInfrastructure unmarshals an instance of AgentInfrastructure from the specified map of raw messages.

func UnmarshalAgentKPIData

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

UnmarshalAgentKPIData unmarshals an instance of AgentKPIData from the specified map of raw messages.

func UnmarshalAgentKPIDataLite

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

UnmarshalAgentKPIDataLite unmarshals an instance of AgentKPIDataLite from the specified map of raw messages.

func UnmarshalAgentList

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

UnmarshalAgentList unmarshals an instance of AgentList from the specified map of raw messages.

func UnmarshalAgentMetadataInfo

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

UnmarshalAgentMetadataInfo unmarshals an instance of AgentMetadataInfo from the specified map of raw messages.

func UnmarshalAgentPRSJob

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

UnmarshalAgentPRSJob unmarshals an instance of AgentPRSJob from the specified map of raw messages.

func UnmarshalAgentSystemState

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

UnmarshalAgentSystemState unmarshals an instance of AgentSystemState from the specified map of raw messages.

func UnmarshalAgentSystemStatus

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

UnmarshalAgentSystemStatus unmarshals an instance of AgentSystemStatus from the specified map of raw messages.

func UnmarshalAgentUserState

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

UnmarshalAgentUserState unmarshals an instance of AgentUserState from the specified map of raw messages.

func UnmarshalAgentVersionInfo

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

UnmarshalAgentVersionInfo unmarshals an instance of AgentVersionInfo from the specified map of raw messages.

func UnmarshalAgentVersions

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

UnmarshalAgentVersions unmarshals an instance of AgentVersions from the specified map of raw messages.

func UnmarshalBastionResourceDefinition

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

UnmarshalBastionResourceDefinition unmarshals an instance of BastionResourceDefinition from the specified map of raw messages.

func UnmarshalCartOrderData

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

UnmarshalCartOrderData unmarshals an instance of CartOrderData from the specified map of raw messages.

func UnmarshalCatalogRef

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

UnmarshalCatalogRef unmarshals an instance of CatalogRef from the specified map of raw messages.

func UnmarshalCatalogSource

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

UnmarshalCatalogSource unmarshals an instance of CatalogSource from the specified map of raw messages.

func UnmarshalCommandsInfo

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

UnmarshalCommandsInfo unmarshals an instance of CommandsInfo from the specified map of raw messages.

func UnmarshalConnectionState

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

UnmarshalConnectionState unmarshals an instance of ConnectionState from the specified map of raw messages.

func UnmarshalCredentialVariableData

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

UnmarshalCredentialVariableData unmarshals an instance of CredentialVariableData from the specified map of raw messages.

func UnmarshalCredentialVariableMetadata

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

UnmarshalCredentialVariableMetadata unmarshals an instance of CredentialVariableMetadata from the specified map of raw messages.

func UnmarshalDependencies

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

UnmarshalDependencies unmarshals an instance of Dependencies from the specified map of raw messages.

func UnmarshalEncryptionInfo

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

UnmarshalEncryptionInfo unmarshals an instance of EncryptionInfo from the specified map of raw messages.

func UnmarshalEnvVariableRequestMap

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

UnmarshalEnvVariableRequestMap unmarshals an instance of EnvVariableRequestMap from the specified map of raw messages.

func UnmarshalEnvVariableResponse

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

UnmarshalEnvVariableResponse unmarshals an instance of EnvVariableResponse from the specified map of raw messages.

func UnmarshalEnvironmentValuesMetadata

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

UnmarshalEnvironmentValuesMetadata unmarshals an instance of EnvironmentValuesMetadata from the specified map of raw messages.

func UnmarshalExternalSource

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

UnmarshalExternalSource unmarshals an instance of ExternalSource from the specified map of raw messages.

func UnmarshalGitSource

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

UnmarshalGitSource unmarshals an instance of GitSource from the specified map of raw messages.

func UnmarshalInjectTerraformTemplateInner

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

UnmarshalInjectTerraformTemplateInner unmarshals an instance of InjectTerraformTemplateInner from the specified map of raw messages.

func UnmarshalInjectTerraformTemplateInnerTftParametersItem

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

UnmarshalInjectTerraformTemplateInnerTftParametersItem unmarshals an instance of InjectTerraformTemplateInnerTftParametersItem from the specified map of raw messages.

func UnmarshalInventoryResourceRecord

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

UnmarshalInventoryResourceRecord unmarshals an instance of InventoryResourceRecord from the specified map of raw messages.

func UnmarshalInventoryResourceRecordList

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

UnmarshalInventoryResourceRecordList unmarshals an instance of InventoryResourceRecordList from the specified map of raw messages.

func UnmarshalJob

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

UnmarshalJob unmarshals an instance of Job from the specified map of raw messages.

func UnmarshalJobData

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

UnmarshalJobData unmarshals an instance of JobData from the specified map of raw messages.

func UnmarshalJobDataAction

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

UnmarshalJobDataAction unmarshals an instance of JobDataAction from the specified map of raw messages.

func UnmarshalJobDataFlow

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

UnmarshalJobDataFlow unmarshals an instance of JobDataFlow from the specified map of raw messages.

func UnmarshalJobDataSystem

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

UnmarshalJobDataSystem unmarshals an instance of JobDataSystem from the specified map of raw messages.

func UnmarshalJobDataTemplate

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

UnmarshalJobDataTemplate unmarshals an instance of JobDataTemplate from the specified map of raw messages.

func UnmarshalJobDataWorkItem

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

UnmarshalJobDataWorkItem unmarshals an instance of JobDataWorkItem from the specified map of raw messages.

func UnmarshalJobDataWorkItemLastJob

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

UnmarshalJobDataWorkItemLastJob unmarshals an instance of JobDataWorkItemLastJob from the specified map of raw messages.

func UnmarshalJobDataWorkspace

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

UnmarshalJobDataWorkspace unmarshals an instance of JobDataWorkspace from the specified map of raw messages.

func UnmarshalJobFileContent

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

UnmarshalJobFileContent unmarshals an instance of JobFileContent from the specified map of raw messages.

func UnmarshalJobFileData

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

UnmarshalJobFileData unmarshals an instance of JobFileData from the specified map of raw messages.

func UnmarshalJobFileDataSummary

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

UnmarshalJobFileDataSummary unmarshals an instance of JobFileDataSummary from the specified map of raw messages.

func UnmarshalJobList

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

UnmarshalJobList unmarshals an instance of JobList from the specified map of raw messages.

func UnmarshalJobLite

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

UnmarshalJobLite unmarshals an instance of JobLite from the specified map of raw messages.

func UnmarshalJobLog

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

UnmarshalJobLog unmarshals an instance of JobLog from the specified map of raw messages.

func UnmarshalJobLogSummary

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

UnmarshalJobLogSummary unmarshals an instance of JobLogSummary from the specified map of raw messages.

func UnmarshalJobLogSummaryActionJob

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

UnmarshalJobLogSummaryActionJob unmarshals an instance of JobLogSummaryActionJob from the specified map of raw messages.

func UnmarshalJobLogSummaryActionJobRecap

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

UnmarshalJobLogSummaryActionJobRecap unmarshals an instance of JobLogSummaryActionJobRecap from the specified map of raw messages.

func UnmarshalJobLogSummaryFlowJob

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

UnmarshalJobLogSummaryFlowJob unmarshals an instance of JobLogSummaryFlowJob from the specified map of raw messages.

func UnmarshalJobLogSummaryLogErrors

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

UnmarshalJobLogSummaryLogErrors unmarshals an instance of JobLogSummaryLogErrors from the specified map of raw messages.

func UnmarshalJobLogSummaryRepoDownloadJob

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

UnmarshalJobLogSummaryRepoDownloadJob unmarshals an instance of JobLogSummaryRepoDownloadJob from the specified map of raw messages.

func UnmarshalJobLogSummarySystemJob

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

UnmarshalJobLogSummarySystemJob unmarshals an instance of JobLogSummarySystemJob from the specified map of raw messages.

func UnmarshalJobLogSummaryWorkitems

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

UnmarshalJobLogSummaryWorkitems unmarshals an instance of JobLogSummaryWorkitems from the specified map of raw messages.

func UnmarshalJobLogSummaryWorkspaceJob

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

UnmarshalJobLogSummaryWorkspaceJob unmarshals an instance of JobLogSummaryWorkspaceJob from the specified map of raw messages.

func UnmarshalJobStatus

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

UnmarshalJobStatus unmarshals an instance of JobStatus from the specified map of raw messages.

func UnmarshalJobStatusAction

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

UnmarshalJobStatusAction unmarshals an instance of JobStatusAction from the specified map of raw messages.

func UnmarshalJobStatusFlow

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

UnmarshalJobStatusFlow unmarshals an instance of JobStatusFlow from the specified map of raw messages.

func UnmarshalJobStatusSchematicsResources

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

UnmarshalJobStatusSchematicsResources unmarshals an instance of JobStatusSchematicsResources from the specified map of raw messages.

func UnmarshalJobStatusSystem

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

UnmarshalJobStatusSystem unmarshals an instance of JobStatusSystem from the specified map of raw messages.

func UnmarshalJobStatusTemplate

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

UnmarshalJobStatusTemplate unmarshals an instance of JobStatusTemplate from the specified map of raw messages.

func UnmarshalJobStatusWorkitem

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

UnmarshalJobStatusWorkitem unmarshals an instance of JobStatusWorkitem from the specified map of raw messages.

func UnmarshalJobStatusWorkspace

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

UnmarshalJobStatusWorkspace unmarshals an instance of JobStatusWorkspace from the specified map of raw messages.

func UnmarshalKMSDiscovery

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

UnmarshalKMSDiscovery unmarshals an instance of KMSDiscovery from the specified map of raw messages.

func UnmarshalKMSInstances

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

UnmarshalKMSInstances unmarshals an instance of KMSInstances from the specified map of raw messages.

func UnmarshalKMSInstancesKeys

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

UnmarshalKMSInstancesKeys unmarshals an instance of KMSInstancesKeys from the specified map of raw messages.

func UnmarshalKMSSettings

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

UnmarshalKMSSettings unmarshals an instance of KMSSettings from the specified map of raw messages.

func UnmarshalKMSSettingsPrimaryCrk

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

UnmarshalKMSSettingsPrimaryCrk unmarshals an instance of KMSSettingsPrimaryCrk from the specified map of raw messages.

func UnmarshalKMSSettingsSecondaryCrk

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

UnmarshalKMSSettingsSecondaryCrk unmarshals an instance of KMSSettingsSecondaryCrk from the specified map of raw messages.

func UnmarshalLastJob

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

UnmarshalLastJob unmarshals an instance of LastJob from the specified map of raw messages.

func UnmarshalLogStoreResponse

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

UnmarshalLogStoreResponse unmarshals an instance of LogStoreResponse from the specified map of raw messages.

func UnmarshalLogStoreResponseList

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

UnmarshalLogStoreResponseList unmarshals an instance of LogStoreResponseList from the specified map of raw messages.

func UnmarshalLogSummary

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

UnmarshalLogSummary unmarshals an instance of LogSummary from the specified map of raw messages.

func UnmarshalOutputValuesInner

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

UnmarshalOutputValuesInner unmarshals an instance of OutputValuesInner from the specified map of raw messages.

func UnmarshalPolicy

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

UnmarshalPolicy unmarshals an instance of Policy from the specified map of raw messages.

func UnmarshalPolicyList

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

UnmarshalPolicyList unmarshals an instance of PolicyList from the specified map of raw messages.

func UnmarshalPolicyLite

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

UnmarshalPolicyLite unmarshals an instance of PolicyLite from the specified map of raw messages.

func UnmarshalPolicyObjectSelector

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

UnmarshalPolicyObjectSelector unmarshals an instance of PolicyObjectSelector from the specified map of raw messages.

func UnmarshalPolicyObjects

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

UnmarshalPolicyObjects unmarshals an instance of PolicyObjects from the specified map of raw messages.

func UnmarshalPolicyParameter

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

UnmarshalPolicyParameter unmarshals an instance of PolicyParameter from the specified map of raw messages.

func UnmarshalResourceGroupResponse

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

UnmarshalResourceGroupResponse unmarshals an instance of ResourceGroupResponse from the specified map of raw messages.

func UnmarshalResourceQuery

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

UnmarshalResourceQuery unmarshals an instance of ResourceQuery from the specified map of raw messages.

func UnmarshalResourceQueryParam

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

UnmarshalResourceQueryParam unmarshals an instance of ResourceQueryParam from the specified map of raw messages.

func UnmarshalResourceQueryRecord

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

UnmarshalResourceQueryRecord unmarshals an instance of ResourceQueryRecord from the specified map of raw messages.

func UnmarshalResourceQueryRecordList

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

UnmarshalResourceQueryRecordList unmarshals an instance of ResourceQueryRecordList from the specified map of raw messages.

func UnmarshalResourceQueryResponseRecord

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

UnmarshalResourceQueryResponseRecord unmarshals an instance of ResourceQueryResponseRecord from the specified map of raw messages.

func UnmarshalResourceQueryResponseRecordQueryOutput

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

UnmarshalResourceQueryResponseRecordQueryOutput unmarshals an instance of ResourceQueryResponseRecordQueryOutput from the specified map of raw messages.

func UnmarshalResourceQueryResponseRecordResponse

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

UnmarshalResourceQueryResponseRecordResponse unmarshals an instance of ResourceQueryResponseRecordResponse from the specified map of raw messages.

func UnmarshalSchematicsLocations

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

UnmarshalSchematicsLocations unmarshals an instance of SchematicsLocations from the specified map of raw messages.

func UnmarshalSchematicsLocationsList

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

UnmarshalSchematicsLocationsList unmarshals an instance of SchematicsLocationsList from the specified map of raw messages.

func UnmarshalSchematicsLocationsLite

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

UnmarshalSchematicsLocationsLite unmarshals an instance of SchematicsLocationsLite from the specified map of raw messages.

func UnmarshalScopedResource

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

UnmarshalScopedResource unmarshals an instance of ScopedResource from the specified map of raw messages.

func UnmarshalServiceExtensions

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

UnmarshalServiceExtensions unmarshals an instance of ServiceExtensions from the specified map of raw messages.

func UnmarshalSharedTargetData

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

UnmarshalSharedTargetData unmarshals an instance of SharedTargetData from the specified map of raw messages.

func UnmarshalSharedTargetDataResponse

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

UnmarshalSharedTargetDataResponse unmarshals an instance of SharedTargetDataResponse from the specified map of raw messages.

func UnmarshalStateStoreResponse

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

UnmarshalStateStoreResponse unmarshals an instance of StateStoreResponse from the specified map of raw messages.

func UnmarshalStateStoreResponseList

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

UnmarshalStateStoreResponseList unmarshals an instance of StateStoreResponseList from the specified map of raw messages.

func UnmarshalSystemLock

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

UnmarshalSystemLock unmarshals an instance of SystemLock from the specified map of raw messages.

func UnmarshalTemplateMetaDataResponse

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

UnmarshalTemplateMetaDataResponse unmarshals an instance of TemplateMetaDataResponse from the specified map of raw messages.

func UnmarshalTemplateReadme

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

UnmarshalTemplateReadme unmarshals an instance of TemplateReadme from the specified map of raw messages.

func UnmarshalTemplateRepoRequest

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

UnmarshalTemplateRepoRequest unmarshals an instance of TemplateRepoRequest from the specified map of raw messages.

func UnmarshalTemplateRepoResponse

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

UnmarshalTemplateRepoResponse unmarshals an instance of TemplateRepoResponse from the specified map of raw messages.

func UnmarshalTemplateRepoTarUploadResponse

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

UnmarshalTemplateRepoTarUploadResponse unmarshals an instance of TemplateRepoTarUploadResponse from the specified map of raw messages.

func UnmarshalTemplateRepoUpdateRequest

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

UnmarshalTemplateRepoUpdateRequest unmarshals an instance of TemplateRepoUpdateRequest from the specified map of raw messages.

func UnmarshalTemplateResources

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

UnmarshalTemplateResources unmarshals an instance of TemplateResources from the specified map of raw messages.

func UnmarshalTemplateRunTimeDataResponse

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

UnmarshalTemplateRunTimeDataResponse unmarshals an instance of TemplateRunTimeDataResponse from the specified map of raw messages.

func UnmarshalTemplateSourceDataRequest

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

UnmarshalTemplateSourceDataRequest unmarshals an instance of TemplateSourceDataRequest from the specified map of raw messages.

func UnmarshalTemplateSourceDataResponse

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

UnmarshalTemplateSourceDataResponse unmarshals an instance of TemplateSourceDataResponse from the specified map of raw messages.

func UnmarshalTemplateStateStore

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

UnmarshalTemplateStateStore unmarshals an instance of TemplateStateStore from the specified map of raw messages.

func UnmarshalTemplateValues

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

UnmarshalTemplateValues unmarshals an instance of TemplateValues from the specified map of raw messages.

func UnmarshalTerraformCommand

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

UnmarshalTerraformCommand unmarshals an instance of TerraformCommand from the specified map of raw messages.

func UnmarshalUserState

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

UnmarshalUserState unmarshals an instance of UserState from the specified map of raw messages.

func UnmarshalUserValues

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

UnmarshalUserValues unmarshals an instance of UserValues from the specified map of raw messages.

func UnmarshalVariableData

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

UnmarshalVariableData unmarshals an instance of VariableData from the specified map of raw messages.

func UnmarshalVariableMetadata

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

UnmarshalVariableMetadata unmarshals an instance of VariableMetadata from the specified map of raw messages.

func UnmarshalVersionResponse

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

UnmarshalVersionResponse unmarshals an instance of VersionResponse from the specified map of raw messages.

func UnmarshalWorkspaceActivities

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

UnmarshalWorkspaceActivities unmarshals an instance of WorkspaceActivities from the specified map of raw messages.

func UnmarshalWorkspaceActivity

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

UnmarshalWorkspaceActivity unmarshals an instance of WorkspaceActivity from the specified map of raw messages.

func UnmarshalWorkspaceActivityApplyResult

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

UnmarshalWorkspaceActivityApplyResult unmarshals an instance of WorkspaceActivityApplyResult from the specified map of raw messages.

func UnmarshalWorkspaceActivityCommandResult

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

UnmarshalWorkspaceActivityCommandResult unmarshals an instance of WorkspaceActivityCommandResult from the specified map of raw messages.

func UnmarshalWorkspaceActivityDestroyResult

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

UnmarshalWorkspaceActivityDestroyResult unmarshals an instance of WorkspaceActivityDestroyResult from the specified map of raw messages.

func UnmarshalWorkspaceActivityLogs

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

UnmarshalWorkspaceActivityLogs unmarshals an instance of WorkspaceActivityLogs from the specified map of raw messages.

func UnmarshalWorkspaceActivityOptionsTemplate

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

UnmarshalWorkspaceActivityOptionsTemplate unmarshals an instance of WorkspaceActivityOptionsTemplate from the specified map of raw messages.

func UnmarshalWorkspaceActivityPlanResult

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

UnmarshalWorkspaceActivityPlanResult unmarshals an instance of WorkspaceActivityPlanResult from the specified map of raw messages.

func UnmarshalWorkspaceActivityRefreshResult

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

UnmarshalWorkspaceActivityRefreshResult unmarshals an instance of WorkspaceActivityRefreshResult from the specified map of raw messages.

func UnmarshalWorkspaceActivityTemplate

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

UnmarshalWorkspaceActivityTemplate unmarshals an instance of WorkspaceActivityTemplate from the specified map of raw messages.

func UnmarshalWorkspaceActivityTemplateLogs

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

UnmarshalWorkspaceActivityTemplateLogs unmarshals an instance of WorkspaceActivityTemplateLogs from the specified map of raw messages.

func UnmarshalWorkspaceBulkDeleteResponse

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

UnmarshalWorkspaceBulkDeleteResponse unmarshals an instance of WorkspaceBulkDeleteResponse from the specified map of raw messages.

func UnmarshalWorkspaceJobResponse

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

UnmarshalWorkspaceJobResponse unmarshals an instance of WorkspaceJobResponse from the specified map of raw messages.

func UnmarshalWorkspaceJobStatusType

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

UnmarshalWorkspaceJobStatusType unmarshals an instance of WorkspaceJobStatusType from the specified map of raw messages.

func UnmarshalWorkspaceResponse

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

UnmarshalWorkspaceResponse unmarshals an instance of WorkspaceResponse from the specified map of raw messages.

func UnmarshalWorkspaceResponseList

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

UnmarshalWorkspaceResponseList unmarshals an instance of WorkspaceResponseList from the specified map of raw messages.

func UnmarshalWorkspaceStatusMessage

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

UnmarshalWorkspaceStatusMessage unmarshals an instance of WorkspaceStatusMessage from the specified map of raw messages.

func UnmarshalWorkspaceStatusRequest

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

UnmarshalWorkspaceStatusRequest unmarshals an instance of WorkspaceStatusRequest from the specified map of raw messages.

func UnmarshalWorkspaceStatusResponse

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

UnmarshalWorkspaceStatusResponse unmarshals an instance of WorkspaceStatusResponse from the specified map of raw messages.

func UnmarshalWorkspaceStatusUpdateRequest

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

UnmarshalWorkspaceStatusUpdateRequest unmarshals an instance of WorkspaceStatusUpdateRequest from the specified map of raw messages.

func UnmarshalWorkspaceTemplateValuesResponse

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

UnmarshalWorkspaceTemplateValuesResponse unmarshals an instance of WorkspaceTemplateValuesResponse from the specified map of raw messages.

func UnmarshalWorkspaceVariableRequest

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

UnmarshalWorkspaceVariableRequest unmarshals an instance of WorkspaceVariableRequest from the specified map of raw messages.

func UnmarshalWorkspaceVariableResponse

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

UnmarshalWorkspaceVariableResponse unmarshals an instance of WorkspaceVariableResponse from the specified map of raw messages.

Types

type Action

type Action struct {
	// The unique name of your action. The name can be up to 128 characters long and can include alphanumeric characters,
	// spaces, dashes, and underscores. **Example** you can use the name to stop action.
	Name *string `json:"name,omitempty"`

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

	// List of locations supported by IBM Cloud Schematics service.  While creating your workspace or action, choose the
	// right region, since it cannot be changed.  Note, this does not limit the location of the IBM Cloud resources,
	// provisioned using Schematics.
	Location *string `json:"location,omitempty"`

	// Resource-group name for an action. By default, an action is created in `Default` resource group.
	ResourceGroup *string `json:"resource_group,omitempty"`

	// Type of connection to be used when connecting to bastion host.  If the `inventory_connection_type=winrm`, then
	// `bastion_connection_type` is not supported.
	BastionConnectionType *string `json:"bastion_connection_type,omitempty"`

	// Type of connection to be used when connecting to remote host.  **Note** Currently, WinRM supports only Windows
	// system with the public IPs and do not support Bastion host.
	InventoryConnectionType *string `json:"inventory_connection_type,omitempty"`

	// Action tags.
	Tags []string `json:"tags,omitempty"`

	// User defined status of the Schematics object.
	UserState *UserState `json:"user_state,omitempty"`

	// URL of the `README` file, for the source URL.
	SourceReadmeURL *string `json:"source_readme_url,omitempty"`

	// Source of templates, playbooks, or controls.
	Source *ExternalSource `json:"source,omitempty"`

	// Type of source for the Template.
	SourceType *string `json:"source_type,omitempty"`

	// Schematics job command parameter (playbook-name).
	CommandParameter *string `json:"command_parameter,omitempty"`

	// Target inventory record ID, used by the action or ansible playbook.
	Inventory *string `json:"inventory,omitempty"`

	// credentials of the Action.
	Credentials []CredentialVariableData `json:"credentials,omitempty"`

	// Describes a bastion resource.
	Bastion *BastionResourceDefinition `json:"bastion,omitempty"`

	// User editable credential variable data and system generated reference to the value.
	BastionCredential *CredentialVariableData `json:"bastion_credential,omitempty"`

	// Inventory of host and host group for the playbook in `INI` file format. For example, `"targets_ini":
	// "[webserverhost]
	//  172.22.192.6
	//  [dbhost]
	//  172.22.192.5"`. For more information, about an inventory host group syntax, see [Inventory host
	// groups](https://cloud.ibm.com/docs/schematics?topic=schematics-schematics-cli-reference#schematics-inventory-host-grps).
	TargetsIni *string `json:"targets_ini,omitempty"`

	// Input variables for the Action.
	Inputs []VariableData `json:"inputs,omitempty"`

	// Output variables for the Action.
	Outputs []VariableData `json:"outputs,omitempty"`

	// Environment variables for the Action.
	Settings []VariableData `json:"settings,omitempty"`

	// Action ID.
	ID *string `json:"id,omitempty"`

	// Action Cloud Resource Name.
	Crn *string `json:"crn,omitempty"`

	// Action account ID.
	Account *string `json:"account,omitempty"`

	// Action Playbook Source creation time.
	SourceCreatedAt *strfmt.DateTime `json:"source_created_at,omitempty"`

	// E-mail address of user who created the Action Playbook Source.
	SourceCreatedBy *string `json:"source_created_by,omitempty"`

	// The action playbook updation time.
	SourceUpdatedAt *strfmt.DateTime `json:"source_updated_at,omitempty"`

	// E-mail address of user who updated the action playbook source.
	SourceUpdatedBy *string `json:"source_updated_by,omitempty"`

	// Action creation time.
	CreatedAt *strfmt.DateTime `json:"created_at,omitempty"`

	// E-mail address of the user who created an action.
	CreatedBy *string `json:"created_by,omitempty"`

	// Action updation time.
	UpdatedAt *strfmt.DateTime `json:"updated_at,omitempty"`

	// E-mail address of the user who updated an action.
	UpdatedBy *string `json:"updated_by,omitempty"`

	// Computed state of the Action.
	State *ActionState `json:"state,omitempty"`

	// Playbook names retrieved from the repository.
	PlaybookNames []string `json:"playbook_names,omitempty"`

	// System lock status.
	SysLock *SystemLock `json:"sys_lock,omitempty"`

	// secrets manager reference to git token.
	GitTokenRef *string `json:"git_token_ref,omitempty"`

	// Encryption details about the workspace such as scheme (byok/kyok) and key CRN.
	Encryption *EncryptionInfo `json:"encryption,omitempty"`
}

Action : Complete Action details with user inputs and system generated data.

type ActionList

type ActionList struct {
	// Total number of records.
	TotalCount *int64 `json:"total_count,omitempty"`

	// Number of records returned.
	Limit *int64 `json:"limit" validate:"required"`

	// Skipped number of records.
	Offset *int64 `json:"offset" validate:"required"`

	// List of action records.
	Actions []ActionLite `json:"actions,omitempty"`
}

ActionList : List of Action definition response.

type ActionLite

type ActionLite struct {
	// Action name (unique for an account).
	Name *string `json:"name,omitempty"`

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

	// Action Id.
	ID *string `json:"id,omitempty"`

	// Action Cloud Resource Name.
	Crn *string `json:"crn,omitempty"`

	// List of locations supported by IBM Cloud Schematics service.  While creating your workspace or action, choose the
	// right region, since it cannot be changed.  Note, this does not limit the location of the IBM Cloud resources,
	// provisioned using Schematics.
	Location *string `json:"location,omitempty"`

	// Resource-group name for the Action.  By default, Action will be created in Default Resource Group.
	ResourceGroup *string `json:"resource_group,omitempty"`

	// name of the namespace.
	Namespace *string `json:"namespace,omitempty"`

	// Action tags.
	Tags []string `json:"tags,omitempty"`

	// Name of the selected playbook.
	PlaybookName *string `json:"playbook_name,omitempty"`

	// User defined status of the Schematics object.
	UserState *UserState `json:"user_state,omitempty"`

	// Computed state of the Action.
	State *ActionLiteState `json:"state,omitempty"`

	// System lock status.
	SysLock *SystemLock `json:"sys_lock,omitempty"`

	// Action creation time.
	CreatedAt *strfmt.DateTime `json:"created_at,omitempty"`

	// Email address of user who created the action.
	CreatedBy *string `json:"created_by,omitempty"`

	// Action updation time.
	UpdatedAt *strfmt.DateTime `json:"updated_at,omitempty"`

	// Email address of user who updated the action.
	UpdatedBy *string `json:"updated_by,omitempty"`

	// Agent name, Agent id and associated policy ID information.
	Agent *AgentInfo `json:"agent,omitempty"`

	// Encryption details about the workspace such as scheme (byok/kyok) and key CRN.
	Encryption *EncryptionInfo `json:"encryption,omitempty"`
}

ActionLite : Action summary profile with user inputs and system generated data.

type ActionLiteState

type ActionLiteState struct {
	// Status of automation (workspace or action).
	StatusCode *string `json:"status_code,omitempty"`

	// Automation status message - to be displayed along with the status_code.
	StatusMessage *string `json:"status_message,omitempty"`
}

ActionLiteState : Computed state of the Action.

type ActionState

type ActionState struct {
	// Status of automation (workspace or action).
	StatusCode *string `json:"status_code,omitempty"`

	// Job id reference for this status.
	StatusJobID *string `json:"status_job_id,omitempty"`

	// Automation status message - to be displayed along with the status_code.
	StatusMessage *string `json:"status_message,omitempty"`
}

ActionState : Computed state of the Action.

type Agent

type Agent struct {
	// The name of the agent (must be unique, for an account).
	Name *string `json:"name" validate:"required"`

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

	// The resource-group name for the agent.  By default, Agent will be registered in Default Resource Group.
	ResourceGroup *string `json:"resource_group,omitempty"`

	// Tags for the agent.
	Tags []string `json:"tags,omitempty"`

	// The location where agent is deployed in the user environment.
	AgentLocation *string `json:"agent_location" validate:"required"`

	// List of locations supported by IBM Cloud Schematics service.  While creating your workspace or action, choose the
	// right region, since it cannot be changed.  Note, this does not limit the location of the IBM Cloud resources,
	// provisioned using Schematics.
	Location *string `json:"location" validate:"required"`

	// The IAM trusted profile id, used by the Agent instance.
	ProfileID *string `json:"profile_id" validate:"required"`

	// The Agent crn, obtained from the Schematics Agent deployment configuration.
	AgentCrn *string `json:"agent_crn,omitempty"`

	// The Agent registration id.
	ID *string `json:"id,omitempty"`

	// The Agent registration date-time.
	RegisteredAt *strfmt.DateTime `json:"registered_at,omitempty"`

	// The email address of an user who registered the Agent.
	RegisteredBy *string `json:"registered_by,omitempty"`

	// The Agent registration updation time.
	UpdatedAt *strfmt.DateTime `json:"updated_at,omitempty"`

	// Email address of user who updated the Agent registration.
	UpdatedBy *string `json:"updated_by,omitempty"`

	// User defined status of the agent.
	UserState *AgentUserState `json:"user_state,omitempty"`

	// Connection status of the agent.
	ConnectionState *ConnectionState `json:"connection_state,omitempty"`

	// Computed state of the agent.
	SystemState *AgentSystemState `json:"system_state,omitempty"`
}

Agent : The agent registration details, with user inputs and system generated data.

type AgentAssignmentPolicyParameter

type AgentAssignmentPolicyParameter struct {
	// Types of schematics object selector.
	SelectorKind *string `json:"selector_kind,omitempty"`

	// The static selectors of schematics object ids (workspace or action) for the Schematics policy.
	SelectorIds []string `json:"selector_ids,omitempty"`

	// The selectors to dynamically list of schematics object ids (workspace or action) for the Schematics policy.
	SelectorScope []PolicyObjectSelector `json:"selector_scope,omitempty"`
}

AgentAssignmentPolicyParameter : Parameters for the `agent_assignment_policy`.

type AgentData

type AgentData struct {
	// The name of the agent (must be unique, for an account).
	Name *string `json:"name" validate:"required"`

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

	// The resource-group name for the agent.  By default, agent will be registered in Default Resource Group.
	ResourceGroup *string `json:"resource_group" validate:"required"`

	// Tags for the agent.
	Tags []string `json:"tags,omitempty"`

	// Agent version.
	Version *string `json:"version" validate:"required"`

	// List of locations supported by IBM Cloud Schematics service.  While creating your workspace or action, choose the
	// right region, since it cannot be changed.  Note, this does not limit the location of the IBM Cloud resources,
	// provisioned using Schematics.
	SchematicsLocation *string `json:"schematics_location" validate:"required"`

	// The location where agent is deployed in the user environment.
	AgentLocation *string `json:"agent_location" validate:"required"`

	// The infrastructure parameters used by the agent.
	AgentInfrastructure *AgentInfrastructure `json:"agent_infrastructure" validate:"required"`

	// The metadata of an agent.
	AgentMetadata []AgentMetadataInfo `json:"agent_metadata,omitempty"`

	// Additional input variables for the agent.
	AgentInputs []VariableData `json:"agent_inputs,omitempty"`

	// User defined status of the agent.
	UserState *AgentUserState `json:"user_state,omitempty"`

	// The agent crn, obtained from the Schematics agent deployment configuration.
	AgentCrn *string `json:"agent_crn,omitempty"`

	// The agent resource id.
	ID *string `json:"id,omitempty"`

	// The agent creation date-time.
	CreatedAt *strfmt.DateTime `json:"created_at,omitempty"`

	// The email address of an user who created the agent.
	CreationBy *string `json:"creation_by,omitempty"`

	// The agent registration updation time.
	UpdatedAt *strfmt.DateTime `json:"updated_at,omitempty"`

	// Email address of user who updated the agent registration.
	UpdatedBy *string `json:"updated_by,omitempty"`

	// Computed state of the agent.
	SystemState *AgentSystemStatus `json:"system_state,omitempty"`

	// Schematics Agent key performance indicators.
	AgentKpi *AgentKPIData `json:"agent_kpi,omitempty"`

	// Run a pre-requisite scanner for deploying agent.
	RecentPrsJob *AgentDataRecentPrsJob `json:"recent_prs_job,omitempty"`

	// Post-installations checks for Agent health.
	RecentDeployJob *AgentDataRecentDeployJob `json:"recent_deploy_job,omitempty"`

	// Agent health check.
	RecentHealthJob *AgentDataRecentHealthJob `json:"recent_health_job,omitempty"`

	// destroy resource provisoned by agent deploy method.
	RecentDestroyJob *AgentDataRecentDestroyJob `json:"recent_destroy_job,omitempty"`

	// Encryption details about the workspace such as scheme (byok/kyok) and key CRN.
	Encryption *EncryptionInfo `json:"encryption,omitempty"`
}

AgentData : The agent details, with user inputs and system generated data.

type AgentDataList

type AgentDataList struct {
	// The total number of records.
	TotalCount *int64 `json:"total_count,omitempty"`

	// The number of records returned.
	Limit *int64 `json:"limit,omitempty"`

	// The skipped number of records.
	Offset *int64 `json:"offset" validate:"required"`

	// The list of agents in the account.
	Agents []AgentDataLite `json:"agents,omitempty"`
}

AgentDataList : The list of agents.

type AgentDataLite

type AgentDataLite struct {
	// The name of the agent (must be unique, for an account).
	Name *string `json:"name,omitempty"`

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

	// The resource-group name for the agent.  By default, agent will be registered in Default Resource Group.
	ResourceGroup *string `json:"resource_group,omitempty"`

	// Tags for the agent.
	Tags []string `json:"tags,omitempty"`

	// The agent version.
	Version *string `json:"version,omitempty"`

	// List of locations supported by IBM Cloud Schematics service.  While creating your workspace or action, choose the
	// right region, since it cannot be changed.  Note, this does not limit the location of the IBM Cloud resources,
	// provisioned using Schematics.
	SchematicsLocation *string `json:"schematics_location,omitempty"`

	// The location where agent is deployed in the user environment.
	AgentLocation *string `json:"agent_location,omitempty"`

	// The metadata of an agent.
	AgentMetadata []AgentMetadataInfo `json:"agent_metadata,omitempty"`

	// User defined status of the agent.
	UserState *AgentUserState `json:"user_state,omitempty"`

	// The agent crn, obtained from the Schematics agent deployment configuration.
	AgentCrn *string `json:"agent_crn,omitempty"`

	// The agent resource id.
	ID *string `json:"id,omitempty"`

	// The agent creation date-time.
	CreatedAt *strfmt.DateTime `json:"created_at,omitempty"`

	// The email address of an user who created the agent.
	CreationBy *string `json:"creation_by,omitempty"`

	// The agent registration updation time.
	UpdatedAt *strfmt.DateTime `json:"updated_at,omitempty"`

	// Email address of user who updated the agent registration.
	UpdatedBy *string `json:"updated_by,omitempty"`

	// Computed state of the agent.
	SystemState *AgentSystemStatus `json:"system_state,omitempty"`

	// Schematics Agent key performance indicators' summary.
	AgentKpi *AgentKPIDataLite `json:"agent_kpi,omitempty"`
}

AgentDataLite : The agent details for a list view.

type AgentDataRecentDeployJob

type AgentDataRecentDeployJob struct {
	// Id of the agent.
	AgentID *string `json:"agent_id,omitempty"`

	// Job Id.
	JobID *string `json:"job_id,omitempty"`

	// The agent deploy job updation time.
	UpdatedAt *strfmt.DateTime `json:"updated_at,omitempty"`

	// Email address of user who ran the agent deploy job.
	UpdatedBy *string `json:"updated_by,omitempty"`

	// True, when the same version of the agent was redeployed.
	IsRedeployed *bool `json:"is_redeployed,omitempty"`

	// Agent version.
	AgentVersion *string `json:"agent_version,omitempty"`

	// Status of Jobs.
	StatusCode *string `json:"status_code,omitempty"`

	// The outcome of the agent deployment job, in a formatted log string.
	StatusMessage *string `json:"status_message,omitempty"`

	// URL to the full agent deployment job logs.
	LogURL *string `json:"log_url,omitempty"`
}

AgentDataRecentDeployJob : Post-installations checks for Agent health.

type AgentDataRecentDestroyJob

type AgentDataRecentDestroyJob struct {
	// Id of the agent.
	AgentID *string `json:"agent_id,omitempty"`

	// Job Id.
	JobID *string `json:"job_id,omitempty"`

	// The agent resources destroy job updation time.
	UpdatedAt *strfmt.DateTime `json:"updated_at,omitempty"`

	// Email address of user who ran the agent resources destroy job.
	UpdatedBy *string `json:"updated_by,omitempty"`

	// Agent version.
	AgentVersion *string `json:"agent_version,omitempty"`

	// Status of Jobs.
	StatusCode *string `json:"status_code,omitempty"`

	// The outcome of the agent resources destroy job, in a formatted log string.
	StatusMessage *string `json:"status_message,omitempty"`

	// URL to the full agent resources destroy job logs.
	LogURL *string `json:"log_url,omitempty"`
}

AgentDataRecentDestroyJob : destroy resource provisoned by agent deploy method.

type AgentDataRecentHealthJob

type AgentDataRecentHealthJob struct {
	// Id of the agent.
	AgentID *string `json:"agent_id,omitempty"`

	// Job Id.
	JobID *string `json:"job_id,omitempty"`

	// The agent health check job updation time.
	UpdatedAt *strfmt.DateTime `json:"updated_at,omitempty"`

	// Email address of user who ran the agent health check job.
	UpdatedBy *string `json:"updated_by,omitempty"`

	// Agent version.
	AgentVersion *string `json:"agent_version,omitempty"`

	// Status of Jobs.
	StatusCode *string `json:"status_code,omitempty"`

	// The outcome of the health-check job, in a formatted log string.
	StatusMessage *string `json:"status_message,omitempty"`

	// URL to the full health-check job logs.
	LogURL *string `json:"log_url,omitempty"`
}

AgentDataRecentHealthJob : Agent health check.

type AgentDataRecentPrsJob

type AgentDataRecentPrsJob struct {
	// Id of the agent.
	AgentID *string `json:"agent_id,omitempty"`

	// Job Id.
	JobID *string `json:"job_id,omitempty"`

	// The agent prs job updation time.
	UpdatedAt *strfmt.DateTime `json:"updated_at,omitempty"`

	// Email address of user who ran the agent prs job.
	UpdatedBy *string `json:"updated_by,omitempty"`

	// Agent version.
	AgentVersion *string `json:"agent_version,omitempty"`

	// Status of Jobs.
	StatusCode *string `json:"status_code,omitempty"`

	// The outcome of the pre-requisite scanner job, in a formatted log string.
	StatusMessage *string `json:"status_message,omitempty"`

	// URL to the full pre-requisite scanner job logs.
	LogURL *string `json:"log_url,omitempty"`
}

AgentDataRecentPrsJob : Run a pre-requisite scanner for deploying agent.

type AgentDeployJob

type AgentDeployJob struct {
	// Id of the agent.
	AgentID *string `json:"agent_id,omitempty"`

	// Job Id.
	JobID *string `json:"job_id,omitempty"`

	// The agent deploy job updation time.
	UpdatedAt *strfmt.DateTime `json:"updated_at,omitempty"`

	// Email address of user who ran the agent deploy job.
	UpdatedBy *string `json:"updated_by,omitempty"`

	// True, when the same version of the agent was redeployed.
	IsRedeployed *bool `json:"is_redeployed,omitempty"`

	// Agent version.
	AgentVersion *string `json:"agent_version,omitempty"`

	// Status of Jobs.
	StatusCode *string `json:"status_code,omitempty"`

	// The outcome of the agent deployment job, in a formatted log string.
	StatusMessage *string `json:"status_message,omitempty"`

	// URL to the full agent deployment job logs.
	LogURL *string `json:"log_url,omitempty"`
}

AgentDeployJob : Post-installations checks for Agent health.

type AgentHealthJob

type AgentHealthJob struct {
	// Id of the agent.
	AgentID *string `json:"agent_id,omitempty"`

	// Job Id.
	JobID *string `json:"job_id,omitempty"`

	// The agent health check job updation time.
	UpdatedAt *strfmt.DateTime `json:"updated_at,omitempty"`

	// Email address of user who ran the agent health check job.
	UpdatedBy *string `json:"updated_by,omitempty"`

	// Agent version.
	AgentVersion *string `json:"agent_version,omitempty"`

	// Status of Jobs.
	StatusCode *string `json:"status_code,omitempty"`

	// The outcome of the health-check job, in a formatted log string.
	StatusMessage *string `json:"status_message,omitempty"`

	// URL to the full health-check job logs.
	LogURL *string `json:"log_url,omitempty"`
}

AgentHealthJob : Agent health check.

type AgentInfo

type AgentInfo struct {
	// ID of the Agent bound to the schematics object (workspace, action).
	ID *string `json:"id,omitempty"`

	// Name of the Agent bound to the schematics object.
	Name *string `json:"name,omitempty"`

	// ID of the agent assignment policy, that is used to bind the Agent to schematics object.
	AssignmentPolicyID *string `json:"assignment_policy_id,omitempty"`
}

AgentInfo : Agent name, Agent id and associated policy ID information.

type AgentInfrastructure

type AgentInfrastructure struct {
	// Type of target agent infrastructure.
	InfraType *string `json:"infra_type,omitempty"`

	// The cluster ID where agent services will be running.
	ClusterID *string `json:"cluster_id,omitempty"`

	// The resource group of the cluster (is it required?).
	ClusterResourceGroup *string `json:"cluster_resource_group,omitempty"`

	// The COS instance name to store the agent logs.
	CosInstanceName *string `json:"cos_instance_name,omitempty"`

	// The COS bucket name used to store the logs.
	CosBucketName *string `json:"cos_bucket_name,omitempty"`

	// The COS bucket region.
	CosBucketRegion *string `json:"cos_bucket_region,omitempty"`
}

AgentInfrastructure : The infrastructure parameters used by the agent.

type AgentKPIData

type AgentKPIData struct {
	// Overall availability indicator reported by the agent.
	AvailabilityIndicator *string `json:"availability_indicator,omitempty"`

	// Overall lifecycle indicator reported by the agents.
	LifecycleIndicator *string `json:"lifecycle_indicator,omitempty"`

	// Percentage usage of the agent resources.
	PercentUsageIndicator *string `json:"percent_usage_indicator,omitempty"`

	// Agent application key performance indicators.
	ApplicationIndicators []interface{} `json:"application_indicators,omitempty"`

	// Agent infrastructure key performance indicators.
	InfraIndicators []interface{} `json:"infra_indicators,omitempty"`
}

AgentKPIData : Schematics Agent key performance indicators.

type AgentKPIDataLite

type AgentKPIDataLite struct {
	// Overall availability indicator reported by the agent.
	AvailabilityIndicator *string `json:"availability_indicator,omitempty"`

	// Overall lifecycle indicator reported by the agents.
	LifecycleIndicator *string `json:"lifecycle_indicator,omitempty"`

	// Percentage usage of the agent resources.
	PercentUsageIndicator *string `json:"percent_usage_indicator,omitempty"`
}

AgentKPIDataLite : Schematics Agent key performance indicators' summary.

type AgentList

type AgentList struct {
	// The total number of records.
	TotalCount *int64 `json:"total_count,omitempty"`

	// The number of records returned.
	Limit *int64 `json:"limit,omitempty"`

	// The skipped number of records.
	Offset *int64 `json:"offset" validate:"required"`

	// The list of agents in the account.
	Agents []Agent `json:"agents,omitempty"`
}

AgentList : The list of agent details.

type AgentMetadataInfo

type AgentMetadataInfo struct {
	// Name of the metadata.
	Name *string `json:"name,omitempty"`

	// Value of the metadata name.
	Value []string `json:"value,omitempty"`
}

AgentMetadataInfo : AgentMetadataInfo struct

type AgentPRSJob

type AgentPRSJob struct {
	// Id of the agent.
	AgentID *string `json:"agent_id,omitempty"`

	// Job Id.
	JobID *string `json:"job_id,omitempty"`

	// The agent prs job updation time.
	UpdatedAt *strfmt.DateTime `json:"updated_at,omitempty"`

	// Email address of user who ran the agent prs job.
	UpdatedBy *string `json:"updated_by,omitempty"`

	// Agent version.
	AgentVersion *string `json:"agent_version,omitempty"`

	// Status of Jobs.
	StatusCode *string `json:"status_code,omitempty"`

	// The outcome of the pre-requisite scanner job, in a formatted log string.
	StatusMessage *string `json:"status_message,omitempty"`

	// URL to the full pre-requisite scanner job logs.
	LogURL *string `json:"log_url,omitempty"`
}

AgentPRSJob : Run a pre-requisite scanner for deploying agent.

type AgentSystemState

type AgentSystemState struct {
	// Agent Status.
	State *string `json:"state,omitempty"`

	// The Agent status message.
	Message *string `json:"message,omitempty"`
}

AgentSystemState : Computed state of the agent.

type AgentSystemStatus

type AgentSystemStatus struct {
	// Agent Status.
	StatusCode *string `json:"status_code,omitempty"`

	// The agent status message.
	StatusMessage *string `json:"status_message,omitempty"`
}

AgentSystemStatus : Computed state of the agent.

type AgentUserState

type AgentUserState struct {
	// User-defined states
	//   * `enable`  Agent is enabled by the user.
	//   * `disable` Agent is disbaled by the user.
	State *string `json:"state,omitempty"`

	// Name of the User who set the state of the Object.
	SetBy *string `json:"set_by,omitempty"`

	// When the User who set the state of the Object.
	SetAt *strfmt.DateTime `json:"set_at,omitempty"`
}

AgentUserState : User defined status of the agent.

type AgentVersionInfo

type AgentVersionInfo struct {
	// The display name of the agent version.
	DisplayName *string `json:"display_name,omitempty"`

	// The version of the agent.
	AgentVersion *string `json:"agent_version,omitempty"`
}

AgentVersionInfo : An item in list of all the versions available.

type AgentVersions

type AgentVersions struct {
	// list of the versions supported.
	SupportedAgentVersions []AgentVersionInfo `json:"supported_agent_versions,omitempty"`
}

AgentVersions : Agent versions available to be deployed.

type ApplyWorkspaceCommandOptions

type ApplyWorkspaceCommandOptions struct {
	// The ID of the workspace for which you want to run a Schematics `apply` job.  To find the workspace ID, use the `GET
	// /workspaces` API.
	WID *string `json:"w_id" validate:"required,ne="`

	// The IAM refresh token for the user or service identity.
	//
	//   **Retrieving refresh token**:
	//   * Use `export IBMCLOUD_API_KEY=<ibmcloud_api_key>`, and execute `curl -X POST
	// "https://iam.cloud.ibm.com/identity/token" -H "Content-Type: application/x-www-form-urlencoded" -d
	// "grant_type=urn:ibm:params:oauth:grant-type:apikey&apikey=$IBMCLOUD_API_KEY" -u bx:bx`.
	//   * For more information, about creating IAM access token and API Docs, refer, [IAM access
	// token](/apidocs/iam-identity-token-api#gettoken-password) and [Create API
	// key](/apidocs/iam-identity-token-api#create-api-key).
	//
	//   **Limitation**:
	//   * If the token is expired, you can use `refresh token` to get a new IAM access token.
	//   * The `refresh_token` parameter cannot be used to retrieve a new IAM access token.
	//   * When the IAM access token is about to expire, use the API key to create a new access token.
	RefreshToken *string `json:"refresh_token" validate:"required"`

	// Workspace job options template.
	ActionOptions *WorkspaceActivityOptionsTemplate `json:"action_options,omitempty"`

	// The IAM delegated token for your IBM Cloud account.  This token is required for requests that are sent via the UI
	// only.
	DelegatedToken *string `json:"delegated_token,omitempty"`

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

ApplyWorkspaceCommandOptions : The ApplyWorkspaceCommand options.

func (*ApplyWorkspaceCommandOptions) SetActionOptions

func (_options *ApplyWorkspaceCommandOptions) SetActionOptions(actionOptions *WorkspaceActivityOptionsTemplate) *ApplyWorkspaceCommandOptions

SetActionOptions : Allow user to set ActionOptions

func (*ApplyWorkspaceCommandOptions) SetDelegatedToken

func (_options *ApplyWorkspaceCommandOptions) SetDelegatedToken(delegatedToken string) *ApplyWorkspaceCommandOptions

SetDelegatedToken : Allow user to set DelegatedToken

func (*ApplyWorkspaceCommandOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

func (*ApplyWorkspaceCommandOptions) SetRefreshToken

func (_options *ApplyWorkspaceCommandOptions) SetRefreshToken(refreshToken string) *ApplyWorkspaceCommandOptions

SetRefreshToken : Allow user to set RefreshToken

func (*ApplyWorkspaceCommandOptions) SetWID

func (_options *ApplyWorkspaceCommandOptions) SetWID(wID string) *ApplyWorkspaceCommandOptions

SetWID : Allow user to set WID

type BastionResourceDefinition

type BastionResourceDefinition struct {
	// Bastion Name; the name must be unique.
	Name *string `json:"name,omitempty"`

	// Reference to the Inventory resource definition.
	Host *string `json:"host,omitempty"`
}

BastionResourceDefinition : Describes a bastion resource.

type CartOrderData

type CartOrderData struct {
	// Name of the property.
	Name *string `json:"name,omitempty"`

	// Value of the property.
	Value *string `json:"value,omitempty"`

	// Type of the values(string, int etc).
	Type *string `json:"type,omitempty"`

	// List of usage kind how the cart data can be used.
	UsageKind []string `json:"usage_kind,omitempty"`
}

CartOrderData : Schematics Cart Order Data.

type CatalogRef

type CatalogRef struct {
	// Dry run.
	DryRun *bool `json:"dry_run,omitempty"`

	// Owning account ID of the catalog.
	OwningAccount *string `json:"owning_account,omitempty"`

	// The URL to the icon of the software template in the IBM Cloud catalog.
	ItemIconURL *string `json:"item_icon_url,omitempty"`

	// The ID of the software template that you chose to install from the IBM Cloud catalog. This software is provisioned
	// with Schematics.
	ItemID *string `json:"item_id,omitempty"`

	// The name of the software that you chose to install from the IBM Cloud catalog.
	ItemName *string `json:"item_name,omitempty"`

	// The URL to the readme file of the software template in the IBM Cloud catalog.
	ItemReadmeURL *string `json:"item_readme_url,omitempty"`

	// The URL to the software template in the IBM Cloud catalog.
	ItemURL *string `json:"item_url,omitempty"`

	// The URL to the dashboard to access your software.
	LaunchURL *string `json:"launch_url,omitempty"`

	// The version of the software template that you chose to install from the IBM Cloud catalog.
	OfferingVersion *string `json:"offering_version,omitempty"`

	ServiceExtensions []ServiceExtensions `json:"service_extensions,omitempty"`
}

CatalogRef : Information about the software template that you chose from the IBM Cloud catalog. This information is returned for IBM Cloud catalog offerings only.

type CatalogSource

type CatalogSource struct {
	// The name of the private catalog.
	CatalogName *string `json:"catalog_name,omitempty"`

	// The ID of a private catalog.
	CatalogID *string `json:"catalog_id,omitempty"`

	// The name of an offering in the IBM Cloud Catalog.
	OfferingName *string `json:"offering_name,omitempty"`

	// The version of the software template that you chose to install from the IBM Cloud catalog.
	OfferingVersion *string `json:"offering_version,omitempty"`

	// The type of an offering, in the IBM Cloud Catalog.
	OfferingKind *string `json:"offering_kind,omitempty"`

	// Offering Target Kind.
	OfferingTargetKind *string `json:"offering_target_kind,omitempty"`

	// The ID of an offering in the IBM Cloud Catalog.
	OfferingID *string `json:"offering_id,omitempty"`

	// The ID of an offering version the IBM Cloud Catalog.
	OfferingVersionID *string `json:"offering_version_id,omitempty"`

	// Offering version flavour name.
	OfferingVersionFlavourName *string `json:"offering_version_flavour_name,omitempty"`

	// The repository URL of an offering, in the IBM Cloud Catalog.
	OfferingRepoURL *string `json:"offering_repo_url,omitempty"`

	// Root folder name in .tgz file.
	OfferingProvisionerWorkingDirectory *string `json:"offering_provisioner_working_directory,omitempty"`

	// Dry run.
	DryRun *bool `json:"dry_run,omitempty"`

	// Owning account ID of the catalog.
	OwningAccount *string `json:"owning_account,omitempty"`

	// The URL to the icon of the software template in the IBM Cloud catalog.
	ItemIconURL *string `json:"item_icon_url,omitempty"`

	// The ID of the software template that you chose to install from the IBM Cloud catalog. This software is provisioned
	// with Schematics.
	ItemID *string `json:"item_id,omitempty"`

	// The name of the software that you chose to install from the IBM Cloud catalog.
	ItemName *string `json:"item_name,omitempty"`

	// The URL to the readme file of the software template in the IBM Cloud catalog.
	ItemReadmeURL *string `json:"item_readme_url,omitempty"`

	// The URL to the software template in the IBM Cloud catalog.
	ItemURL *string `json:"item_url,omitempty"`

	// The URL to the dashboard to access your software.
	LaunchURL *string `json:"launch_url,omitempty"`
}

CatalogSource : The connection details to the IBM Cloud Catalog source.

type CommandsInfo

type CommandsInfo struct {
	// Name of the command.
	Name *string `json:"name,omitempty"`

	// outcome of the command.
	Outcome *string `json:"outcome,omitempty"`
}

CommandsInfo : Workspace commands run as part of the job.

type ConnectionState

type ConnectionState struct {
	// Agent Connection Status
	//   * `Connected` When Schematics is able to connect to the agent.
	//   * `Disconnected` When Schematics is able not connect to the agent.
	State *string `json:"state,omitempty"`

	// When the connection state is modified.
	CheckedAt *strfmt.DateTime `json:"checked_at,omitempty"`
}

ConnectionState : Connection status of the agent.

type CreateActionOptions

type CreateActionOptions struct {
	// The unique name of your action. The name can be up to 128 characters long and can include alphanumeric characters,
	// spaces, dashes, and underscores. **Example** you can use the name to stop action.
	Name *string `json:"name,omitempty"`

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

	// List of locations supported by IBM Cloud Schematics service.  While creating your workspace or action, choose the
	// right region, since it cannot be changed.  Note, this does not limit the location of the IBM Cloud resources,
	// provisioned using Schematics.
	Location *string `json:"location,omitempty"`

	// Resource-group name for an action. By default, an action is created in `Default` resource group.
	ResourceGroup *string `json:"resource_group,omitempty"`

	// Type of connection to be used when connecting to bastion host.  If the `inventory_connection_type=winrm`, then
	// `bastion_connection_type` is not supported.
	BastionConnectionType *string `json:"bastion_connection_type,omitempty"`

	// Type of connection to be used when connecting to remote host.  **Note** Currently, WinRM supports only Windows
	// system with the public IPs and do not support Bastion host.
	InventoryConnectionType *string `json:"inventory_connection_type,omitempty"`

	// Action tags.
	Tags []string `json:"tags,omitempty"`

	// User defined status of the Schematics object.
	UserState *UserState `json:"user_state,omitempty"`

	// URL of the `README` file, for the source URL.
	SourceReadmeURL *string `json:"source_readme_url,omitempty"`

	// Source of templates, playbooks, or controls.
	Source *ExternalSource `json:"source,omitempty"`

	// Type of source for the Template.
	SourceType *string `json:"source_type,omitempty"`

	// Schematics job command parameter (playbook-name).
	CommandParameter *string `json:"command_parameter,omitempty"`

	// Target inventory record ID, used by the action or ansible playbook.
	Inventory *string `json:"inventory,omitempty"`

	// credentials of the Action.
	Credentials []CredentialVariableData `json:"credentials,omitempty"`

	// Describes a bastion resource.
	Bastion *BastionResourceDefinition `json:"bastion,omitempty"`

	// User editable credential variable data and system generated reference to the value.
	BastionCredential *CredentialVariableData `json:"bastion_credential,omitempty"`

	// Inventory of host and host group for the playbook in `INI` file format. For example, `"targets_ini":
	// "[webserverhost]
	//  172.22.192.6
	//  [dbhost]
	//  172.22.192.5"`. For more information, about an inventory host group syntax, see [Inventory host
	// groups](https://cloud.ibm.com/docs/schematics?topic=schematics-schematics-cli-reference#schematics-inventory-host-grps).
	TargetsIni *string `json:"targets_ini,omitempty"`

	// Input variables for the Action.
	Inputs []VariableData `json:"inputs,omitempty"`

	// Output variables for the Action.
	Outputs []VariableData `json:"outputs,omitempty"`

	// Environment variables for the Action.
	Settings []VariableData `json:"settings,omitempty"`

	// The personal access token to authenticate with your private GitHub or GitLab repository and access your Terraform
	// template.
	XGithubToken *string `json:"X-Github-token,omitempty"`

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

CreateActionOptions : The CreateAction options.

func (*CreateActionOptions) SetBastion

func (_options *CreateActionOptions) SetBastion(bastion *BastionResourceDefinition) *CreateActionOptions

SetBastion : Allow user to set Bastion

func (*CreateActionOptions) SetBastionConnectionType

func (_options *CreateActionOptions) SetBastionConnectionType(bastionConnectionType string) *CreateActionOptions

SetBastionConnectionType : Allow user to set BastionConnectionType

func (*CreateActionOptions) SetBastionCredential

func (_options *CreateActionOptions) SetBastionCredential(bastionCredential *CredentialVariableData) *CreateActionOptions

SetBastionCredential : Allow user to set BastionCredential

func (*CreateActionOptions) SetCommandParameter

func (_options *CreateActionOptions) SetCommandParameter(commandParameter string) *CreateActionOptions

SetCommandParameter : Allow user to set CommandParameter

func (*CreateActionOptions) SetCredentials

func (_options *CreateActionOptions) SetCredentials(credentials []CredentialVariableData) *CreateActionOptions

SetCredentials : Allow user to set Credentials

func (*CreateActionOptions) SetDescription

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

SetDescription : Allow user to set Description

func (*CreateActionOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

func (*CreateActionOptions) SetInputs

func (_options *CreateActionOptions) SetInputs(inputs []VariableData) *CreateActionOptions

SetInputs : Allow user to set Inputs

func (*CreateActionOptions) SetInventory

func (_options *CreateActionOptions) SetInventory(inventory string) *CreateActionOptions

SetInventory : Allow user to set Inventory

func (*CreateActionOptions) SetInventoryConnectionType

func (_options *CreateActionOptions) SetInventoryConnectionType(inventoryConnectionType string) *CreateActionOptions

SetInventoryConnectionType : Allow user to set InventoryConnectionType

func (*CreateActionOptions) SetLocation

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

SetLocation : Allow user to set Location

func (*CreateActionOptions) SetName

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

SetName : Allow user to set Name

func (*CreateActionOptions) SetOutputs

func (_options *CreateActionOptions) SetOutputs(outputs []VariableData) *CreateActionOptions

SetOutputs : Allow user to set Outputs

func (*CreateActionOptions) SetResourceGroup

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

SetResourceGroup : Allow user to set ResourceGroup

func (*CreateActionOptions) SetSettings

func (_options *CreateActionOptions) SetSettings(settings []VariableData) *CreateActionOptions

SetSettings : Allow user to set Settings

func (*CreateActionOptions) SetSource

func (_options *CreateActionOptions) SetSource(source *ExternalSource) *CreateActionOptions

SetSource : Allow user to set Source

func (*CreateActionOptions) SetSourceReadmeURL

func (_options *CreateActionOptions) SetSourceReadmeURL(sourceReadmeURL string) *CreateActionOptions

SetSourceReadmeURL : Allow user to set SourceReadmeURL

func (*CreateActionOptions) SetSourceType

func (_options *CreateActionOptions) SetSourceType(sourceType string) *CreateActionOptions

SetSourceType : Allow user to set SourceType

func (*CreateActionOptions) SetTags

func (_options *CreateActionOptions) SetTags(tags []string) *CreateActionOptions

SetTags : Allow user to set Tags

func (*CreateActionOptions) SetTargetsIni

func (_options *CreateActionOptions) SetTargetsIni(targetsIni string) *CreateActionOptions

SetTargetsIni : Allow user to set TargetsIni

func (*CreateActionOptions) SetUserState

func (_options *CreateActionOptions) SetUserState(userState *UserState) *CreateActionOptions

SetUserState : Allow user to set UserState

func (*CreateActionOptions) SetXGithubToken

func (_options *CreateActionOptions) SetXGithubToken(xGithubToken string) *CreateActionOptions

SetXGithubToken : Allow user to set XGithubToken

type CreateAgentDataOptions

type CreateAgentDataOptions struct {
	// The name of the agent (must be unique, for an account).
	Name *string `json:"name" validate:"required"`

	// The resource-group name for the agent.  By default, agent will be registered in Default Resource Group.
	ResourceGroup *string `json:"resource_group" validate:"required"`

	// Agent version.
	Version *string `json:"version" validate:"required"`

	// List of locations supported by IBM Cloud Schematics service.  While creating your workspace or action, choose the
	// right region, since it cannot be changed.  Note, this does not limit the location of the IBM Cloud resources,
	// provisioned using Schematics.
	SchematicsLocation *string `json:"schematics_location" validate:"required"`

	// The location where agent is deployed in the user environment.
	AgentLocation *string `json:"agent_location" validate:"required"`

	// The infrastructure parameters used by the agent.
	AgentInfrastructure *AgentInfrastructure `json:"agent_infrastructure" validate:"required"`

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

	// Tags for the agent.
	Tags []string `json:"tags,omitempty"`

	// The metadata of an agent.
	AgentMetadata []AgentMetadataInfo `json:"agent_metadata,omitempty"`

	// Additional input variables for the agent.
	AgentInputs []VariableData `json:"agent_inputs,omitempty"`

	// User defined status of the agent.
	UserState *AgentUserState `json:"user_state,omitempty"`

	// Schematics Agent key performance indicators.
	AgentKpi *AgentKPIData `json:"agent_kpi,omitempty"`

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

CreateAgentDataOptions : The CreateAgentData options.

func (*CreateAgentDataOptions) SetAgentInfrastructure

func (_options *CreateAgentDataOptions) SetAgentInfrastructure(agentInfrastructure *AgentInfrastructure) *CreateAgentDataOptions

SetAgentInfrastructure : Allow user to set AgentInfrastructure

func (*CreateAgentDataOptions) SetAgentInputs

func (_options *CreateAgentDataOptions) SetAgentInputs(agentInputs []VariableData) *CreateAgentDataOptions

SetAgentInputs : Allow user to set AgentInputs

func (*CreateAgentDataOptions) SetAgentKpi

func (_options *CreateAgentDataOptions) SetAgentKpi(agentKpi *AgentKPIData) *CreateAgentDataOptions

SetAgentKpi : Allow user to set AgentKpi

func (*CreateAgentDataOptions) SetAgentLocation

func (_options *CreateAgentDataOptions) SetAgentLocation(agentLocation string) *CreateAgentDataOptions

SetAgentLocation : Allow user to set AgentLocation

func (*CreateAgentDataOptions) SetAgentMetadata

func (_options *CreateAgentDataOptions) SetAgentMetadata(agentMetadata []AgentMetadataInfo) *CreateAgentDataOptions

SetAgentMetadata : Allow user to set AgentMetadata

func (*CreateAgentDataOptions) SetDescription

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

SetDescription : Allow user to set Description

func (*CreateAgentDataOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

func (*CreateAgentDataOptions) SetName

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

SetName : Allow user to set Name

func (*CreateAgentDataOptions) SetResourceGroup

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

SetResourceGroup : Allow user to set ResourceGroup

func (*CreateAgentDataOptions) SetSchematicsLocation

func (_options *CreateAgentDataOptions) SetSchematicsLocation(schematicsLocation string) *CreateAgentDataOptions

SetSchematicsLocation : Allow user to set SchematicsLocation

func (*CreateAgentDataOptions) SetTags

func (_options *CreateAgentDataOptions) SetTags(tags []string) *CreateAgentDataOptions

SetTags : Allow user to set Tags

func (*CreateAgentDataOptions) SetUserState

func (_options *CreateAgentDataOptions) SetUserState(userState *AgentUserState) *CreateAgentDataOptions

SetUserState : Allow user to set UserState

func (*CreateAgentDataOptions) SetVersion

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

SetVersion : Allow user to set Version

type CreateInventoryOptions

type CreateInventoryOptions struct {
	// The unique name of your Inventory definition. The name can be up to 128 characters long and can include alphanumeric
	// characters, spaces, dashes, and underscores.
	Name *string `json:"name,omitempty"`

	// The description of your Inventory definition. The description can be up to 2048 characters long in size.
	Description *string `json:"description,omitempty"`

	// List of locations supported by IBM Cloud Schematics service.  While creating your workspace or action, choose the
	// right region, since it cannot be changed.  Note, this does not limit the location of the IBM Cloud resources,
	// provisioned using Schematics.
	Location *string `json:"location,omitempty"`

	// Resource-group name for the Inventory definition.   By default, Inventory definition will be created in Default
	// Resource Group.
	ResourceGroup *string `json:"resource_group,omitempty"`

	// Input inventory of host and host group for the playbook, in the `.ini` file format.
	InventoriesIni *string `json:"inventories_ini,omitempty"`

	// Input resource query definitions that is used to dynamically generate the inventory of host and host group for the
	// playbook.
	ResourceQueries []string `json:"resource_queries,omitempty"`

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

CreateInventoryOptions : The CreateInventory options.

func (*CreateInventoryOptions) SetDescription

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

SetDescription : Allow user to set Description

func (*CreateInventoryOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

func (*CreateInventoryOptions) SetInventoriesIni

func (_options *CreateInventoryOptions) SetInventoriesIni(inventoriesIni string) *CreateInventoryOptions

SetInventoriesIni : Allow user to set InventoriesIni

func (*CreateInventoryOptions) SetLocation

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

SetLocation : Allow user to set Location

func (*CreateInventoryOptions) SetName

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

SetName : Allow user to set Name

func (*CreateInventoryOptions) SetResourceGroup

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

SetResourceGroup : Allow user to set ResourceGroup

func (*CreateInventoryOptions) SetResourceQueries

func (_options *CreateInventoryOptions) SetResourceQueries(resourceQueries []string) *CreateInventoryOptions

SetResourceQueries : Allow user to set ResourceQueries

type CreateJobOptions

type CreateJobOptions struct {
	// The IAM refresh token for the user or service identity.
	//
	//   **Retrieving refresh token**:
	//   * Use `export IBMCLOUD_API_KEY=<ibmcloud_api_key>`, and execute `curl -X POST
	// "https://iam.cloud.ibm.com/identity/token" -H "Content-Type: application/x-www-form-urlencoded" -d
	// "grant_type=urn:ibm:params:oauth:grant-type:apikey&apikey=$IBMCLOUD_API_KEY" -u bx:bx`.
	//   * For more information, about creating IAM access token and API Docs, refer, [IAM access
	// token](/apidocs/iam-identity-token-api#gettoken-password) and [Create API
	// key](/apidocs/iam-identity-token-api#create-api-key).
	//
	//   **Limitation**:
	//   * If the token is expired, you can use `refresh token` to get a new IAM access token.
	//   * The `refresh_token` parameter cannot be used to retrieve a new IAM access token.
	//   * When the IAM access token is about to expire, use the API key to create a new access token.
	RefreshToken *string `json:"refresh_token" validate:"required"`

	// Name of the Schematics automation resource.
	CommandObject *string `json:"command_object,omitempty"`

	// Job command object id (workspace-id, action-id).
	CommandObjectID *string `json:"command_object_id,omitempty"`

	// Schematics job command name.
	CommandName *string `json:"command_name,omitempty"`

	// Schematics job command parameter (playbook-name).
	CommandParameter *string `json:"command_parameter,omitempty"`

	// Command line options for the command.
	CommandOptions []string `json:"command_options,omitempty"`

	// Job inputs used by Action or Workspace.
	Inputs []VariableData `json:"inputs,omitempty"`

	// Environment variables used by the Job while performing Action or Workspace.
	Settings []VariableData `json:"settings,omitempty"`

	// User defined tags, while running the job.
	Tags []string `json:"tags,omitempty"`

	// List of locations supported by IBM Cloud Schematics service.  While creating your workspace or action, choose the
	// right region, since it cannot be changed.  Note, this does not limit the location of the IBM Cloud resources,
	// provisioned using Schematics.
	Location *string `json:"location,omitempty"`

	// Job Status.
	Status *JobStatus `json:"status,omitempty"`

	// Contains the cart order data which can be used for different purpose for eg. service tagging.
	CartOrderData []CartOrderData `json:"cart_order_data,omitempty"`

	// Job data.
	Data *JobData `json:"data,omitempty"`

	// Describes a bastion resource.
	Bastion *BastionResourceDefinition `json:"bastion,omitempty"`

	// Job log summary record.
	LogSummary *JobLogSummary `json:"log_summary,omitempty"`

	// Agent name, Agent id and associated policy ID information.
	Agent *AgentInfo `json:"agent,omitempty"`

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

CreateJobOptions : The CreateJob options.

func (*CreateJobOptions) SetAgent

func (_options *CreateJobOptions) SetAgent(agent *AgentInfo) *CreateJobOptions

SetAgent : Allow user to set Agent

func (*CreateJobOptions) SetBastion

func (_options *CreateJobOptions) SetBastion(bastion *BastionResourceDefinition) *CreateJobOptions

SetBastion : Allow user to set Bastion

func (*CreateJobOptions) SetCartOrderData

func (_options *CreateJobOptions) SetCartOrderData(cartOrderData []CartOrderData) *CreateJobOptions

SetCartOrderData : Allow user to set CartOrderData

func (*CreateJobOptions) SetCommandName

func (_options *CreateJobOptions) SetCommandName(commandName string) *CreateJobOptions

SetCommandName : Allow user to set CommandName

func (*CreateJobOptions) SetCommandObject

func (_options *CreateJobOptions) SetCommandObject(commandObject string) *CreateJobOptions

SetCommandObject : Allow user to set CommandObject

func (*CreateJobOptions) SetCommandObjectID

func (_options *CreateJobOptions) SetCommandObjectID(commandObjectID string) *CreateJobOptions

SetCommandObjectID : Allow user to set CommandObjectID

func (*CreateJobOptions) SetCommandOptions

func (_options *CreateJobOptions) SetCommandOptions(commandOptions []string) *CreateJobOptions

SetCommandOptions : Allow user to set CommandOptions

func (*CreateJobOptions) SetCommandParameter

func (_options *CreateJobOptions) SetCommandParameter(commandParameter string) *CreateJobOptions

SetCommandParameter : Allow user to set CommandParameter

func (*CreateJobOptions) SetData

func (_options *CreateJobOptions) SetData(data *JobData) *CreateJobOptions

SetData : Allow user to set Data

func (*CreateJobOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

func (*CreateJobOptions) SetInputs

func (_options *CreateJobOptions) SetInputs(inputs []VariableData) *CreateJobOptions

SetInputs : Allow user to set Inputs

func (*CreateJobOptions) SetLocation

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

SetLocation : Allow user to set Location

func (*CreateJobOptions) SetLogSummary

func (_options *CreateJobOptions) SetLogSummary(logSummary *JobLogSummary) *CreateJobOptions

SetLogSummary : Allow user to set LogSummary

func (*CreateJobOptions) SetRefreshToken

func (_options *CreateJobOptions) SetRefreshToken(refreshToken string) *CreateJobOptions

SetRefreshToken : Allow user to set RefreshToken

func (*CreateJobOptions) SetSettings

func (_options *CreateJobOptions) SetSettings(settings []VariableData) *CreateJobOptions

SetSettings : Allow user to set Settings

func (*CreateJobOptions) SetStatus

func (_options *CreateJobOptions) SetStatus(status *JobStatus) *CreateJobOptions

SetStatus : Allow user to set Status

func (*CreateJobOptions) SetTags

func (_options *CreateJobOptions) SetTags(tags []string) *CreateJobOptions

SetTags : Allow user to set Tags

type CreatePolicyOptions

type CreatePolicyOptions struct {
	// Name of Schematics customization policy.
	Name *string `json:"name,omitempty"`

	// The description of Schematics customization policy.
	Description *string `json:"description,omitempty"`

	// The resource group name for the policy.  By default, Policy will be created in `default` Resource Group.
	ResourceGroup *string `json:"resource_group,omitempty"`

	// Tags for the Schematics customization policy.
	Tags []string `json:"tags,omitempty"`

	// List of locations supported by IBM Cloud Schematics service.  While creating your workspace or action, choose the
	// right region, since it cannot be changed.  Note, this does not limit the location of the IBM Cloud resources,
	// provisioned using Schematics.
	Location *string `json:"location,omitempty"`

	// User defined status of the Schematics object.
	State *UserState `json:"state,omitempty"`

	// Policy kind or categories for managing and deriving policy decision
	//   * `agent_assignment_policy` Agent assignment policy for job execution.
	Kind *string `json:"kind,omitempty"`

	// The objects for the Schematics policy.
	Target *PolicyObjects `json:"target,omitempty"`

	// The parameter to tune the Schematics policy.
	Parameter *PolicyParameter `json:"parameter,omitempty"`

	// List of scoped Schematics resources targeted by the policy.
	ScopedResources []ScopedResource `json:"scoped_resources,omitempty"`

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

CreatePolicyOptions : The CreatePolicy options.

func (*CreatePolicyOptions) SetDescription

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

SetDescription : Allow user to set Description

func (*CreatePolicyOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

func (*CreatePolicyOptions) SetKind

func (_options *CreatePolicyOptions) SetKind(kind string) *CreatePolicyOptions

SetKind : Allow user to set Kind

func (*CreatePolicyOptions) SetLocation

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

SetLocation : Allow user to set Location

func (*CreatePolicyOptions) SetName

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

SetName : Allow user to set Name

func (*CreatePolicyOptions) SetParameter

func (_options *CreatePolicyOptions) SetParameter(parameter *PolicyParameter) *CreatePolicyOptions

SetParameter : Allow user to set Parameter

func (*CreatePolicyOptions) SetResourceGroup

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

SetResourceGroup : Allow user to set ResourceGroup

func (*CreatePolicyOptions) SetScopedResources

func (_options *CreatePolicyOptions) SetScopedResources(scopedResources []ScopedResource) *CreatePolicyOptions

SetScopedResources : Allow user to set ScopedResources

func (*CreatePolicyOptions) SetState

func (_options *CreatePolicyOptions) SetState(state *UserState) *CreatePolicyOptions

SetState : Allow user to set State

func (*CreatePolicyOptions) SetTags

func (_options *CreatePolicyOptions) SetTags(tags []string) *CreatePolicyOptions

SetTags : Allow user to set Tags

func (*CreatePolicyOptions) SetTarget

func (_options *CreatePolicyOptions) SetTarget(target *PolicyObjects) *CreatePolicyOptions

SetTarget : Allow user to set Target

type CreateResourceQueryOptions

type CreateResourceQueryOptions struct {
	// Resource type (cluster, vsi, icd, vpc).
	Type *string `json:"type,omitempty"`

	// Resource query name.
	Name *string `json:"name,omitempty"`

	Queries []ResourceQuery `json:"queries,omitempty"`

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

CreateResourceQueryOptions : The CreateResourceQuery options.

func (*CreateResourceQueryOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

func (*CreateResourceQueryOptions) SetName

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

SetName : Allow user to set Name

func (*CreateResourceQueryOptions) SetQueries

func (_options *CreateResourceQueryOptions) SetQueries(queries []ResourceQuery) *CreateResourceQueryOptions

SetQueries : Allow user to set Queries

func (*CreateResourceQueryOptions) SetType

func (_options *CreateResourceQueryOptions) SetType(typeVar string) *CreateResourceQueryOptions

SetType : Allow user to set Type

type CreateWorkspaceDeletionJobOptions

type CreateWorkspaceDeletionJobOptions struct {
	// The IAM refresh token for the user or service identity.
	//
	//   **Retrieving refresh token**:
	//   * Use `export IBMCLOUD_API_KEY=<ibmcloud_api_key>`, and execute `curl -X POST
	// "https://iam.cloud.ibm.com/identity/token" -H "Content-Type: application/x-www-form-urlencoded" -d
	// "grant_type=urn:ibm:params:oauth:grant-type:apikey&apikey=$IBMCLOUD_API_KEY" -u bx:bx`.
	//   * For more information, about creating IAM access token and API Docs, refer, [IAM access
	// token](/apidocs/iam-identity-token-api#gettoken-password) and [Create API
	// key](/apidocs/iam-identity-token-api#create-api-key).
	//
	//   **Limitation**:
	//   * If the token is expired, you can use `refresh token` to get a new IAM access token.
	//   * The `refresh_token` parameter cannot be used to retrieve a new IAM access token.
	//   * When the IAM access token is about to expire, use the API key to create a new access token.
	RefreshToken *string `json:"refresh_token" validate:"required"`

	// Job type such as delete of a batch operation.
	Job *string `json:"job,omitempty"`

	// A version of the terraform template.
	Version *string `json:"version,omitempty"`

	// The List of workspaces to be deleted.
	Workspaces []string `json:"workspaces,omitempty"`

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

CreateWorkspaceDeletionJobOptions : The CreateWorkspaceDeletionJob options.

func (*CreateWorkspaceDeletionJobOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

func (*CreateWorkspaceDeletionJobOptions) SetJob

func (_options *CreateWorkspaceDeletionJobOptions) SetJob(job string) *CreateWorkspaceDeletionJobOptions

SetJob : Allow user to set Job

func (*CreateWorkspaceDeletionJobOptions) SetRefreshToken

func (_options *CreateWorkspaceDeletionJobOptions) SetRefreshToken(refreshToken string) *CreateWorkspaceDeletionJobOptions

SetRefreshToken : Allow user to set RefreshToken

func (*CreateWorkspaceDeletionJobOptions) SetVersion

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

SetVersion : Allow user to set Version

func (*CreateWorkspaceDeletionJobOptions) SetWorkspaces

func (_options *CreateWorkspaceDeletionJobOptions) SetWorkspaces(workspaces []string) *CreateWorkspaceDeletionJobOptions

SetWorkspaces : Allow user to set Workspaces

type CreateWorkspaceOptions

type CreateWorkspaceOptions struct {
	// List of applied shared dataset ID.
	// Deprecated: this field is deprecated and may be removed in a future release.
	AppliedShareddataIds []string `json:"applied_shareddata_ids,omitempty"`

	// Information about the software template that you chose from the IBM Cloud catalog. This information is returned for
	// IBM Cloud catalog offerings only.
	CatalogRef *CatalogRef `json:"catalog_ref,omitempty"`

	// Workspace dependencies.
	Dependencies *Dependencies `json:"dependencies,omitempty"`

	// The description of the workspace.
	Description *string `json:"description,omitempty"`

	// The location where you want to create your Schematics workspace and run the Schematics jobs. The location that you
	// enter must match the API endpoint that you use. For example, if you use the Frankfurt API endpoint, you must specify
	// `eu-de` as your location. If you use an API endpoint for a geography and you do not specify a location, Schematics
	// determines the location based on availability.
	Location *string `json:"location,omitempty"`

	// The name of your workspace. The name can be up to 128 characters long and can include alphanumeric characters,
	// spaces, dashes, and underscores. When you create a workspace for your own Terraform template, consider including the
	// microservice component that you set up with your Terraform template and the IBM Cloud environment where you want to
	// deploy your resources in your name.
	Name *string `json:"name,omitempty"`

	// The ID of the resource group where you want to provision the workspace.
	ResourceGroup *string `json:"resource_group,omitempty"`

	// Information about the Target used by the templates originating from the  IBM Cloud catalog offerings. This
	// information is not relevant for workspace created using your own Terraform template.
	SharedData *SharedTargetData `json:"shared_data,omitempty"`

	// A list of tags that are associated with the workspace.
	Tags []string `json:"tags,omitempty"`

	// Input data for the Template.
	TemplateData []TemplateSourceDataRequest `json:"template_data,omitempty"`

	// Workspace template ref.
	TemplateRef *string `json:"template_ref,omitempty"`

	// Input variables for the Template repoository, while creating a workspace.
	TemplateRepo *TemplateRepoRequest `json:"template_repo,omitempty"`

	// List of Workspace type.
	Type []string `json:"type,omitempty"`

	// WorkspaceStatusRequest -.
	WorkspaceStatus *WorkspaceStatusRequest `json:"workspace_status,omitempty"`

	// agent id which is binded to with the workspace.
	AgentID *string `json:"agent_id,omitempty"`

	// Input settings to be applied to the workspace, for example, `job_timeout_override`.
	Settings []VariableData `json:"settings,omitempty"`

	// The personal access token to authenticate with your private GitHub or GitLab repository and access your Terraform
	// template.
	XGithubToken *string `json:"X-Github-token,omitempty"`

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

CreateWorkspaceOptions : The CreateWorkspace options.

func (*CreateWorkspaceOptions) SetAgentID

func (_options *CreateWorkspaceOptions) SetAgentID(agentID string) *CreateWorkspaceOptions

SetAgentID : Allow user to set AgentID

func (*CreateWorkspaceOptions) SetAppliedShareddataIds

func (_options *CreateWorkspaceOptions) SetAppliedShareddataIds(appliedShareddataIds []string) *CreateWorkspaceOptions

SetAppliedShareddataIds : Allow user to set AppliedShareddataIds Deprecated: this method is deprecated and may be removed in a future release.

func (*CreateWorkspaceOptions) SetCatalogRef

func (_options *CreateWorkspaceOptions) SetCatalogRef(catalogRef *CatalogRef) *CreateWorkspaceOptions

SetCatalogRef : Allow user to set CatalogRef

func (*CreateWorkspaceOptions) SetDependencies

func (_options *CreateWorkspaceOptions) SetDependencies(dependencies *Dependencies) *CreateWorkspaceOptions

SetDependencies : Allow user to set Dependencies

func (*CreateWorkspaceOptions) SetDescription

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

SetDescription : Allow user to set Description

func (*CreateWorkspaceOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

func (*CreateWorkspaceOptions) SetLocation

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

SetLocation : Allow user to set Location

func (*CreateWorkspaceOptions) SetName

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

SetName : Allow user to set Name

func (*CreateWorkspaceOptions) SetResourceGroup

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

SetResourceGroup : Allow user to set ResourceGroup

func (*CreateWorkspaceOptions) SetSettings

func (_options *CreateWorkspaceOptions) SetSettings(settings []VariableData) *CreateWorkspaceOptions

SetSettings : Allow user to set Settings

func (*CreateWorkspaceOptions) SetSharedData

func (_options *CreateWorkspaceOptions) SetSharedData(sharedData *SharedTargetData) *CreateWorkspaceOptions

SetSharedData : Allow user to set SharedData

func (*CreateWorkspaceOptions) SetTags

func (_options *CreateWorkspaceOptions) SetTags(tags []string) *CreateWorkspaceOptions

SetTags : Allow user to set Tags

func (*CreateWorkspaceOptions) SetTemplateData

func (_options *CreateWorkspaceOptions) SetTemplateData(templateData []TemplateSourceDataRequest) *CreateWorkspaceOptions

SetTemplateData : Allow user to set TemplateData

func (*CreateWorkspaceOptions) SetTemplateRef

func (_options *CreateWorkspaceOptions) SetTemplateRef(templateRef string) *CreateWorkspaceOptions

SetTemplateRef : Allow user to set TemplateRef

func (*CreateWorkspaceOptions) SetTemplateRepo

func (_options *CreateWorkspaceOptions) SetTemplateRepo(templateRepo *TemplateRepoRequest) *CreateWorkspaceOptions

SetTemplateRepo : Allow user to set TemplateRepo

func (*CreateWorkspaceOptions) SetType

func (_options *CreateWorkspaceOptions) SetType(typeVar []string) *CreateWorkspaceOptions

SetType : Allow user to set Type

func (*CreateWorkspaceOptions) SetWorkspaceStatus

func (_options *CreateWorkspaceOptions) SetWorkspaceStatus(workspaceStatus *WorkspaceStatusRequest) *CreateWorkspaceOptions

SetWorkspaceStatus : Allow user to set WorkspaceStatus

func (*CreateWorkspaceOptions) SetXGithubToken

func (_options *CreateWorkspaceOptions) SetXGithubToken(xGithubToken string) *CreateWorkspaceOptions

SetXGithubToken : Allow user to set XGithubToken

type CredentialVariableData

type CredentialVariableData struct {
	// The name of the credential variable.
	Name *string `json:"name,omitempty"`

	// The credential value for the variable or reference to the value. **Note** The SSH key should contain three `\n` in
	// the SSH key value as shown in the example for CLI or API calls. When using Bastion from API you need to add SSH key
	// in both `credentials` and `bastion_credentials`.
	Value *string `json:"value,omitempty"`

	// True, will ignore the data in the value attribute, instead the data in metadata.default_value will be used.
	UseDefault *bool `json:"use_default,omitempty"`

	// An user editable metadata for the credential variables.
	Metadata *CredentialVariableMetadata `json:"metadata,omitempty"`

	// The reference link to the variable value By default the expression points to `$self.value`.
	Link *string `json:"link,omitempty"`
}

CredentialVariableData : User editable credential variable data and system generated reference to the value.

type CredentialVariableMetadata

type CredentialVariableMetadata struct {
	// Type of the variable.
	Type *string `json:"type,omitempty"`

	// The list of aliases for the variable name.
	Aliases []string `json:"aliases,omitempty"`

	// The description of the meta data.
	Description *string `json:"description,omitempty"`

	// Cloud data type of the credential variable. eg. api_key, iam_token, profile_id.
	CloudDataType *string `json:"cloud_data_type,omitempty"`

	// Default value for the variable only if the override value is not specified.
	DefaultValue *string `json:"default_value,omitempty"`

	// The status of the link.
	LinkStatus *string `json:"link_status,omitempty"`

	// Is the variable readonly ?.
	Immutable *bool `json:"immutable,omitempty"`

	// If **true**, the variable is not displayed on UI or Command line.
	Hidden *bool `json:"hidden,omitempty"`

	// If the variable required?.
	Required *bool `json:"required,omitempty"`

	// The relative position of this variable in a list.
	Position *int64 `json:"position,omitempty"`

	// The display name of the group this variable belongs to.
	GroupBy *string `json:"group_by,omitempty"`

	// The source of this meta-data.
	Source *string `json:"source,omitempty"`
}

CredentialVariableMetadata : An user editable metadata for the credential variables.

type DeleteActionOptions

type DeleteActionOptions struct {
	// Action Id.  Use GET /actions API to look up the Action Ids in your IBM Cloud account.
	ActionID *string `json:"action_id" validate:"required,ne="`

	// Equivalent to -force options in the command line.
	Force *bool `json:"force,omitempty"`

	// Auto propagate the chaange or deletion to the dependent resources.
	Propagate *bool `json:"propagate,omitempty"`

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

DeleteActionOptions : The DeleteAction options.

func (*DeleteActionOptions) SetActionID

func (_options *DeleteActionOptions) SetActionID(actionID string) *DeleteActionOptions

SetActionID : Allow user to set ActionID

func (*DeleteActionOptions) SetForce

func (_options *DeleteActionOptions) SetForce(force bool) *DeleteActionOptions

SetForce : Allow user to set Force

func (*DeleteActionOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

func (*DeleteActionOptions) SetPropagate

func (_options *DeleteActionOptions) SetPropagate(propagate bool) *DeleteActionOptions

SetPropagate : Allow user to set Propagate

type DeleteAgentDataOptions

type DeleteAgentDataOptions struct {
	// Agent ID to get the details of agent.
	AgentID *string `json:"agent_id" validate:"required,ne="`

	// Equivalent to -force options in the command line, default is false.
	Force *bool `json:"force,omitempty"`

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

DeleteAgentDataOptions : The DeleteAgentData options.

func (*DeleteAgentDataOptions) SetAgentID

func (_options *DeleteAgentDataOptions) SetAgentID(agentID string) *DeleteAgentDataOptions

SetAgentID : Allow user to set AgentID

func (*DeleteAgentDataOptions) SetForce

func (_options *DeleteAgentDataOptions) SetForce(force bool) *DeleteAgentDataOptions

SetForce : Allow user to set Force

func (*DeleteAgentDataOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

type DeleteAgentOptions

type DeleteAgentOptions struct {
	// Agent ID to get the details of agent.
	AgentID *string `json:"agent_id" validate:"required,ne="`

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

DeleteAgentOptions : The DeleteAgent options.

func (*DeleteAgentOptions) SetAgentID

func (_options *DeleteAgentOptions) SetAgentID(agentID string) *DeleteAgentOptions

SetAgentID : Allow user to set AgentID

func (*DeleteAgentOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

type DeleteAgentResourcesOptions

type DeleteAgentResourcesOptions struct {
	// Agent ID to get the details of agent.
	AgentID *string `json:"agent_id" validate:"required,ne="`

	// The IAM refresh token for the user or service identity.
	//
	//   **Retrieving refresh token**:
	//   * Use `export IBMCLOUD_API_KEY=<ibmcloud_api_key>`, and execute `curl -X POST
	// "https://iam.cloud.ibm.com/identity/token" -H "Content-Type: application/x-www-form-urlencoded" -d
	// "grant_type=urn:ibm:params:oauth:grant-type:apikey&apikey=$IBMCLOUD_API_KEY" -u bx:bx`.
	//   * For more information, about creating IAM access token and API Docs, refer, [IAM access
	// token](/apidocs/iam-identity-token-api#gettoken-password) and [Create API
	// key](/apidocs/iam-identity-token-api#create-api-key).
	//
	//   **Limitation**:
	//   * If the token is expired, you can use `refresh token` to get a new IAM access token.
	//   * The `refresh_token` parameter cannot be used to retrieve a new IAM access token.
	//   * When the IAM access token is about to expire, use the API key to create a new access token.
	RefreshToken *string `json:"refresh_token" validate:"required"`

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

DeleteAgentResourcesOptions : The DeleteAgentResources options.

func (*DeleteAgentResourcesOptions) SetAgentID

func (_options *DeleteAgentResourcesOptions) SetAgentID(agentID string) *DeleteAgentResourcesOptions

SetAgentID : Allow user to set AgentID

func (*DeleteAgentResourcesOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

func (*DeleteAgentResourcesOptions) SetRefreshToken

func (_options *DeleteAgentResourcesOptions) SetRefreshToken(refreshToken string) *DeleteAgentResourcesOptions

SetRefreshToken : Allow user to set RefreshToken

type DeleteInventoryOptions

type DeleteInventoryOptions struct {
	// Resource Inventory Id.  Use `GET /v2/inventories` API to look up the Resource Inventory definition Ids  in your IBM
	// Cloud account.
	InventoryID *string `json:"inventory_id" validate:"required,ne="`

	// Equivalent to -force options in the command line.
	Force *bool `json:"force,omitempty"`

	// Auto propagate the chaange or deletion to the dependent resources.
	Propagate *bool `json:"propagate,omitempty"`

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

DeleteInventoryOptions : The DeleteInventory options.

func (*DeleteInventoryOptions) SetForce

func (_options *DeleteInventoryOptions) SetForce(force bool) *DeleteInventoryOptions

SetForce : Allow user to set Force

func (*DeleteInventoryOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

func (*DeleteInventoryOptions) SetInventoryID

func (_options *DeleteInventoryOptions) SetInventoryID(inventoryID string) *DeleteInventoryOptions

SetInventoryID : Allow user to set InventoryID

func (*DeleteInventoryOptions) SetPropagate

func (_options *DeleteInventoryOptions) SetPropagate(propagate bool) *DeleteInventoryOptions

SetPropagate : Allow user to set Propagate

type DeleteJobOptions

type DeleteJobOptions struct {
	// Job Id. Use `GET /v2/jobs` API to look up the Job Ids in your IBM Cloud account.
	JobID *string `json:"job_id" validate:"required,ne="`

	// The IAM refresh token for the user or service identity.
	//
	//   **Retrieving refresh token**:
	//   * Use `export IBMCLOUD_API_KEY=<ibmcloud_api_key>`, and execute `curl -X POST
	// "https://iam.cloud.ibm.com/identity/token" -H "Content-Type: application/x-www-form-urlencoded" -d
	// "grant_type=urn:ibm:params:oauth:grant-type:apikey&apikey=$IBMCLOUD_API_KEY" -u bx:bx`.
	//   * For more information, about creating IAM access token and API Docs, refer, [IAM access
	// token](/apidocs/iam-identity-token-api#gettoken-password) and [Create API
	// key](/apidocs/iam-identity-token-api#create-api-key).
	//
	//   **Limitation**:
	//   * If the token is expired, you can use `refresh token` to get a new IAM access token.
	//   * The `refresh_token` parameter cannot be used to retrieve a new IAM access token.
	//   * When the IAM access token is about to expire, use the API key to create a new access token.
	RefreshToken *string `json:"refresh_token" validate:"required"`

	// Equivalent to -force options in the command line.
	Force *bool `json:"force,omitempty"`

	// Auto propagate the chaange or deletion to the dependent resources.
	Propagate *bool `json:"propagate,omitempty"`

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

DeleteJobOptions : The DeleteJob options.

func (*DeleteJobOptions) SetForce

func (_options *DeleteJobOptions) SetForce(force bool) *DeleteJobOptions

SetForce : Allow user to set Force

func (*DeleteJobOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

func (*DeleteJobOptions) SetJobID

func (_options *DeleteJobOptions) SetJobID(jobID string) *DeleteJobOptions

SetJobID : Allow user to set JobID

func (*DeleteJobOptions) SetPropagate

func (_options *DeleteJobOptions) SetPropagate(propagate bool) *DeleteJobOptions

SetPropagate : Allow user to set Propagate

func (*DeleteJobOptions) SetRefreshToken

func (_options *DeleteJobOptions) SetRefreshToken(refreshToken string) *DeleteJobOptions

SetRefreshToken : Allow user to set RefreshToken

type DeletePolicyOptions

type DeletePolicyOptions struct {
	// ID to get the details of policy.
	PolicyID *string `json:"policy_id" validate:"required,ne="`

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

DeletePolicyOptions : The DeletePolicy options.

func (*DeletePolicyOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

func (*DeletePolicyOptions) SetPolicyID

func (_options *DeletePolicyOptions) SetPolicyID(policyID string) *DeletePolicyOptions

SetPolicyID : Allow user to set PolicyID

type DeleteResourcesQueryOptions

type DeleteResourcesQueryOptions struct {
	// Resource query Id.  Use `GET /v2/resource_query` API to look up the Resource query definition Ids  in your IBM Cloud
	// account.
	QueryID *string `json:"query_id" validate:"required,ne="`

	// Equivalent to -force options in the command line.
	Force *bool `json:"force,omitempty"`

	// Auto propagate the chaange or deletion to the dependent resources.
	Propagate *bool `json:"propagate,omitempty"`

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

DeleteResourcesQueryOptions : The DeleteResourcesQuery options.

func (*DeleteResourcesQueryOptions) SetForce

func (_options *DeleteResourcesQueryOptions) SetForce(force bool) *DeleteResourcesQueryOptions

SetForce : Allow user to set Force

func (*DeleteResourcesQueryOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

func (*DeleteResourcesQueryOptions) SetPropagate

func (_options *DeleteResourcesQueryOptions) SetPropagate(propagate bool) *DeleteResourcesQueryOptions

SetPropagate : Allow user to set Propagate

func (*DeleteResourcesQueryOptions) SetQueryID

func (_options *DeleteResourcesQueryOptions) SetQueryID(queryID string) *DeleteResourcesQueryOptions

SetQueryID : Allow user to set QueryID

type DeleteWorkspaceActivityOptions

type DeleteWorkspaceActivityOptions struct {
	// The ID of the workspace.  To find the workspace ID, use the `GET /v1/workspaces` API.
	WID *string `json:"w_id" validate:"required,ne="`

	// The ID of the activity or job, for which you want to retrieve details.  To find the job ID, use the `GET
	// /v1/workspaces/{id}/actions` API.
	ActivityID *string `json:"activity_id" validate:"required,ne="`

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

DeleteWorkspaceActivityOptions : The DeleteWorkspaceActivity options.

func (*DeleteWorkspaceActivityOptions) SetActivityID

func (_options *DeleteWorkspaceActivityOptions) SetActivityID(activityID string) *DeleteWorkspaceActivityOptions

SetActivityID : Allow user to set ActivityID

func (*DeleteWorkspaceActivityOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

func (*DeleteWorkspaceActivityOptions) SetWID

func (_options *DeleteWorkspaceActivityOptions) SetWID(wID string) *DeleteWorkspaceActivityOptions

SetWID : Allow user to set WID

type DeleteWorkspaceOptions

type DeleteWorkspaceOptions struct {
	// The IAM refresh token for the user or service identity. The IAM refresh token is required only if you want to
	// destroy the Terraform resources before deleting the Schematics workspace. If you want to delete the workspace only
	// and keep all your Terraform resources, refresh token is not required.
	//
	//   **Retrieving refresh token**:
	//   * Use `export IBMCLOUD_API_KEY=<ibmcloud_api_key>`, and execute `curl -X POST
	// "https://iam.cloud.ibm.com/identity/token" -H "Content-Type: application/x-www-form-urlencoded" -d
	// "grant_type=urn:ibm:params:oauth:grant-type:apikey&apikey=$IBMCLOUD_API_KEY" -u bx:bx`.
	//   * For more information, about creating IAM access token and API Docs, refer, [IAM access
	// token](/apidocs/iam-identity-token-api#gettoken-password) and [Create API
	// key](/apidocs/iam-identity-token-api#create-api-key).
	//
	//   **Limitation**:
	//   * If the token is expired, you can use `refresh token` to get a new IAM access token.
	//   * The `refresh_token` parameter cannot be used to retrieve a new IAM access token.
	//   * When the IAM access token is about to expire, use the API key to create a new access token.
	RefreshToken *string `json:"refresh_token" validate:"required"`

	// The ID of the workspace.  To find the workspace ID, use the `GET /v1/workspaces` API.
	WID *string `json:"w_id" validate:"required,ne="`

	// If set to `true`, refresh_token header configuration is required to delete all the Terraform resources, and the
	// Schematics workspace. If set to `false`, you can remove only the workspace. Your Terraform resources are still
	// available and must be managed with the resource dashboard or CLI.
	DestroyResources *string `json:"destroy_resources,omitempty"`

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

DeleteWorkspaceOptions : The DeleteWorkspace options.

func (*DeleteWorkspaceOptions) SetDestroyResources

func (_options *DeleteWorkspaceOptions) SetDestroyResources(destroyResources string) *DeleteWorkspaceOptions

SetDestroyResources : Allow user to set DestroyResources

func (*DeleteWorkspaceOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

func (*DeleteWorkspaceOptions) SetRefreshToken

func (_options *DeleteWorkspaceOptions) SetRefreshToken(refreshToken string) *DeleteWorkspaceOptions

SetRefreshToken : Allow user to set RefreshToken

func (*DeleteWorkspaceOptions) SetWID

func (_options *DeleteWorkspaceOptions) SetWID(wID string) *DeleteWorkspaceOptions

SetWID : Allow user to set WID

type Dependencies

type Dependencies struct {
	// List of workspace parents CRN identifiers.
	Parents []string `json:"parents,omitempty"`

	// List of workspace children CRN identifiers.
	Children []string `json:"children,omitempty"`
}

Dependencies : Workspace dependencies.

type DeployAgentJobOptions

type DeployAgentJobOptions struct {
	// Agent ID to get the details of agent.
	AgentID *string `json:"agent_id" validate:"required,ne="`

	// Equivalent to -force options in the command line, default is false.
	Force *bool `json:"force,omitempty"`

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

DeployAgentJobOptions : The DeployAgentJob options.

func (*DeployAgentJobOptions) SetAgentID

func (_options *DeployAgentJobOptions) SetAgentID(agentID string) *DeployAgentJobOptions

SetAgentID : Allow user to set AgentID

func (*DeployAgentJobOptions) SetForce

func (_options *DeployAgentJobOptions) SetForce(force bool) *DeployAgentJobOptions

SetForce : Allow user to set Force

func (*DeployAgentJobOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

type DestroyWorkspaceCommandOptions

type DestroyWorkspaceCommandOptions struct {
	// The ID of the workspace for which you want to perform a Schematics `destroy` job.  To find the workspace ID, use the
	// `GET /workspaces` API.
	WID *string `json:"w_id" validate:"required,ne="`

	// The IAM refresh token for the user or service identity.
	//
	//   **Retrieving refresh token**:
	//   * Use `export IBMCLOUD_API_KEY=<ibmcloud_api_key>`, and execute `curl -X POST
	// "https://iam.cloud.ibm.com/identity/token" -H "Content-Type: application/x-www-form-urlencoded" -d
	// "grant_type=urn:ibm:params:oauth:grant-type:apikey&apikey=$IBMCLOUD_API_KEY" -u bx:bx`.
	//   * For more information, about creating IAM access token and API Docs, refer, [IAM access
	// token](/apidocs/iam-identity-token-api#gettoken-password) and [Create API
	// key](/apidocs/iam-identity-token-api#create-api-key).
	//
	//   **Limitation**:
	//   * If the token is expired, you can use `refresh token` to get a new IAM access token.
	//   * The `refresh_token` parameter cannot be used to retrieve a new IAM access token.
	//   * When the IAM access token is about to expire, use the API key to create a new access token.
	RefreshToken *string `json:"refresh_token" validate:"required"`

	// Workspace job options template.
	ActionOptions *WorkspaceActivityOptionsTemplate `json:"action_options,omitempty"`

	// The IAM delegated token for your IBM Cloud account.  This token is required for requests that are sent via the UI
	// only.
	DelegatedToken *string `json:"delegated_token,omitempty"`

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

DestroyWorkspaceCommandOptions : The DestroyWorkspaceCommand options.

func (*DestroyWorkspaceCommandOptions) SetActionOptions

func (_options *DestroyWorkspaceCommandOptions) SetActionOptions(actionOptions *WorkspaceActivityOptionsTemplate) *DestroyWorkspaceCommandOptions

SetActionOptions : Allow user to set ActionOptions

func (*DestroyWorkspaceCommandOptions) SetDelegatedToken

func (_options *DestroyWorkspaceCommandOptions) SetDelegatedToken(delegatedToken string) *DestroyWorkspaceCommandOptions

SetDelegatedToken : Allow user to set DelegatedToken

func (*DestroyWorkspaceCommandOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

func (*DestroyWorkspaceCommandOptions) SetRefreshToken

func (_options *DestroyWorkspaceCommandOptions) SetRefreshToken(refreshToken string) *DestroyWorkspaceCommandOptions

SetRefreshToken : Allow user to set RefreshToken

func (*DestroyWorkspaceCommandOptions) SetWID

func (_options *DestroyWorkspaceCommandOptions) SetWID(wID string) *DestroyWorkspaceCommandOptions

SetWID : Allow user to set WID

type EncryptionInfo

type EncryptionInfo struct {
	// Key CRN.
	Crn *string `json:"crn,omitempty"`

	// Encryption scheme.
	Scheme *string `json:"scheme,omitempty"`
}

EncryptionInfo : Encryption details about the workspace such as scheme (byok/kyok) and key CRN.

type EnvVariableRequestMap

type EnvVariableRequestMap struct {
	// Environment variable is hidden.
	Hidden *bool `json:"hidden,omitempty"`

	// Environment variable name.
	Name *string `json:"name,omitempty"`

	// Environment variable is secure.
	Secure *bool `json:"secure,omitempty"`

	// Value for environment variable.
	Value *string `json:"value,omitempty"`
}

EnvVariableRequestMap : One variable is a map where one entry is there with key as name of the env var and the value as value.

type EnvVariableResponse

type EnvVariableResponse struct {
	// Environment variable is hidden.
	Hidden *bool `json:"hidden,omitempty"`

	// Environment variable name.
	Name *string `json:"name,omitempty"`

	// Environment variable is secure.
	Secure *bool `json:"secure,omitempty"`

	// Value for environment variable.
	Value *string `json:"value,omitempty"`
}

EnvVariableResponse : List of environment values.

type EnvironmentValuesMetadata

type EnvironmentValuesMetadata struct {
	// Environment variable is hidden.
	Hidden *bool `json:"hidden,omitempty"`

	// Environment variable name.
	Name *string `json:"name,omitempty"`

	// Environment variable is secure.
	Secure *bool `json:"secure,omitempty"`
}

EnvironmentValuesMetadata : Environment variables metadata.

type ExecuteResourceQueryOptions

type ExecuteResourceQueryOptions struct {
	// Resource query Id.  Use `GET /v2/resource_query` API to look up the Resource query definition Ids  in your IBM Cloud
	// account.
	QueryID *string `json:"query_id" validate:"required,ne="`

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

ExecuteResourceQueryOptions : The ExecuteResourceQuery options.

func (*ExecuteResourceQueryOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

func (*ExecuteResourceQueryOptions) SetQueryID

func (_options *ExecuteResourceQueryOptions) SetQueryID(queryID string) *ExecuteResourceQueryOptions

SetQueryID : Allow user to set QueryID

type ExternalSource

type ExternalSource struct {
	// Type of source for the Template.
	SourceType *string `json:"source_type" validate:"required"`

	// The connection details to the Git source repository.
	Git *GitSource `json:"git,omitempty"`

	// The connection details to the IBM Cloud Catalog source.
	Catalog *CatalogSource `json:"catalog,omitempty"`
}

ExternalSource : Source of templates, playbooks, or controls.

type GetActionOptions

type GetActionOptions struct {
	// Action Id.  Use GET /actions API to look up the Action Ids in your IBM Cloud account.
	ActionID *string `json:"action_id" validate:"required,ne="`

	// Level of details returned by the get method.
	Profile *string `json:"profile,omitempty"`

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

GetActionOptions : The GetAction options.

func (*GetActionOptions) SetActionID

func (_options *GetActionOptions) SetActionID(actionID string) *GetActionOptions

SetActionID : Allow user to set ActionID

func (*GetActionOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

func (*GetActionOptions) SetProfile

func (_options *GetActionOptions) SetProfile(profile string) *GetActionOptions

SetProfile : Allow user to set Profile

type GetAgentDataOptions

type GetAgentDataOptions struct {
	// Agent ID to get the details of agent.
	AgentID *string `json:"agent_id" validate:"required,ne="`

	// Level of details returned by the get method.
	Profile *string `json:"profile,omitempty"`

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

GetAgentDataOptions : The GetAgentData options.

func (*GetAgentDataOptions) SetAgentID

func (_options *GetAgentDataOptions) SetAgentID(agentID string) *GetAgentDataOptions

SetAgentID : Allow user to set AgentID

func (*GetAgentDataOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

func (*GetAgentDataOptions) SetProfile

func (_options *GetAgentDataOptions) SetProfile(profile string) *GetAgentDataOptions

SetProfile : Allow user to set Profile

type GetAgentOptions

type GetAgentOptions struct {
	// Agent ID to get the details of agent.
	AgentID *string `json:"agent_id" validate:"required,ne="`

	// Level of details returned by the get method.
	Profile *string `json:"profile,omitempty"`

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

GetAgentOptions : The GetAgent options.

func (*GetAgentOptions) SetAgentID

func (_options *GetAgentOptions) SetAgentID(agentID string) *GetAgentOptions

SetAgentID : Allow user to set AgentID

func (*GetAgentOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

func (*GetAgentOptions) SetProfile

func (_options *GetAgentOptions) SetProfile(profile string) *GetAgentOptions

SetProfile : Allow user to set Profile

type GetAgentVersionsOptions

type GetAgentVersionsOptions struct {

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

GetAgentVersionsOptions : The GetAgentVersions options.

func (*GetAgentVersionsOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

type GetAllWorkspaceInputsOptions

type GetAllWorkspaceInputsOptions struct {
	// The ID of the workspace for which you want to retrieve input parameters and  values. To find the workspace ID, use
	// the `GET /workspaces` API.
	WID *string `json:"w_id" validate:"required,ne="`

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

GetAllWorkspaceInputsOptions : The GetAllWorkspaceInputs options.

func (*GetAllWorkspaceInputsOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

func (*GetAllWorkspaceInputsOptions) SetWID

func (_options *GetAllWorkspaceInputsOptions) SetWID(wID string) *GetAllWorkspaceInputsOptions

SetWID : Allow user to set WID

type GetDeployAgentJobOptions

type GetDeployAgentJobOptions struct {
	// Agent ID to get the details of agent.
	AgentID *string `json:"agent_id" validate:"required,ne="`

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

GetDeployAgentJobOptions : The GetDeployAgentJob options.

func (*GetDeployAgentJobOptions) SetAgentID

func (_options *GetDeployAgentJobOptions) SetAgentID(agentID string) *GetDeployAgentJobOptions

SetAgentID : Allow user to set AgentID

func (*GetDeployAgentJobOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

type GetHealthCheckAgentJobOptions

type GetHealthCheckAgentJobOptions struct {
	// Agent ID to get the details of agent.
	AgentID *string `json:"agent_id" validate:"required,ne="`

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

GetHealthCheckAgentJobOptions : The GetHealthCheckAgentJob options.

func (*GetHealthCheckAgentJobOptions) SetAgentID

func (_options *GetHealthCheckAgentJobOptions) SetAgentID(agentID string) *GetHealthCheckAgentJobOptions

SetAgentID : Allow user to set AgentID

func (*GetHealthCheckAgentJobOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

type GetInventoryOptions

type GetInventoryOptions struct {
	// Resource Inventory Id.  Use `GET /v2/inventories` API to look up the Resource Inventory definition Ids  in your IBM
	// Cloud account.
	InventoryID *string `json:"inventory_id" validate:"required,ne="`

	// Level of details returned by the get method.
	Profile *string `json:"profile,omitempty"`

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

GetInventoryOptions : The GetInventory options.

func (*GetInventoryOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

func (*GetInventoryOptions) SetInventoryID

func (_options *GetInventoryOptions) SetInventoryID(inventoryID string) *GetInventoryOptions

SetInventoryID : Allow user to set InventoryID

func (*GetInventoryOptions) SetProfile

func (_options *GetInventoryOptions) SetProfile(profile string) *GetInventoryOptions

SetProfile : Allow user to set Profile

type GetJobFilesOptions

type GetJobFilesOptions struct {
	// Job Id. Use `GET /v2/jobs` API to look up the Job Ids in your IBM Cloud account.
	JobID *string `json:"job_id" validate:"required,ne="`

	// The type of file you want to download eg.state_file, plan_json.
	FileType *string `json:"file_type" validate:"required"`

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

GetJobFilesOptions : The GetJobFiles options.

func (*GetJobFilesOptions) SetFileType

func (_options *GetJobFilesOptions) SetFileType(fileType string) *GetJobFilesOptions

SetFileType : Allow user to set FileType

func (*GetJobFilesOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

func (*GetJobFilesOptions) SetJobID

func (_options *GetJobFilesOptions) SetJobID(jobID string) *GetJobFilesOptions

SetJobID : Allow user to set JobID

type GetJobOptions

type GetJobOptions struct {
	// Job Id. Use `GET /v2/jobs` API to look up the Job Ids in your IBM Cloud account.
	JobID *string `json:"job_id" validate:"required,ne="`

	// Level of details returned by the get method.
	Profile *string `json:"profile,omitempty"`

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

GetJobOptions : The GetJob options.

func (*GetJobOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

func (*GetJobOptions) SetJobID

func (_options *GetJobOptions) SetJobID(jobID string) *GetJobOptions

SetJobID : Allow user to set JobID

func (*GetJobOptions) SetProfile

func (_options *GetJobOptions) SetProfile(profile string) *GetJobOptions

SetProfile : Allow user to set Profile

type GetKmsSettingsOptions

type GetKmsSettingsOptions struct {
	// The location of the Resource.
	Location *string `json:"location" validate:"required"`

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

GetKmsSettingsOptions : The GetKmsSettings options.

func (*GetKmsSettingsOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

func (*GetKmsSettingsOptions) SetLocation

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

SetLocation : Allow user to set Location

type GetPolicyOptions

type GetPolicyOptions struct {
	// ID to get the details of policy.
	PolicyID *string `json:"policy_id" validate:"required,ne="`

	// Level of details returned by the get method.
	Profile *string `json:"profile,omitempty"`

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

GetPolicyOptions : The GetPolicy options.

func (*GetPolicyOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

func (*GetPolicyOptions) SetPolicyID

func (_options *GetPolicyOptions) SetPolicyID(policyID string) *GetPolicyOptions

SetPolicyID : Allow user to set PolicyID

func (*GetPolicyOptions) SetProfile

func (_options *GetPolicyOptions) SetProfile(profile string) *GetPolicyOptions

SetProfile : Allow user to set Profile

type GetPrsAgentJobOptions

type GetPrsAgentJobOptions struct {
	// Agent ID to get the details of agent.
	AgentID *string `json:"agent_id" validate:"required,ne="`

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

GetPrsAgentJobOptions : The GetPrsAgentJob options.

func (*GetPrsAgentJobOptions) SetAgentID

func (_options *GetPrsAgentJobOptions) SetAgentID(agentID string) *GetPrsAgentJobOptions

SetAgentID : Allow user to set AgentID

func (*GetPrsAgentJobOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

type GetResourcesQueryOptions

type GetResourcesQueryOptions struct {
	// Resource query Id.  Use `GET /v2/resource_query` API to look up the Resource query definition Ids  in your IBM Cloud
	// account.
	QueryID *string `json:"query_id" validate:"required,ne="`

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

GetResourcesQueryOptions : The GetResourcesQuery options.

func (*GetResourcesQueryOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

func (*GetResourcesQueryOptions) SetQueryID

func (_options *GetResourcesQueryOptions) SetQueryID(queryID string) *GetResourcesQueryOptions

SetQueryID : Allow user to set QueryID

type GetSchematicsVersionOptions

type GetSchematicsVersionOptions struct {

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

GetSchematicsVersionOptions : The GetSchematicsVersion options.

func (*GetSchematicsVersionOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

type GetTemplateActivityLogOptions

type GetTemplateActivityLogOptions struct {
	// The ID of the workspace.  To find the workspace ID, use the `GET /v1/workspaces` API.
	WID *string `json:"w_id" validate:"required,ne="`

	// The ID of the Terraform template or IBM Cloud catalog software template in the workspace.  Use the `GET
	// /v1/workspaces` to look up the workspace IDs and template IDs or `template_data.id`.
	TID *string `json:"t_id" validate:"required,ne="`

	// The ID of the activity or job, for which you want to retrieve details.  To find the job ID, use the `GET
	// /v1/workspaces/{id}/actions` API.
	ActivityID *string `json:"activity_id" validate:"required,ne="`

	// Enter false to replace the first line in each Terraform command section, such as Terraform INIT or Terraform PLAN,
	// with Schematics INIT (Schematics PLAN) in your log output.  In addition, the log lines Starting command: terraform
	// init -input=false -no-color and Starting command: terraform apply -state=terraform.tfstate
	// -var-file=schematics.tfvars -auto-approve -no-color are suppressed.  All subsequent command lines still use the
	// Terraform command prefix. To remove this prefix, use the log_tf_prefix option.
	LogTfCmd *bool `json:"log_tf_cmd,omitempty"`

	// `false` will hide all the terraform command prefix in the log statements.
	LogTfPrefix *bool `json:"log_tf_prefix,omitempty"`

	// `false` will hide all the null resource prefix in the log statements.
	LogTfNullResource *bool `json:"log_tf_null_resource,omitempty"`

	// `true` will format all logs to withhold the original format  of ansible output in the log statements.
	LogTfAnsible *bool `json:"log_tf_ansible,omitempty"`

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

GetTemplateActivityLogOptions : The GetTemplateActivityLog options.

func (*GetTemplateActivityLogOptions) SetActivityID

func (_options *GetTemplateActivityLogOptions) SetActivityID(activityID string) *GetTemplateActivityLogOptions

SetActivityID : Allow user to set ActivityID

func (*GetTemplateActivityLogOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

func (*GetTemplateActivityLogOptions) SetLogTfAnsible

func (_options *GetTemplateActivityLogOptions) SetLogTfAnsible(logTfAnsible bool) *GetTemplateActivityLogOptions

SetLogTfAnsible : Allow user to set LogTfAnsible

func (*GetTemplateActivityLogOptions) SetLogTfCmd

func (_options *GetTemplateActivityLogOptions) SetLogTfCmd(logTfCmd bool) *GetTemplateActivityLogOptions

SetLogTfCmd : Allow user to set LogTfCmd

func (*GetTemplateActivityLogOptions) SetLogTfNullResource

func (_options *GetTemplateActivityLogOptions) SetLogTfNullResource(logTfNullResource bool) *GetTemplateActivityLogOptions

SetLogTfNullResource : Allow user to set LogTfNullResource

func (*GetTemplateActivityLogOptions) SetLogTfPrefix

func (_options *GetTemplateActivityLogOptions) SetLogTfPrefix(logTfPrefix bool) *GetTemplateActivityLogOptions

SetLogTfPrefix : Allow user to set LogTfPrefix

func (*GetTemplateActivityLogOptions) SetTID

func (_options *GetTemplateActivityLogOptions) SetTID(tID string) *GetTemplateActivityLogOptions

SetTID : Allow user to set TID

func (*GetTemplateActivityLogOptions) SetWID

func (_options *GetTemplateActivityLogOptions) SetWID(wID string) *GetTemplateActivityLogOptions

SetWID : Allow user to set WID

type GetTemplateLogsOptions

type GetTemplateLogsOptions struct {
	// The ID of the workspace.  To find the workspace ID, use the `GET /v1/workspaces` API.
	WID *string `json:"w_id" validate:"required,ne="`

	// The ID of the Terraform template or IBM Cloud catalog software template in the workspace.  Use the `GET
	// /v1/workspaces` to look up the workspace IDs and template IDs or `template_data.id`.
	TID *string `json:"t_id" validate:"required,ne="`

	// Enter false to replace the first line in each Terraform command section, such as Terraform INIT or Terraform PLAN,
	// with Schematics INIT (Schematics PLAN) in your log output.  In addition, the log lines Starting command: terraform
	// init -input=false -no-color and Starting command: terraform apply -state=terraform.tfstate
	// -var-file=schematics.tfvars -auto-approve -no-color are suppressed.  All subsequent command lines still use the
	// Terraform command prefix. To remove this prefix, use the log_tf_prefix option.
	LogTfCmd *bool `json:"log_tf_cmd,omitempty"`

	// `false` will hide all the terraform command prefix in the log statements.
	LogTfPrefix *bool `json:"log_tf_prefix,omitempty"`

	// `false` will hide all the null resource prefix in the log statements.
	LogTfNullResource *bool `json:"log_tf_null_resource,omitempty"`

	// `true` will format all logs to withhold the original format  of ansible output in the log statements.
	LogTfAnsible *bool `json:"log_tf_ansible,omitempty"`

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

GetTemplateLogsOptions : The GetTemplateLogs options.

func (*GetTemplateLogsOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

func (*GetTemplateLogsOptions) SetLogTfAnsible

func (_options *GetTemplateLogsOptions) SetLogTfAnsible(logTfAnsible bool) *GetTemplateLogsOptions

SetLogTfAnsible : Allow user to set LogTfAnsible

func (*GetTemplateLogsOptions) SetLogTfCmd

func (_options *GetTemplateLogsOptions) SetLogTfCmd(logTfCmd bool) *GetTemplateLogsOptions

SetLogTfCmd : Allow user to set LogTfCmd

func (*GetTemplateLogsOptions) SetLogTfNullResource

func (_options *GetTemplateLogsOptions) SetLogTfNullResource(logTfNullResource bool) *GetTemplateLogsOptions

SetLogTfNullResource : Allow user to set LogTfNullResource

func (*GetTemplateLogsOptions) SetLogTfPrefix

func (_options *GetTemplateLogsOptions) SetLogTfPrefix(logTfPrefix bool) *GetTemplateLogsOptions

SetLogTfPrefix : Allow user to set LogTfPrefix

func (*GetTemplateLogsOptions) SetTID

func (_options *GetTemplateLogsOptions) SetTID(tID string) *GetTemplateLogsOptions

SetTID : Allow user to set TID

func (*GetTemplateLogsOptions) SetWID

func (_options *GetTemplateLogsOptions) SetWID(wID string) *GetTemplateLogsOptions

SetWID : Allow user to set WID

type GetWorkspaceActivityLogsOptions

type GetWorkspaceActivityLogsOptions struct {
	// The ID of the workspace for which you want to retrieve the Terraform statefile.  To find the workspace ID, use the
	// `GET /v1/workspaces` API.
	WID *string `json:"w_id" validate:"required,ne="`

	// The ID of the activity or job, for which you want to retrieve details.  To find the job ID, use the `GET
	// /v1/workspaces/{id}/actions` API.
	ActivityID *string `json:"activity_id" validate:"required,ne="`

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

GetWorkspaceActivityLogsOptions : The GetWorkspaceActivityLogs options.

func (*GetWorkspaceActivityLogsOptions) SetActivityID

func (_options *GetWorkspaceActivityLogsOptions) SetActivityID(activityID string) *GetWorkspaceActivityLogsOptions

SetActivityID : Allow user to set ActivityID

func (*GetWorkspaceActivityLogsOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

func (*GetWorkspaceActivityLogsOptions) SetWID

func (_options *GetWorkspaceActivityLogsOptions) SetWID(wID string) *GetWorkspaceActivityLogsOptions

SetWID : Allow user to set WID

type GetWorkspaceActivityOptions

type GetWorkspaceActivityOptions struct {
	// The ID of the workspace.  To find the workspace ID, use the `GET /v1/workspaces` API.
	WID *string `json:"w_id" validate:"required,ne="`

	// The ID of the activity or job, for which you want to retrieve details.  To find the job ID, use the `GET
	// /v1/workspaces/{id}/actions` API.
	ActivityID *string `json:"activity_id" validate:"required,ne="`

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

GetWorkspaceActivityOptions : The GetWorkspaceActivity options.

func (*GetWorkspaceActivityOptions) SetActivityID

func (_options *GetWorkspaceActivityOptions) SetActivityID(activityID string) *GetWorkspaceActivityOptions

SetActivityID : Allow user to set ActivityID

func (*GetWorkspaceActivityOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

func (*GetWorkspaceActivityOptions) SetWID

func (_options *GetWorkspaceActivityOptions) SetWID(wID string) *GetWorkspaceActivityOptions

SetWID : Allow user to set WID

type GetWorkspaceDeletionJobStatusOptions

type GetWorkspaceDeletionJobStatusOptions struct {
	// The workspace job ID.
	WjID *string `json:"wj_id" validate:"required,ne="`

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

GetWorkspaceDeletionJobStatusOptions : The GetWorkspaceDeletionJobStatus options.

func (*GetWorkspaceDeletionJobStatusOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

func (*GetWorkspaceDeletionJobStatusOptions) SetWjID

func (_options *GetWorkspaceDeletionJobStatusOptions) SetWjID(wjID string) *GetWorkspaceDeletionJobStatusOptions

SetWjID : Allow user to set WjID

type GetWorkspaceInputMetadataOptions

type GetWorkspaceInputMetadataOptions struct {
	// The ID of the workspace for which you want to retrieve the metadata of the input variables that are declared in the
	// template. To find the workspace ID, use the `GET /v1/workspaces` API.
	WID *string `json:"w_id" validate:"required,ne="`

	// The ID of the Terraform template for which you want to retrieve the metadata of your input variables. When you
	// create a workspace, the Terraform template that your workspace points to is assigned a unique ID. To find this ID,
	// use the `GET /v1/workspaces` API and review the `template_data.id` value.
	TID *string `json:"t_id" validate:"required,ne="`

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

GetWorkspaceInputMetadataOptions : The GetWorkspaceInputMetadata options.

func (*GetWorkspaceInputMetadataOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

func (*GetWorkspaceInputMetadataOptions) SetTID

func (_options *GetWorkspaceInputMetadataOptions) SetTID(tID string) *GetWorkspaceInputMetadataOptions

SetTID : Allow user to set TID

func (*GetWorkspaceInputMetadataOptions) SetWID

func (_options *GetWorkspaceInputMetadataOptions) SetWID(wID string) *GetWorkspaceInputMetadataOptions

SetWID : Allow user to set WID

type GetWorkspaceInputsOptions

type GetWorkspaceInputsOptions struct {
	// The ID of the workspace.  To find the workspace ID, use the `GET /v1/workspaces` API.
	WID *string `json:"w_id" validate:"required,ne="`

	// The ID of the Terraform template in your workspace.  When you create a workspace, the Terraform template that  your
	// workspace points to is assigned a unique ID. Use the `GET /v1/workspaces` to look up the workspace IDs  and template
	// IDs or `template_data.id` in your IBM Cloud account.
	TID *string `json:"t_id" validate:"required,ne="`

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

GetWorkspaceInputsOptions : The GetWorkspaceInputs options.

func (*GetWorkspaceInputsOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

func (*GetWorkspaceInputsOptions) SetTID

func (_options *GetWorkspaceInputsOptions) SetTID(tID string) *GetWorkspaceInputsOptions

SetTID : Allow user to set TID

func (*GetWorkspaceInputsOptions) SetWID

func (_options *GetWorkspaceInputsOptions) SetWID(wID string) *GetWorkspaceInputsOptions

SetWID : Allow user to set WID

type GetWorkspaceLogUrlsOptions

type GetWorkspaceLogUrlsOptions struct {
	// The ID of the workspace.  To find the workspace ID, use the `GET /v1/workspaces` API.
	WID *string `json:"w_id" validate:"required,ne="`

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

GetWorkspaceLogUrlsOptions : The GetWorkspaceLogUrls options.

func (*GetWorkspaceLogUrlsOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

func (*GetWorkspaceLogUrlsOptions) SetWID

func (_options *GetWorkspaceLogUrlsOptions) SetWID(wID string) *GetWorkspaceLogUrlsOptions

SetWID : Allow user to set WID

type GetWorkspaceOptions

type GetWorkspaceOptions struct {
	// The ID of the workspace.  To find the workspace ID, use the `GET /v1/workspaces` API.
	WID *string `json:"w_id" validate:"required,ne="`

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

GetWorkspaceOptions : The GetWorkspace options.

func (*GetWorkspaceOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

func (*GetWorkspaceOptions) SetWID

func (_options *GetWorkspaceOptions) SetWID(wID string) *GetWorkspaceOptions

SetWID : Allow user to set WID

type GetWorkspaceOutputsOptions

type GetWorkspaceOutputsOptions struct {
	// The ID of the workspace for which you want to retrieve output parameters and  values. To find the workspace ID, use
	// the `GET /workspaces` API.
	WID *string `json:"w_id" validate:"required,ne="`

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

GetWorkspaceOutputsOptions : The GetWorkspaceOutputs options.

func (*GetWorkspaceOutputsOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

func (*GetWorkspaceOutputsOptions) SetWID

func (_options *GetWorkspaceOutputsOptions) SetWID(wID string) *GetWorkspaceOutputsOptions

SetWID : Allow user to set WID

type GetWorkspaceReadmeOptions

type GetWorkspaceReadmeOptions struct {
	// The ID of the workspace.  To find the workspace ID, use the `GET /v1/workspaces` API.
	WID *string `json:"w_id" validate:"required,ne="`

	// The GitHub or GitLab branch where the `README.md` file is stored,  or the commit ID or tag that references the
	// `README.md` file that you want to retrieve.  If you do not specify this option, the `README.md` file is retrieved
	// from the master branch by default.
	Ref *string `json:"ref,omitempty"`

	// The format of the readme file.  Value ”markdown” will give markdown, otherwise html.
	Formatted *string `json:"formatted,omitempty"`

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

GetWorkspaceReadmeOptions : The GetWorkspaceReadme options.

func (*GetWorkspaceReadmeOptions) SetFormatted

func (_options *GetWorkspaceReadmeOptions) SetFormatted(formatted string) *GetWorkspaceReadmeOptions

SetFormatted : Allow user to set Formatted

func (*GetWorkspaceReadmeOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

func (*GetWorkspaceReadmeOptions) SetRef

func (_options *GetWorkspaceReadmeOptions) SetRef(ref string) *GetWorkspaceReadmeOptions

SetRef : Allow user to set Ref

func (*GetWorkspaceReadmeOptions) SetWID

func (_options *GetWorkspaceReadmeOptions) SetWID(wID string) *GetWorkspaceReadmeOptions

SetWID : Allow user to set WID

type GetWorkspaceResourcesOptions

type GetWorkspaceResourcesOptions struct {
	// The ID of the workspace.  To find the workspace ID, use the `GET /v1/workspaces` API.
	WID *string `json:"w_id" validate:"required,ne="`

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

GetWorkspaceResourcesOptions : The GetWorkspaceResources options.

func (*GetWorkspaceResourcesOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

func (*GetWorkspaceResourcesOptions) SetWID

func (_options *GetWorkspaceResourcesOptions) SetWID(wID string) *GetWorkspaceResourcesOptions

SetWID : Allow user to set WID

type GetWorkspaceStateOptions

type GetWorkspaceStateOptions struct {
	// The ID of the workspace for which you want to retrieve the Terraform statefile.  To find the workspace ID, use the
	// `GET /v1/workspaces` API.
	WID *string `json:"w_id" validate:"required,ne="`

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

GetWorkspaceStateOptions : The GetWorkspaceState options.

func (*GetWorkspaceStateOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

func (*GetWorkspaceStateOptions) SetWID

func (_options *GetWorkspaceStateOptions) SetWID(wID string) *GetWorkspaceStateOptions

SetWID : Allow user to set WID

type GetWorkspaceTemplateStateOptions

type GetWorkspaceTemplateStateOptions struct {
	// The ID of the workspace for which you want to retrieve the Terraform statefile.  To find the workspace ID, use the
	// `GET /v1/workspaces` API.
	WID *string `json:"w_id" validate:"required,ne="`

	// The ID of the Terraform template for which you want to retrieve the Terraform statefile.  When you create a
	// workspace, the Terraform template that your workspace points to is assigned a unique ID.  To find this ID, use the
	// `GET /v1/workspaces` API and review the template_data.id value.
	TID *string `json:"t_id" validate:"required,ne="`

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

GetWorkspaceTemplateStateOptions : The GetWorkspaceTemplateState options.

func (*GetWorkspaceTemplateStateOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

func (*GetWorkspaceTemplateStateOptions) SetTID

func (_options *GetWorkspaceTemplateStateOptions) SetTID(tID string) *GetWorkspaceTemplateStateOptions

SetTID : Allow user to set TID

func (*GetWorkspaceTemplateStateOptions) SetWID

func (_options *GetWorkspaceTemplateStateOptions) SetWID(wID string) *GetWorkspaceTemplateStateOptions

SetWID : Allow user to set WID

type GitSource

type GitSource struct {
	// The complete URL which is computed by the **git_repo_url**, **git_repo_folder**, and **branch**.
	ComputedGitRepoURL *string `json:"computed_git_repo_url,omitempty"`

	// The URL to the Git repository that can be used to clone the template.
	GitRepoURL *string `json:"git_repo_url,omitempty"`

	// The Personal Access Token (PAT) to connect to the Git URLs.
	GitToken *string `json:"git_token,omitempty"`

	// The name of the folder in the Git repository, that contains the template.
	GitRepoFolder *string `json:"git_repo_folder,omitempty"`

	// The name of the release tag that are used to fetch the Git repository.
	GitRelease *string `json:"git_release,omitempty"`

	// The name of the branch that are used to fetch the Git repository.
	GitBranch *string `json:"git_branch,omitempty"`

	// The git commit hash used to fetch the repository.
	GitCommit *string `json:"git_commit,omitempty"`

	// The timestamp of the git commit hash used to fetch the repository.
	GitCommitTimestamp *string `json:"git_commit_timestamp,omitempty"`
}

GitSource : The connection details to the Git source repository.

type HealthCheckAgentJobOptions

type HealthCheckAgentJobOptions struct {
	// Agent ID to get the details of agent.
	AgentID *string `json:"agent_id" validate:"required,ne="`

	// Equivalent to -force options in the command line, default is false.
	Force *bool `json:"force,omitempty"`

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

HealthCheckAgentJobOptions : The HealthCheckAgentJob options.

func (*HealthCheckAgentJobOptions) SetAgentID

func (_options *HealthCheckAgentJobOptions) SetAgentID(agentID string) *HealthCheckAgentJobOptions

SetAgentID : Allow user to set AgentID

func (*HealthCheckAgentJobOptions) SetForce

func (_options *HealthCheckAgentJobOptions) SetForce(force bool) *HealthCheckAgentJobOptions

SetForce : Allow user to set Force

func (*HealthCheckAgentJobOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

type InjectTerraformTemplateInner

type InjectTerraformTemplateInner struct {
	// Git repo url hosting terraform template files.
	TftGitURL *string `json:"tft_git_url,omitempty"`

	// Token to access the git repository (Optional).
	TftGitToken *string `json:"tft_git_token,omitempty"`

	// Optional prefix word to append to files (Optional).
	TftPrefix *string `json:"tft_prefix,omitempty"`

	// Injection type. Default is 'override'.
	InjectionType *string `json:"injection_type,omitempty"`

	// Terraform template name. Maps to folder name in git repo.
	TftName *string `json:"tft_name,omitempty"`

	TftParameters []InjectTerraformTemplateInnerTftParametersItem `json:"tft_parameters,omitempty"`
}

InjectTerraformTemplateInner : InjectTerraformTemplateInner struct

type InjectTerraformTemplateInnerTftParametersItem

type InjectTerraformTemplateInnerTftParametersItem struct {
	// Key name to replace.
	Name *string `json:"name,omitempty"`

	// Value to replace.
	Value *string `json:"value,omitempty"`
}

InjectTerraformTemplateInnerTftParametersItem : InjectTerraformTemplateInnerTftParametersItem struct

type InventoryResourceRecord

type InventoryResourceRecord struct {
	// The unique name of your Inventory.  The name can be up to 128 characters long and can include alphanumeric
	// characters, spaces, dashes, and underscores.
	Name *string `json:"name,omitempty"`

	// Inventory id.
	ID *string `json:"id,omitempty"`

	// The description of your Inventory.  The description can be up to 2048 characters long in size.
	Description *string `json:"description,omitempty"`

	// List of locations supported by IBM Cloud Schematics service.  While creating your workspace or action, choose the
	// right region, since it cannot be changed.  Note, this does not limit the location of the IBM Cloud resources,
	// provisioned using Schematics.
	Location *string `json:"location,omitempty"`

	// Resource-group name for the Inventory definition.  By default, Inventory will be created in Default Resource Group.
	ResourceGroup *string `json:"resource_group,omitempty"`

	// Inventory creation time.
	CreatedAt *strfmt.DateTime `json:"created_at,omitempty"`

	// Email address of user who created the Inventory.
	CreatedBy *string `json:"created_by,omitempty"`

	// Inventory updation time.
	UpdatedAt *strfmt.DateTime `json:"updated_at,omitempty"`

	// Email address of user who updated the Inventory.
	UpdatedBy *string `json:"updated_by,omitempty"`

	// Input inventory of host and host group for the playbook,  in the .ini file format.
	InventoriesIni *string `json:"inventories_ini,omitempty"`

	// Input resource queries that is used to dynamically generate  the inventory of host and host group for the playbook.
	ResourceQueries []string `json:"resource_queries,omitempty"`
}

InventoryResourceRecord : Complete inventory definition details.

type InventoryResourceRecordList

type InventoryResourceRecordList struct {
	// Total number of records.
	TotalCount *int64 `json:"total_count,omitempty"`

	// Number of records returned.
	Limit *int64 `json:"limit" validate:"required"`

	// Skipped number of records.
	Offset *int64 `json:"offset" validate:"required"`

	// List of inventory definition records.
	Inventories []InventoryResourceRecord `json:"inventories,omitempty"`
}

InventoryResourceRecordList : List of Inventory definition records.

type Job

type Job struct {
	// Name of the Schematics automation resource.
	CommandObject *string `json:"command_object,omitempty"`

	// Job command object id (workspace-id, action-id).
	CommandObjectID *string `json:"command_object_id,omitempty"`

	// Schematics job command name.
	CommandName *string `json:"command_name,omitempty"`

	// Schematics job command parameter (playbook-name).
	CommandParameter *string `json:"command_parameter,omitempty"`

	// Command line options for the command.
	CommandOptions []string `json:"command_options,omitempty"`

	// Job inputs used by Action or Workspace.
	Inputs []VariableData `json:"inputs,omitempty"`

	// Environment variables used by the Job while performing Action or Workspace.
	Settings []VariableData `json:"settings,omitempty"`

	// User defined tags, while running the job.
	Tags []string `json:"tags,omitempty"`

	// Job ID.
	ID *string `json:"id,omitempty"`

	// Job name, uniquely derived from the related Workspace or Action.
	Name *string `json:"name,omitempty"`

	// The description of your job is derived from the related action or workspace.  The description can be up to 2048
	// characters long in size.
	Description *string `json:"description,omitempty"`

	// List of locations supported by IBM Cloud Schematics service.  While creating your workspace or action, choose the
	// right region, since it cannot be changed.  Note, this does not limit the location of the IBM Cloud resources,
	// provisioned using Schematics.
	Location *string `json:"location,omitempty"`

	// Resource-group name derived from the related Workspace or Action.
	ResourceGroup *string `json:"resource_group,omitempty"`

	// Job submission time.
	SubmittedAt *strfmt.DateTime `json:"submitted_at,omitempty"`

	// Email address of user who submitted the job.
	SubmittedBy *string `json:"submitted_by,omitempty"`

	// Job start time.
	StartAt *strfmt.DateTime `json:"start_at,omitempty"`

	// Job end time.
	EndAt *strfmt.DateTime `json:"end_at,omitempty"`

	// Duration of job execution; example 40 sec.
	Duration *string `json:"duration,omitempty"`

	// Job Status.
	Status *JobStatus `json:"status,omitempty"`

	// Contains the cart order data which can be used for different purpose for eg. service tagging.
	CartOrderData []CartOrderData `json:"cart_order_data,omitempty"`

	// Job data.
	Data *JobData `json:"data,omitempty"`

	// Describes a bastion resource.
	Bastion *BastionResourceDefinition `json:"bastion,omitempty"`

	// Job log summary record.
	LogSummary *JobLogSummary `json:"log_summary,omitempty"`

	// Job log store URL.
	LogStoreURL *string `json:"log_store_url,omitempty"`

	// Job state store URL.
	StateStoreURL *string `json:"state_store_url,omitempty"`

	// Job results store URL.
	ResultsURL *string `json:"results_url,omitempty"`

	// Job status updation timestamp.
	UpdatedAt *strfmt.DateTime `json:"updated_at,omitempty"`

	// ID of the Job Runner.
	JobRunnerID *string `json:"job_runner_id,omitempty"`

	// Agent name, Agent id and associated policy ID information.
	Agent *AgentInfo `json:"agent,omitempty"`
}

Job : Complete Job with user inputs and system generated data.

type JobData

type JobData struct {
	// Type of Job.
	JobType *string `json:"job_type" validate:"required"`

	// Workspace Job data.
	WorkspaceJobData *JobDataWorkspace `json:"workspace_job_data,omitempty"`

	// Action Job data.
	ActionJobData *JobDataAction `json:"action_job_data,omitempty"`

	// Controls Job data.
	SystemJobData *JobDataSystem `json:"system_job_data,omitempty"`

	// Flow Job data.
	FlowJobData *JobDataFlow `json:"flow_job_data,omitempty"`
}

JobData : Job data.

type JobDataAction

type JobDataAction struct {
	// Flow name.
	ActionName *string `json:"action_name,omitempty"`

	// Input variables data used by the Action Job.
	Inputs []VariableData `json:"inputs,omitempty"`

	// Output variables data from the Action Job.
	Outputs []VariableData `json:"outputs,omitempty"`

	// Environment variables used by all the templates in the Action.
	Settings []VariableData `json:"settings,omitempty"`

	// Job status updation timestamp.
	UpdatedAt *strfmt.DateTime `json:"updated_at,omitempty"`

	// Complete inventory definition details.
	InventoryRecord *InventoryResourceRecord `json:"inventory_record,omitempty"`

	// Materialized inventory details used by the Action Job, in .ini format.
	MaterializedInventory *string `json:"materialized_inventory,omitempty"`
}

JobDataAction : Action Job data.

type JobDataFlow

type JobDataFlow struct {
	// Flow ID.
	FlowID *string `json:"flow_id,omitempty"`

	// Flow Name.
	FlowName *string `json:"flow_name,omitempty"`

	// Job data used by each workitem Job.
	Workitems []JobDataWorkItem `json:"workitems,omitempty"`

	// Job status updation timestamp.
	UpdatedAt *strfmt.DateTime `json:"updated_at,omitempty"`
}

JobDataFlow : Flow Job data.

type JobDataSystem

type JobDataSystem struct {
	// Key ID for which key event is generated.
	KeyID *string `json:"key_id,omitempty"`

	// List of the schematics resource id.
	SchematicsResourceID []string `json:"schematics_resource_id,omitempty"`

	// Job status updation timestamp.
	UpdatedAt *strfmt.DateTime `json:"updated_at,omitempty"`
}

JobDataSystem : Controls Job data.

type JobDataTemplate

type JobDataTemplate struct {
	// Template Id.
	TemplateID *string `json:"template_id,omitempty"`

	// Template name.
	TemplateName *string `json:"template_name,omitempty"`

	// Index of the template in the Flow.
	FlowIndex *int64 `json:"flow_index,omitempty"`

	// Job inputs used by the Templates.
	Inputs []VariableData `json:"inputs,omitempty"`

	// Job output from the Templates.
	Outputs []VariableData `json:"outputs,omitempty"`

	// Environment variables used by the template.
	Settings []VariableData `json:"settings,omitempty"`

	// Job status updation timestamp.
	UpdatedAt *strfmt.DateTime `json:"updated_at,omitempty"`
}

JobDataTemplate : Template Job data.

type JobDataWorkItem

type JobDataWorkItem struct {
	// command object id.
	CommandObjectID *string `json:"command_object_id,omitempty"`

	// command object name.
	CommandObjectName *string `json:"command_object_name,omitempty"`

	// layer name.
	Layers *string `json:"layers,omitempty"`

	// Type of source for the Template.
	SourceType *string `json:"source_type,omitempty"`

	// Source of templates, playbooks, or controls.
	Source *ExternalSource `json:"source,omitempty"`

	// Input variables data for the workItem used in FlowJob.
	Inputs []VariableData `json:"inputs,omitempty"`

	// Output variables for the workItem.
	Outputs []VariableData `json:"outputs,omitempty"`

	// Environment variables for the workItem.
	Settings []VariableData `json:"settings,omitempty"`

	// Status of the last job executed by the workitem.
	LastJob *JobDataWorkItemLastJob `json:"last_job,omitempty"`

	// Job status updation timestamp.
	UpdatedAt *strfmt.DateTime `json:"updated_at,omitempty"`
}

JobDataWorkItem : Environment work items.

type JobDataWorkItemLastJob

type JobDataWorkItemLastJob struct {
	// Name of the Schematics automation resource.
	CommandObject *string `json:"command_object,omitempty"`

	// command object name (workspace_name/action_name).
	CommandObjectName *string `json:"command_object_name,omitempty"`

	// Workitem command object id, maps to workspace_id or action_id.
	CommandObjectID *string `json:"command_object_id,omitempty"`

	// Schematics job command name.
	CommandName *string `json:"command_name,omitempty"`

	// Workspace job id.
	JobID *string `json:"job_id,omitempty"`

	// Status of Jobs.
	JobStatus *string `json:"job_status,omitempty"`
}

JobDataWorkItemLastJob : Status of the last job executed by the workitem.

type JobDataWorkspace

type JobDataWorkspace struct {
	// Workspace name.
	WorkspaceName *string `json:"workspace_name,omitempty"`

	// Flow Id.
	FlowID *string `json:"flow_id,omitempty"`

	// Flow name.
	FlowName *string `json:"flow_name,omitempty"`

	// Input variables data used by the Workspace Job.
	Inputs []VariableData `json:"inputs,omitempty"`

	// Output variables data from the Workspace Job.
	Outputs []VariableData `json:"outputs,omitempty"`

	// Environment variables used by all the templates in the Workspace.
	Settings []VariableData `json:"settings,omitempty"`

	// Input / output data of the Template in the Workspace Job.
	TemplateData []JobDataTemplate `json:"template_data,omitempty"`

	// Job status updation timestamp.
	UpdatedAt *strfmt.DateTime `json:"updated_at,omitempty"`
}

JobDataWorkspace : Workspace Job data.

type JobFileContent

type JobFileContent struct {
	// Name of the file.
	FileName *string `json:"file_name,omitempty"`

	// Content of the file, generated by the job.
	FileContent *string `json:"file_content,omitempty"`
}

JobFileContent : JobFileContent struct

type JobFileData

type JobFileData struct {
	// Job Id.
	JobID *string `json:"job_id,omitempty"`

	// Job name, uniquely derived from the related Workspace and Action.
	JobName *string `json:"job_name,omitempty"`

	// Summary metadata in the output files.
	Summary []JobFileDataSummary `json:"summary,omitempty"`

	// The type of output file generated by the Job.
	FileType *string `json:"file_type,omitempty"`

	// Content of the file, generated by the job.
	FileContent *string `json:"file_content,omitempty"`

	// Content of the additional files, generated by the child job.
	AdditionalFiles []JobFileContent `json:"additional_files,omitempty"`

	// Job file updation timestamp.
	UpdatedAt *strfmt.DateTime `json:"updated_at,omitempty"`
}

JobFileData : Output files from the Job record.

type JobFileDataSummary

type JobFileDataSummary struct {
	// Summary feature name.
	Name *string `json:"name,omitempty"`

	// Summary feature type.
	Type *string `json:"type,omitempty"`

	// Summary feature value.
	Value *string `json:"value,omitempty"`
}

JobFileDataSummary : JobFileDataSummary struct

type JobList

type JobList struct {
	// Total number of records.
	TotalCount *int64 `json:"total_count,omitempty"`

	// Number of records returned.
	Limit *int64 `json:"limit" validate:"required"`

	// Skipped number of records.
	Offset *int64 `json:"offset" validate:"required"`

	// List of job records.
	Jobs []JobLite `json:"jobs,omitempty"`
}

JobList : List of Job details.

type JobLite

type JobLite struct {
	// Job ID.
	ID *string `json:"id,omitempty"`

	// Job name, uniquely derived from the related Workspace or Action.
	Name *string `json:"name,omitempty"`

	// Job description derived from the related Workspace or Action.
	Description *string `json:"description,omitempty"`

	// Name of the Schematics automation resource.
	CommandObject *string `json:"command_object,omitempty"`

	// Job command object id (workspace-id, action-id).
	CommandObjectID *string `json:"command_object_id,omitempty"`

	// Schematics job command name.
	CommandName *string `json:"command_name,omitempty"`

	// User defined tags, while running the job.
	Tags []string `json:"tags,omitempty"`

	// List of locations supported by IBM Cloud Schematics service.  While creating your workspace or action, choose the
	// right region, since it cannot be changed.  Note, this does not limit the location of the IBM Cloud resources,
	// provisioned using Schematics.
	Location *string `json:"location,omitempty"`

	// Resource-group name derived from the related Workspace or Action.
	ResourceGroup *string `json:"resource_group,omitempty"`

	// Job submission time.
	SubmittedAt *strfmt.DateTime `json:"submitted_at,omitempty"`

	// Email address of user who submitted the job.
	SubmittedBy *string `json:"submitted_by,omitempty"`

	// Duration of job execution; example 40 sec.
	Duration *string `json:"duration,omitempty"`

	// Job start time.
	StartAt *strfmt.DateTime `json:"start_at,omitempty"`

	// Job end time.
	EndAt *strfmt.DateTime `json:"end_at,omitempty"`

	// Job Status.
	Status *JobStatus `json:"status,omitempty"`

	// Job log summary record.
	LogSummary *JobLogSummary `json:"log_summary,omitempty"`

	// Job status updation timestamp.
	UpdatedAt *strfmt.DateTime `json:"updated_at,omitempty"`

	// ID of the Job Runner.
	JobRunnerID *string `json:"job_runner_id,omitempty"`

	// Agent name, Agent id and associated policy ID information.
	Agent *AgentInfo `json:"agent,omitempty"`
}

JobLite : Job summary profile with system generated data.

type JobLog

type JobLog struct {
	// Job Id.
	JobID *string `json:"job_id,omitempty"`

	// Job name, uniquely derived from the related Workspace, Action or Controls.
	JobName *string `json:"job_name,omitempty"`

	// Job log summary record.
	LogSummary *JobLogSummary `json:"log_summary,omitempty"`

	// Format of the Log text.
	Format *string `json:"format,omitempty"`

	// Log text, generated by the Job.
	Details *[]byte `json:"details,omitempty"`

	// Job status updation timestamp.
	UpdatedAt *strfmt.DateTime `json:"updated_at,omitempty"`
}

JobLog : Job Log details.

type JobLogSummary

type JobLogSummary struct {
	// Workspace Id.
	JobID *string `json:"job_id,omitempty"`

	// Type of Job.
	JobType *string `json:"job_type,omitempty"`

	// Job log start timestamp.
	LogStartAt *strfmt.DateTime `json:"log_start_at,omitempty"`

	// Job log update timestamp.
	LogAnalyzedTill *strfmt.DateTime `json:"log_analyzed_till,omitempty"`

	// Job log elapsed time (log_analyzed_till - log_start_at).
	ElapsedTime *float64 `json:"elapsed_time,omitempty"`

	// Job log errors.
	LogErrors []JobLogSummaryLogErrors `json:"log_errors,omitempty"`

	// Repo download Job log summary.
	RepoDownloadJob *JobLogSummaryRepoDownloadJob `json:"repo_download_job,omitempty"`

	// Workspace Job log summary.
	WorkspaceJob *JobLogSummaryWorkspaceJob `json:"workspace_job,omitempty"`

	// Flow Job log summary.
	FlowJob *JobLogSummaryFlowJob `json:"flow_job,omitempty"`

	// Flow Job log summary.
	ActionJob *JobLogSummaryActionJob `json:"action_job,omitempty"`

	// System Job log summary.
	SystemJob *JobLogSummarySystemJob `json:"system_job,omitempty"`
}

JobLogSummary : Job log summary record.

type JobLogSummaryActionJob

type JobLogSummaryActionJob struct {
	// number of targets or hosts.
	TargetCount *float64 `json:"target_count,omitempty"`

	// number of tasks in playbook.
	TaskCount *float64 `json:"task_count,omitempty"`

	// number of plays in playbook.
	PlayCount *float64 `json:"play_count,omitempty"`

	// Recap records.
	Recap *JobLogSummaryActionJobRecap `json:"recap,omitempty"`
}

JobLogSummaryActionJob : Flow Job log summary.

type JobLogSummaryActionJobRecap

type JobLogSummaryActionJobRecap struct {
	// List of target or host name.
	Target []string `json:"target,omitempty"`

	// Number of OK.
	Ok *float64 `json:"ok,omitempty"`

	// Number of changed.
	Changed *float64 `json:"changed,omitempty"`

	// Number of failed.
	Failed *float64 `json:"failed,omitempty"`

	// Number of skipped.
	Skipped *float64 `json:"skipped,omitempty"`

	// Number of unreachable.
	Unreachable *float64 `json:"unreachable,omitempty"`
}

JobLogSummaryActionJobRecap : Recap records.

type JobLogSummaryFlowJob

type JobLogSummaryFlowJob struct {
	// Number of workitems completed successfully.
	WorkitemsCompleted *float64 `json:"workitems_completed,omitempty"`

	// Number of workitems pending in the flow.
	WorkitemsPending *float64 `json:"workitems_pending,omitempty"`

	// Number of workitems failed.
	WorkitemsFailed *float64 `json:"workitems_failed,omitempty"`

	Workitems []JobLogSummaryWorkitems `json:"workitems,omitempty"`
}

JobLogSummaryFlowJob : Flow Job log summary.

type JobLogSummaryLogErrors

type JobLogSummaryLogErrors struct {
	// Error code in the Log.
	ErrorCode *string `json:"error_code,omitempty"`

	// Summary error message in the log.
	ErrorMsg *string `json:"error_msg,omitempty"`

	// Number of occurrence.
	ErrorCount *float64 `json:"error_count,omitempty"`
}

JobLogSummaryLogErrors : JobLogSummaryLogErrors struct

type JobLogSummaryRepoDownloadJob

type JobLogSummaryRepoDownloadJob struct {
	// Number of files scanned.
	ScannedFileCount *float64 `json:"scanned_file_count,omitempty"`

	// Number of files quarantined.
	QuarantinedFileCount *float64 `json:"quarantined_file_count,omitempty"`

	// Detected template or data file type.
	DetectedFiletype *string `json:"detected_filetype,omitempty"`

	// Number of inputs detected.
	InputsCount *string `json:"inputs_count,omitempty"`

	// Number of outputs detected.
	OutputsCount *string `json:"outputs_count,omitempty"`
}

JobLogSummaryRepoDownloadJob : Repo download Job log summary.

type JobLogSummarySystemJob

type JobLogSummarySystemJob struct {
	// number of targets or hosts.
	TargetCount *float64 `json:"target_count,omitempty"`

	// Number of passed.
	Success *float64 `json:"success,omitempty"`

	// Number of failed.
	Failed *float64 `json:"failed,omitempty"`
}

JobLogSummarySystemJob : System Job log summary.

type JobLogSummaryWorkitems

type JobLogSummaryWorkitems struct {
	// workspace ID.
	WorkspaceID *string `json:"workspace_id,omitempty"`

	// workspace JOB ID.
	JobID *string `json:"job_id,omitempty"`

	// Number of resources add.
	ResourcesAdd *float64 `json:"resources_add,omitempty"`

	// Number of resources modify.
	ResourcesModify *float64 `json:"resources_modify,omitempty"`

	// Number of resources destroy.
	ResourcesDestroy *float64 `json:"resources_destroy,omitempty"`

	// Log url for job.
	LogURL *string `json:"log_url,omitempty"`
}

JobLogSummaryWorkitems : Job log summary of the flow workitem.

type JobLogSummaryWorkspaceJob

type JobLogSummaryWorkspaceJob struct {
	// Number of resources add.
	ResourcesAdd *float64 `json:"resources_add,omitempty"`

	// Number of resources modify.
	ResourcesModify *float64 `json:"resources_modify,omitempty"`

	// Number of resources destroy.
	ResourcesDestroy *float64 `json:"resources_destroy,omitempty"`
}

JobLogSummaryWorkspaceJob : Workspace Job log summary.

type JobStatus

type JobStatus struct {
	// Position of job in pending queue.
	PositionInQueue *float64 `json:"position_in_queue,omitempty"`

	// Total no. of jobs in pending queue.
	TotalInQueue *float64 `json:"total_in_queue,omitempty"`

	// Workspace Job Status.
	WorkspaceJobStatus *JobStatusWorkspace `json:"workspace_job_status,omitempty"`

	// Action Job Status.
	ActionJobStatus *JobStatusAction `json:"action_job_status,omitempty"`

	// System Job Status.
	SystemJobStatus *JobStatusSystem `json:"system_job_status,omitempty"`

	// Environment Flow JOB Status.
	FlowJobStatus *JobStatusFlow `json:"flow_job_status,omitempty"`
}

JobStatus : Job Status.

type JobStatusAction

type JobStatusAction struct {
	// Action name.
	ActionName *string `json:"action_name,omitempty"`

	// Status of Jobs.
	StatusCode *string `json:"status_code,omitempty"`

	// Action Job status message - to be displayed along with the action_status_code.
	StatusMessage *string `json:"status_message,omitempty"`

	// Status of Resources.
	BastionStatusCode *string `json:"bastion_status_code,omitempty"`

	// Bastion status message - to be displayed along with the bastion_status_code;.
	BastionStatusMessage *string `json:"bastion_status_message,omitempty"`

	// Status of Resources.
	TargetsStatusCode *string `json:"targets_status_code,omitempty"`

	// Aggregated status message for all target resources,  to be displayed along with the targets_status_code;.
	TargetsStatusMessage *string `json:"targets_status_message,omitempty"`

	// Job status updation timestamp.
	UpdatedAt *strfmt.DateTime `json:"updated_at,omitempty"`
}

JobStatusAction : Action Job Status.

type JobStatusFlow

type JobStatusFlow struct {
	// flow id.
	FlowID *string `json:"flow_id,omitempty"`

	// flow name.
	FlowName *string `json:"flow_name,omitempty"`

	// Status of Jobs.
	StatusCode *string `json:"status_code,omitempty"`

	// Flow Job status message - to be displayed along with the status_code;.
	StatusMessage *string `json:"status_message,omitempty"`

	// Environment's individual workItem status details;.
	Workitems []JobStatusWorkitem `json:"workitems,omitempty"`

	// Job status updation timestamp.
	UpdatedAt *strfmt.DateTime `json:"updated_at,omitempty"`
}

JobStatusFlow : Environment Flow JOB Status.

type JobStatusSchematicsResources

type JobStatusSchematicsResources struct {
	// Status of Jobs.
	StatusCode *string `json:"status_code,omitempty"`

	// system job status message.
	StatusMessage *string `json:"status_message,omitempty"`

	// id for each resource which is targeted as a part of system job.
	SchematicsResourceID *string `json:"schematics_resource_id,omitempty"`

	// Job status updation timestamp.
	UpdatedAt *strfmt.DateTime `json:"updated_at,omitempty"`
}

JobStatusSchematicsResources : schematics Resources Job Status.

type JobStatusSystem

type JobStatusSystem struct {
	// System job message.
	SystemStatusMessage *string `json:"system_status_message,omitempty"`

	// Status of Jobs.
	SystemStatusCode *string `json:"system_status_code,omitempty"`

	// job staus for each schematics resource.
	SchematicsResourceStatus []JobStatusSchematicsResources `json:"schematics_resource_status,omitempty"`

	// Job status updation timestamp.
	UpdatedAt *strfmt.DateTime `json:"updated_at,omitempty"`
}

JobStatusSystem : System Job Status.

type JobStatusTemplate

type JobStatusTemplate struct {
	// Template Id.
	TemplateID *string `json:"template_id,omitempty"`

	// Template name.
	TemplateName *string `json:"template_name,omitempty"`

	// Index of the template in the Flow.
	FlowIndex *int64 `json:"flow_index,omitempty"`

	// Status of Jobs.
	StatusCode *string `json:"status_code,omitempty"`

	// Template job status message (eg. VPCt1_Apply_Pending, for a 'VPCt1' Template).
	StatusMessage *string `json:"status_message,omitempty"`

	// Job status updation timestamp.
	UpdatedAt *strfmt.DateTime `json:"updated_at,omitempty"`
}

JobStatusTemplate : Template Job Status.

type JobStatusWorkitem

type JobStatusWorkitem struct {
	// Workspace id.
	WorkspaceID *string `json:"workspace_id,omitempty"`

	// workspace name.
	WorkspaceName *string `json:"workspace_name,omitempty"`

	// workspace job id.
	JobID *string `json:"job_id,omitempty"`

	// Status of Jobs.
	StatusCode *string `json:"status_code,omitempty"`

	// workitem job status message;.
	StatusMessage *string `json:"status_message,omitempty"`

	// workitem job status updation timestamp.
	UpdatedAt *strfmt.DateTime `json:"updated_at,omitempty"`
}

JobStatusWorkitem : Individual workitem status info.

type JobStatusWorkspace

type JobStatusWorkspace struct {
	// Workspace name.
	WorkspaceName *string `json:"workspace_name,omitempty"`

	// Status of Jobs.
	StatusCode *string `json:"status_code,omitempty"`

	// Workspace job status message (eg. App1_Setup_Pending, for a 'Setup' flow in the 'App1' Workspace).
	StatusMessage *string `json:"status_message,omitempty"`

	// Environment Flow JOB Status.
	FlowStatus *JobStatusFlow `json:"flow_status,omitempty"`

	// Workspace Flow Template job status.
	TemplateStatus []JobStatusTemplate `json:"template_status,omitempty"`

	// Job status updation timestamp.
	UpdatedAt *strfmt.DateTime `json:"updated_at,omitempty"`

	// List of terraform commands executed and their status.
	Commands []CommandsInfo `json:"commands,omitempty"`
}

JobStatusWorkspace : Workspace Job Status.

type KMSDiscovery

type KMSDiscovery struct {
	// The total number of records.
	TotalCount *int64 `json:"total_count,omitempty"`

	// The number of records returned.
	Limit *int64 `json:"limit" validate:"required"`

	// The skipped number of records.
	Offset *int64 `json:"offset" validate:"required"`

	// The list of kms instances.
	KmsInstances []KMSInstances `json:"kms_instances,omitempty"`
}

KMSDiscovery : Discover kms instances in the account based on location.

type KMSInstances

type KMSInstances struct {
	// The location to integrate kms instance. For example, location can be `US` and `EU`.
	Location *string `json:"location,omitempty"`

	// The encryption scheme values. **Allowable values** [`byok`,`kyok`].
	EncryptionScheme *string `json:"encryption_scheme,omitempty"`

	// The kms instance resource group to integrate.
	ResourceGroup *string `json:"resource_group,omitempty"`

	// The primary kms CRN information.
	KmsCrn *string `json:"kms_crn,omitempty"`

	// The kms instance name.
	KmsName *string `json:"kms_name,omitempty"`

	// The kms instance private endpoints.
	KmsPrivateEndpoint *string `json:"kms_private_endpoint,omitempty"`

	// The kms instance public endpoints.
	KmsPublicEndpoint *string `json:"kms_public_endpoint,omitempty"`

	// Detailed list of keys.
	Keys []KMSInstancesKeys `json:"keys,omitempty"`
}

KMSInstances : User defined kms instances.

type KMSInstancesKeys

type KMSInstancesKeys struct {
	// The name of the root key.
	Name *string `json:"name,omitempty"`

	// The kms CRN of the root key.
	Crn *string `json:"crn,omitempty"`

	// The error message details.
	Error *string `json:"error,omitempty"`
}

KMSInstancesKeys : KMSInstancesKeys struct

type KMSSettings

type KMSSettings struct {
	// The location to integrate kms instance. For example, location can be `US` and `EU`.
	Location *string `json:"location,omitempty"`

	// The encryption scheme values. **Allowable values** [`byok`,`kyok`].
	EncryptionScheme *string `json:"encryption_scheme,omitempty"`

	// The kms instance resource group to integrate.
	ResourceGroup *string `json:"resource_group,omitempty"`

	// The primary kms instance details.
	PrimaryCrk *KMSSettingsPrimaryCrk `json:"primary_crk,omitempty"`

	// The secondary kms instance details.
	SecondaryCrk *KMSSettingsSecondaryCrk `json:"secondary_crk,omitempty"`
}

KMSSettings : User defined kms settings information.

type KMSSettingsPrimaryCrk

type KMSSettingsPrimaryCrk struct {
	// The primary kms instance name.
	KmsName *string `json:"kms_name,omitempty"`

	// The primary kms instance private endpoint.
	KmsPrivateEndpoint *string `json:"kms_private_endpoint,omitempty"`

	// The CRN of the primary root key.
	KeyCrn *string `json:"key_crn,omitempty"`
}

KMSSettingsPrimaryCrk : The primary kms instance details.

type KMSSettingsSecondaryCrk

type KMSSettingsSecondaryCrk struct {
	// The secondary kms instance name.
	KmsName *string `json:"kms_name,omitempty"`

	// The secondary kms instance private endpoint.
	KmsPrivateEndpoint *string `json:"kms_private_endpoint,omitempty"`

	// The CRN of the secondary key.
	KeyCrn *string `json:"key_crn,omitempty"`
}

KMSSettingsSecondaryCrk : The secondary kms instance details.

type LastJob

type LastJob struct {
	// ID of last job.
	JobID *string `json:"job_id,omitempty"`

	// Name of the last job.
	JobName *string `json:"job_name,omitempty"`

	// Status of the last job.
	JobStatus *string `json:"job_status,omitempty"`
}

LastJob : Last job details.

type ListActionsOptions

type ListActionsOptions struct {
	// The starting position of the item in the list of items. For example, if you have three workspaces in your account,
	// the first workspace is assigned position number 0, the second workspace is assigned position number 1, and so forth.
	// If you have 6 workspaces and you want to list the details for workspaces `2-6`, enter 1. To limit the number of
	// workspaces that is returned, use the `limit` option in addition to the `offset` option. Negative numbers are not
	// supported and are ignored.
	Offset *int64 `json:"offset,omitempty"`

	// The maximum number of items that you want to list. The number must be a positive integer between 1 and 2000. If no
	// value is provided, 100 is used by default.
	Limit *int64 `json:"limit,omitempty"`

	// Name of the field to sort-by;  Use the '.' character to delineate sub-resources and sub-fields (eg.
	// owner.last_name). Prepend the field with '+' or '-', indicating 'ascending' or 'descending' (default is ascending)
	// Ignore unrecognized or unsupported sort field.
	Sort *string `json:"sort,omitempty"`

	// Level of details returned by the get method.
	Profile *string `json:"profile,omitempty"`

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

ListActionsOptions : The ListActions options.

func (*ListActionsOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

func (*ListActionsOptions) SetLimit

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

SetLimit : Allow user to set Limit

func (*ListActionsOptions) SetOffset

func (_options *ListActionsOptions) SetOffset(offset int64) *ListActionsOptions

SetOffset : Allow user to set Offset

func (*ListActionsOptions) SetProfile

func (_options *ListActionsOptions) SetProfile(profile string) *ListActionsOptions

SetProfile : Allow user to set Profile

func (*ListActionsOptions) SetSort

func (_options *ListActionsOptions) SetSort(sort string) *ListActionsOptions

SetSort : Allow user to set Sort

type ListAgentDataOptions

type ListAgentDataOptions struct {
	// The starting position of the item in the list of items. For example, if you have three workspaces in your account,
	// the first workspace is assigned position number 0, the second workspace is assigned position number 1, and so forth.
	// If you have 6 workspaces and you want to list the details for workspaces `2-6`, enter 1. To limit the number of
	// workspaces that is returned, use the `limit` option in addition to the `offset` option. Negative numbers are not
	// supported and are ignored.
	Offset *int64 `json:"offset,omitempty"`

	// The maximum number of items that you want to list. The number must be a positive integer between 1 and 2000. If no
	// value is provided, 100 is used by default.
	Limit *int64 `json:"limit,omitempty"`

	// Level of details returned by the get method.
	Profile *string `json:"profile,omitempty"`

	// Use `new` to get all unregistered agents; use `saved` to get all registered agents.
	Filter *string `json:"filter,omitempty"`

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

ListAgentDataOptions : The ListAgentData options.

func (*ListAgentDataOptions) SetFilter

func (_options *ListAgentDataOptions) SetFilter(filter string) *ListAgentDataOptions

SetFilter : Allow user to set Filter

func (*ListAgentDataOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

func (*ListAgentDataOptions) SetLimit

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

SetLimit : Allow user to set Limit

func (*ListAgentDataOptions) SetOffset

func (_options *ListAgentDataOptions) SetOffset(offset int64) *ListAgentDataOptions

SetOffset : Allow user to set Offset

func (*ListAgentDataOptions) SetProfile

func (_options *ListAgentDataOptions) SetProfile(profile string) *ListAgentDataOptions

SetProfile : Allow user to set Profile

type ListAgentOptions

type ListAgentOptions struct {
	// The starting position of the item in the list of items. For example, if you have three workspaces in your account,
	// the first workspace is assigned position number 0, the second workspace is assigned position number 1, and so forth.
	// If you have 6 workspaces and you want to list the details for workspaces `2-6`, enter 1. To limit the number of
	// workspaces that is returned, use the `limit` option in addition to the `offset` option. Negative numbers are not
	// supported and are ignored.
	Offset *int64 `json:"offset,omitempty"`

	// The maximum number of items that you want to list. The number must be a positive integer between 1 and 2000. If no
	// value is provided, 100 is used by default.
	Limit *int64 `json:"limit,omitempty"`

	// Level of details returned by the get method.
	Profile *string `json:"profile,omitempty"`

	// Use `new` to get all unregistered agents; use `saved` to get all registered agents.
	Filter *string `json:"filter,omitempty"`

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

ListAgentOptions : The ListAgent options.

func (*ListAgentOptions) SetFilter

func (_options *ListAgentOptions) SetFilter(filter string) *ListAgentOptions

SetFilter : Allow user to set Filter

func (*ListAgentOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

func (*ListAgentOptions) SetLimit

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

SetLimit : Allow user to set Limit

func (*ListAgentOptions) SetOffset

func (_options *ListAgentOptions) SetOffset(offset int64) *ListAgentOptions

SetOffset : Allow user to set Offset

func (*ListAgentOptions) SetProfile

func (_options *ListAgentOptions) SetProfile(profile string) *ListAgentOptions

SetProfile : Allow user to set Profile

type ListInventoriesOptions

type ListInventoriesOptions struct {
	// The starting position of the item in the list of items. For example, if you have three workspaces in your account,
	// the first workspace is assigned position number 0, the second workspace is assigned position number 1, and so forth.
	// If you have 6 workspaces and you want to list the details for workspaces `2-6`, enter 1. To limit the number of
	// workspaces that is returned, use the `limit` option in addition to the `offset` option. Negative numbers are not
	// supported and are ignored.
	Offset *int64 `json:"offset,omitempty"`

	// The maximum number of items that you want to list. The number must be a positive integer between 1 and 2000. If no
	// value is provided, 100 is used by default.
	Limit *int64 `json:"limit,omitempty"`

	// Name of the field to sort-by;  Use the '.' character to delineate sub-resources and sub-fields (eg.
	// owner.last_name). Prepend the field with '+' or '-', indicating 'ascending' or 'descending' (default is ascending)
	// Ignore unrecognized or unsupported sort field.
	Sort *string `json:"sort,omitempty"`

	// Level of details returned by the get method.
	Profile *string `json:"profile,omitempty"`

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

ListInventoriesOptions : The ListInventories options.

func (*ListInventoriesOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

func (*ListInventoriesOptions) SetLimit

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

SetLimit : Allow user to set Limit

func (*ListInventoriesOptions) SetOffset

func (_options *ListInventoriesOptions) SetOffset(offset int64) *ListInventoriesOptions

SetOffset : Allow user to set Offset

func (*ListInventoriesOptions) SetProfile

func (_options *ListInventoriesOptions) SetProfile(profile string) *ListInventoriesOptions

SetProfile : Allow user to set Profile

func (*ListInventoriesOptions) SetSort

func (_options *ListInventoriesOptions) SetSort(sort string) *ListInventoriesOptions

SetSort : Allow user to set Sort

type ListJobLogsOptions

type ListJobLogsOptions struct {
	// Job Id. Use `GET /v2/jobs` API to look up the Job Ids in your IBM Cloud account.
	JobID *string `json:"job_id" validate:"required,ne="`

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

ListJobLogsOptions : The ListJobLogs options.

func (*ListJobLogsOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

func (*ListJobLogsOptions) SetJobID

func (_options *ListJobLogsOptions) SetJobID(jobID string) *ListJobLogsOptions

SetJobID : Allow user to set JobID

type ListJobsOptions

type ListJobsOptions struct {
	// The starting position of the item in the list of items. For example, if you have three workspaces in your account,
	// the first workspace is assigned position number 0, the second workspace is assigned position number 1, and so forth.
	// If you have 6 workspaces and you want to list the details for workspaces `2-6`, enter 1. To limit the number of
	// workspaces that is returned, use the `limit` option in addition to the `offset` option. Negative numbers are not
	// supported and are ignored.
	Offset *int64 `json:"offset,omitempty"`

	// The maximum number of items that you want to list. The number must be a positive integer between 1 and 2000. If no
	// value is provided, 100 is used by default.
	Limit *int64 `json:"limit,omitempty"`

	// Name of the field to sort-by;  Use the '.' character to delineate sub-resources and sub-fields (eg.
	// owner.last_name). Prepend the field with '+' or '-', indicating 'ascending' or 'descending' (default is ascending)
	// Ignore unrecognized or unsupported sort field.
	Sort *string `json:"sort,omitempty"`

	// Level of details returned by the get method.
	Profile *string `json:"profile,omitempty"`

	// Name of the resource (workspaces, actions, environment or controls).
	Resource *string `json:"resource,omitempty"`

	// The Resource Id. It could be an Action-id or Workspace-id.
	ResourceID *string `json:"resource_id,omitempty"`

	// Action Id.
	ActionID *string `json:"action_id,omitempty"`

	// Workspace Id.
	WorkspaceID *string `json:"workspace_id,omitempty"`

	// list jobs.
	List *string `json:"list,omitempty"`

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

ListJobsOptions : The ListJobs options.

func (*ListJobsOptions) SetActionID

func (_options *ListJobsOptions) SetActionID(actionID string) *ListJobsOptions

SetActionID : Allow user to set ActionID

func (*ListJobsOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

func (*ListJobsOptions) SetLimit

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

SetLimit : Allow user to set Limit

func (*ListJobsOptions) SetList

func (_options *ListJobsOptions) SetList(list string) *ListJobsOptions

SetList : Allow user to set List

func (*ListJobsOptions) SetOffset

func (_options *ListJobsOptions) SetOffset(offset int64) *ListJobsOptions

SetOffset : Allow user to set Offset

func (*ListJobsOptions) SetProfile

func (_options *ListJobsOptions) SetProfile(profile string) *ListJobsOptions

SetProfile : Allow user to set Profile

func (*ListJobsOptions) SetResource

func (_options *ListJobsOptions) SetResource(resource string) *ListJobsOptions

SetResource : Allow user to set Resource

func (*ListJobsOptions) SetResourceID

func (_options *ListJobsOptions) SetResourceID(resourceID string) *ListJobsOptions

SetResourceID : Allow user to set ResourceID

func (*ListJobsOptions) SetSort

func (_options *ListJobsOptions) SetSort(sort string) *ListJobsOptions

SetSort : Allow user to set Sort

func (*ListJobsOptions) SetWorkspaceID

func (_options *ListJobsOptions) SetWorkspaceID(workspaceID string) *ListJobsOptions

SetWorkspaceID : Allow user to set WorkspaceID

type ListKmsOptions

type ListKmsOptions struct {
	// The encryption scheme to be used.
	EncryptionScheme *string `json:"encryption_scheme" validate:"required"`

	// The location of the Resource.
	Location *string `json:"location" validate:"required"`

	// The resource group (by default, fetch from all resource groups) name or ID.
	ResourceGroup *string `json:"resource_group,omitempty"`

	// The maximum number of items that you want to list. The number must be a positive integer between 1 and 2000. If no
	// value is provided, 100 is used by default.
	Limit *int64 `json:"limit,omitempty"`

	// Name of the field to sort-by;  Use the '.' character to delineate sub-resources and sub-fields (eg.
	// owner.last_name). Prepend the field with '+' or '-', indicating 'ascending' or 'descending' (default is ascending)
	// Ignore unrecognized or unsupported sort field.
	Sort *string `json:"sort,omitempty"`

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

ListKmsOptions : The ListKms options.

func (*ListKmsOptions) SetEncryptionScheme

func (_options *ListKmsOptions) SetEncryptionScheme(encryptionScheme string) *ListKmsOptions

SetEncryptionScheme : Allow user to set EncryptionScheme

func (*ListKmsOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

func (*ListKmsOptions) SetLimit

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

SetLimit : Allow user to set Limit

func (*ListKmsOptions) SetLocation

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

SetLocation : Allow user to set Location

func (*ListKmsOptions) SetResourceGroup

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

SetResourceGroup : Allow user to set ResourceGroup

func (*ListKmsOptions) SetSort

func (_options *ListKmsOptions) SetSort(sort string) *ListKmsOptions

SetSort : Allow user to set Sort

type ListLocationsOptions

type ListLocationsOptions struct {

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

ListLocationsOptions : The ListLocations options.

func (*ListLocationsOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

type ListPolicyOptions

type ListPolicyOptions struct {
	// The starting position of the item in the list of items. For example, if you have three workspaces in your account,
	// the first workspace is assigned position number 0, the second workspace is assigned position number 1, and so forth.
	// If you have 6 workspaces and you want to list the details for workspaces `2-6`, enter 1. To limit the number of
	// workspaces that is returned, use the `limit` option in addition to the `offset` option. Negative numbers are not
	// supported and are ignored.
	Offset *int64 `json:"offset,omitempty"`

	// The maximum number of items that you want to list. The number must be a positive integer between 1 and 2000. If no
	// value is provided, 100 is used by default.
	Limit *int64 `json:"limit,omitempty"`

	// Level of details returned by the get method.
	Profile *string `json:"profile,omitempty"`

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

ListPolicyOptions : The ListPolicy options.

func (*ListPolicyOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

func (*ListPolicyOptions) SetLimit

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

SetLimit : Allow user to set Limit

func (*ListPolicyOptions) SetOffset

func (_options *ListPolicyOptions) SetOffset(offset int64) *ListPolicyOptions

SetOffset : Allow user to set Offset

func (*ListPolicyOptions) SetProfile

func (_options *ListPolicyOptions) SetProfile(profile string) *ListPolicyOptions

SetProfile : Allow user to set Profile

type ListResourceGroupOptions

type ListResourceGroupOptions struct {

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

ListResourceGroupOptions : The ListResourceGroup options.

func (*ListResourceGroupOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

type ListResourceQueryOptions

type ListResourceQueryOptions struct {
	// The starting position of the item in the list of items. For example, if you have three workspaces in your account,
	// the first workspace is assigned position number 0, the second workspace is assigned position number 1, and so forth.
	// If you have 6 workspaces and you want to list the details for workspaces `2-6`, enter 1. To limit the number of
	// workspaces that is returned, use the `limit` option in addition to the `offset` option. Negative numbers are not
	// supported and are ignored.
	Offset *int64 `json:"offset,omitempty"`

	// The maximum number of items that you want to list. The number must be a positive integer between 1 and 2000. If no
	// value is provided, 100 is used by default.
	Limit *int64 `json:"limit,omitempty"`

	// Name of the field to sort-by;  Use the '.' character to delineate sub-resources and sub-fields (eg.
	// owner.last_name). Prepend the field with '+' or '-', indicating 'ascending' or 'descending' (default is ascending)
	// Ignore unrecognized or unsupported sort field.
	Sort *string `json:"sort,omitempty"`

	// Level of details returned by the get method.
	Profile *string `json:"profile,omitempty"`

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

ListResourceQueryOptions : The ListResourceQuery options.

func (*ListResourceQueryOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

func (*ListResourceQueryOptions) SetLimit

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

SetLimit : Allow user to set Limit

func (*ListResourceQueryOptions) SetOffset

func (_options *ListResourceQueryOptions) SetOffset(offset int64) *ListResourceQueryOptions

SetOffset : Allow user to set Offset

func (*ListResourceQueryOptions) SetProfile

func (_options *ListResourceQueryOptions) SetProfile(profile string) *ListResourceQueryOptions

SetProfile : Allow user to set Profile

func (*ListResourceQueryOptions) SetSort

func (_options *ListResourceQueryOptions) SetSort(sort string) *ListResourceQueryOptions

SetSort : Allow user to set Sort

type ListSchematicsLocationOptions

type ListSchematicsLocationOptions struct {

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

ListSchematicsLocationOptions : The ListSchematicsLocation options.

func (*ListSchematicsLocationOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

type ListWorkspaceActivitiesOptions

type ListWorkspaceActivitiesOptions struct {
	// The ID of the workspace.  To find the workspace ID, use the `GET /v1/workspaces` API.
	WID *string `json:"w_id" validate:"required,ne="`

	// The starting position of the item in the list of items. For example, if you have three workspaces in your account,
	// the first workspace is assigned position number 0, the second workspace is assigned position number 1, and so forth.
	// If you have 6 workspaces and you want to list the details for workspaces `2-6`, enter 1. To limit the number of
	// workspaces that is returned, use the `limit` option in addition to the `offset` option. Negative numbers are not
	// supported and are ignored.
	Offset *int64 `json:"offset,omitempty"`

	// The maximum number of items that you want to list. The number must be a positive integer between 1 and 2000. If no
	// value is provided, 100 is used by default.
	Limit *int64 `json:"limit,omitempty"`

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

ListWorkspaceActivitiesOptions : The ListWorkspaceActivities options.

func (*ListWorkspaceActivitiesOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

func (*ListWorkspaceActivitiesOptions) SetLimit

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

SetLimit : Allow user to set Limit

func (*ListWorkspaceActivitiesOptions) SetOffset

func (_options *ListWorkspaceActivitiesOptions) SetOffset(offset int64) *ListWorkspaceActivitiesOptions

SetOffset : Allow user to set Offset

func (*ListWorkspaceActivitiesOptions) SetWID

func (_options *ListWorkspaceActivitiesOptions) SetWID(wID string) *ListWorkspaceActivitiesOptions

SetWID : Allow user to set WID

type ListWorkspacesOptions

type ListWorkspacesOptions struct {
	// The starting position of the item in the list of items. For example, if you have three workspaces in your account,
	// the first workspace is assigned position number 0, the second workspace is assigned position number 1, and so forth.
	// If you have 6 workspaces and you want to list the details for workspaces `2-6`, enter 1. To limit the number of
	// workspaces that is returned, use the `limit` option in addition to the `offset` option. Negative numbers are not
	// supported and are ignored.
	Offset *int64 `json:"offset,omitempty"`

	// The maximum number of items that you want to list. The number must be a positive integer between 1 and 2000. If no
	// value is provided, 100 is used by default.
	Limit *int64 `json:"limit,omitempty"`

	// Level of details returned by the get method.
	Profile *string `json:"profile,omitempty"`

	// The resource group (by default, fetch from all resource groups) name or ID.
	ResourceGroup *string `json:"resource_group,omitempty"`

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

ListWorkspacesOptions : The ListWorkspaces options.

func (*ListWorkspacesOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

func (*ListWorkspacesOptions) SetLimit

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

SetLimit : Allow user to set Limit

func (*ListWorkspacesOptions) SetOffset

func (_options *ListWorkspacesOptions) SetOffset(offset int64) *ListWorkspacesOptions

SetOffset : Allow user to set Offset

func (*ListWorkspacesOptions) SetProfile

func (_options *ListWorkspacesOptions) SetProfile(profile string) *ListWorkspacesOptions

SetProfile : Allow user to set Profile

func (*ListWorkspacesOptions) SetResourceGroup

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

SetResourceGroup : Allow user to set ResourceGroup

type LogStoreResponse

type LogStoreResponse struct {
	// The provisioning engine that was used for the job.
	EngineName *string `json:"engine_name,omitempty"`

	// The version of the provisioning engine that was used for the job.
	EngineVersion *string `json:"engine_version,omitempty"`

	// The ID that was assigned to your Terraform template of IBM Cloud catalog software template.
	ID *string `json:"id,omitempty"`

	// The URL to access the logs that were created during the plan, apply, or destroy job.
	LogStoreURL *string `json:"log_store_url,omitempty"`
}

LogStoreResponse : Log file URL for job that ran against your workspace.

type LogStoreResponseList

type LogStoreResponseList struct {
	// Runtime data.
	RuntimeData []LogStoreResponse `json:"runtime_data,omitempty"`
}

LogStoreResponseList : List of log file URL that ran against your workspace.

type LogSummary

type LogSummary struct {
	// The status of your activity or job. To retrieve the URL to your job logs, use the GET
	// /v1/workspaces/{id}/actions/{action_id}/logs API.
	//
	// * **COMPLETED**: The job completed successfully.
	// * **CREATED**: The job was created, but the provisioning, modification, or removal of IBM Cloud resources has not
	// started yet.
	// * **FAILED**: An error occurred during the plan, apply, or destroy job. Use the job ID to retrieve the URL to the
	// log files for your job.
	// * **IN PROGRESS**: The job is in progress. You can use the log_url to access the logs.
	ActivityStatus *string `json:"activity_status,omitempty"`

	// Template detected type.
	DetectedTemplateType *string `json:"detected_template_type,omitempty"`

	// Numner of discarded files.
	DiscardedFiles *int64 `json:"discarded_files,omitempty"`

	// Numner of errors in log.
	Error *string `json:"error,omitempty"`

	// Numner of resources added.
	ResourcesAdded *int64 `json:"resources_added,omitempty"`

	// Numner of resources destroyed.
	ResourcesDestroyed *int64 `json:"resources_destroyed,omitempty"`

	// Numner of resources modified.
	ResourcesModified *int64 `json:"resources_modified,omitempty"`

	// Numner of filed scanned.
	ScannedFiles *int64 `json:"scanned_files,omitempty"`

	// Numner of template variables.
	TemplateVariableCount *int64 `json:"template_variable_count,omitempty"`

	// Elapsed time to run the job.
	TimeTaken *float64 `json:"time_taken,omitempty"`
}

LogSummary : Summary information extracted from the job logs.

type OutputValuesInner

type OutputValuesInner struct {
	// The subfolder in the GitHub or GitLab repository where your Terraform template is stored. If the template is stored
	// in the root directory, `.` is returned.
	Folder *string `json:"folder,omitempty"`

	// The ID that was assigned to your Terraform template or IBM Cloud catalog software template.
	ID *string `json:"id,omitempty"`

	// A list of Terraform output values.
	OutputValues []map[string]interface{} `json:"output_values,omitempty"`

	// The Terraform version that was used to apply your template.
	ValueType *string `json:"value_type,omitempty"`
}

OutputValuesInner : OutputValuesInner struct

type PlanWorkspaceCommandOptions

type PlanWorkspaceCommandOptions struct {
	// The ID of the workspace, for which you want to run a Schematics `plan` job.  To find the ID of your workspace, use
	// the `GET /v1/workspaces` API.
	WID *string `json:"w_id" validate:"required,ne="`

	// The IAM refresh token for the user or service identity.
	//
	//   **Retrieving refresh token**:
	//   * Use `export IBMCLOUD_API_KEY=<ibmcloud_api_key>`, and execute `curl -X POST
	// "https://iam.cloud.ibm.com/identity/token" -H "Content-Type: application/x-www-form-urlencoded" -d
	// "grant_type=urn:ibm:params:oauth:grant-type:apikey&apikey=$IBMCLOUD_API_KEY" -u bx:bx`.
	//   * For more information, about creating IAM access token and API Docs, refer, [IAM access
	// token](/apidocs/iam-identity-token-api#gettoken-password) and [Create API
	// key](/apidocs/iam-identity-token-api#create-api-key).
	//
	//   **Limitation**:
	//   * If the token is expired, you can use `refresh token` to get a new IAM access token.
	//   * The `refresh_token` parameter cannot be used to retrieve a new IAM access token.
	//   * When the IAM access token is about to expire, use the API key to create a new access token.
	RefreshToken *string `json:"refresh_token" validate:"required"`

	// Workspace job options template.
	ActionOptions *WorkspaceActivityOptionsTemplate `json:"action_options,omitempty"`

	// The IAM delegated token for your IBM Cloud account.  This token is required for requests that are sent via the UI
	// only.
	DelegatedToken *string `json:"delegated_token,omitempty"`

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

PlanWorkspaceCommandOptions : The PlanWorkspaceCommand options.

func (*PlanWorkspaceCommandOptions) SetActionOptions

func (_options *PlanWorkspaceCommandOptions) SetActionOptions(actionOptions *WorkspaceActivityOptionsTemplate) *PlanWorkspaceCommandOptions

SetActionOptions : Allow user to set ActionOptions

func (*PlanWorkspaceCommandOptions) SetDelegatedToken

func (_options *PlanWorkspaceCommandOptions) SetDelegatedToken(delegatedToken string) *PlanWorkspaceCommandOptions

SetDelegatedToken : Allow user to set DelegatedToken

func (*PlanWorkspaceCommandOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

func (*PlanWorkspaceCommandOptions) SetRefreshToken

func (_options *PlanWorkspaceCommandOptions) SetRefreshToken(refreshToken string) *PlanWorkspaceCommandOptions

SetRefreshToken : Allow user to set RefreshToken

func (*PlanWorkspaceCommandOptions) SetWID

func (_options *PlanWorkspaceCommandOptions) SetWID(wID string) *PlanWorkspaceCommandOptions

SetWID : Allow user to set WID

type Policy

type Policy struct {
	// Name of Schematics customization policy.
	Name *string `json:"name,omitempty"`

	// The description of Schematics customization policy.
	Description *string `json:"description,omitempty"`

	// The resource group name for the policy.  By default, Policy will be created in `default` Resource Group.
	ResourceGroup *string `json:"resource_group,omitempty"`

	// Tags for the Schematics customization policy.
	Tags []string `json:"tags,omitempty"`

	// List of locations supported by IBM Cloud Schematics service.  While creating your workspace or action, choose the
	// right region, since it cannot be changed.  Note, this does not limit the location of the IBM Cloud resources,
	// provisioned using Schematics.
	Location *string `json:"location,omitempty"`

	// User defined status of the Schematics object.
	State *UserState `json:"state,omitempty"`

	// Policy kind or categories for managing and deriving policy decision
	//   * `agent_assignment_policy` Agent assignment policy for job execution.
	Kind *string `json:"kind,omitempty"`

	// The objects for the Schematics policy.
	Target *PolicyObjects `json:"target,omitempty"`

	// The parameter to tune the Schematics policy.
	Parameter *PolicyParameter `json:"parameter,omitempty"`

	// The system generated policy Id.
	ID *string `json:"id,omitempty"`

	// The policy CRN.
	Crn *string `json:"crn,omitempty"`

	// The Account id.
	Account *string `json:"account,omitempty"`

	// List of scoped Schematics resources targeted by the policy.
	ScopedResources []ScopedResource `json:"scoped_resources,omitempty"`

	// The policy creation time.
	CreatedAt *strfmt.DateTime `json:"created_at,omitempty"`

	// The user who created the policy.
	CreatedBy *string `json:"created_by,omitempty"`

	// The policy updation time.
	UpdatedAt *strfmt.DateTime `json:"updated_at,omitempty"`
}

Policy : Detailed information about the Schematics customization policy. This policy can be used to customize the behaviour or the core Schematics service.

type PolicyList

type PolicyList struct {
	// The total number of policy records.
	TotalCount *int64 `json:"total_count,omitempty"`

	// The number of policy records returned.
	Limit *int64 `json:"limit,omitempty"`

	// The skipped number of policy records.
	Offset *int64 `json:"offset" validate:"required"`

	// The list of Schematics policies.
	Policies []PolicyLite `json:"policies,omitempty"`
}

PolicyList : The list of Schematics customization policies.

type PolicyLite

type PolicyLite struct {
	// The name of Schematics customization policy.
	Name *string `json:"name,omitempty"`

	// The system generated Policy Id.
	ID *string `json:"id,omitempty"`

	// The policy CRN.
	Crn *string `json:"crn,omitempty"`

	// The Account id.
	Account *string `json:"account,omitempty"`

	// The description of Schematics customization policy.
	Description *string `json:"description,omitempty"`

	// Resource-group name for the Policy.  By default, Policy will be created in Default Resource Group.
	ResourceGroup *string `json:"resource_group,omitempty"`

	// Tags for the Schematics customization policy.
	Tags []string `json:"tags,omitempty"`

	// List of locations supported by IBM Cloud Schematics service.  While creating your workspace or action, choose the
	// right region, since it cannot be changed.  Note, this does not limit the location of the IBM Cloud resources,
	// provisioned using Schematics.
	Location *string `json:"location,omitempty"`

	// User defined status of the Schematics object.
	State *UserState `json:"state,omitempty"`

	// Policy kind or categories for managing and deriving policy decision
	//   * `agent_assignment_policy` Agent assignment policy for job execution.
	PolicyKind *string `json:"policy_kind,omitempty"`

	// The policy creation time.
	CreatedAt *strfmt.DateTime `json:"created_at,omitempty"`

	// The user who created the Policy.
	CreatedBy *string `json:"created_by,omitempty"`

	// The policy updation time.
	UpdatedAt *strfmt.DateTime `json:"updated_at,omitempty"`

	// The user who updated the policy.
	UpdatedBy *string `json:"updated_by,omitempty"`
}

PolicyLite : The summary of Schematics policy.

type PolicyObjectSelector

type PolicyObjectSelector struct {
	// Name of the Schematics automation resource.
	Kind *string `json:"kind,omitempty"`

	// The tag based selector.
	Tags []string `json:"tags,omitempty"`

	// The resource group based selector.
	ResourceGroups []string `json:"resource_groups,omitempty"`

	// The location based selector.
	Locations []string `json:"locations,omitempty"`
}

PolicyObjectSelector : Selector rule to dynamically select Schematics object based on the following metadata attributes. The rule can be defined as follows ((tags in ["policy:secured-job", "policy:dept_id:A00132"]) AND (resource_grous in ["default", "sales_rg"])).

type PolicyObjects

type PolicyObjects struct {
	// Types of schematics object selector.
	SelectorKind *string `json:"selector_kind,omitempty"`

	// Static selectors of schematics object ids (agent, workspace or action) for the Schematics policy.
	SelectorIds []string `json:"selector_ids,omitempty"`

	// Selectors to dynamically list of schematics object ids (agent, workspace or action) for the Schematics policy.
	SelectorScope []PolicyObjectSelector `json:"selector_scope,omitempty"`
}

PolicyObjects : The objects for the Schematics policy.

type PolicyParameter

type PolicyParameter struct {
	// Parameters for the `agent_assignment_policy`.
	AgentAssignmentPolicyParameter *AgentAssignmentPolicyParameter `json:"agent_assignment_policy_parameter,omitempty"`
}

PolicyParameter : The parameter to tune the Schematics policy.

type ProcessTemplateMetaDataOptions

type ProcessTemplateMetaDataOptions struct {
	// Template type such as **terraform**, **ansible**, **helm**, **cloudpak**, or **bash script**.
	TemplateType *string `json:"template_type" validate:"required"`

	// Source of templates, playbooks, or controls.
	Source *ExternalSource `json:"source" validate:"required"`

	// Region on which request should process. Applicable only on global endpoint.
	Region *string `json:"region,omitempty"`

	// Type of source for the Template.
	SourceType *string `json:"source_type,omitempty"`

	// The personal access token to authenticate with your private GitHub or GitLab repository and access your Terraform
	// template.
	XGithubToken *string `json:"X-Github-token,omitempty"`

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

ProcessTemplateMetaDataOptions : The ProcessTemplateMetaData options.

func (*ProcessTemplateMetaDataOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

func (*ProcessTemplateMetaDataOptions) SetRegion

func (_options *ProcessTemplateMetaDataOptions) SetRegion(region string) *ProcessTemplateMetaDataOptions

SetRegion : Allow user to set Region

func (*ProcessTemplateMetaDataOptions) SetSource

func (_options *ProcessTemplateMetaDataOptions) SetSource(source *ExternalSource) *ProcessTemplateMetaDataOptions

SetSource : Allow user to set Source

func (*ProcessTemplateMetaDataOptions) SetSourceType

func (_options *ProcessTemplateMetaDataOptions) SetSourceType(sourceType string) *ProcessTemplateMetaDataOptions

SetSourceType : Allow user to set SourceType

func (*ProcessTemplateMetaDataOptions) SetTemplateType

func (_options *ProcessTemplateMetaDataOptions) SetTemplateType(templateType string) *ProcessTemplateMetaDataOptions

SetTemplateType : Allow user to set TemplateType

func (*ProcessTemplateMetaDataOptions) SetXGithubToken

func (_options *ProcessTemplateMetaDataOptions) SetXGithubToken(xGithubToken string) *ProcessTemplateMetaDataOptions

SetXGithubToken : Allow user to set XGithubToken

type PrsAgentJobOptions

type PrsAgentJobOptions struct {
	// Agent ID to get the details of agent.
	AgentID *string `json:"agent_id" validate:"required,ne="`

	// Equivalent to -force options in the command line, default is false.
	Force *bool `json:"force,omitempty"`

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

PrsAgentJobOptions : The PrsAgentJob options.

func (*PrsAgentJobOptions) SetAgentID

func (_options *PrsAgentJobOptions) SetAgentID(agentID string) *PrsAgentJobOptions

SetAgentID : Allow user to set AgentID

func (*PrsAgentJobOptions) SetForce

func (_options *PrsAgentJobOptions) SetForce(force bool) *PrsAgentJobOptions

SetForce : Allow user to set Force

func (*PrsAgentJobOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

type RefreshWorkspaceCommandOptions

type RefreshWorkspaceCommandOptions struct {
	// The ID of the workspace, for which you want to run a Schematics `refresh` job.  To find the ID of your workspace,
	// use the `GET /v1/workspaces` API.
	WID *string `json:"w_id" validate:"required,ne="`

	// The IAM refresh token for the user or service identity.
	//
	//   **Retrieving refresh token**:
	//   * Use `export IBMCLOUD_API_KEY=<ibmcloud_api_key>`, and execute `curl -X POST
	// "https://iam.cloud.ibm.com/identity/token" -H "Content-Type: application/x-www-form-urlencoded" -d
	// "grant_type=urn:ibm:params:oauth:grant-type:apikey&apikey=$IBMCLOUD_API_KEY" -u bx:bx`.
	//   * For more information, about creating IAM access token and API Docs, refer, [IAM access
	// token](/apidocs/iam-identity-token-api#gettoken-password) and [Create API
	// key](/apidocs/iam-identity-token-api#create-api-key).
	//
	//   **Limitation**:
	//   * If the token is expired, you can use `refresh token` to get a new IAM access token.
	//   * The `refresh_token` parameter cannot be used to retrieve a new IAM access token.
	//   * When the IAM access token is about to expire, use the API key to create a new access token.
	RefreshToken *string `json:"refresh_token" validate:"required"`

	// The IAM delegated token for your IBM Cloud account.  This token is required for requests that are sent via the UI
	// only.
	DelegatedToken *string `json:"delegated_token,omitempty"`

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

RefreshWorkspaceCommandOptions : The RefreshWorkspaceCommand options.

func (*RefreshWorkspaceCommandOptions) SetDelegatedToken

func (_options *RefreshWorkspaceCommandOptions) SetDelegatedToken(delegatedToken string) *RefreshWorkspaceCommandOptions

SetDelegatedToken : Allow user to set DelegatedToken

func (*RefreshWorkspaceCommandOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

func (*RefreshWorkspaceCommandOptions) SetRefreshToken

func (_options *RefreshWorkspaceCommandOptions) SetRefreshToken(refreshToken string) *RefreshWorkspaceCommandOptions

SetRefreshToken : Allow user to set RefreshToken

func (*RefreshWorkspaceCommandOptions) SetWID

func (_options *RefreshWorkspaceCommandOptions) SetWID(wID string) *RefreshWorkspaceCommandOptions

SetWID : Allow user to set WID

type RegisterAgentOptions

type RegisterAgentOptions struct {
	// The name of the agent (must be unique, for an account).
	Name *string `json:"name" validate:"required"`

	// The location where agent is deployed in the user environment.
	AgentLocation *string `json:"agent_location" validate:"required"`

	// List of locations supported by IBM Cloud Schematics service.  While creating your workspace or action, choose the
	// right region, since it cannot be changed.  Note, this does not limit the location of the IBM Cloud resources,
	// provisioned using Schematics.
	Location *string `json:"location" validate:"required"`

	// The IAM trusted profile id, used by the Agent instance.
	ProfileID *string `json:"profile_id" validate:"required"`

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

	// The resource-group name for the agent.  By default, Agent will be registered in Default Resource Group.
	ResourceGroup *string `json:"resource_group,omitempty"`

	// Tags for the agent.
	Tags []string `json:"tags,omitempty"`

	// User defined status of the agent.
	UserState *AgentUserState `json:"user_state,omitempty"`

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

RegisterAgentOptions : The RegisterAgent options.

func (*RegisterAgentOptions) SetAgentLocation

func (_options *RegisterAgentOptions) SetAgentLocation(agentLocation string) *RegisterAgentOptions

SetAgentLocation : Allow user to set AgentLocation

func (*RegisterAgentOptions) SetDescription

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

SetDescription : Allow user to set Description

func (*RegisterAgentOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

func (*RegisterAgentOptions) SetLocation

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

SetLocation : Allow user to set Location

func (*RegisterAgentOptions) SetName

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

SetName : Allow user to set Name

func (*RegisterAgentOptions) SetProfileID

func (_options *RegisterAgentOptions) SetProfileID(profileID string) *RegisterAgentOptions

SetProfileID : Allow user to set ProfileID

func (*RegisterAgentOptions) SetResourceGroup

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

SetResourceGroup : Allow user to set ResourceGroup

func (*RegisterAgentOptions) SetTags

func (_options *RegisterAgentOptions) SetTags(tags []string) *RegisterAgentOptions

SetTags : Allow user to set Tags

func (*RegisterAgentOptions) SetUserState

func (_options *RegisterAgentOptions) SetUserState(userState *AgentUserState) *RegisterAgentOptions

SetUserState : Allow user to set UserState

type ReplaceInventoryOptions

type ReplaceInventoryOptions struct {
	// Resource Inventory Id.  Use `GET /v2/inventories` API to look up the Resource Inventory definition Ids  in your IBM
	// Cloud account.
	InventoryID *string `json:"inventory_id" validate:"required,ne="`

	// The unique name of your Inventory definition. The name can be up to 128 characters long and can include alphanumeric
	// characters, spaces, dashes, and underscores.
	Name *string `json:"name,omitempty"`

	// The description of your Inventory definition. The description can be up to 2048 characters long in size.
	Description *string `json:"description,omitempty"`

	// List of locations supported by IBM Cloud Schematics service.  While creating your workspace or action, choose the
	// right region, since it cannot be changed.  Note, this does not limit the location of the IBM Cloud resources,
	// provisioned using Schematics.
	Location *string `json:"location,omitempty"`

	// Resource-group name for the Inventory definition.   By default, Inventory definition will be created in Default
	// Resource Group.
	ResourceGroup *string `json:"resource_group,omitempty"`

	// Input inventory of host and host group for the playbook, in the `.ini` file format.
	InventoriesIni *string `json:"inventories_ini,omitempty"`

	// Input resource query definitions that is used to dynamically generate the inventory of host and host group for the
	// playbook.
	ResourceQueries []string `json:"resource_queries,omitempty"`

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

ReplaceInventoryOptions : The ReplaceInventory options.

func (*ReplaceInventoryOptions) SetDescription

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

SetDescription : Allow user to set Description

func (*ReplaceInventoryOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

func (*ReplaceInventoryOptions) SetInventoriesIni

func (_options *ReplaceInventoryOptions) SetInventoriesIni(inventoriesIni string) *ReplaceInventoryOptions

SetInventoriesIni : Allow user to set InventoriesIni

func (*ReplaceInventoryOptions) SetInventoryID

func (_options *ReplaceInventoryOptions) SetInventoryID(inventoryID string) *ReplaceInventoryOptions

SetInventoryID : Allow user to set InventoryID

func (*ReplaceInventoryOptions) SetLocation

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

SetLocation : Allow user to set Location

func (*ReplaceInventoryOptions) SetName

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

SetName : Allow user to set Name

func (*ReplaceInventoryOptions) SetResourceGroup

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

SetResourceGroup : Allow user to set ResourceGroup

func (*ReplaceInventoryOptions) SetResourceQueries

func (_options *ReplaceInventoryOptions) SetResourceQueries(resourceQueries []string) *ReplaceInventoryOptions

SetResourceQueries : Allow user to set ResourceQueries

type ReplaceResourcesQueryOptions

type ReplaceResourcesQueryOptions struct {
	// Resource query Id.  Use `GET /v2/resource_query` API to look up the Resource query definition Ids  in your IBM Cloud
	// account.
	QueryID *string `json:"query_id" validate:"required,ne="`

	// Resource type (cluster, vsi, icd, vpc).
	Type *string `json:"type,omitempty"`

	// Resource query name.
	Name *string `json:"name,omitempty"`

	Queries []ResourceQuery `json:"queries,omitempty"`

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

ReplaceResourcesQueryOptions : The ReplaceResourcesQuery options.

func (*ReplaceResourcesQueryOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

func (*ReplaceResourcesQueryOptions) SetName

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

SetName : Allow user to set Name

func (*ReplaceResourcesQueryOptions) SetQueries

func (_options *ReplaceResourcesQueryOptions) SetQueries(queries []ResourceQuery) *ReplaceResourcesQueryOptions

SetQueries : Allow user to set Queries

func (*ReplaceResourcesQueryOptions) SetQueryID

func (_options *ReplaceResourcesQueryOptions) SetQueryID(queryID string) *ReplaceResourcesQueryOptions

SetQueryID : Allow user to set QueryID

func (*ReplaceResourcesQueryOptions) SetType

func (_options *ReplaceResourcesQueryOptions) SetType(typeVar string) *ReplaceResourcesQueryOptions

SetType : Allow user to set Type

type ReplaceWorkspaceInputsOptions

type ReplaceWorkspaceInputsOptions struct {
	// The ID of the workspace.  To find the workspace ID, use the `GET /v1/workspaces` API.
	WID *string `json:"w_id" validate:"required,ne="`

	// The ID of the Terraform template in your workspace.  When you create a workspace, the Terraform template that  your
	// workspace points to is assigned a unique ID. Use the `GET /v1/workspaces` to look up the workspace IDs  and template
	// IDs or `template_data.id` in your IBM Cloud account.
	TID *string `json:"t_id" validate:"required,ne="`

	// A list of environment variables that you want to apply during the execution of a bash script or Terraform job. This
	// field must be provided as a list of key-value pairs, for example, **TF_LOG=debug**. Each entry will be a map with
	// one entry where `key is the environment variable name and value is value`. You can define environment variables for
	// IBM Cloud catalog offerings that are provisioned by using a bash script. See [example to use special environment
	// variable](https://cloud.ibm.com/docs/schematics?topic=schematics-set-parallelism#parallelism-example)  that are
	// supported by Schematics.
	EnvValues []map[string]interface{} `json:"env_values,omitempty"`

	// User values.
	Values *string `json:"values,omitempty"`

	// VariablesRequest -.
	Variablestore []WorkspaceVariableRequest `json:"variablestore,omitempty"`

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

ReplaceWorkspaceInputsOptions : The ReplaceWorkspaceInputs options.

func (*ReplaceWorkspaceInputsOptions) SetEnvValues

func (_options *ReplaceWorkspaceInputsOptions) SetEnvValues(envValues []map[string]interface{}) *ReplaceWorkspaceInputsOptions

SetEnvValues : Allow user to set EnvValues

func (*ReplaceWorkspaceInputsOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

func (*ReplaceWorkspaceInputsOptions) SetTID

func (_options *ReplaceWorkspaceInputsOptions) SetTID(tID string) *ReplaceWorkspaceInputsOptions

SetTID : Allow user to set TID

func (*ReplaceWorkspaceInputsOptions) SetValues

func (_options *ReplaceWorkspaceInputsOptions) SetValues(values string) *ReplaceWorkspaceInputsOptions

SetValues : Allow user to set Values

func (*ReplaceWorkspaceInputsOptions) SetVariablestore

func (_options *ReplaceWorkspaceInputsOptions) SetVariablestore(variablestore []WorkspaceVariableRequest) *ReplaceWorkspaceInputsOptions

SetVariablestore : Allow user to set Variablestore

func (*ReplaceWorkspaceInputsOptions) SetWID

func (_options *ReplaceWorkspaceInputsOptions) SetWID(wID string) *ReplaceWorkspaceInputsOptions

SetWID : Allow user to set WID

type ReplaceWorkspaceOptions

type ReplaceWorkspaceOptions struct {
	// The ID of the workspace.  To find the workspace ID, use the `GET /v1/workspaces` API.
	WID *string `json:"w_id" validate:"required,ne="`

	// Information about the software template that you chose from the IBM Cloud catalog. This information is returned for
	// IBM Cloud catalog offerings only.
	CatalogRef *CatalogRef `json:"catalog_ref,omitempty"`

	// The description of the workspace.
	Description *string `json:"description,omitempty"`

	// Workspace dependencies.
	Dependencies *Dependencies `json:"dependencies,omitempty"`

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

	// Information about the Target used by the templates originating from the  IBM Cloud catalog offerings. This
	// information is not relevant for workspace created using your own Terraform template.
	SharedData *SharedTargetData `json:"shared_data,omitempty"`

	// A list of tags that you want to associate with your workspace.
	Tags []string `json:"tags,omitempty"`

	// Input data for the Template.
	TemplateData []TemplateSourceDataRequest `json:"template_data,omitempty"`

	// Input to update the template repository data.
	TemplateRepo *TemplateRepoUpdateRequest `json:"template_repo,omitempty"`

	// List of Workspace type.
	Type []string `json:"type,omitempty"`

	// Input to update the workspace status.
	WorkspaceStatus *WorkspaceStatusUpdateRequest `json:"workspace_status,omitempty"`

	// Information about the last job that ran against the workspace. -.
	WorkspaceStatusMsg *WorkspaceStatusMessage `json:"workspace_status_msg,omitempty"`

	// agent id that process workspace jobs.
	AgentID *string `json:"agent_id,omitempty"`

	// Input settings to be applied to the workspace, for example, `job_timeout_override`.
	Settings []VariableData `json:"settings,omitempty"`

	// The personal access token to authenticate with your private GitHub or GitLab repository and access your Terraform
	// template.
	XGithubToken *string `json:"X-Github-token,omitempty"`

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

ReplaceWorkspaceOptions : The ReplaceWorkspace options.

func (*ReplaceWorkspaceOptions) SetAgentID

func (_options *ReplaceWorkspaceOptions) SetAgentID(agentID string) *ReplaceWorkspaceOptions

SetAgentID : Allow user to set AgentID

func (*ReplaceWorkspaceOptions) SetCatalogRef

func (_options *ReplaceWorkspaceOptions) SetCatalogRef(catalogRef *CatalogRef) *ReplaceWorkspaceOptions

SetCatalogRef : Allow user to set CatalogRef

func (*ReplaceWorkspaceOptions) SetDependencies

func (_options *ReplaceWorkspaceOptions) SetDependencies(dependencies *Dependencies) *ReplaceWorkspaceOptions

SetDependencies : Allow user to set Dependencies

func (*ReplaceWorkspaceOptions) SetDescription

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

SetDescription : Allow user to set Description

func (*ReplaceWorkspaceOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

func (*ReplaceWorkspaceOptions) SetName

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

SetName : Allow user to set Name

func (*ReplaceWorkspaceOptions) SetSettings

func (_options *ReplaceWorkspaceOptions) SetSettings(settings []VariableData) *ReplaceWorkspaceOptions

SetSettings : Allow user to set Settings

func (*ReplaceWorkspaceOptions) SetSharedData

func (_options *ReplaceWorkspaceOptions) SetSharedData(sharedData *SharedTargetData) *ReplaceWorkspaceOptions

SetSharedData : Allow user to set SharedData

func (*ReplaceWorkspaceOptions) SetTags

func (_options *ReplaceWorkspaceOptions) SetTags(tags []string) *ReplaceWorkspaceOptions

SetTags : Allow user to set Tags

func (*ReplaceWorkspaceOptions) SetTemplateData

func (_options *ReplaceWorkspaceOptions) SetTemplateData(templateData []TemplateSourceDataRequest) *ReplaceWorkspaceOptions

SetTemplateData : Allow user to set TemplateData

func (*ReplaceWorkspaceOptions) SetTemplateRepo

func (_options *ReplaceWorkspaceOptions) SetTemplateRepo(templateRepo *TemplateRepoUpdateRequest) *ReplaceWorkspaceOptions

SetTemplateRepo : Allow user to set TemplateRepo

func (*ReplaceWorkspaceOptions) SetType

func (_options *ReplaceWorkspaceOptions) SetType(typeVar []string) *ReplaceWorkspaceOptions

SetType : Allow user to set Type

func (*ReplaceWorkspaceOptions) SetWID

func (_options *ReplaceWorkspaceOptions) SetWID(wID string) *ReplaceWorkspaceOptions

SetWID : Allow user to set WID

func (*ReplaceWorkspaceOptions) SetWorkspaceStatus

func (_options *ReplaceWorkspaceOptions) SetWorkspaceStatus(workspaceStatus *WorkspaceStatusUpdateRequest) *ReplaceWorkspaceOptions

SetWorkspaceStatus : Allow user to set WorkspaceStatus

func (*ReplaceWorkspaceOptions) SetWorkspaceStatusMsg

func (_options *ReplaceWorkspaceOptions) SetWorkspaceStatusMsg(workspaceStatusMsg *WorkspaceStatusMessage) *ReplaceWorkspaceOptions

SetWorkspaceStatusMsg : Allow user to set WorkspaceStatusMsg

func (*ReplaceWorkspaceOptions) SetXGithubToken

func (_options *ReplaceWorkspaceOptions) SetXGithubToken(xGithubToken string) *ReplaceWorkspaceOptions

SetXGithubToken : Allow user to set XGithubToken

type ResourceGroupResponse

type ResourceGroupResponse struct {
	// The ID of the account for which you listed the resource groups.
	AccountID *string `json:"account_id,omitempty"`

	// The CRN of the resource group.
	Crn *string `json:"crn,omitempty"`

	// If set to **true**, the resource group is used as the default resource group for your account. If set to **false**,
	// the resource group is not used as the default resource group in your account.
	Default *bool `json:"default,omitempty"`

	// The name of the resource group.
	Name *string `json:"name,omitempty"`

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

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

ResourceGroupResponse : A list of resource groups that your account has access to.

type ResourceQuery

type ResourceQuery struct {
	// Type of the query(workspaces).
	QueryType *string `json:"query_type,omitempty"`

	QueryCondition []ResourceQueryParam `json:"query_condition,omitempty"`

	// List of query selection parameters.
	QuerySelect []string `json:"query_select,omitempty"`
}

ResourceQuery : Describe resource query.

type ResourceQueryParam

type ResourceQueryParam struct {
	// Name of the resource query param.
	Name *string `json:"name,omitempty"`

	// Value of the resource query param.
	Value *string `json:"value,omitempty"`

	// Description of resource query param variable.
	Description *string `json:"description,omitempty"`
}

ResourceQueryParam : Describe resource query param.

type ResourceQueryRecord

type ResourceQueryRecord struct {
	// Resource type (cluster, vsi, icd, vpc).
	Type *string `json:"type,omitempty"`

	// Resource query name.
	Name *string `json:"name,omitempty"`

	// Resource Query id.
	ID *string `json:"id,omitempty"`

	// Resource query creation time.
	CreatedAt *strfmt.DateTime `json:"created_at,omitempty"`

	// Email address of user who created the Resource query.
	CreatedBy *string `json:"created_by,omitempty"`

	// Resource query updation time.
	UpdatedAt *strfmt.DateTime `json:"updated_at,omitempty"`

	// Email address of user who updated the Resource query.
	UpdatedBy *string `json:"updated_by,omitempty"`

	Queries []ResourceQuery `json:"queries,omitempty"`
}

ResourceQueryRecord : Describe resource query record.

type ResourceQueryRecordList

type ResourceQueryRecordList struct {
	// Total number of records.
	TotalCount *int64 `json:"total_count,omitempty"`

	// Number of records returned.
	Limit *int64 `json:"limit" validate:"required"`

	// Skipped number of records.
	Offset *int64 `json:"offset" validate:"required"`

	// List of resource query records. (Deprecated ResourceQueries. Instead, use resource_queries.).
	ResourceQueries []ResourceQueryRecord `json:"resource_queries,omitempty"`
}

ResourceQueryRecordList : List of Resource query records.

type ResourceQueryResponseRecord

type ResourceQueryResponseRecord struct {
	Response []ResourceQueryResponseRecordResponse `json:"response,omitempty"`
}

ResourceQueryResponseRecord : Describe resource query.

type ResourceQueryResponseRecordQueryOutput

type ResourceQueryResponseRecordQueryOutput struct {
	// Name of the output param.
	Name *string `json:"name,omitempty"`

	// value of the output param.
	Value *string `json:"value,omitempty"`
}

ResourceQueryResponseRecordQueryOutput : List of query output values.

type ResourceQueryResponseRecordResponse

type ResourceQueryResponseRecordResponse struct {
	// Type of the query(workspaces).
	QueryType *string `json:"query_type,omitempty"`

	QueryCondition []ResourceQueryParam `json:"query_condition,omitempty"`

	// List of query selection parameters.
	QuerySelect []string `json:"query_select,omitempty"`

	QueryOutput []ResourceQueryResponseRecordQueryOutput `json:"query_output,omitempty"`
}

ResourceQueryResponseRecordResponse : ResourceQueryResponseRecordResponse struct

type RunWorkspaceCommandsOptions

type RunWorkspaceCommandsOptions struct {
	// The ID of the workspace.  To find the workspace ID, use the `GET /v1/workspaces` API.
	WID *string `json:"w_id" validate:"required,ne="`

	// The IAM refresh token for the user or service identity.
	//
	//   **Retrieving refresh token**:
	//   * Use `export IBMCLOUD_API_KEY=<ibmcloud_api_key>`, and execute `curl -X POST
	// "https://iam.cloud.ibm.com/identity/token" -H "Content-Type: application/x-www-form-urlencoded" -d
	// "grant_type=urn:ibm:params:oauth:grant-type:apikey&apikey=$IBMCLOUD_API_KEY" -u bx:bx`.
	//   * For more information, about creating IAM access token and API Docs, refer, [IAM access
	// token](/apidocs/iam-identity-token-api#gettoken-password) and [Create API
	// key](/apidocs/iam-identity-token-api#create-api-key).
	//
	//   **Limitation**:
	//   * If the token is expired, you can use `refresh token` to get a new IAM access token.
	//   * The `refresh_token` parameter cannot be used to retrieve a new IAM access token.
	//   * When the IAM access token is about to expire, use the API key to create a new access token.
	RefreshToken *string `json:"refresh_token" validate:"required"`

	// List of commands.  You can execute single set of commands or multiple commands.  For more information, about the
	// payload of the multiple commands,  refer to
	// [Commands](https://cloud.ibm.com/docs/schematics?topic=schematics-schematics-cli-reference#commands).
	Commands []TerraformCommand `json:"commands,omitempty"`

	// Command name.
	OperationName *string `json:"operation_name,omitempty"`

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

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

RunWorkspaceCommandsOptions : The RunWorkspaceCommands options.

func (*RunWorkspaceCommandsOptions) SetCommands

func (_options *RunWorkspaceCommandsOptions) SetCommands(commands []TerraformCommand) *RunWorkspaceCommandsOptions

SetCommands : Allow user to set Commands

func (*RunWorkspaceCommandsOptions) SetDescription

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

SetDescription : Allow user to set Description

func (*RunWorkspaceCommandsOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

func (*RunWorkspaceCommandsOptions) SetOperationName

func (_options *RunWorkspaceCommandsOptions) SetOperationName(operationName string) *RunWorkspaceCommandsOptions

SetOperationName : Allow user to set OperationName

func (*RunWorkspaceCommandsOptions) SetRefreshToken

func (_options *RunWorkspaceCommandsOptions) SetRefreshToken(refreshToken string) *RunWorkspaceCommandsOptions

SetRefreshToken : Allow user to set RefreshToken

func (*RunWorkspaceCommandsOptions) SetWID

func (_options *RunWorkspaceCommandsOptions) SetWID(wID string) *RunWorkspaceCommandsOptions

SetWID : Allow user to set WID

type SchematicsLocations

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

	// The ID of the location.
	ID *string `json:"id,omitempty"`

	// The country where the location is located.
	Country *string `json:"country,omitempty"`

	// The geography that the location belongs to.
	Geography *string `json:"geography,omitempty"`

	// Geographical continent locations code having the data centres of IBM Cloud Schematics service.
	GeographyCode *string `json:"geography_code,omitempty"`

	// The metro area that the location belongs to.
	Metro *string `json:"metro,omitempty"`

	// The multizone metro area that the location belongs to.
	MultizoneMetro *string `json:"multizone_metro,omitempty"`

	// The kind of location.
	Kind *string `json:"kind,omitempty"`

	// The list of paired regions used by Schematics.
	PairedRegion []string `json:"paired_region,omitempty"`

	// The restricted region.
	Restricted *bool `json:"restricted,omitempty"`

	// The metadata of an agent.
	AgentMetadata []AgentMetadataInfo `json:"agent_metadata,omitempty"`
}

SchematicsLocations : Information about the location.

type SchematicsLocationsList

type SchematicsLocationsList struct {
	// The list of locations.
	Locations []SchematicsLocationsLite `json:"locations,omitempty"`
}

SchematicsLocationsList : The list of locations details.

type SchematicsLocationsLite

type SchematicsLocationsLite struct {
	// The Geographical region code having the data centres of the IBM Cloud Schematics service.
	Region *string `json:"region,omitempty"`

	// The Geographical city locations having the data centres of the IBM Cloud Schematics service.
	Metro *string `json:"metro,omitempty"`

	// The Geographical continent locations code having the data centres of the IBM Cloud Schematics service.
	GeographyCode *string `json:"geography_code,omitempty"`

	// The Geographical continent locations having the data centres of the IBM Cloud Schematics service.
	Geography *string `json:"geography,omitempty"`

	// The Country locations having the data centres of the IBM Cloud Schematics service.
	Country *string `json:"country,omitempty"`

	// The kind of location.
	Kind *string `json:"kind,omitempty"`

	// The list of paired regions used by the Schematics.
	PairedRegion []string `json:"paired_region,omitempty"`

	// The restricted region.
	Restricted *bool `json:"restricted,omitempty"`

	// Display name for the region.
	DisplayName *string `json:"display_name,omitempty"`

	// Schematics public endpoint for the region.
	SchematicsRegionalPublicEndpoint *string `json:"schematics_regional_public_endpoint,omitempty"`

	// Schematics private endpoint for the region.
	SchematicsRegionalPrivateEndpoint *string `json:"schematics_regional_private_endpoint,omitempty"`
}

SchematicsLocationsLite : An individual location details.

type SchematicsV1

type SchematicsV1 struct {
	Service *core.BaseService
}

SchematicsV1 : IBM Cloud Schematics service is to provide the capability to manage resources of cloud provider infrastructure by using file based configurations. With the IBM Cloud Schematics service you can specify the required set of resources and the configuration in `config files`, and then pass the config files to the service to fulfill it by calling the necessary actions on the infrastructure. This principle is known as Infrastructure as Code. For more information, refer to [Getting started with IBM Cloud Schematics] (https://cloud.ibm.com/docs/schematics?topic=schematics-getting-started).

API Version: 1.0

func NewSchematicsV1

func NewSchematicsV1(options *SchematicsV1Options) (service *SchematicsV1, err error)

NewSchematicsV1 : constructs an instance of SchematicsV1 with passed in options.

func NewSchematicsV1UsingExternalConfig

func NewSchematicsV1UsingExternalConfig(options *SchematicsV1Options) (schematics *SchematicsV1, err error)

NewSchematicsV1UsingExternalConfig : constructs an instance of SchematicsV1 with passed in options and external configuration.

func (*SchematicsV1) ApplyWorkspaceCommand

func (schematics *SchematicsV1) ApplyWorkspaceCommand(applyWorkspaceCommandOptions *ApplyWorkspaceCommandOptions) (result *WorkspaceActivityApplyResult, response *core.DetailedResponse, err error)

ApplyWorkspaceCommand : Perform a Schematics `apply` job Run a Schematics `apply` job against your workspace. An `apply` job provisions, modifies, or removes the IBM Cloud resources that you described in the Terraform template that your workspace points to. Depending on the type and number of resources that you want to provision or modify, this process might take a few minutes, or even up to hours to complete. During this time, you cannot make changes to your workspace. After all updates are applied, the state of the files is [persisted](https://cloud.ibm.com/docs/schematics?topic=schematics-persist-files) to determine what resources exist in your IBM Cloud account.

**Important**: Your workspace must be in an `Inactive`, `Active`, `Failed`, or
`Stopped` state to perform a Schematics `apply` job. After all updates are applied,
the state of the files is [persisted](https://cloud.ibm.com/docs/schematics?topic=schematics-persist-files)
to determine what resources exist in your IBM Cloud account.

**Note**: This API returns an activity or job ID that you use to retrieve the
log URL with the `GET /v1/workspaces/{id}/actions/{action_id}/logs` API.

**Important:** Applying a template might incur costs. Make sure to review
the pricing information for the resources that you specified in your
templates before you apply the template in IBM Cloud.
To find a summary of job that Schematics is about to perform,
create a Terraform execution plan with the `POST /v1/workspaces/{id}/plan` API.

<h3>Authorization</h3>

Schematics support generic authorization for its resources.
For more information, about Schematics access and permissions,
see [Schematics service access roles and required

permissions](https://cloud.ibm.com/docs/schematics?topic=schematics-access#access-roles).

func (*SchematicsV1) ApplyWorkspaceCommandWithContext

func (schematics *SchematicsV1) ApplyWorkspaceCommandWithContext(ctx context.Context, applyWorkspaceCommandOptions *ApplyWorkspaceCommandOptions) (result *WorkspaceActivityApplyResult, response *core.DetailedResponse, err error)

ApplyWorkspaceCommandWithContext is an alternate form of the ApplyWorkspaceCommand method which supports a Context parameter

func (*SchematicsV1) Clone

func (schematics *SchematicsV1) Clone() *SchematicsV1

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

func (*SchematicsV1) CreateAction

func (schematics *SchematicsV1) CreateAction(createActionOptions *CreateActionOptions) (result *Action, response *core.DetailedResponse, err error)

CreateAction : Create an action Create an IBM Cloud Schematics action to run on a single target or groups of target hosts, roles, policies, or steps to deploy your resources in the target hosts. You can run the IBM Cloud resources the order in which you want to execute them. **Note** If your Git repository already contains a host file. Schematics does not overwrite the host file already present in your Git repository. For sample templates, see IBM Cloud Automation [templates](https://github.com/Cloud-Schematics).

The Schematics action API now supports bastion host connection with `non-root` user, and bastion connection type is

marked as optional, when inventory connection type is set as [Windows Remote Management](https://www.ibm.com/docs/en/license-metric-tool?topic=v-configuring-winrm-hyper-hosts)(`winrm`).

For more information, about the Schematics create action,
see [ibmcloud schematics action

create](https://cloud.ibm.com/docs/schematics?topic=schematics-schematics-cli-reference#schematics-create-action).

**Note** you cannot update the location and region once an action is created.
Also, make sure your IP addresses are in the

[allowlist](https://cloud.ibm.com/docs/schematics?topic=schematics-allowed-ipaddresses).

<h3>Authorization</h3>

Schematics support generic authorization for its resources.
For more information, about Schematics access and permissions,
see [Schematics service access roles and required

permissions](/docs/schematics?topic=schematics-access#action-permissions).

func (*SchematicsV1) CreateActionWithContext

func (schematics *SchematicsV1) CreateActionWithContext(ctx context.Context, createActionOptions *CreateActionOptions) (result *Action, response *core.DetailedResponse, err error)

CreateActionWithContext is an alternate form of the CreateAction method which supports a Context parameter

func (*SchematicsV1) CreateAgentData

func (schematics *SchematicsV1) CreateAgentData(createAgentDataOptions *CreateAgentDataOptions) (result *AgentData, response *core.DetailedResponse, err error)

CreateAgentData : Create an agent Subsequently, create an agent definition to manage the agent deployment with the agent configuration that will be used to deploy your agent to its target location. **Getting API endpoint**:- * The Schematics API endpoint that you use to create the agent determines where your Schematics agent run and your data is stored. For more information about supported API endpoints, see [API endpoints](https://cloud.ibm.com/apidocs/schematics/schematics#api-endpoints). * If you use the API endpoint for a geography and not a specific location, such as North America, you can specify the location in your API request body. * If you do not specify the location in the request body, Schematics determines your agent location based on availability. * If you use an API endpoint for a specific location, such as Frankfurt, the location that you enter in your API request body must match your API endpoint. * You also have the option to not specify a location in your API request body if you use a location-specific API endpoint. * Follow the [steps](https://cloud.ibm.com/docs/schematics?topic=schematics-setup-api#cs_api) to retrieve your IAM access token and authenticate with IBM Cloud Schematics by using the API. * For more information about frequently asked questions, see [FAQ](https://cloud.ibm.com/docs/schematics?topic=schematics-faqs-agent) and [Troubleshooting guide](https://cloud.ibm.com/docs/schematics?topic=schematics-agent-crn-not-found).

<h3>Authorization</h3>

Schematics support generic authorization for its resources.
For more information, about Schematics access and permissions, see [Schematics service access
roles and required permissions](https://cloud.ibm.com/docs/schematics?topic=schematics-access#access-roles).

func (*SchematicsV1) CreateAgentDataWithContext

func (schematics *SchematicsV1) CreateAgentDataWithContext(ctx context.Context, createAgentDataOptions *CreateAgentDataOptions) (result *AgentData, response *core.DetailedResponse, err error)

CreateAgentDataWithContext is an alternate form of the CreateAgentData method which supports a Context parameter

func (*SchematicsV1) CreateInventory

func (schematics *SchematicsV1) CreateInventory(createInventoryOptions *CreateInventoryOptions) (result *InventoryResourceRecord, response *core.DetailedResponse, err error)

CreateInventory : Create an inventory definition Create an IBM Cloud Schematics inventory as a single IBM Cloud resource where you want to run Ansible playbook by using Schematics actions. For more information, about inventory host groups, refer to [creating static and dynamic inventory for Schematics actions](https://cloud.ibm.com/docs/schematics?topic=schematics-inventories-setup).

**Note** you cannot update the location and region, resource group once an action is created. Also, make sure your

IP addresses are in the [allowlist](https://cloud.ibm.com/docs/schematics?topic=schematics-allowed-ipaddresses).

If your Git repository already contains a host file. Schematics does not overwrite the host file already present in

your Git repository.

<h3>Authorization</h3>

Schematics support generic authorization for its resources.
For more information, about Schematics access and permissions, see
[Schematics service access roles and required

permissions](https://cloud.ibm.com/docs/schematics?topic=schematics-access#access-roles).

func (*SchematicsV1) CreateInventoryWithContext

func (schematics *SchematicsV1) CreateInventoryWithContext(ctx context.Context, createInventoryOptions *CreateInventoryOptions) (result *InventoryResourceRecord, response *core.DetailedResponse, err error)

CreateInventoryWithContext is an alternate form of the CreateInventory method which supports a Context parameter

func (*SchematicsV1) CreateJob

func (schematics *SchematicsV1) CreateJob(createJobOptions *CreateJobOptions) (result *Job, response *core.DetailedResponse, err error)

CreateJob : Create a job Create & launch the Schematics job. It can be used to launch an Ansible playbook against a target hosts. The job displays a list of jobs with the status as `pending`, `in_progess`, `success`, or `failed`.

func (*SchematicsV1) CreateJobWithContext

func (schematics *SchematicsV1) CreateJobWithContext(ctx context.Context, createJobOptions *CreateJobOptions) (result *Job, response *core.DetailedResponse, err error)

CreateJobWithContext is an alternate form of the CreateJob method which supports a Context parameter

func (*SchematicsV1) CreatePolicy

func (schematics *SchematicsV1) CreatePolicy(createPolicyOptions *CreatePolicyOptions) (result *Policy, response *core.DetailedResponse, err error)

CreatePolicy : Create a policy account Use this API to create a policy using Schematics to select one or more Schematics objects (such as, Workspaces, Action) to deliver targeted Schematics feature. For more information about frequently asked questions, see [FAQ](https://cloud.ibm.com/docs/schematics?topic=schematics-faqs-agent) and [Troubleshooting guide](https://cloud.ibm.com/docs/schematics?topic=schematics-agent-crn-not-found).

<h3>Authorization</h3>

Schematics support generic authorization for its resources.
For more information, about Schematics access and permissions, see [Schematics service access
roles and required permissions](https://cloud.ibm.com/docs/schematics?topic=schematics-access#access-roles).

func (*SchematicsV1) CreatePolicyWithContext

func (schematics *SchematicsV1) CreatePolicyWithContext(ctx context.Context, createPolicyOptions *CreatePolicyOptions) (result *Policy, response *core.DetailedResponse, err error)

CreatePolicyWithContext is an alternate form of the CreatePolicy method which supports a Context parameter

func (*SchematicsV1) CreateResourceQuery

func (schematics *SchematicsV1) CreateResourceQuery(createResourceQueryOptions *CreateResourceQueryOptions) (result *ResourceQueryRecord, response *core.DetailedResponse, err error)

CreateResourceQuery : Create resource query Use this API to create a resource query definition that will be used to select an IBM Cloud resource or a group of resources as the dynamic inventory for the Schematics Actions. For more information, about resource query commands, refer to [ibmcloud schematics resource query create](https://cloud.ibm.com/docs/schematics?topic=schematics-schematics-cli-reference#schematics-create-rq). **Note** you cannot update the location and region, resource group once an action is created. Also, make sure your IP addresses are in the [allowlist](https://cloud.ibm.com/docs/schematics?topic=schematics-allowed-ipaddresses). If your Git repository already contains a host file. Schematics does not overwrite the host file already present in your Git repository. <h3>Authorization</h3>

Schematics support generic authorization for its resources.
For more information, about Schematics access and permissions, see
[Schematics service access roles and required

permissions](https://cloud.ibm.com/docs/schematics?topic=schematics-access#access-roles).

func (*SchematicsV1) CreateResourceQueryWithContext

func (schematics *SchematicsV1) CreateResourceQueryWithContext(ctx context.Context, createResourceQueryOptions *CreateResourceQueryOptions) (result *ResourceQueryRecord, response *core.DetailedResponse, err error)

CreateResourceQueryWithContext is an alternate form of the CreateResourceQuery method which supports a Context parameter

func (*SchematicsV1) CreateWorkspace

func (schematics *SchematicsV1) CreateWorkspace(createWorkspaceOptions *CreateWorkspaceOptions) (result *WorkspaceResponse, response *core.DetailedResponse, err error)

CreateWorkspace : Create a workspace Create an IBM Cloud Schematics workspace that points to the source repository where your Terraform template or the IBM Cloud software template is stored. You can decide to create your workspace without connecting it to a GitHub or GitLab repository. Your workspace is then created with a **Draft** state. To later connect your workspace to a GitHub or GitLab repository, you must use the `PUT /v1/workspaces/{id}` API to update the workspace or use the `/v1/workspaces/{id}/templates/{template_id}/template_repo_upload` API to upload a TAR file instead.

**Getting API endpoint**:-

* The Schematics API endpoint that you use to create the workspace determines where your Schematics actions run and

your data is stored. See [API endpoints](/apidocs/schematics#api-endpoints) for more information.

• If you use the API endpoint for a geography and not a specific location, such as North America, you can specify

the location in your API request body.

• If you do not specify the location in the request body, Schematics determines your workspace location based on

availability.

• If you use an API endpoint for a specific location, such as Frankfurt, the location that you enter in your API

request body must match your API endpoint.

• You also have the option to not specify a location in your API request body if you use a location-specific API

endpoint.

**Getting IAM access token** :-
* Before you create Schematics workspace, you need to create the IAM access token for your IBM Cloud Account.
* To create IAM access token, use `export IBMCLOUD_API_KEY=<ibmcloud_api_key>` and execute `curl -X POST

"https://iam.cloud.ibm.com/identity/token" -H "Content-Type= application/x-www-form-urlencoded" -d "grant_type=urn:ibm:params:oauth:grant-type:apikey&apikey=$IBMCLOUD_API_KEY" -u bx:bx`. For more information, about creating IAM access token and API Docs, see [IAM access token](/apidocs/iam-identity-token-api#gettoken-password) and [Create API key](/apidocs/iam-identity-token-api#create-api-key).

• You can set the environment values `export ACCESS_TOKEN=<access_token>` and `export

REFRESH_TOKEN=<refresh_token>`.

• You can use the obtained IAM access token in create workspace `curl` command.

  <h3>Authorization</h3>

  Schematics support generic authorization for its resources. For more information, about Schematics access and permissions, see [Schematics service access roles and required

permissions](https://cloud.ibm.com/docs/schematics?topic=schematics-access#access-roles).

func (*SchematicsV1) CreateWorkspaceDeletionJob

func (schematics *SchematicsV1) CreateWorkspaceDeletionJob(createWorkspaceDeletionJobOptions *CreateWorkspaceDeletionJobOptions) (result *WorkspaceBulkDeleteResponse, response *core.DetailedResponse, err error)

CreateWorkspaceDeletionJob : Delete one or more workspace Delete one or multiple Schematics workspace. Deleting a workspace does not destroy the resources from the Schematics workspace.

<h3>Authorization</h3>

Schematics support generic authorization for its resources.
For more information, about Schematics access and permissions, see
[Schematics service access roles and required

permissions](https://cloud.ibm.com/docs/schematics?topic=schematics-access#access-roles).

func (*SchematicsV1) CreateWorkspaceDeletionJobWithContext

func (schematics *SchematicsV1) CreateWorkspaceDeletionJobWithContext(ctx context.Context, createWorkspaceDeletionJobOptions *CreateWorkspaceDeletionJobOptions) (result *WorkspaceBulkDeleteResponse, response *core.DetailedResponse, err error)

CreateWorkspaceDeletionJobWithContext is an alternate form of the CreateWorkspaceDeletionJob method which supports a Context parameter

func (*SchematicsV1) CreateWorkspaceWithContext

func (schematics *SchematicsV1) CreateWorkspaceWithContext(ctx context.Context, createWorkspaceOptions *CreateWorkspaceOptions) (result *WorkspaceResponse, response *core.DetailedResponse, err error)

CreateWorkspaceWithContext is an alternate form of the CreateWorkspace method which supports a Context parameter

func (*SchematicsV1) DeleteAction

func (schematics *SchematicsV1) DeleteAction(deleteActionOptions *DeleteActionOptions) (response *core.DetailedResponse, err error)

DeleteAction : Delete an action Delete a Schematics action and specify the Ansible playbook that you want to run against your IBM Cloud resources. **Note** you cannot delete or stop the job activity from an ongoing execution of an action defined in the playbook. You can repeat the execution of same job, whenever you patch the actions. For more information, about the Schematics action state, see [Schematics action state diagram](https://cloud.ibm.com/docs/schematics?topic=schematics-action-setup#action-state-diagram).

<h3>Authorization</h3>

Schematics support generic authorization for its resources.
For more information, about Schematics access and permissions, see
[Schematics service access roles and required

permissions](https://cloud.ibm.com/docs/schematics?topic=schematics-access#access-roles).

func (*SchematicsV1) DeleteActionWithContext

func (schematics *SchematicsV1) DeleteActionWithContext(ctx context.Context, deleteActionOptions *DeleteActionOptions) (response *core.DetailedResponse, err error)

DeleteActionWithContext is an alternate form of the DeleteAction method which supports a Context parameter

func (*SchematicsV1) DeleteAgent

func (schematics *SchematicsV1) DeleteAgent(deleteAgentOptions *DeleteAgentOptions) (response *core.DetailedResponse, err error)

DeleteAgent : Deregister the agent Deregistering an agent.

<h3>Authorization</h3>

Schematics support generic authorization for its resources.
For more information, about Schematics access and permissions, see [Schematics service access
roles and required permissions](https://cloud.ibm.com/docs/schematics?topic=schematics-access#access-roles).

Deprecated: this method is deprecated and may be removed in a future release.

func (*SchematicsV1) DeleteAgentData

func (schematics *SchematicsV1) DeleteAgentData(deleteAgentDataOptions *DeleteAgentDataOptions) (response *core.DetailedResponse, err error)

DeleteAgentData : Delete agent Use this API to disable and delete the agent. Follow the [steps](https://cloud.ibm.com/docs/schematics?topic=schematics-setup-api#cs_api) to retrieve your IAM access token and authenticate with IBM Cloud Schematics by using the API. For more information about frequently asked questions, see [FAQ](/docs/schematics?topic=schematics-faqs-agent) and [Troubleshooting guide](https://cloud.ibm.com/docs/schematics?topic=schematics-agent-crn-not-found).

<h3>Authorization</h3>

Schematics support generic authorization for its resources.
For more information, about Schematics access and permissions, see [Schematics service access
roles and required permissions](https://cloud.ibm.com/docs/schematics?topic=schematics-access#access-roles).

func (*SchematicsV1) DeleteAgentDataWithContext

func (schematics *SchematicsV1) DeleteAgentDataWithContext(ctx context.Context, deleteAgentDataOptions *DeleteAgentDataOptions) (response *core.DetailedResponse, err error)

DeleteAgentDataWithContext is an alternate form of the DeleteAgentData method which supports a Context parameter

func (*SchematicsV1) DeleteAgentResources

func (schematics *SchematicsV1) DeleteAgentResources(deleteAgentResourcesOptions *DeleteAgentResourcesOptions) (response *core.DetailedResponse, err error)

DeleteAgentResources : Delete resources provisioned by agent Use this API to destroy the resources provisioned for running an agent.

func (*SchematicsV1) DeleteAgentResourcesWithContext

func (schematics *SchematicsV1) DeleteAgentResourcesWithContext(ctx context.Context, deleteAgentResourcesOptions *DeleteAgentResourcesOptions) (response *core.DetailedResponse, err error)

DeleteAgentResourcesWithContext is an alternate form of the DeleteAgentResources method which supports a Context parameter

func (*SchematicsV1) DeleteAgentWithContext

func (schematics *SchematicsV1) DeleteAgentWithContext(ctx context.Context, deleteAgentOptions *DeleteAgentOptions) (response *core.DetailedResponse, err error)

DeleteAgentWithContext is an alternate form of the DeleteAgent method which supports a Context parameter Deprecated: this method is deprecated and may be removed in a future release.

func (*SchematicsV1) DeleteInventory

func (schematics *SchematicsV1) DeleteInventory(deleteInventoryOptions *DeleteInventoryOptions) (response *core.DetailedResponse, err error)

DeleteInventory : Delete an inventory definition Use this API to delete the resource inventory definition by using the inventory ID that you want to run against. For more information, about inventory delete, refer to [ibmcloud schematics inventory delete](https://cloud.ibm.com/docs/schematics?topic=schematics-schematics-cli-reference#schematics-delete-inventory).

**Note** you cannot delete the location and region, resource group from where your inventory is created. Also, make

sure your IP addresses are in the [allowlist](https://cloud.ibm.com/docs/schematics?topic=schematics-allowed-ipaddresses).

<h3>Authorization</h3>

Schematics support generic authorization for its resources.
For more information, about Schematics access and permissions, see
[Schematics service access roles and required

permissions](https://cloud.ibm.com/docs/schematics?topic=schematics-access#access-roles).

func (*SchematicsV1) DeleteInventoryWithContext

func (schematics *SchematicsV1) DeleteInventoryWithContext(ctx context.Context, deleteInventoryOptions *DeleteInventoryOptions) (response *core.DetailedResponse, err error)

DeleteInventoryWithContext is an alternate form of the DeleteInventory method which supports a Context parameter

func (*SchematicsV1) DeleteJob

func (schematics *SchematicsV1) DeleteJob(deleteJobOptions *DeleteJobOptions) (response *core.DetailedResponse, err error)

DeleteJob : Stop the running Job, and delete the Job Stop the running Job, and delete the Job. **Note** You cannot delete or stop the job activity from an ongoing execution of an action defined in the playbook. You can repeat the execution of same job, whenever you patch or update the action or workspace.

<h3>Authorization</h3>

Schematics support generic authorization for its resources.
For more information, about Schematics access and permissions, see
[Schematics service access roles and required

permissions](https://cloud.ibm.com/docs/schematics?topic=schematics-access#access-roles).

func (*SchematicsV1) DeleteJobWithContext

func (schematics *SchematicsV1) DeleteJobWithContext(ctx context.Context, deleteJobOptions *DeleteJobOptions) (response *core.DetailedResponse, err error)

DeleteJobWithContext is an alternate form of the DeleteJob method which supports a Context parameter

func (*SchematicsV1) DeletePolicy

func (schematics *SchematicsV1) DeletePolicy(deletePolicyOptions *DeletePolicyOptions) (response *core.DetailedResponse, err error)

DeletePolicy : Delete policy Use this API to delete the policy. Follow the [steps](https://cloud.ibm.com/docs/schematics?topic=schematics-setup-api#cs_api) to retrieve your IAM access token and authenticate with IBM Cloud Schematics by using the API. For more information about frequently asked questions, see [FAQ](https://cloud.ibm.com/docs/schematics?topic=schematics-faqs-agent) and [Troubleshooting guide](https://cloud.ibm.com/docs/schematics?topic=schematics-agent-crn-not-found).

<h3>Authorization</h3>

Schematics support generic authorization for its resources.
For more information, about Schematics access and permissions, see [Schematics service access
roles and required permissions](https://cloud.ibm.com/docs/schematics?topic=schematics-access#access-roles).

func (*SchematicsV1) DeletePolicyWithContext

func (schematics *SchematicsV1) DeletePolicyWithContext(ctx context.Context, deletePolicyOptions *DeletePolicyOptions) (response *core.DetailedResponse, err error)

DeletePolicyWithContext is an alternate form of the DeletePolicy method which supports a Context parameter

func (*SchematicsV1) DeleteResourcesQuery

func (schematics *SchematicsV1) DeleteResourcesQuery(deleteResourcesQueryOptions *DeleteResourcesQueryOptions) (response *core.DetailedResponse, err error)

DeleteResourcesQuery : Delete resources query Use this API to delete the resource query definition by Id. For more information, about resource query commands, refer to [ibmcloud schematics resource query delete](https://cloud.ibm.com/docs/schematics?topic=schematics-schematics-cli-reference#schematics-delete-resource-query).

<h3>Authorization</h3>

Schematics support generic authorization for its resources.
For more information, about Schematics access and permissions, see
[Schematics service access roles and required

permissions](https://cloud.ibm.com/docs/schematics?topic=schematics-access#access-roles).

func (*SchematicsV1) DeleteResourcesQueryWithContext

func (schematics *SchematicsV1) DeleteResourcesQueryWithContext(ctx context.Context, deleteResourcesQueryOptions *DeleteResourcesQueryOptions) (response *core.DetailedResponse, err error)

DeleteResourcesQueryWithContext is an alternate form of the DeleteResourcesQuery method which supports a Context parameter

func (*SchematicsV1) DeleteWorkspace

func (schematics *SchematicsV1) DeleteWorkspace(deleteWorkspaceOptions *DeleteWorkspaceOptions) (result *string, response *core.DetailedResponse, err error)

DeleteWorkspace : Delete a workspace Deletes a workspace from IBM Cloud Schematics. Deleting a workspace does not automatically remove the IBM Cloud resources that the workspace manages. To remove all resources that are associated with the workspace, use the `DELETE /v1/workspaces/{id}?destroy_resources=true` API.

**Note**: If you delete a workspace without deleting the resources,
you must manage your resources with the resource dashboard or CLI afterwards.
You cannot use IBM Cloud Schematics anymore to manage your resources.

<h3>Authorization</h3>

Schematics support generic authorization for its resources.
For more information, about Schematics access and permissions,
see [Schematics service access roles and required

permissions](https://cloud.ibm.com/docs/schematics?topic=schematics-access#access-roles).

func (*SchematicsV1) DeleteWorkspaceActivity

func (schematics *SchematicsV1) DeleteWorkspaceActivity(deleteWorkspaceActivityOptions *DeleteWorkspaceActivityOptions) (result *WorkspaceActivityApplyResult, response *core.DetailedResponse, err error)

DeleteWorkspaceActivity : Stop the workspace job Stop an ongoing schematics job that runs against your workspace. **Note**: If you remove the Schematics apply job that runs against your workspace, any changes to your IBM Cloud resources that are already applied are not reverted. If a creation, update, or deletion is currently in progress, Schematics waits for the job to be completed first. Then, any other resource creations, updates, or deletions that are included in your Terraform template file are ignored. <h3>Authorization</h3>

Schematics support generic authorization for its resources.
For more information, about Schematics access and permissions,
see [Schematics service access roles and required

permissions](https://cloud.ibm.com/docs/schematics?topic=schematics-access#access-roles).

func (*SchematicsV1) DeleteWorkspaceActivityWithContext

func (schematics *SchematicsV1) DeleteWorkspaceActivityWithContext(ctx context.Context, deleteWorkspaceActivityOptions *DeleteWorkspaceActivityOptions) (result *WorkspaceActivityApplyResult, response *core.DetailedResponse, err error)

DeleteWorkspaceActivityWithContext is an alternate form of the DeleteWorkspaceActivity method which supports a Context parameter

func (*SchematicsV1) DeleteWorkspaceWithContext

func (schematics *SchematicsV1) DeleteWorkspaceWithContext(ctx context.Context, deleteWorkspaceOptions *DeleteWorkspaceOptions) (result *string, response *core.DetailedResponse, err error)

DeleteWorkspaceWithContext is an alternate form of the DeleteWorkspace method which supports a Context parameter

func (*SchematicsV1) DeployAgentJob

func (schematics *SchematicsV1) DeployAgentJob(deployAgentJobOptions *DeployAgentJobOptions) (result *AgentDeployJob, response *core.DetailedResponse, err error)

DeployAgentJob : Run the agent deployment job Use run agent deployment job API to execute the agent deployment job based on the agent ID. For more information about supported API endpoints, see [API endpoint](https://cloud.ibm.com/apidocs/schematics/schematics#api-endpoints). <h3>Authorization</h3> Schematics support generic authorization for its resources. For more information, about Schematics access and permissions, see [Schematics service access

roles and required permissions](https://cloud.ibm.com/docs/schematics?topic=schematics-access#access-roles).

func (*SchematicsV1) DeployAgentJobWithContext

func (schematics *SchematicsV1) DeployAgentJobWithContext(ctx context.Context, deployAgentJobOptions *DeployAgentJobOptions) (result *AgentDeployJob, response *core.DetailedResponse, err error)

DeployAgentJobWithContext is an alternate form of the DeployAgentJob method which supports a Context parameter

func (*SchematicsV1) DestroyWorkspaceCommand

func (schematics *SchematicsV1) DestroyWorkspaceCommand(destroyWorkspaceCommandOptions *DestroyWorkspaceCommandOptions) (result *WorkspaceActivityDestroyResult, response *core.DetailedResponse, err error)

DestroyWorkspaceCommand : Perform a Schematics `destroy` job Run a Schematics `destroy` job against your workspace. A `destroy` job removes all IBM Cloud resources that are associated with your workspace. Removing your resources does not delete the Schematics workspace. To delete the workspace, use the `DELETE /v1/workspaces/{id}` API. This API returns an activity or job ID that you use to retrieve the URL to the log file with the `GET /v1/workspaces/{id}/actions/{action_id}/logs` API.

**Important**: Your workspace must be in an `Active`, `Failed`, or `Stopped` state to perform a Schematics `destroy`

job.

**Note**: Deleting IBM Cloud resources cannot be undone. Make sure that you back up any required data before you

remove your resources.

<h3>Authorization</h3>

Schematics support generic authorization for its resources.
For more information, about Schematics access and permissions,
see [Schematics service access roles and required

permissions](https://cloud.ibm.com/docs/schematics?topic=schematics-access#access-roles).

func (*SchematicsV1) DestroyWorkspaceCommandWithContext

func (schematics *SchematicsV1) DestroyWorkspaceCommandWithContext(ctx context.Context, destroyWorkspaceCommandOptions *DestroyWorkspaceCommandOptions) (result *WorkspaceActivityDestroyResult, response *core.DetailedResponse, err error)

DestroyWorkspaceCommandWithContext is an alternate form of the DestroyWorkspaceCommand method which supports a Context parameter

func (*SchematicsV1) DisableRetries

func (schematics *SchematicsV1) DisableRetries()

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

func (*SchematicsV1) EnableRetries

func (schematics *SchematicsV1) 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 (*SchematicsV1) ExecuteResourceQuery

func (schematics *SchematicsV1) ExecuteResourceQuery(executeResourceQueryOptions *ExecuteResourceQueryOptions) (result *ResourceQueryResponseRecord, response *core.DetailedResponse, err error)

ExecuteResourceQuery : Run the resource query Run the resource query.

func (*SchematicsV1) ExecuteResourceQueryWithContext

func (schematics *SchematicsV1) ExecuteResourceQueryWithContext(ctx context.Context, executeResourceQueryOptions *ExecuteResourceQueryOptions) (result *ResourceQueryResponseRecord, response *core.DetailedResponse, err error)

ExecuteResourceQueryWithContext is an alternate form of the ExecuteResourceQuery method which supports a Context parameter

func (*SchematicsV1) GetAction

func (schematics *SchematicsV1) GetAction(getActionOptions *GetActionOptions) (result *Action, response *core.DetailedResponse, err error)

GetAction : Get action details Retrieve the detailed information of an actions from your IBM Cloud account. This API returns a URL to the log file that you can retrieve by using the `GET /v2/actions/{action_id}/logs` API.

<h3>Authorization</h3>

Schematics support generic authorization for its resources.
For more information, about Schematics access and permissions, see
[Schematics service access roles and required

permissions](https://cloud.ibm.com/docs/schematics?topic=schematics-access#action-permissions).

func (*SchematicsV1) GetActionWithContext

func (schematics *SchematicsV1) GetActionWithContext(ctx context.Context, getActionOptions *GetActionOptions) (result *Action, response *core.DetailedResponse, err error)

GetActionWithContext is an alternate form of the GetAction method which supports a Context parameter

func (*SchematicsV1) GetAgent

func (schematics *SchematicsV1) GetAgent(getAgentOptions *GetAgentOptions) (result *Agent, response *core.DetailedResponse, err error)

GetAgent : Get the registered agent details Reterive list the registered agent details

<h3>Authorization</h3>

Schematics support generic authorization for its resources.
For more information, about Schematics access and permissions, see [Schematics service access
roles and required permissions](https://cloud.ibm.com/docs/schematics?topic=schematics-access#access-roles).

Deprecated: this method is deprecated and may be removed in a future release.

func (*SchematicsV1) GetAgentData

func (schematics *SchematicsV1) GetAgentData(getAgentDataOptions *GetAgentDataOptions) (result *AgentData, response *core.DetailedResponse, err error)

GetAgentData : Get agent details Retrieve a detailed configuration of an agent with a specific agent ID. The agent that is returned depends on the API endpoint that you use. For example, if you use an API endpoint for a geography, such as North America, only agents that are created in `us-south or `us-east` are returned. For more information about frequently asked questions, see [FAQ](https://cloud.ibm.com/docs/schematics?topic=schematics-faqs-agent) and [Troubleshooting guide](https://cloud.ibm.com/docs/schematics?topic=schematics-agent-crn-not-found). For more information about supported API endpoints, see [API endpoint](https://cloud.ibm.com/apidocs/schematics/schematics#api-endpoints).

<h3>Authorization</h3>

Schematics support generic authorization for its resources.
For more information, about Schematics access and permissions, see [Schematics service access
roles and required permissions](https://cloud.ibm.com/docs/schematics?topic=schematics-access#access-roles).

func (*SchematicsV1) GetAgentDataWithContext

func (schematics *SchematicsV1) GetAgentDataWithContext(ctx context.Context, getAgentDataOptions *GetAgentDataOptions) (result *AgentData, response *core.DetailedResponse, err error)

GetAgentDataWithContext is an alternate form of the GetAgentData method which supports a Context parameter

func (*SchematicsV1) GetAgentVersions

func (schematics *SchematicsV1) GetAgentVersions(getAgentVersionsOptions *GetAgentVersionsOptions) (result *AgentVersions, response *core.DetailedResponse, err error)

GetAgentVersions : Get agent versions Retrieve the list of agent version's available to be deployed. For more information about supported API endpoints, see [API endpoint](https://cloud.ibm.com/apidocs/schematics/schematics#api-endpoints).

<h3>Authorization</h3>

Schematics support generic authorization for its resources.
For more information, about Schematics access and permissions, see [Schematics service access
roles and required permissions](https://cloud.ibm.com/docs/schematics?topic=schematics-access#access-roles).

func (*SchematicsV1) GetAgentVersionsWithContext

func (schematics *SchematicsV1) GetAgentVersionsWithContext(ctx context.Context, getAgentVersionsOptions *GetAgentVersionsOptions) (result *AgentVersions, response *core.DetailedResponse, err error)

GetAgentVersionsWithContext is an alternate form of the GetAgentVersions method which supports a Context parameter

func (*SchematicsV1) GetAgentWithContext

func (schematics *SchematicsV1) GetAgentWithContext(ctx context.Context, getAgentOptions *GetAgentOptions) (result *Agent, response *core.DetailedResponse, err error)

GetAgentWithContext is an alternate form of the GetAgent method which supports a Context parameter Deprecated: this method is deprecated and may be removed in a future release.

func (*SchematicsV1) GetAllWorkspaceInputs

func (schematics *SchematicsV1) GetAllWorkspaceInputs(getAllWorkspaceInputsOptions *GetAllWorkspaceInputsOptions) (result *WorkspaceTemplateValuesResponse, response *core.DetailedResponse, err error)

GetAllWorkspaceInputs : Get workspace template details Retrieve detailed information about the Terraform template that your workspace points to.

<h3>Authorization</h3>

Schematics support generic authorization for its resources.
For more information, about Schematics access and permissions,
see [Schematics service access roles and required

permissions](https://cloud.ibm.com/docs/schematics?topic=schematics-access#access-roles).

func (*SchematicsV1) GetAllWorkspaceInputsWithContext

func (schematics *SchematicsV1) GetAllWorkspaceInputsWithContext(ctx context.Context, getAllWorkspaceInputsOptions *GetAllWorkspaceInputsOptions) (result *WorkspaceTemplateValuesResponse, response *core.DetailedResponse, err error)

GetAllWorkspaceInputsWithContext is an alternate form of the GetAllWorkspaceInputs method which supports a Context parameter

func (*SchematicsV1) GetDeployAgentJob

func (schematics *SchematicsV1) GetDeployAgentJob(getDeployAgentJobOptions *GetDeployAgentJobOptions) (result *AgentDeployJob, response *core.DetailedResponse, err error)

GetDeployAgentJob : Get agent deployment job Use get agent deployment job API to retrieve the agent deployment job status based on the agent ID. For more information about supported API endpoints, see [API endpoint](https://cloud.ibm.com/apidocs/schematics/schematics#api-endpoints). <h3>Authorization</h3> Schematics support generic authorization for its resources. For more information, about Schematics access and permissions, see [Schematics service access

roles and required permissions](https://cloud.ibm.com/docs/schematics?topic=schematics-access#access-roles).

func (*SchematicsV1) GetDeployAgentJobWithContext

func (schematics *SchematicsV1) GetDeployAgentJobWithContext(ctx context.Context, getDeployAgentJobOptions *GetDeployAgentJobOptions) (result *AgentDeployJob, response *core.DetailedResponse, err error)

GetDeployAgentJobWithContext is an alternate form of the GetDeployAgentJob method which supports a Context parameter

func (*SchematicsV1) GetEnableGzipCompression

func (schematics *SchematicsV1) GetEnableGzipCompression() bool

GetEnableGzipCompression returns the service's EnableGzipCompression field

func (*SchematicsV1) GetHealthCheckAgentJob

func (schematics *SchematicsV1) GetHealthCheckAgentJob(getHealthCheckAgentJobOptions *GetHealthCheckAgentJobOptions) (result *AgentHealthJob, response *core.DetailedResponse, err error)

GetHealthCheckAgentJob : Get agent health check job Use get agent health check job API to retrieve the agent health check job status based on the agent ID. For more information about supported API endpoints, see [API endpoint](/apidocs/schematics/schematics#api-endpoints). <h3>Authorization</h3>

Schematics support generic authorization for its resources. For more information, about Schematics access and

permissions, see [Schematics service access

roles and required permissions](https://cloud.ibm.com/docs/schematics?topic=schematics-access#access-roles).

func (*SchematicsV1) GetHealthCheckAgentJobWithContext

func (schematics *SchematicsV1) GetHealthCheckAgentJobWithContext(ctx context.Context, getHealthCheckAgentJobOptions *GetHealthCheckAgentJobOptions) (result *AgentHealthJob, response *core.DetailedResponse, err error)

GetHealthCheckAgentJobWithContext is an alternate form of the GetHealthCheckAgentJob method which supports a Context parameter

func (*SchematicsV1) GetInventory

func (schematics *SchematicsV1) GetInventory(getInventoryOptions *GetInventoryOptions) (result *InventoryResourceRecord, response *core.DetailedResponse, err error)

GetInventory : Get an inventory definition Use this API to retrieve the detailed information for a resource inventory definition used to target an action in your IBM Cloud account. For more information, about inventory get, refer to [ibmcloud schematics inventory get](https://cloud.ibm.com/docs/schematics?topic=schematics-schematics-cli-reference#schematics-get-inv).

**Note** you can fetch only the location and region, resource group from where your inventory is created.
Also, make sure your IP addresses are in the

[allowlist](https://cloud.ibm.com/docs/schematics?topic=schematics-allowed-ipaddresses).

<h3>Authorization</h3>

Schematics support generic authorization for its resources.
For more information, about Schematics access and permissions, see
[Schematics service access roles and required

permissions](https://cloud.ibm.com/docs/schematics?topic=schematics-access#access-roles).

func (*SchematicsV1) GetInventoryWithContext

func (schematics *SchematicsV1) GetInventoryWithContext(ctx context.Context, getInventoryOptions *GetInventoryOptions) (result *InventoryResourceRecord, response *core.DetailedResponse, err error)

GetInventoryWithContext is an alternate form of the GetInventory method which supports a Context parameter

func (*SchematicsV1) GetJob

func (schematics *SchematicsV1) GetJob(getJobOptions *GetJobOptions) (result *Job, response *core.DetailedResponse, err error)

GetJob : Get a job Retrieve the detailed information of Job

<h3>Authorization</h3>

Schematics support generic authorization for its resources.
For more information, about Schematics access and permissions, see
[Schematics service access roles and required

permissions](https://cloud.ibm.com/docs/schematics?topic=schematics-access#access-roles).

func (*SchematicsV1) GetJobFiles

func (schematics *SchematicsV1) GetJobFiles(getJobFilesOptions *GetJobFilesOptions) (result *JobFileData, response *core.DetailedResponse, err error)

GetJobFiles : Get output files from the Job record Get output files from the Job record. For more information, about the Schematics job status, download job logs, and download the output files, see [Download Schematics Job](https://cloud.ibm.com/docs/schematics?topic=schematics-job-download).

func (*SchematicsV1) GetJobFilesWithContext

func (schematics *SchematicsV1) GetJobFilesWithContext(ctx context.Context, getJobFilesOptions *GetJobFilesOptions) (result *JobFileData, response *core.DetailedResponse, err error)

GetJobFilesWithContext is an alternate form of the GetJobFiles method which supports a Context parameter

func (*SchematicsV1) GetJobWithContext

func (schematics *SchematicsV1) GetJobWithContext(ctx context.Context, getJobOptions *GetJobOptions) (result *Job, response *core.DetailedResponse, err error)

GetJobWithContext is an alternate form of the GetJob method which supports a Context parameter

func (*SchematicsV1) GetKmsSettings

func (schematics *SchematicsV1) GetKmsSettings(getKmsSettingsOptions *GetKmsSettingsOptions) (result *KMSSettings, response *core.DetailedResponse, err error)

GetKmsSettings : Get a KMS settings Retrieve the kms instance that is integrated with Schematics for the **byok** and **kyok**. For each geographic location supported in Schematics we can have different kms settings. For example `US` and `EU` will have different kms settings. <h3>Authorization</h3>

Schematics support generic authorization for its resources.
For more information, about Schematics access and permissions, see
[Schematics service access roles and required

permissions](https://cloud.ibm.com/docs/schematics?topic=schematics-access#access-roles).

func (*SchematicsV1) GetKmsSettingsWithContext

func (schematics *SchematicsV1) GetKmsSettingsWithContext(ctx context.Context, getKmsSettingsOptions *GetKmsSettingsOptions) (result *KMSSettings, response *core.DetailedResponse, err error)

GetKmsSettingsWithContext is an alternate form of the GetKmsSettings method which supports a Context parameter

func (*SchematicsV1) GetPolicy

func (schematics *SchematicsV1) GetPolicy(getPolicyOptions *GetPolicyOptions) (result *Policy, response *core.DetailedResponse, err error)

GetPolicy : Get policy Retrieve the detailed information of a policy details identified by `policy_id`. For more information about frequently asked questions, see [FAQ](https://cloud.ibm.com/docs/schematics?topic=schematics-faqs-agent) and [Troubleshooting guide](https://cloud.ibm.com/docs/schematics?topic=schematics-agent-crn-not-found). For more information about supported API endpoints, see [API endpoint](https://cloud.ibm.com/apidocs/schematics/schematics#api-endpoints).

<h3>Authorization</h3>

Schematics support generic authorization for its resources.
For more information, about Schematics access and permissions, see [Schematics service access
roles and required permissions](https://cloud.ibm.com/docs/schematics?topic=schematics-access#access-roles).

func (*SchematicsV1) GetPolicyWithContext

func (schematics *SchematicsV1) GetPolicyWithContext(ctx context.Context, getPolicyOptions *GetPolicyOptions) (result *Policy, response *core.DetailedResponse, err error)

GetPolicyWithContext is an alternate form of the GetPolicy method which supports a Context parameter

func (*SchematicsV1) GetPrsAgentJob

func (schematics *SchematicsV1) GetPrsAgentJob(getPrsAgentJobOptions *GetPrsAgentJobOptions) (result *AgentPRSJob, response *core.DetailedResponse, err error)

GetPrsAgentJob : Get pre-requisite scanner job status Use get pre-requisite scanner job status API for deploying an agent by using the `agent_id`, `job_id`. The API results the status as **pending**, **in-progress**, **success**, or **failed** in a string format. For more information about supported API endpoints, see [API endpoint](https://cloud.ibm.com/apidocs/schematics/schematics#api-endpoints). <h3>Authorization</h3>

Schematics support generic authorization for its resources. For more information, about Schematics access and

permissions, see [Schematics service access

roles and required permissions](https://cloud.ibm.com/docs/schematics?topic=schematics-access#access-roles).

func (*SchematicsV1) GetPrsAgentJobWithContext

func (schematics *SchematicsV1) GetPrsAgentJobWithContext(ctx context.Context, getPrsAgentJobOptions *GetPrsAgentJobOptions) (result *AgentPRSJob, response *core.DetailedResponse, err error)

GetPrsAgentJobWithContext is an alternate form of the GetPrsAgentJob method which supports a Context parameter

func (*SchematicsV1) GetResourcesQuery

func (schematics *SchematicsV1) GetResourcesQuery(getResourcesQueryOptions *GetResourcesQueryOptions) (result *ResourceQueryRecord, response *core.DetailedResponse, err error)

GetResourcesQuery : Get resources query Use this API to retrieve the information resource query by Id. For more information, about resource query commands, refer to [ibmcloud schematics resource query get](https://cloud.ibm.com/docs/schematics?topic=schematics-schematics-cli-reference#schematics-get-rq). <h3>Authorization</h3>

Schematics support generic authorization for its resources.
For more information, about Schematics access and permissions, see
[Schematics service access roles and required

permissions](https://cloud.ibm.com/docs/schematics?topic=schematics-access#access-roles).

func (*SchematicsV1) GetResourcesQueryWithContext

func (schematics *SchematicsV1) GetResourcesQueryWithContext(ctx context.Context, getResourcesQueryOptions *GetResourcesQueryOptions) (result *ResourceQueryRecord, response *core.DetailedResponse, err error)

GetResourcesQueryWithContext is an alternate form of the GetResourcesQuery method which supports a Context parameter

func (*SchematicsV1) GetSchematicsVersion

func (schematics *SchematicsV1) GetSchematicsVersion(getSchematicsVersionOptions *GetSchematicsVersionOptions) (result *VersionResponse, response *core.DetailedResponse, err error)

GetSchematicsVersion : Get Schematics API information Retrieve detailed information about the IBM Cloud Schematics API version and the version of the provider plug-ins that the API uses.

func (*SchematicsV1) GetSchematicsVersionWithContext

func (schematics *SchematicsV1) GetSchematicsVersionWithContext(ctx context.Context, getSchematicsVersionOptions *GetSchematicsVersionOptions) (result *VersionResponse, response *core.DetailedResponse, err error)

GetSchematicsVersionWithContext is an alternate form of the GetSchematicsVersion method which supports a Context parameter

func (*SchematicsV1) GetServiceURL

func (schematics *SchematicsV1) GetServiceURL() string

GetServiceURL returns the service URL

func (*SchematicsV1) GetTemplateActivityLog

func (schematics *SchematicsV1) GetTemplateActivityLog(getTemplateActivityLogOptions *GetTemplateActivityLogOptions) (result *string, response *core.DetailedResponse, err error)

GetTemplateActivityLog : Show logs for a workspace job Show the Terraform logs for an job that ran against your workspace.

func (*SchematicsV1) GetTemplateActivityLogWithContext

func (schematics *SchematicsV1) GetTemplateActivityLogWithContext(ctx context.Context, getTemplateActivityLogOptions *GetTemplateActivityLogOptions) (result *string, response *core.DetailedResponse, err error)

GetTemplateActivityLogWithContext is an alternate form of the GetTemplateActivityLog method which supports a Context parameter

func (*SchematicsV1) GetTemplateLogs

func (schematics *SchematicsV1) GetTemplateLogs(getTemplateLogsOptions *GetTemplateLogsOptions) (result *string, response *core.DetailedResponse, err error)

GetTemplateLogs : Show latest logs for a workspace template Show the Terraform logs for the most recent job of a template that ran against your workspace.

<h3>Authorization</h3>

Schematics support generic authorization for its resources.
For more information, about Schematics access and permissions,
see [Schematics service access roles and required

permissions](https://cloud.ibm.com/docs/schematics?topic=schematics-access#access-roles).

func (*SchematicsV1) GetTemplateLogsWithContext

func (schematics *SchematicsV1) GetTemplateLogsWithContext(ctx context.Context, getTemplateLogsOptions *GetTemplateLogsOptions) (result *string, response *core.DetailedResponse, err error)

GetTemplateLogsWithContext is an alternate form of the GetTemplateLogs method which supports a Context parameter

func (*SchematicsV1) GetWorkspace

func (schematics *SchematicsV1) GetWorkspace(getWorkspaceOptions *GetWorkspaceOptions) (result *WorkspaceResponse, response *core.DetailedResponse, err error)

GetWorkspace : Get workspace details Retrieve detailed information for a workspace in your IBM Cloud account.

<h3>Authorization</h3>

Schematics support generic authorization for its resources.
For more information, about Schematics access and permissions, see [Schematics service access
roles and required permissions](https://cloud.ibm.com/docs/schematics?topic=schematics-access#access-roles).

func (*SchematicsV1) GetWorkspaceActivity

func (schematics *SchematicsV1) GetWorkspaceActivity(getWorkspaceActivityOptions *GetWorkspaceActivityOptions) (result *WorkspaceActivity, response *core.DetailedResponse, err error)

GetWorkspaceActivity : Get workspace job details Get the details for a workspace job that ran against the workspace. This API returns the job status and a URL to the log file that you can retrieve by using the `GET /v1/workspaces/{id}/actions/{action_id}/logs` API.

func (*SchematicsV1) GetWorkspaceActivityLogs

func (schematics *SchematicsV1) GetWorkspaceActivityLogs(getWorkspaceActivityLogsOptions *GetWorkspaceActivityLogsOptions) (result *WorkspaceActivityLogs, response *core.DetailedResponse, err error)

GetWorkspaceActivityLogs : Get workspace job log URL Get the Terraform log file URL for a workspace job. You can retrieve the log URL for jobs that were created with the `PUT /v1/workspaces/{id}/apply`, `POST /v1/workspaces/{id}/plan`, or `DELETE /v1/workspaces/{id}/destroy` API.

<h3>Authorization</h3>

Schematics support generic authorization for its resources.
For more information, about Schematics access and permissions,
see [Schematics service access roles and required

permissions](https://cloud.ibm.com/docs/schematics?topic=schematics-access#access-roles). Deprecated: this method is deprecated and may be removed in a future release.

func (*SchematicsV1) GetWorkspaceActivityLogsWithContext

func (schematics *SchematicsV1) GetWorkspaceActivityLogsWithContext(ctx context.Context, getWorkspaceActivityLogsOptions *GetWorkspaceActivityLogsOptions) (result *WorkspaceActivityLogs, response *core.DetailedResponse, err error)

GetWorkspaceActivityLogsWithContext is an alternate form of the GetWorkspaceActivityLogs method which supports a Context parameter Deprecated: this method is deprecated and may be removed in a future release.

func (*SchematicsV1) GetWorkspaceActivityWithContext

func (schematics *SchematicsV1) GetWorkspaceActivityWithContext(ctx context.Context, getWorkspaceActivityOptions *GetWorkspaceActivityOptions) (result *WorkspaceActivity, response *core.DetailedResponse, err error)

GetWorkspaceActivityWithContext is an alternate form of the GetWorkspaceActivity method which supports a Context parameter

func (*SchematicsV1) GetWorkspaceDeletionJobStatus

func (schematics *SchematicsV1) GetWorkspaceDeletionJobStatus(getWorkspaceDeletionJobStatusOptions *GetWorkspaceDeletionJobStatusOptions) (result *WorkspaceJobResponse, response *core.DetailedResponse, err error)

GetWorkspaceDeletionJobStatus : Get the workspace deletion job status Retrieve detailed information for a workspace deletion job status.

<h3>Authorization</h3>

Schematics support generic authorization for its resources.
For more information, about Schematics access and permissions, see
[Schematics service access roles and required

permissions](https://cloud.ibm.com/docs/schematics?topic=schematics-access#access-roles).

func (*SchematicsV1) GetWorkspaceDeletionJobStatusWithContext

func (schematics *SchematicsV1) GetWorkspaceDeletionJobStatusWithContext(ctx context.Context, getWorkspaceDeletionJobStatusOptions *GetWorkspaceDeletionJobStatusOptions) (result *WorkspaceJobResponse, response *core.DetailedResponse, err error)

GetWorkspaceDeletionJobStatusWithContext is an alternate form of the GetWorkspaceDeletionJobStatus method which supports a Context parameter

func (*SchematicsV1) GetWorkspaceInputMetadata

func (schematics *SchematicsV1) GetWorkspaceInputMetadata(getWorkspaceInputMetadataOptions *GetWorkspaceInputMetadataOptions) (result []map[string]interface{}, response *core.DetailedResponse, err error)

GetWorkspaceInputMetadata : List workspace variable metadata Retrieve the metadata for all the workspace input variables that are declared in the template that your workspace points to.

func (*SchematicsV1) GetWorkspaceInputMetadataWithContext

func (schematics *SchematicsV1) GetWorkspaceInputMetadataWithContext(ctx context.Context, getWorkspaceInputMetadataOptions *GetWorkspaceInputMetadataOptions) (result []map[string]interface{}, response *core.DetailedResponse, err error)

GetWorkspaceInputMetadataWithContext is an alternate form of the GetWorkspaceInputMetadata method which supports a Context parameter

func (*SchematicsV1) GetWorkspaceInputs

func (schematics *SchematicsV1) GetWorkspaceInputs(getWorkspaceInputsOptions *GetWorkspaceInputsOptions) (result *TemplateValues, response *core.DetailedResponse, err error)

GetWorkspaceInputs : List workspace input variables Retrieve a list of input variables that are declared in your Terraform or IBM Cloud catalog template.

<h3>Authorization</h3>

Schematics support generic authorization for its resources.
For more information, about Schematics access and permissions,
see [Schematics service access roles and required

permissions](https://cloud.ibm.com/docs/schematics?topic=schematics-access#access-roles).

func (*SchematicsV1) GetWorkspaceInputsWithContext

func (schematics *SchematicsV1) GetWorkspaceInputsWithContext(ctx context.Context, getWorkspaceInputsOptions *GetWorkspaceInputsOptions) (result *TemplateValues, response *core.DetailedResponse, err error)

GetWorkspaceInputsWithContext is an alternate form of the GetWorkspaceInputs method which supports a Context parameter

func (*SchematicsV1) GetWorkspaceLogUrls

func (schematics *SchematicsV1) GetWorkspaceLogUrls(getWorkspaceLogUrlsOptions *GetWorkspaceLogUrlsOptions) (result *LogStoreResponseList, response *core.DetailedResponse, err error)

GetWorkspaceLogUrls : Get latest workspace job log URL for all workspace templates Retrieve the log file URL for the latest job of a template that ran against your workspace. You use this URL to retrieve detailed logs for the latest job. Deprecated: this method is deprecated and may be removed in a future release.

func (*SchematicsV1) GetWorkspaceLogUrlsWithContext

func (schematics *SchematicsV1) GetWorkspaceLogUrlsWithContext(ctx context.Context, getWorkspaceLogUrlsOptions *GetWorkspaceLogUrlsOptions) (result *LogStoreResponseList, response *core.DetailedResponse, err error)

GetWorkspaceLogUrlsWithContext is an alternate form of the GetWorkspaceLogUrls method which supports a Context parameter Deprecated: this method is deprecated and may be removed in a future release.

func (*SchematicsV1) GetWorkspaceOutputs

func (schematics *SchematicsV1) GetWorkspaceOutputs(getWorkspaceOutputsOptions *GetWorkspaceOutputsOptions) (result []OutputValuesInner, response *core.DetailedResponse, err error)

GetWorkspaceOutputs : List workspace output values Retrieve a list of Terraform output variables. You define output values in your Terraform template to include information that you want to make accessible for other Terraform templates.

func (*SchematicsV1) GetWorkspaceOutputsWithContext

func (schematics *SchematicsV1) GetWorkspaceOutputsWithContext(ctx context.Context, getWorkspaceOutputsOptions *GetWorkspaceOutputsOptions) (result []OutputValuesInner, response *core.DetailedResponse, err error)

GetWorkspaceOutputsWithContext is an alternate form of the GetWorkspaceOutputs method which supports a Context parameter

func (*SchematicsV1) GetWorkspaceReadme

func (schematics *SchematicsV1) GetWorkspaceReadme(getWorkspaceReadmeOptions *GetWorkspaceReadmeOptions) (result *TemplateReadme, response *core.DetailedResponse, err error)

GetWorkspaceReadme : Show workspace template readme Retrieve the `README.md` file of the Terraform of IBM Cloud catalog template that your workspace points to. Deprecated: this method is deprecated and may be removed in a future release.

func (*SchematicsV1) GetWorkspaceReadmeWithContext

func (schematics *SchematicsV1) GetWorkspaceReadmeWithContext(ctx context.Context, getWorkspaceReadmeOptions *GetWorkspaceReadmeOptions) (result *TemplateReadme, response *core.DetailedResponse, err error)

GetWorkspaceReadmeWithContext is an alternate form of the GetWorkspaceReadme method which supports a Context parameter Deprecated: this method is deprecated and may be removed in a future release.

func (*SchematicsV1) GetWorkspaceResources

func (schematics *SchematicsV1) GetWorkspaceResources(getWorkspaceResourcesOptions *GetWorkspaceResourcesOptions) (result []TemplateResources, response *core.DetailedResponse, err error)

GetWorkspaceResources : List workspace resources Retrieve a list of IBM Cloud resources that you created with your workspace.

func (*SchematicsV1) GetWorkspaceResourcesWithContext

func (schematics *SchematicsV1) GetWorkspaceResourcesWithContext(ctx context.Context, getWorkspaceResourcesOptions *GetWorkspaceResourcesOptions) (result []TemplateResources, response *core.DetailedResponse, err error)

GetWorkspaceResourcesWithContext is an alternate form of the GetWorkspaceResources method which supports a Context parameter

func (*SchematicsV1) GetWorkspaceState

func (schematics *SchematicsV1) GetWorkspaceState(getWorkspaceStateOptions *GetWorkspaceStateOptions) (result *StateStoreResponseList, response *core.DetailedResponse, err error)

GetWorkspaceState : Get Terraform statefile URL This API is deprecated, and is replaced by the `GET /v2/jobs/{job_id}/files`, with `file_type` equal `state_file`. Retrieve the URL to the Terraform statefile (`terraform.tfstate`). You use the URL to access the Terraform statefile. The Terraform statefile includes detailed information about the IBM Cloud resources that you provisioned with IBM Cloud Schematics and Schematics uses the file to determine future create, modify, or delete actions for your resources. To show the content of the Terraform statefile, use the `GET /v1/workspaces/{id}/runtime_data/{template_id}/state_store` API.

<h3>Authorization</h3>

Schematics support generic authorization for its resources.
For more information, about Schematics access and permissions,
see [Schematics service access roles and required

permissions](https://cloud.ibm.com/docs/schematics?topic=schematics-access#access-roles). Deprecated: this method is deprecated and may be removed in a future release.

func (*SchematicsV1) GetWorkspaceStateWithContext

func (schematics *SchematicsV1) GetWorkspaceStateWithContext(ctx context.Context, getWorkspaceStateOptions *GetWorkspaceStateOptions) (result *StateStoreResponseList, response *core.DetailedResponse, err error)

GetWorkspaceStateWithContext is an alternate form of the GetWorkspaceState method which supports a Context parameter Deprecated: this method is deprecated and may be removed in a future release.

func (*SchematicsV1) GetWorkspaceTemplateState

func (schematics *SchematicsV1) GetWorkspaceTemplateState(getWorkspaceTemplateStateOptions *GetWorkspaceTemplateStateOptions) (result *TemplateStateStore, response *core.DetailedResponse, err error)

GetWorkspaceTemplateState : Show Terraform statefile content This API is deprecated, and is replaced by the `GET /v2/jobs/{job_id}/files`, with `file_type` equal `state_file`. Show the content of the Terraform statefile (`terraform.tfstate`) that was created when your Terraform template was applied in IBM Cloud. The statefile holds detailed information about the IBM Cloud resources that were created by IBM Cloud Schematics and Schematics uses the file to determine future create, modify, or delete actions for your resources. Deprecated: this method is deprecated and may be removed in a future release.

func (*SchematicsV1) GetWorkspaceTemplateStateWithContext

func (schematics *SchematicsV1) GetWorkspaceTemplateStateWithContext(ctx context.Context, getWorkspaceTemplateStateOptions *GetWorkspaceTemplateStateOptions) (result *TemplateStateStore, response *core.DetailedResponse, err error)

GetWorkspaceTemplateStateWithContext is an alternate form of the GetWorkspaceTemplateState method which supports a Context parameter Deprecated: this method is deprecated and may be removed in a future release.

func (*SchematicsV1) GetWorkspaceWithContext

func (schematics *SchematicsV1) GetWorkspaceWithContext(ctx context.Context, getWorkspaceOptions *GetWorkspaceOptions) (result *WorkspaceResponse, response *core.DetailedResponse, err error)

GetWorkspaceWithContext is an alternate form of the GetWorkspace method which supports a Context parameter

func (*SchematicsV1) HealthCheckAgentJob

func (schematics *SchematicsV1) HealthCheckAgentJob(healthCheckAgentJobOptions *HealthCheckAgentJobOptions) (result *AgentHealthJob, response *core.DetailedResponse, err error)

HealthCheckAgentJob : Run agent health check Use run agent health check job API to execute an agent health check job based on the agent ID. For more information about supported API endpoints, see [API endpoint](https://cloud.ibm.com/apidocs/schematics/schematics#api-endpoints). <h3>Authorization</h3> Schematics support generic authorization for its resources. For more information, about Schematics access and permissions, see [Schematics service access

roles and required permissions](https://cloud.ibm.com/docs/schematics?topic=schematics-access#access-roles).

func (*SchematicsV1) HealthCheckAgentJobWithContext

func (schematics *SchematicsV1) HealthCheckAgentJobWithContext(ctx context.Context, healthCheckAgentJobOptions *HealthCheckAgentJobOptions) (result *AgentHealthJob, response *core.DetailedResponse, err error)

HealthCheckAgentJobWithContext is an alternate form of the HealthCheckAgentJob method which supports a Context parameter

func (*SchematicsV1) ListActions

func (schematics *SchematicsV1) ListActions(listActionsOptions *ListActionsOptions) (result *ActionList, response *core.DetailedResponse, err error)

ListActions : List actions Retrieve a list of all Schematics actions that depends on the API endpoint that you have access. For example, if you use an API endpoint for a geography, such as North America, only actions that are created in `us-south` or `us-east` are retrieved.

For more information, about supported API endpoints, see

[API endpoints](/apidocs/schematics#api-endpoints).

<h3>Authorization</h3>

Schematics support generic authorization for its resources.
For more information, about Schematics access and permissions, see
[Schematics service access roles and required

permissions](https://cloud.ibm.com/docs/schematics?topic=schematics-access#access-roles).

func (*SchematicsV1) ListActionsWithContext

func (schematics *SchematicsV1) ListActionsWithContext(ctx context.Context, listActionsOptions *ListActionsOptions) (result *ActionList, response *core.DetailedResponse, err error)

ListActionsWithContext is an alternate form of the ListActions method which supports a Context parameter

func (*SchematicsV1) ListAgent

func (schematics *SchematicsV1) ListAgent(listAgentOptions *ListAgentOptions) (result *AgentList, response *core.DetailedResponse, err error)

ListAgent : Get all registered/unregistered agents in the Account Get all registered or unregistered agents, in the Account.

<h3>Authorization</h3>

Schematics support generic authorization for its resources.
For more information, about Schematics access and permissions, see [Schematics service access
roles and required permissions](https://cloud.ibm.com/docs/schematics?topic=schematics-access#access-roles).

Deprecated: this method is deprecated and may be removed in a future release.

func (*SchematicsV1) ListAgentData

func (schematics *SchematicsV1) ListAgentData(listAgentDataOptions *ListAgentDataOptions) (result *AgentDataList, response *core.DetailedResponse, err error)

ListAgentData : List agents Retrieve a list of Schematics agents from your IBM Cloud account that you have access to. The list of agents that is returned depends on the API endpoint that you use. For example, if you use an API endpoint for a geography, such as North America, only agents that are created in `us-south or `us-east` are returned. For more information about frequently asked questions, see [FAQ](https://cloud.ibm.com/docs/schematics?topic=schematics-faqs-agent) and [Troubleshooting guide](https://cloud.ibm.com/docs/schematics?topic=schematics-agent-crn-not-found). For more information about supported API endpoints, see [API endpoint](https://cloud.ibm.com/apidocs/schematics/schematics#api-endpoints).

<h3>Authorization</h3>

Schematics support generic authorization for its resources.
For more information, about Schematics access and permissions, see [Schematics service access
roles and required permissions](https://cloud.ibm.com/docs/schematics?topic=schematics-access#access-roles).

func (*SchematicsV1) ListAgentDataWithContext

func (schematics *SchematicsV1) ListAgentDataWithContext(ctx context.Context, listAgentDataOptions *ListAgentDataOptions) (result *AgentDataList, response *core.DetailedResponse, err error)

ListAgentDataWithContext is an alternate form of the ListAgentData method which supports a Context parameter

func (*SchematicsV1) ListAgentWithContext

func (schematics *SchematicsV1) ListAgentWithContext(ctx context.Context, listAgentOptions *ListAgentOptions) (result *AgentList, response *core.DetailedResponse, err error)

ListAgentWithContext is an alternate form of the ListAgent method which supports a Context parameter Deprecated: this method is deprecated and may be removed in a future release.

func (*SchematicsV1) ListInventories

func (schematics *SchematicsV1) ListInventories(listInventoriesOptions *ListInventoriesOptions) (result *InventoryResourceRecordList, response *core.DetailedResponse, err error)

ListInventories : List inventory definitions Retrieve a list of all Schematics inventories that depends on the API endpoint that you have access. For example, if you use an API endpoint for a geography, such as North America, only inventories that are created in `us-south` or `us-east` are retrieved. For more information, about supported API endpoints, see [APIendpoints](/apidocs/schematics#api-endpoints).

<h3>Authorization</h3>

Schematics support generic authorization for its resources.
For more information, about Schematics access and permissions, see
[Schematics service access roles and required

permissions](https://cloud.ibm.com/docs/schematics?topic=schematics-access#access-roles).

func (*SchematicsV1) ListInventoriesWithContext

func (schematics *SchematicsV1) ListInventoriesWithContext(ctx context.Context, listInventoriesOptions *ListInventoriesOptions) (result *InventoryResourceRecordList, response *core.DetailedResponse, err error)

ListInventoriesWithContext is an alternate form of the ListInventories method which supports a Context parameter

func (*SchematicsV1) ListJobLogs

func (schematics *SchematicsV1) ListJobLogs(listJobLogsOptions *ListJobLogsOptions) (result *JobLog, response *core.DetailedResponse, err error)

ListJobLogs : Get job logs Retrieve the job logs <h3>Authorization</h3> Schematics support generic authorization for its resources. For more information, about Schematics access and permissions, see [Schematics service access roles and required permissions](https://cloud.ibm.com/docs/schematics?topic=schematics-access#access-roles).

func (*SchematicsV1) ListJobLogsWithContext

func (schematics *SchematicsV1) ListJobLogsWithContext(ctx context.Context, listJobLogsOptions *ListJobLogsOptions) (result *JobLog, response *core.DetailedResponse, err error)

ListJobLogsWithContext is an alternate form of the ListJobLogs method which supports a Context parameter

func (*SchematicsV1) ListJobs

func (schematics *SchematicsV1) ListJobs(listJobsOptions *ListJobsOptions) (result *JobList, response *core.DetailedResponse, err error)

ListJobs : List jobs Retrieve a list of all Schematics jobs. The job displays a list of jobs with the status as `pending`, `in_progess`, `success`, or `failed`. Jobs are generated when you use the `POST /v2/jobs`, `PUT /v2/jobs/{job_id}`, or `DELETE /v2/jobs/{job_id}`.

<h3>Authorization</h3>

Schematics support generic authorization for its resources.
For more information, about Schematics access and permissions, see
[Schematics service access roles and required

permissions](https://cloud.ibm.com/docs/schematics?topic=schematics-access#access-roles).

func (*SchematicsV1) ListJobsWithContext

func (schematics *SchematicsV1) ListJobsWithContext(ctx context.Context, listJobsOptions *ListJobsOptions) (result *JobList, response *core.DetailedResponse, err error)

ListJobsWithContext is an alternate form of the ListJobs method which supports a Context parameter

func (*SchematicsV1) ListKms

func (schematics *SchematicsV1) ListKms(listKmsOptions *ListKmsOptions) (result *KMSDiscovery, response *core.DetailedResponse, err error)

ListKms : List KMS instances Lists the kms instances of your IBM Cloud account to find your Key Protect or Hyper Protect Crypto Services by using the location and encrypted scheme.

<h3>Authorization</h3>

Schematics support generic authorization for its resources.
For more information, about Schematics access and permissions, see
[Schematics service access roles and required

permissions](https://cloud.ibm.com/docs/schematics?topic=schematics-access#access-roles).

func (*SchematicsV1) ListKmsWithContext

func (schematics *SchematicsV1) ListKmsWithContext(ctx context.Context, listKmsOptions *ListKmsOptions) (result *KMSDiscovery, response *core.DetailedResponse, err error)

ListKmsWithContext is an alternate form of the ListKms method which supports a Context parameter

func (*SchematicsV1) ListLocations

func (schematics *SchematicsV1) ListLocations(listLocationsOptions *ListLocationsOptions) (result *SchematicsLocationsList, response *core.DetailedResponse, err error)

ListLocations : List supported locations Retrieve a list of IBM Cloud locations where you can work with the Schematics objects.

<h3>Authorization</h3>

Schematics support generic authorization for its resources.
For more information, about Schematics access and permissions,
see [Schematics service access roles and required

permissions](https://cloud.ibm.com/docs/schematics?topic=schematics-access#access-roles).

func (*SchematicsV1) ListLocationsWithContext

func (schematics *SchematicsV1) ListLocationsWithContext(ctx context.Context, listLocationsOptions *ListLocationsOptions) (result *SchematicsLocationsList, response *core.DetailedResponse, err error)

ListLocationsWithContext is an alternate form of the ListLocations method which supports a Context parameter

func (*SchematicsV1) ListPolicy

func (schematics *SchematicsV1) ListPolicy(listPolicyOptions *ListPolicyOptions) (result *PolicyList, response *core.DetailedResponse, err error)

ListPolicy : List policies Retrieve a list of all policies from the account that you have access. the list of policies that is returned depends on the API endpoint that you use. For example, if you use an API endpoint for a geography, such as North America, only policies that are created in `us-south` or `us-east` are returned. For more information about supported API endpoints, see [API endpoint](https://cloud.ibm.com/apidocs/schematics/schematics#api-endpoints).

<h3>Authorization</h3>

Schematics support generic authorization for its resources.
For more information, about Schematics access and permissions, see [Schematics service access
roles and required permissions](https://cloud.ibm.com/docs/schematics?topic=schematics-access#access-roles).

func (*SchematicsV1) ListPolicyWithContext

func (schematics *SchematicsV1) ListPolicyWithContext(ctx context.Context, listPolicyOptions *ListPolicyOptions) (result *PolicyList, response *core.DetailedResponse, err error)

ListPolicyWithContext is an alternate form of the ListPolicy method which supports a Context parameter

func (*SchematicsV1) ListResourceGroup

func (schematics *SchematicsV1) ListResourceGroup(listResourceGroupOptions *ListResourceGroupOptions) (result []ResourceGroupResponse, response *core.DetailedResponse, err error)

ListResourceGroup : List resource groups Retrieve a list of IBM Cloud resource groups that your account has access to.

<h3>Authorization</h3>

Schematics support generic authorization for its resources.
For more information, about Schematics access and permissions,
see [Schematics service access roles and required

permissions](https://cloud.ibm.com/docs/schematics?topic=schematics-access#access-roles).

func (*SchematicsV1) ListResourceGroupWithContext

func (schematics *SchematicsV1) ListResourceGroupWithContext(ctx context.Context, listResourceGroupOptions *ListResourceGroupOptions) (result []ResourceGroupResponse, response *core.DetailedResponse, err error)

ListResourceGroupWithContext is an alternate form of the ListResourceGroup method which supports a Context parameter

func (*SchematicsV1) ListResourceQuery

func (schematics *SchematicsV1) ListResourceQuery(listResourceQueryOptions *ListResourceQueryOptions) (result *ResourceQueryRecordList, response *core.DetailedResponse, err error)

ListResourceQuery : List resource queries Retrieve the list of resource query definitions that you have access to. The list of resource queries that is returned depends on the API endpoint that you use. For example, if you use an API endpoint for a geography, such as North America, only resource query definitions that are created in `us-south` or `us-east` are retrieved. For more information, about supported API endpoints, see [API endpoints](/apidocs/schematics#api-endpoints). <h3>Authorization</h3>

Schematics support generic authorization for its resources.
For more information, about Schematics access and permissions, see
[Schematics service access roles and required

permissions](https://cloud.ibm.com/docs/schematics?topic=schematics-access#access-roles).

func (*SchematicsV1) ListResourceQueryWithContext

func (schematics *SchematicsV1) ListResourceQueryWithContext(ctx context.Context, listResourceQueryOptions *ListResourceQueryOptions) (result *ResourceQueryRecordList, response *core.DetailedResponse, err error)

ListResourceQueryWithContext is an alternate form of the ListResourceQuery method which supports a Context parameter

func (*SchematicsV1) ListSchematicsLocation

func (schematics *SchematicsV1) ListSchematicsLocation(listSchematicsLocationOptions *ListSchematicsLocationOptions) (result []SchematicsLocations, response *core.DetailedResponse, err error)

ListSchematicsLocation : List supported schematics locations Retrieve a list of IBM Cloud locations where you can create the Schematics workspace or action. workspaces.

<h3>Authorization</h3>

Schematics support generic authorization for its resources.
For more information, about Schematics access and permissions,
see [Schematics service access roles and required

permissions](https://cloud.ibm.com/docs/schematics?topic=schematics-access#access-roles).

func (*SchematicsV1) ListSchematicsLocationWithContext

func (schematics *SchematicsV1) ListSchematicsLocationWithContext(ctx context.Context, listSchematicsLocationOptions *ListSchematicsLocationOptions) (result []SchematicsLocations, response *core.DetailedResponse, err error)

ListSchematicsLocationWithContext is an alternate form of the ListSchematicsLocation method which supports a Context parameter

func (*SchematicsV1) ListWorkspaceActivities

func (schematics *SchematicsV1) ListWorkspaceActivities(listWorkspaceActivitiesOptions *ListWorkspaceActivitiesOptions) (result *WorkspaceActivities, response *core.DetailedResponse, err error)

ListWorkspaceActivities : List workspace jobs Retrieve a list of all jobs that ran against a workspace. Jobs are generated when you use the `apply`, `plan`, `destroy`, and `refresh`, command API.

func (*SchematicsV1) ListWorkspaceActivitiesWithContext

func (schematics *SchematicsV1) ListWorkspaceActivitiesWithContext(ctx context.Context, listWorkspaceActivitiesOptions *ListWorkspaceActivitiesOptions) (result *WorkspaceActivities, response *core.DetailedResponse, err error)

ListWorkspaceActivitiesWithContext is an alternate form of the ListWorkspaceActivities method which supports a Context parameter

func (*SchematicsV1) ListWorkspaces

func (schematics *SchematicsV1) ListWorkspaces(listWorkspacesOptions *ListWorkspacesOptions) (result *WorkspaceResponseList, response *core.DetailedResponse, err error)

ListWorkspaces : List workspaces Retrieve a list of Schematics workspaces from your IBM Cloud account that you have access to. The list of workspaces that is returned depends on the API endpoint that you use. For example, if you use an API endpoint for a geography, such as North America, only workspaces that are created in `us-south` or `us-east` are returned.

For more information about supported API endpoints, see [API endpoints](/apidocs/schematics#api-endpoints).

 <h3>Authorization</h3>

 Schematics support generic authorization for its resources.
 For more information, about Schematics access and permissions,
 see [Schematics service access roles and required

permissions](https://cloud.ibm.com/docs/schematics?topic=schematics-access#access-roles).

func (*SchematicsV1) ListWorkspacesWithContext

func (schematics *SchematicsV1) ListWorkspacesWithContext(ctx context.Context, listWorkspacesOptions *ListWorkspacesOptions) (result *WorkspaceResponseList, response *core.DetailedResponse, err error)

ListWorkspacesWithContext is an alternate form of the ListWorkspaces method which supports a Context parameter

func (*SchematicsV1) NewAgent

func (*SchematicsV1) NewAgent(name string, agentLocation string, location string, profileID string) (_model *Agent, err error)

NewAgent : Instantiate Agent (Generic Model Constructor)

func (*SchematicsV1) NewAgentData

func (*SchematicsV1) NewAgentData(name string, resourceGroup string, version string, schematicsLocation string, agentLocation string, agentInfrastructure *AgentInfrastructure) (_model *AgentData, err error)

NewAgentData : Instantiate AgentData (Generic Model Constructor)

func (*SchematicsV1) NewApplyWorkspaceCommandOptions

func (*SchematicsV1) NewApplyWorkspaceCommandOptions(wID string, refreshToken string) *ApplyWorkspaceCommandOptions

NewApplyWorkspaceCommandOptions : Instantiate ApplyWorkspaceCommandOptions

func (*SchematicsV1) NewCreateActionOptions

func (*SchematicsV1) NewCreateActionOptions() *CreateActionOptions

NewCreateActionOptions : Instantiate CreateActionOptions

func (*SchematicsV1) NewCreateAgentDataOptions

func (*SchematicsV1) NewCreateAgentDataOptions(name string, resourceGroup string, version string, schematicsLocation string, agentLocation string, agentInfrastructure *AgentInfrastructure) *CreateAgentDataOptions

NewCreateAgentDataOptions : Instantiate CreateAgentDataOptions

func (*SchematicsV1) NewCreateInventoryOptions

func (*SchematicsV1) NewCreateInventoryOptions() *CreateInventoryOptions

NewCreateInventoryOptions : Instantiate CreateInventoryOptions

func (*SchematicsV1) NewCreateJobOptions

func (*SchematicsV1) NewCreateJobOptions(refreshToken string) *CreateJobOptions

NewCreateJobOptions : Instantiate CreateJobOptions

func (*SchematicsV1) NewCreatePolicyOptions

func (*SchematicsV1) NewCreatePolicyOptions() *CreatePolicyOptions

NewCreatePolicyOptions : Instantiate CreatePolicyOptions

func (*SchematicsV1) NewCreateResourceQueryOptions

func (*SchematicsV1) NewCreateResourceQueryOptions() *CreateResourceQueryOptions

NewCreateResourceQueryOptions : Instantiate CreateResourceQueryOptions

func (*SchematicsV1) NewCreateWorkspaceDeletionJobOptions

func (*SchematicsV1) NewCreateWorkspaceDeletionJobOptions(refreshToken string) *CreateWorkspaceDeletionJobOptions

NewCreateWorkspaceDeletionJobOptions : Instantiate CreateWorkspaceDeletionJobOptions

func (*SchematicsV1) NewCreateWorkspaceOptions

func (*SchematicsV1) NewCreateWorkspaceOptions() *CreateWorkspaceOptions

NewCreateWorkspaceOptions : Instantiate CreateWorkspaceOptions

func (*SchematicsV1) NewDeleteActionOptions

func (*SchematicsV1) NewDeleteActionOptions(actionID string) *DeleteActionOptions

NewDeleteActionOptions : Instantiate DeleteActionOptions

func (*SchematicsV1) NewDeleteAgentDataOptions

func (*SchematicsV1) NewDeleteAgentDataOptions(agentID string) *DeleteAgentDataOptions

NewDeleteAgentDataOptions : Instantiate DeleteAgentDataOptions

func (*SchematicsV1) NewDeleteAgentOptions

func (*SchematicsV1) NewDeleteAgentOptions(agentID string) *DeleteAgentOptions

NewDeleteAgentOptions : Instantiate DeleteAgentOptions

func (*SchematicsV1) NewDeleteAgentResourcesOptions

func (*SchematicsV1) NewDeleteAgentResourcesOptions(agentID string, refreshToken string) *DeleteAgentResourcesOptions

NewDeleteAgentResourcesOptions : Instantiate DeleteAgentResourcesOptions

func (*SchematicsV1) NewDeleteInventoryOptions

func (*SchematicsV1) NewDeleteInventoryOptions(inventoryID string) *DeleteInventoryOptions

NewDeleteInventoryOptions : Instantiate DeleteInventoryOptions

func (*SchematicsV1) NewDeleteJobOptions

func (*SchematicsV1) NewDeleteJobOptions(jobID string, refreshToken string) *DeleteJobOptions

NewDeleteJobOptions : Instantiate DeleteJobOptions

func (*SchematicsV1) NewDeletePolicyOptions

func (*SchematicsV1) NewDeletePolicyOptions(policyID string) *DeletePolicyOptions

NewDeletePolicyOptions : Instantiate DeletePolicyOptions

func (*SchematicsV1) NewDeleteResourcesQueryOptions

func (*SchematicsV1) NewDeleteResourcesQueryOptions(queryID string) *DeleteResourcesQueryOptions

NewDeleteResourcesQueryOptions : Instantiate DeleteResourcesQueryOptions

func (*SchematicsV1) NewDeleteWorkspaceActivityOptions

func (*SchematicsV1) NewDeleteWorkspaceActivityOptions(wID string, activityID string) *DeleteWorkspaceActivityOptions

NewDeleteWorkspaceActivityOptions : Instantiate DeleteWorkspaceActivityOptions

func (*SchematicsV1) NewDeleteWorkspaceOptions

func (*SchematicsV1) NewDeleteWorkspaceOptions(refreshToken string, wID string) *DeleteWorkspaceOptions

NewDeleteWorkspaceOptions : Instantiate DeleteWorkspaceOptions

func (*SchematicsV1) NewDeployAgentJobOptions

func (*SchematicsV1) NewDeployAgentJobOptions(agentID string) *DeployAgentJobOptions

NewDeployAgentJobOptions : Instantiate DeployAgentJobOptions

func (*SchematicsV1) NewDestroyWorkspaceCommandOptions

func (*SchematicsV1) NewDestroyWorkspaceCommandOptions(wID string, refreshToken string) *DestroyWorkspaceCommandOptions

NewDestroyWorkspaceCommandOptions : Instantiate DestroyWorkspaceCommandOptions

func (*SchematicsV1) NewExecuteResourceQueryOptions

func (*SchematicsV1) NewExecuteResourceQueryOptions(queryID string) *ExecuteResourceQueryOptions

NewExecuteResourceQueryOptions : Instantiate ExecuteResourceQueryOptions

func (*SchematicsV1) NewExternalSource

func (*SchematicsV1) NewExternalSource(sourceType string) (_model *ExternalSource, err error)

NewExternalSource : Instantiate ExternalSource (Generic Model Constructor)

func (*SchematicsV1) NewGetActionOptions

func (*SchematicsV1) NewGetActionOptions(actionID string) *GetActionOptions

NewGetActionOptions : Instantiate GetActionOptions

func (*SchematicsV1) NewGetAgentDataOptions

func (*SchematicsV1) NewGetAgentDataOptions(agentID string) *GetAgentDataOptions

NewGetAgentDataOptions : Instantiate GetAgentDataOptions

func (*SchematicsV1) NewGetAgentOptions

func (*SchematicsV1) NewGetAgentOptions(agentID string) *GetAgentOptions

NewGetAgentOptions : Instantiate GetAgentOptions

func (*SchematicsV1) NewGetAgentVersionsOptions

func (*SchematicsV1) NewGetAgentVersionsOptions() *GetAgentVersionsOptions

NewGetAgentVersionsOptions : Instantiate GetAgentVersionsOptions

func (*SchematicsV1) NewGetAllWorkspaceInputsOptions

func (*SchematicsV1) NewGetAllWorkspaceInputsOptions(wID string) *GetAllWorkspaceInputsOptions

NewGetAllWorkspaceInputsOptions : Instantiate GetAllWorkspaceInputsOptions

func (*SchematicsV1) NewGetDeployAgentJobOptions

func (*SchematicsV1) NewGetDeployAgentJobOptions(agentID string) *GetDeployAgentJobOptions

NewGetDeployAgentJobOptions : Instantiate GetDeployAgentJobOptions

func (*SchematicsV1) NewGetHealthCheckAgentJobOptions

func (*SchematicsV1) NewGetHealthCheckAgentJobOptions(agentID string) *GetHealthCheckAgentJobOptions

NewGetHealthCheckAgentJobOptions : Instantiate GetHealthCheckAgentJobOptions

func (*SchematicsV1) NewGetInventoryOptions

func (*SchematicsV1) NewGetInventoryOptions(inventoryID string) *GetInventoryOptions

NewGetInventoryOptions : Instantiate GetInventoryOptions

func (*SchematicsV1) NewGetJobFilesOptions

func (*SchematicsV1) NewGetJobFilesOptions(jobID string, fileType string) *GetJobFilesOptions

NewGetJobFilesOptions : Instantiate GetJobFilesOptions

func (*SchematicsV1) NewGetJobOptions

func (*SchematicsV1) NewGetJobOptions(jobID string) *GetJobOptions

NewGetJobOptions : Instantiate GetJobOptions

func (*SchematicsV1) NewGetKmsSettingsOptions

func (*SchematicsV1) NewGetKmsSettingsOptions(location string) *GetKmsSettingsOptions

NewGetKmsSettingsOptions : Instantiate GetKmsSettingsOptions

func (*SchematicsV1) NewGetPolicyOptions

func (*SchematicsV1) NewGetPolicyOptions(policyID string) *GetPolicyOptions

NewGetPolicyOptions : Instantiate GetPolicyOptions

func (*SchematicsV1) NewGetPrsAgentJobOptions

func (*SchematicsV1) NewGetPrsAgentJobOptions(agentID string) *GetPrsAgentJobOptions

NewGetPrsAgentJobOptions : Instantiate GetPrsAgentJobOptions

func (*SchematicsV1) NewGetResourcesQueryOptions

func (*SchematicsV1) NewGetResourcesQueryOptions(queryID string) *GetResourcesQueryOptions

NewGetResourcesQueryOptions : Instantiate GetResourcesQueryOptions

func (*SchematicsV1) NewGetSchematicsVersionOptions

func (*SchematicsV1) NewGetSchematicsVersionOptions() *GetSchematicsVersionOptions

NewGetSchematicsVersionOptions : Instantiate GetSchematicsVersionOptions

func (*SchematicsV1) NewGetTemplateActivityLogOptions

func (*SchematicsV1) NewGetTemplateActivityLogOptions(wID string, tID string, activityID string) *GetTemplateActivityLogOptions

NewGetTemplateActivityLogOptions : Instantiate GetTemplateActivityLogOptions

func (*SchematicsV1) NewGetTemplateLogsOptions

func (*SchematicsV1) NewGetTemplateLogsOptions(wID string, tID string) *GetTemplateLogsOptions

NewGetTemplateLogsOptions : Instantiate GetTemplateLogsOptions

func (*SchematicsV1) NewGetWorkspaceActivityLogsOptions

func (*SchematicsV1) NewGetWorkspaceActivityLogsOptions(wID string, activityID string) *GetWorkspaceActivityLogsOptions

NewGetWorkspaceActivityLogsOptions : Instantiate GetWorkspaceActivityLogsOptions

func (*SchematicsV1) NewGetWorkspaceActivityOptions

func (*SchematicsV1) NewGetWorkspaceActivityOptions(wID string, activityID string) *GetWorkspaceActivityOptions

NewGetWorkspaceActivityOptions : Instantiate GetWorkspaceActivityOptions

func (*SchematicsV1) NewGetWorkspaceDeletionJobStatusOptions

func (*SchematicsV1) NewGetWorkspaceDeletionJobStatusOptions(wjID string) *GetWorkspaceDeletionJobStatusOptions

NewGetWorkspaceDeletionJobStatusOptions : Instantiate GetWorkspaceDeletionJobStatusOptions

func (*SchematicsV1) NewGetWorkspaceInputMetadataOptions

func (*SchematicsV1) NewGetWorkspaceInputMetadataOptions(wID string, tID string) *GetWorkspaceInputMetadataOptions

NewGetWorkspaceInputMetadataOptions : Instantiate GetWorkspaceInputMetadataOptions

func (*SchematicsV1) NewGetWorkspaceInputsOptions

func (*SchematicsV1) NewGetWorkspaceInputsOptions(wID string, tID string) *GetWorkspaceInputsOptions

NewGetWorkspaceInputsOptions : Instantiate GetWorkspaceInputsOptions

func (*SchematicsV1) NewGetWorkspaceLogUrlsOptions

func (*SchematicsV1) NewGetWorkspaceLogUrlsOptions(wID string) *GetWorkspaceLogUrlsOptions

NewGetWorkspaceLogUrlsOptions : Instantiate GetWorkspaceLogUrlsOptions

func (*SchematicsV1) NewGetWorkspaceOptions

func (*SchematicsV1) NewGetWorkspaceOptions(wID string) *GetWorkspaceOptions

NewGetWorkspaceOptions : Instantiate GetWorkspaceOptions

func (*SchematicsV1) NewGetWorkspaceOutputsOptions

func (*SchematicsV1) NewGetWorkspaceOutputsOptions(wID string) *GetWorkspaceOutputsOptions

NewGetWorkspaceOutputsOptions : Instantiate GetWorkspaceOutputsOptions

func (*SchematicsV1) NewGetWorkspaceReadmeOptions

func (*SchematicsV1) NewGetWorkspaceReadmeOptions(wID string) *GetWorkspaceReadmeOptions

NewGetWorkspaceReadmeOptions : Instantiate GetWorkspaceReadmeOptions

func (*SchematicsV1) NewGetWorkspaceResourcesOptions

func (*SchematicsV1) NewGetWorkspaceResourcesOptions(wID string) *GetWorkspaceResourcesOptions

NewGetWorkspaceResourcesOptions : Instantiate GetWorkspaceResourcesOptions

func (*SchematicsV1) NewGetWorkspaceStateOptions

func (*SchematicsV1) NewGetWorkspaceStateOptions(wID string) *GetWorkspaceStateOptions

NewGetWorkspaceStateOptions : Instantiate GetWorkspaceStateOptions

func (*SchematicsV1) NewGetWorkspaceTemplateStateOptions

func (*SchematicsV1) NewGetWorkspaceTemplateStateOptions(wID string, tID string) *GetWorkspaceTemplateStateOptions

NewGetWorkspaceTemplateStateOptions : Instantiate GetWorkspaceTemplateStateOptions

func (*SchematicsV1) NewHealthCheckAgentJobOptions

func (*SchematicsV1) NewHealthCheckAgentJobOptions(agentID string) *HealthCheckAgentJobOptions

NewHealthCheckAgentJobOptions : Instantiate HealthCheckAgentJobOptions

func (*SchematicsV1) NewJobData

func (*SchematicsV1) NewJobData(jobType string) (_model *JobData, err error)

NewJobData : Instantiate JobData (Generic Model Constructor)

func (*SchematicsV1) NewListActionsOptions

func (*SchematicsV1) NewListActionsOptions() *ListActionsOptions

NewListActionsOptions : Instantiate ListActionsOptions

func (*SchematicsV1) NewListAgentDataOptions

func (*SchematicsV1) NewListAgentDataOptions() *ListAgentDataOptions

NewListAgentDataOptions : Instantiate ListAgentDataOptions

func (*SchematicsV1) NewListAgentOptions

func (*SchematicsV1) NewListAgentOptions() *ListAgentOptions

NewListAgentOptions : Instantiate ListAgentOptions

func (*SchematicsV1) NewListInventoriesOptions

func (*SchematicsV1) NewListInventoriesOptions() *ListInventoriesOptions

NewListInventoriesOptions : Instantiate ListInventoriesOptions

func (*SchematicsV1) NewListJobLogsOptions

func (*SchematicsV1) NewListJobLogsOptions(jobID string) *ListJobLogsOptions

NewListJobLogsOptions : Instantiate ListJobLogsOptions

func (*SchematicsV1) NewListJobsOptions

func (*SchematicsV1) NewListJobsOptions() *ListJobsOptions

NewListJobsOptions : Instantiate ListJobsOptions

func (*SchematicsV1) NewListKmsOptions

func (*SchematicsV1) NewListKmsOptions(encryptionScheme string, location string) *ListKmsOptions

NewListKmsOptions : Instantiate ListKmsOptions

func (*SchematicsV1) NewListLocationsOptions

func (*SchematicsV1) NewListLocationsOptions() *ListLocationsOptions

NewListLocationsOptions : Instantiate ListLocationsOptions

func (*SchematicsV1) NewListPolicyOptions

func (*SchematicsV1) NewListPolicyOptions() *ListPolicyOptions

NewListPolicyOptions : Instantiate ListPolicyOptions

func (*SchematicsV1) NewListResourceGroupOptions

func (*SchematicsV1) NewListResourceGroupOptions() *ListResourceGroupOptions

NewListResourceGroupOptions : Instantiate ListResourceGroupOptions

func (*SchematicsV1) NewListResourceQueryOptions

func (*SchematicsV1) NewListResourceQueryOptions() *ListResourceQueryOptions

NewListResourceQueryOptions : Instantiate ListResourceQueryOptions

func (*SchematicsV1) NewListSchematicsLocationOptions

func (*SchematicsV1) NewListSchematicsLocationOptions() *ListSchematicsLocationOptions

NewListSchematicsLocationOptions : Instantiate ListSchematicsLocationOptions

func (*SchematicsV1) NewListWorkspaceActivitiesOptions

func (*SchematicsV1) NewListWorkspaceActivitiesOptions(wID string) *ListWorkspaceActivitiesOptions

NewListWorkspaceActivitiesOptions : Instantiate ListWorkspaceActivitiesOptions

func (*SchematicsV1) NewListWorkspacesOptions

func (*SchematicsV1) NewListWorkspacesOptions() *ListWorkspacesOptions

NewListWorkspacesOptions : Instantiate ListWorkspacesOptions

func (*SchematicsV1) NewPlanWorkspaceCommandOptions

func (*SchematicsV1) NewPlanWorkspaceCommandOptions(wID string, refreshToken string) *PlanWorkspaceCommandOptions

NewPlanWorkspaceCommandOptions : Instantiate PlanWorkspaceCommandOptions

func (*SchematicsV1) NewProcessTemplateMetaDataOptions

func (*SchematicsV1) NewProcessTemplateMetaDataOptions(templateType string, source *ExternalSource) *ProcessTemplateMetaDataOptions

NewProcessTemplateMetaDataOptions : Instantiate ProcessTemplateMetaDataOptions

func (*SchematicsV1) NewPrsAgentJobOptions

func (*SchematicsV1) NewPrsAgentJobOptions(agentID string) *PrsAgentJobOptions

NewPrsAgentJobOptions : Instantiate PrsAgentJobOptions

func (*SchematicsV1) NewRefreshWorkspaceCommandOptions

func (*SchematicsV1) NewRefreshWorkspaceCommandOptions(wID string, refreshToken string) *RefreshWorkspaceCommandOptions

NewRefreshWorkspaceCommandOptions : Instantiate RefreshWorkspaceCommandOptions

func (*SchematicsV1) NewRegisterAgentOptions

func (*SchematicsV1) NewRegisterAgentOptions(name string, agentLocation string, location string, profileID string) *RegisterAgentOptions

NewRegisterAgentOptions : Instantiate RegisterAgentOptions

func (*SchematicsV1) NewReplaceInventoryOptions

func (*SchematicsV1) NewReplaceInventoryOptions(inventoryID string) *ReplaceInventoryOptions

NewReplaceInventoryOptions : Instantiate ReplaceInventoryOptions

func (*SchematicsV1) NewReplaceResourcesQueryOptions

func (*SchematicsV1) NewReplaceResourcesQueryOptions(queryID string) *ReplaceResourcesQueryOptions

NewReplaceResourcesQueryOptions : Instantiate ReplaceResourcesQueryOptions

func (*SchematicsV1) NewReplaceWorkspaceInputsOptions

func (*SchematicsV1) NewReplaceWorkspaceInputsOptions(wID string, tID string) *ReplaceWorkspaceInputsOptions

NewReplaceWorkspaceInputsOptions : Instantiate ReplaceWorkspaceInputsOptions

func (*SchematicsV1) NewReplaceWorkspaceOptions

func (*SchematicsV1) NewReplaceWorkspaceOptions(wID string) *ReplaceWorkspaceOptions

NewReplaceWorkspaceOptions : Instantiate ReplaceWorkspaceOptions

func (*SchematicsV1) NewRunWorkspaceCommandsOptions

func (*SchematicsV1) NewRunWorkspaceCommandsOptions(wID string, refreshToken string) *RunWorkspaceCommandsOptions

NewRunWorkspaceCommandsOptions : Instantiate RunWorkspaceCommandsOptions

func (*SchematicsV1) NewTemplateRepoUploadOptions

func (*SchematicsV1) NewTemplateRepoUploadOptions(wID string, tID string) *TemplateRepoUploadOptions

NewTemplateRepoUploadOptions : Instantiate TemplateRepoUploadOptions

func (*SchematicsV1) NewUpdateActionOptions

func (*SchematicsV1) NewUpdateActionOptions(actionID string) *UpdateActionOptions

NewUpdateActionOptions : Instantiate UpdateActionOptions

func (*SchematicsV1) NewUpdateAgentDataOptions

func (*SchematicsV1) NewUpdateAgentDataOptions(agentID string, name string, resourceGroup string, version string, schematicsLocation string, agentLocation string, agentInfrastructure *AgentInfrastructure) *UpdateAgentDataOptions

NewUpdateAgentDataOptions : Instantiate UpdateAgentDataOptions

func (*SchematicsV1) NewUpdateAgentRegistrationOptions

func (*SchematicsV1) NewUpdateAgentRegistrationOptions(agentID string, name string, agentLocation string, location string, profileID string) *UpdateAgentRegistrationOptions

NewUpdateAgentRegistrationOptions : Instantiate UpdateAgentRegistrationOptions

func (*SchematicsV1) NewUpdateJobOptions

func (*SchematicsV1) NewUpdateJobOptions(jobID string, refreshToken string) *UpdateJobOptions

NewUpdateJobOptions : Instantiate UpdateJobOptions

func (*SchematicsV1) NewUpdateKmsSettingsOptions

func (*SchematicsV1) NewUpdateKmsSettingsOptions() *UpdateKmsSettingsOptions

NewUpdateKmsSettingsOptions : Instantiate UpdateKmsSettingsOptions

func (*SchematicsV1) NewUpdatePolicyOptions

func (*SchematicsV1) NewUpdatePolicyOptions(policyID string) *UpdatePolicyOptions

NewUpdatePolicyOptions : Instantiate UpdatePolicyOptions

func (*SchematicsV1) NewUpdateWorkspaceOptions

func (*SchematicsV1) NewUpdateWorkspaceOptions(wID string) *UpdateWorkspaceOptions

NewUpdateWorkspaceOptions : Instantiate UpdateWorkspaceOptions

func (*SchematicsV1) NewUploadTemplateTarActionOptions

func (*SchematicsV1) NewUploadTemplateTarActionOptions(actionID string) *UploadTemplateTarActionOptions

NewUploadTemplateTarActionOptions : Instantiate UploadTemplateTarActionOptions

func (*SchematicsV1) PlanWorkspaceCommand

func (schematics *SchematicsV1) PlanWorkspaceCommand(planWorkspaceCommandOptions *PlanWorkspaceCommandOptions) (result *WorkspaceActivityPlanResult, response *core.DetailedResponse, err error)

PlanWorkspaceCommand : Perform a Schematics `plan` job Run a Schematics `plan` job against your workspace. The `plan` job creates a summary of IBM Cloud resources that must be created, modified, or deleted to achieve the state that is described in the Terraform or IBM Cloud catalog template that your workspace points to. During this time, you cannot make changes to your workspace. You can use the summary to verify your changes before you apply the template in IBM Cloud.

**Important**: Your workspace must be in an `Inactive`, `Active`, `Failed`, or `Stopped` state to perform a

Schematics `plan` job.

**Note**: This API returns an activity or job ID that you use to retrieve the URL to the log file with the `GET

/v1/workspaces/{id}/actions/{action_id}/logs` API.

<h3>Authorization</h3>

Schematics support generic authorization for its resources.
For more information, about Schematics access and permissions,
see [Schematics service access roles and required

permissions](https://cloud.ibm.com/docs/schematics?topic=schematics-access#access-roles).

func (*SchematicsV1) PlanWorkspaceCommandWithContext

func (schematics *SchematicsV1) PlanWorkspaceCommandWithContext(ctx context.Context, planWorkspaceCommandOptions *PlanWorkspaceCommandOptions) (result *WorkspaceActivityPlanResult, response *core.DetailedResponse, err error)

PlanWorkspaceCommandWithContext is an alternate form of the PlanWorkspaceCommand method which supports a Context parameter

func (*SchematicsV1) ProcessTemplateMetaData

func (schematics *SchematicsV1) ProcessTemplateMetaData(processTemplateMetaDataOptions *ProcessTemplateMetaDataOptions) (result *TemplateMetaDataResponse, response *core.DetailedResponse, err error)

ProcessTemplateMetaData : Get variable metadata by parsing the template Get the variable metadata from the template. This metadata can be passed in the payload during Schematics workspace create or update API call.

<h3>Authorization</h3>

Schematics support generic authorization for its resources.
For more information, about Schematics access and permissions, see
[Schematics service access roles and required

permissions](https://cloud.ibm.com/docs/schematics?topic=schematics-access#access-roles).

func (*SchematicsV1) ProcessTemplateMetaDataWithContext

func (schematics *SchematicsV1) ProcessTemplateMetaDataWithContext(ctx context.Context, processTemplateMetaDataOptions *ProcessTemplateMetaDataOptions) (result *TemplateMetaDataResponse, response *core.DetailedResponse, err error)

ProcessTemplateMetaDataWithContext is an alternate form of the ProcessTemplateMetaData method which supports a Context parameter

func (*SchematicsV1) PrsAgentJob

func (schematics *SchematicsV1) PrsAgentJob(prsAgentJobOptions *PrsAgentJobOptions) (result *AgentPRSJob, response *core.DetailedResponse, err error)

PrsAgentJob : Run pre-requisite scanner job Use run pre-requisite scanner job API before deploying an agent. The API results the agent `prs` job updation time with the E-mail address and the status in a string format. For more information about supported API endpoints, see [API endpoint](/apidocs/schematics/schematics#api-endpoints). <h3>Authorization</h3> Schematics support generic authorization for its resources. For more information, about Schematics access and permissions, see [Schematics service access

roles and required permissions](https://cloud.ibm.com/docs/schematics?topic=schematics-access#access-roles).

func (*SchematicsV1) PrsAgentJobWithContext

func (schematics *SchematicsV1) PrsAgentJobWithContext(ctx context.Context, prsAgentJobOptions *PrsAgentJobOptions) (result *AgentPRSJob, response *core.DetailedResponse, err error)

PrsAgentJobWithContext is an alternate form of the PrsAgentJob method which supports a Context parameter

func (*SchematicsV1) RefreshWorkspaceCommand

func (schematics *SchematicsV1) RefreshWorkspaceCommand(refreshWorkspaceCommandOptions *RefreshWorkspaceCommandOptions) (result *WorkspaceActivityRefreshResult, response *core.DetailedResponse, err error)

RefreshWorkspaceCommand : Perform a Schematics `refresh` job Run a Schematics `refresh` job against your workspace. A `refresh` job validates the IBM Cloud resources in your account against the state that is stored in the Terraform statefile of your workspace. If differences are found, the Terraform statefile is updated accordingly. This API returns an activity or job ID that you use to retrieve the URL to the log file with the `GET /v1/workspaces/{id}/actions/{action_id}/logs` API.

<h3>Authorization</h3>

Schematics support generic authorization for its resources.
For more information, about Schematics access and permissions,
see [Schematics service access roles and required

permissions](https://cloud.ibm.com/docs/schematics?topic=schematics-access#access-roles).

func (*SchematicsV1) RefreshWorkspaceCommandWithContext

func (schematics *SchematicsV1) RefreshWorkspaceCommandWithContext(ctx context.Context, refreshWorkspaceCommandOptions *RefreshWorkspaceCommandOptions) (result *WorkspaceActivityRefreshResult, response *core.DetailedResponse, err error)

RefreshWorkspaceCommandWithContext is an alternate form of the RefreshWorkspaceCommand method which supports a Context parameter

func (*SchematicsV1) RegisterAgent

func (schematics *SchematicsV1) RegisterAgent(registerAgentOptions *RegisterAgentOptions) (result *Agent, response *core.DetailedResponse, err error)

RegisterAgent : Register the agent with schematics Register the agent with schematics

<h3>Authorization</h3>

Schematics support generic authorization for its resources.
For more information, about Schematics access and permissions, see [Schematics service access
roles and required permissions](https://cloud.ibm.com/docs/schematics?topic=schematics-access#access-roles).

Deprecated: this method is deprecated and may be removed in a future release.

func (*SchematicsV1) RegisterAgentWithContext

func (schematics *SchematicsV1) RegisterAgentWithContext(ctx context.Context, registerAgentOptions *RegisterAgentOptions) (result *Agent, response *core.DetailedResponse, err error)

RegisterAgentWithContext is an alternate form of the RegisterAgent method which supports a Context parameter Deprecated: this method is deprecated and may be removed in a future release.

func (*SchematicsV1) ReplaceInventory

func (schematics *SchematicsV1) ReplaceInventory(replaceInventoryOptions *ReplaceInventoryOptions) (result *InventoryResourceRecord, response *core.DetailedResponse, err error)

ReplaceInventory : Update an inventory definition Use this API to update the inventory definition resource used to target an action. For more information, about inventory update, refer to [ibmcloud schematics inventory update](https://cloud.ibm.com/docs/schematics?topic=schematics-schematics-cli-reference#schematics-update-inv).

**Note** you cannot update the location and region, resource group once an action is created.
Also, make sure your IP addresses are in the

[allowlist](https://cloud.ibm.com/docs/schematics?topic=schematics-allowed-ipaddresses).

<h3>Authorization</h3>

Schematics support generic authorization for its resources.
For more information, about Schematics access and permissions, see
[Schematics service access roles and required

permissions](https://cloud.ibm.com/docs/schematics?topic=schematics-access#access-roles).

func (*SchematicsV1) ReplaceInventoryWithContext

func (schematics *SchematicsV1) ReplaceInventoryWithContext(ctx context.Context, replaceInventoryOptions *ReplaceInventoryOptions) (result *InventoryResourceRecord, response *core.DetailedResponse, err error)

ReplaceInventoryWithContext is an alternate form of the ReplaceInventory method which supports a Context parameter

func (*SchematicsV1) ReplaceResourcesQuery

func (schematics *SchematicsV1) ReplaceResourcesQuery(replaceResourcesQueryOptions *ReplaceResourcesQueryOptions) (result *ResourceQueryRecord, response *core.DetailedResponse, err error)

ReplaceResourcesQuery : Update resources query definition Use this API to update the resource query definition used to build the dynamic inventory for the Schematics Action. For more information, about resource query commands, refer to [ibmcloud schematics resource query update](https://cloud.ibm.com/docs/schematics?topic=schematics-schematics-cli-reference#schematics-update-rq). **Note** you cannot update the location and region, resource group once a resource query is created. Also, make sure your IP addresses are in the [allowlist](https://cloud.ibm.com/docs/schematics?topic=schematics-allowed-ipaddresses). <h3>Authorization</h3>

Schematics support generic authorization for its resources.
For more information, about Schematics access and permissions, see
[Schematics service access roles and required

permissions](https://cloud.ibm.com/docs/schematics?topic=schematics-access#access-roles).

func (*SchematicsV1) ReplaceResourcesQueryWithContext

func (schematics *SchematicsV1) ReplaceResourcesQueryWithContext(ctx context.Context, replaceResourcesQueryOptions *ReplaceResourcesQueryOptions) (result *ResourceQueryRecord, response *core.DetailedResponse, err error)

ReplaceResourcesQueryWithContext is an alternate form of the ReplaceResourcesQuery method which supports a Context parameter

func (*SchematicsV1) ReplaceWorkspace

func (schematics *SchematicsV1) ReplaceWorkspace(replaceWorkspaceOptions *ReplaceWorkspaceOptions) (result *WorkspaceResponse, response *core.DetailedResponse, err error)

ReplaceWorkspace : Update workspace Use this API to update or replace the entire workspace, including the Terraform template (`template_repo`) or IBM Cloud catalog software template (`catalog_ref`) that your workspace points to.

**Tip**:- If you want to update workspace metadata, use the `PATCH /v1/workspaces/{id}` API.
To update workspace variables, use the `PUT /v1/workspaces/{id}/template_data/{template_id}/values` API.

<h3>Authorization</h3>

Schematics support generic authorization for its resources.
For more information, about Schematics access and permissions,
see [Schematics service access roles and required

permissions](https://cloud.ibm.com/docs/schematics?topic=schematics-access#access-roles).

func (*SchematicsV1) ReplaceWorkspaceInputs

func (schematics *SchematicsV1) ReplaceWorkspaceInputs(replaceWorkspaceInputsOptions *ReplaceWorkspaceInputsOptions) (result *UserValues, response *core.DetailedResponse, err error)

ReplaceWorkspaceInputs : Replace workspace input variables Replace or Update the input variables for the template that your workspace points to.

func (*SchematicsV1) ReplaceWorkspaceInputsWithContext

func (schematics *SchematicsV1) ReplaceWorkspaceInputsWithContext(ctx context.Context, replaceWorkspaceInputsOptions *ReplaceWorkspaceInputsOptions) (result *UserValues, response *core.DetailedResponse, err error)

ReplaceWorkspaceInputsWithContext is an alternate form of the ReplaceWorkspaceInputs method which supports a Context parameter

func (*SchematicsV1) ReplaceWorkspaceWithContext

func (schematics *SchematicsV1) ReplaceWorkspaceWithContext(ctx context.Context, replaceWorkspaceOptions *ReplaceWorkspaceOptions) (result *WorkspaceResponse, response *core.DetailedResponse, err error)

ReplaceWorkspaceWithContext is an alternate form of the ReplaceWorkspace method which supports a Context parameter

func (*SchematicsV1) RunWorkspaceCommands

func (schematics *SchematicsV1) RunWorkspaceCommands(runWorkspaceCommandsOptions *RunWorkspaceCommandsOptions) (result *WorkspaceActivityCommandResult, response *core.DetailedResponse, err error)

RunWorkspaceCommands : Run Terraform Commands Run Terraform state commands to modify the workspace state file, by using the IBM Cloud Schematics API.

<h3>Authorization</h3>

Schematics support generic authorization for its resources.
For more information, about Schematics access and permissions,
see [Schematics service access roles and required

permissions](https://cloud.ibm.com/docs/schematics?topic=schematics-access#access-roles).

func (*SchematicsV1) RunWorkspaceCommandsWithContext

func (schematics *SchematicsV1) RunWorkspaceCommandsWithContext(ctx context.Context, runWorkspaceCommandsOptions *RunWorkspaceCommandsOptions) (result *WorkspaceActivityCommandResult, response *core.DetailedResponse, err error)

RunWorkspaceCommandsWithContext is an alternate form of the RunWorkspaceCommands method which supports a Context parameter

func (*SchematicsV1) SetDefaultHeaders

func (schematics *SchematicsV1) SetDefaultHeaders(headers http.Header)

SetDefaultHeaders sets HTTP headers to be sent in every request

func (*SchematicsV1) SetEnableGzipCompression

func (schematics *SchematicsV1) SetEnableGzipCompression(enableGzip bool)

SetEnableGzipCompression sets the service's EnableGzipCompression field

func (*SchematicsV1) SetServiceURL

func (schematics *SchematicsV1) SetServiceURL(url string) error

SetServiceURL sets the service URL

func (*SchematicsV1) TemplateRepoUpload

func (schematics *SchematicsV1) TemplateRepoUpload(templateRepoUploadOptions *TemplateRepoUploadOptions) (result *TemplateRepoTarUploadResponse, response *core.DetailedResponse, err error)

TemplateRepoUpload : Upload a TAR file to your workspace Provide your Terraform template by uploading a TAR file from your local machine. Before you use this API, you must create a workspace without a link to a GitHub or GitLab repository with the `POST /v1/workspaces` API.

<h3>Authorization</h3>

Schematics support generic authorization for its resources.
For more information, about Schematics access and permissions,
see [Schematics service access roles and required

permissions](https://cloud.ibm.com/docs/schematics?topic=schematics-access#access-roles).

func (*SchematicsV1) TemplateRepoUploadWithContext

func (schematics *SchematicsV1) TemplateRepoUploadWithContext(ctx context.Context, templateRepoUploadOptions *TemplateRepoUploadOptions) (result *TemplateRepoTarUploadResponse, response *core.DetailedResponse, err error)

TemplateRepoUploadWithContext is an alternate form of the TemplateRepoUpload method which supports a Context parameter

func (*SchematicsV1) UpdateAction

func (schematics *SchematicsV1) UpdateAction(updateActionOptions *UpdateActionOptions) (result *Action, response *core.DetailedResponse, err error)

UpdateAction : Update an action Update or replace an action to change the action state from the critical state to normal state, or pending state to the normal state for a successful execution. For more information, about the Schematics action state, see [Schematics action state diagram](https://cloud.ibm.com/docs/schematics?topic=schematics-action-setup#action-state-diagram).

The Schematics action API now supports bastion host connection with `non-root` user, and bastion connection type is

marked as optional, when inventory connection type is set as [Windows Remote Management](https://www.ibm.com/docs/en/license-metric-tool?topic=v-configuring-winrm-hyper-hosts)(`winrm`).

**Note** you cannot update the location and region once an action is created. Also, make sure your IP addresses are

in the [allowlist](https://cloud.ibm.com/docs/schematics?topic=schematics-allowed-ipaddresses].

<h3>Authorization</h3>

Schematics support generic authorization for its resources.
For more information, about Schematics access and permissions, see
[Schematics service access roles and required

permissions](https://cloud.ibm.com/docs/schematics?topic=schematics-access#access-roles).

func (*SchematicsV1) UpdateActionWithContext

func (schematics *SchematicsV1) UpdateActionWithContext(ctx context.Context, updateActionOptions *UpdateActionOptions) (result *Action, response *core.DetailedResponse, err error)

UpdateActionWithContext is an alternate form of the UpdateAction method which supports a Context parameter

func (*SchematicsV1) UpdateAgentData

func (schematics *SchematicsV1) UpdateAgentData(updateAgentDataOptions *UpdateAgentDataOptions) (result *AgentData, response *core.DetailedResponse, err error)

UpdateAgentData : Update agent Use update agent API to update or replace the entire agent. For more information about steps to apply `UPDATE` and `PUT` command, see [Deploying agent](https://cloud.ibm.com/docs/schematics?topic=schematics-deploy-agent-overview&interface=api). For more information about supported API endpoints, see [API endpoint](https://cloud.ibm.com/apidocs/schematics/schematics#api-endpoints).

<h3>Authorization</h3>

Schematics support generic authorization for its resources.
For more information, about Schematics access and permissions, see [Schematics service access
roles and required permissions](https://cloud.ibm.com/docs/schematics?topic=schematics-access#access-roles).

func (*SchematicsV1) UpdateAgentDataWithContext

func (schematics *SchematicsV1) UpdateAgentDataWithContext(ctx context.Context, updateAgentDataOptions *UpdateAgentDataOptions) (result *AgentData, response *core.DetailedResponse, err error)

UpdateAgentDataWithContext is an alternate form of the UpdateAgentData method which supports a Context parameter

func (*SchematicsV1) UpdateAgentRegistration

func (schematics *SchematicsV1) UpdateAgentRegistration(updateAgentRegistrationOptions *UpdateAgentRegistrationOptions) (result *Agent, response *core.DetailedResponse, err error)

UpdateAgentRegistration : Update the agent registration Update the agent registeration.

<h3>Authorization</h3>

Schematics support generic authorization for its resources.
For more information, about Schematics access and permissions, see [Schematics service access
roles and required permissions](https://cloud.ibm.com/docs/schematics?topic=schematics-access#access-roles).

Deprecated: this method is deprecated and may be removed in a future release.

func (*SchematicsV1) UpdateAgentRegistrationWithContext

func (schematics *SchematicsV1) UpdateAgentRegistrationWithContext(ctx context.Context, updateAgentRegistrationOptions *UpdateAgentRegistrationOptions) (result *Agent, response *core.DetailedResponse, err error)

UpdateAgentRegistrationWithContext is an alternate form of the UpdateAgentRegistration method which supports a Context parameter Deprecated: this method is deprecated and may be removed in a future release.

func (*SchematicsV1) UpdateJob

func (schematics *SchematicsV1) UpdateJob(updateJobOptions *UpdateJobOptions) (result *Job, response *core.DetailedResponse, err error)

UpdateJob : Update a job Creates a copy of the Schematics job and relaunches an existing job by updating the information of an existing Schematics job.

<h3>Authorization</h3>

Schematics support generic authorization for its resources.
For more information, about Schematics access and permissions, see
[Schematics service access roles and required

permissions](https://cloud.ibm.com/docs/schematics?topic=schematics-access#access-roles).

func (*SchematicsV1) UpdateJobWithContext

func (schematics *SchematicsV1) UpdateJobWithContext(ctx context.Context, updateJobOptions *UpdateJobOptions) (result *Job, response *core.DetailedResponse, err error)

UpdateJobWithContext is an alternate form of the UpdateJob method which supports a Context parameter

func (*SchematicsV1) UpdateKmsSettings

func (schematics *SchematicsV1) UpdateKmsSettings(updateKmsSettingsOptions *UpdateKmsSettingsOptions) (result *KMSSettings, response *core.DetailedResponse, err error)

UpdateKmsSettings : Update a KMS settings Replace or Update kms settings for a given location can be updated. **Note** you can update the kms settings only once. For example, if you use an API endpoint for a geography, such as North America, only kms settings for that region can be retrieved. <h3>Authorization</h3>

Schematics support generic authorization for its resources.
For more information, about Schematics access and permissions, see
[Schematics service access roles and required

permissions](https://cloud.ibm.com/docs/schematics?topic=schematics-access#access-roles).

func (*SchematicsV1) UpdateKmsSettingsWithContext

func (schematics *SchematicsV1) UpdateKmsSettingsWithContext(ctx context.Context, updateKmsSettingsOptions *UpdateKmsSettingsOptions) (result *KMSSettings, response *core.DetailedResponse, err error)

UpdateKmsSettingsWithContext is an alternate form of the UpdateKmsSettings method which supports a Context parameter

func (*SchematicsV1) UpdatePolicy

func (schematics *SchematicsV1) UpdatePolicy(updatePolicyOptions *UpdatePolicyOptions) (result *Policy, response *core.DetailedResponse, err error)

UpdatePolicy : Update policy Use update policy API to update or replace the policy details by using policy ID. For more information about supported API endpoints, see [API endpoint](https://cloud.ibm.com/apidocs/schematics/schematics#api-endpoints). Follow the [steps](https://cloud.ibm.com/docs/schematics?topic=schematics-setup-api#cs_api) to retrieve your IAM access token and authenticate with IBM Cloud Schematics by using the API. For more information about frequently asked questions, see [FAQ](https://cloud.ibm.com/docs/schematics?topic=schematics-faqs-agent) and [Troubleshooting guide](https://cloud.ibm.com/docs/schematics?topic=schematics-agent-crn-not-found).

<h3>Authorization</h3>

Schematics support generic authorization for its resources.
For more information, about Schematics access and permissions, see [Schematics service access
roles and required permissions](https://cloud.ibm.com/docs/schematics?topic=schematics-access#access-roles).

func (*SchematicsV1) UpdatePolicyWithContext

func (schematics *SchematicsV1) UpdatePolicyWithContext(ctx context.Context, updatePolicyOptions *UpdatePolicyOptions) (result *Policy, response *core.DetailedResponse, err error)

UpdatePolicyWithContext is an alternate form of the UpdatePolicy method which supports a Context parameter

func (*SchematicsV1) UpdateWorkspace

func (schematics *SchematicsV1) UpdateWorkspace(updateWorkspaceOptions *UpdateWorkspaceOptions) (result *WorkspaceResponse, response *core.DetailedResponse, err error)

UpdateWorkspace : Update workspace metadata Use this API to update the following workspace metadata:

• Workspace name (`name`) - **Note**: Updating the workspace name does not update the ID of the workspace.

• Workspace description (`description`)

• Tags (`tags[]`)

• Resource group (`resource_group`)

• Workspace status (`workspace_status.frozen`)

  **Tip**: If you want to update information about the Terraform template or IBM Cloud catalog software template that your workspace points to, use the `PUT /v1/workspaces/{id}` API. To update workspace variables, use the `PUT /v1/workspaces/{id}/template_data/{template_id}/values` API.

  <h3>Authorization</h3>

  Schematics support generic authorization for its resources. For more information, about Schematics access and permissions, see [Schematics service access roles and required

permissions](https://cloud.ibm.com/docs/schematics?topic=schematics-access#access-roles).

func (*SchematicsV1) UpdateWorkspaceWithContext

func (schematics *SchematicsV1) UpdateWorkspaceWithContext(ctx context.Context, updateWorkspaceOptions *UpdateWorkspaceOptions) (result *WorkspaceResponse, response *core.DetailedResponse, err error)

UpdateWorkspaceWithContext is an alternate form of the UpdateWorkspace method which supports a Context parameter

func (*SchematicsV1) UploadTemplateTarAction

func (schematics *SchematicsV1) UploadTemplateTarAction(uploadTemplateTarActionOptions *UploadTemplateTarActionOptions) (result *TemplateRepoTarUploadResponse, response *core.DetailedResponse, err error)

UploadTemplateTarAction : Upload a TAR file to an action Update your template by uploading tape archive file (.tar) file from your local machine. Before you use this API, you must create an action without a link to a GitHub or GitLab repository with the `POST /v2/actions` API.

<h3>Authorization</h3>

Schematics support generic authorization for its resources.
For more information, about Schematics access and permissions,
see [Schematics service access roles and required

permissions](/docs/schematics?topic=schematics-access#action-permissions).

func (*SchematicsV1) UploadTemplateTarActionWithContext

func (schematics *SchematicsV1) UploadTemplateTarActionWithContext(ctx context.Context, uploadTemplateTarActionOptions *UploadTemplateTarActionOptions) (result *TemplateRepoTarUploadResponse, response *core.DetailedResponse, err error)

UploadTemplateTarActionWithContext is an alternate form of the UploadTemplateTarAction method which supports a Context parameter

type SchematicsV1Options

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

SchematicsV1Options : Service options

type ScopedResource

type ScopedResource struct {
	// Name of the Schematics automation resource.
	Kind *string `json:"kind,omitempty"`

	// Schematics resource Id.
	ID *string `json:"id,omitempty"`
}

ScopedResource : scoped Schematics resource.

type ServiceExtensions

type ServiceExtensions struct {
	// Name of the Service Data.
	Name *string `json:"name,omitempty"`

	// Values of service data.
	Value interface{} `json:"value,omitempty"`

	// Type of the value string, int, bool.
	Type *string `json:"type,omitempty"`
}

ServiceExtensions : Service Extensions.

type SharedTargetData

type SharedTargetData struct {
	// Cluster created on.
	ClusterCreatedOn *string `json:"cluster_created_on,omitempty"`

	// The ID of the cluster where you want to provision the resources of all IBM Cloud catalog templates that are included
	// in the catalog offering.
	ClusterID *string `json:"cluster_id,omitempty"`

	// The cluster name.
	ClusterName *string `json:"cluster_name,omitempty"`

	// The cluster type.
	ClusterType *string `json:"cluster_type,omitempty"`

	// The entitlement key that you want to use to install IBM Cloud entitled software.
	EntitlementKeys []map[string]interface{} `json:"entitlement_keys,omitempty"`

	// The Kubernetes namespace or OpenShift project where the resources of all IBM Cloud catalog templates that are
	// included in the catalog offering are deployed into.
	Namespace *string `json:"namespace,omitempty"`

	// The IBM Cloud region that you want to use for the resources of all IBM Cloud catalog templates that are included in
	// the catalog offering.
	Region *string `json:"region,omitempty"`

	// The ID of the resource group that you want to use for the resources of all IBM Cloud catalog templates that are
	// included in the catalog offering.
	ResourceGroupID *string `json:"resource_group_id,omitempty"`

	// The cluster worker count.
	WorkerCount *int64 `json:"worker_count,omitempty"`

	// The cluster worker type.
	WorkerMachineType *string `json:"worker_machine_type,omitempty"`
}

SharedTargetData : Information about the Target used by the templates originating from the IBM Cloud catalog offerings. This information is not relevant for workspace created using your own Terraform template.

type SharedTargetDataResponse

type SharedTargetDataResponse struct {
	// The ID of the cluster where you want to provision the resources of all IBM Cloud catalog templates that are included
	// in the catalog offering.
	ClusterID *string `json:"cluster_id,omitempty"`

	// Target cluster name.
	ClusterName *string `json:"cluster_name,omitempty"`

	// The entitlement key that you want to use to install IBM Cloud entitled software.
	EntitlementKeys []map[string]interface{} `json:"entitlement_keys,omitempty"`

	// The Kubernetes namespace or OpenShift project where the resources of all IBM Cloud catalog templates that are
	// included in the catalog offering are deployed into.
	Namespace *string `json:"namespace,omitempty"`

	// The IBM Cloud region that you want to use for the resources of all IBM Cloud catalog templates that are included in
	// the catalog offering.
	Region *string `json:"region,omitempty"`

	// The ID of the resource group that you want to use for the resources of all IBM Cloud catalog templates that are
	// included in the catalog offering.
	ResourceGroupID *string `json:"resource_group_id,omitempty"`
}

SharedTargetDataResponse : Information about the Target used by the templates originating from IBM Cloud catalog offerings. This information is not relevant when you create a workspace from your own Terraform template.

type StateStoreResponse

type StateStoreResponse struct {
	// The provisioning engine that was used to apply the Terraform template or IBM Cloud catalog software template.
	EngineName *string `json:"engine_name,omitempty"`

	// The version of the provisioning engine that was used.
	EngineVersion *string `json:"engine_version,omitempty"`

	// The ID that was assigned to your Terraform template or IBM Cloud catalog software template.
	ID *string `json:"id,omitempty"`

	// The URL where the Terraform statefile (`terraform.tfstate`) is stored. You can use the statefile to find an overview
	// of IBM Cloud resources that were created by Schematics. Schematics uses the statefile as an inventory list to
	// determine future create, update, or deletion jobs.
	StateStoreURL *string `json:"state_store_url,omitempty"`
}

StateStoreResponse : Information about workspace runtime data.

type StateStoreResponseList

type StateStoreResponseList struct {
	// Information about workspace runtime data.
	RuntimeData []StateStoreResponse `json:"runtime_data,omitempty"`
}

StateStoreResponseList : Information about the Terraform statefile URL.

type SystemLock

type SystemLock struct {
	// Is the automation locked by a Schematic job ?.
	SysLocked *bool `json:"sys_locked,omitempty"`

	// Name of the User who performed the job, that lead to the locking of the automation.
	SysLockedBy *string `json:"sys_locked_by,omitempty"`

	// When the User performed the job that lead to locking of the automation ?.
	SysLockedAt *strfmt.DateTime `json:"sys_locked_at,omitempty"`
}

SystemLock : System lock status.

type TemplateMetaDataResponse

type TemplateMetaDataResponse struct {
	// The template type such as **terraform**, **ansible**, **helm**, **cloudpak**, or **bash script**.
	Type *string `json:"type,omitempty"`

	// List of variables and its metadata.
	Variables []VariableData `json:"variables" validate:"required"`
}

TemplateMetaDataResponse : Template metadata response.

type TemplateReadme

type TemplateReadme struct {
	// The `README.md` file for the template used by the workspace.
	Readme *string `json:"readme,omitempty"`
}

TemplateReadme : The `README.md` file for the template used by the workspace.

type TemplateRepoRequest

type TemplateRepoRequest struct {
	// The repository branch.
	Branch *string `json:"branch,omitempty"`

	// The repository release.
	Release *string `json:"release,omitempty"`

	// The repository SHA value.
	RepoShaValue *string `json:"repo_sha_value,omitempty"`

	// The repository URL.
	RepoURL *string `json:"repo_url,omitempty"`

	// The source URL.
	URL *string `json:"url,omitempty"`

	// Set this variable to checkout git sub-modules.
	SkipSubmodulesCheckout *bool `json:"skip_submodules_checkout,omitempty"`
}

TemplateRepoRequest : Input variables for the Template repoository, while creating a workspace.

type TemplateRepoResponse

type TemplateRepoResponse struct {
	// The repository branch.
	Branch *string `json:"branch,omitempty"`

	// Full repository URL.
	FullURL *string `json:"full_url,omitempty"`

	// Has uploaded Git repository tar.
	HasUploadedgitrepotar *bool `json:"has_uploadedgitrepotar,omitempty"`

	// The repository release.
	Release *string `json:"release,omitempty"`

	// The repository SHA value.
	RepoShaValue *string `json:"repo_sha_value,omitempty"`

	// The repository URL. For more information, about using `.netrc` in `env_values`, see [Usage of private module
	// template](https://cloud.ibm.com/docs/schematics?topic=schematics-download-modules-pvt-git).
	RepoURL *string `json:"repo_url,omitempty"`

	// The source URL.
	URL *string `json:"url,omitempty"`

	// Set this variable to checkout git sub-modules.
	SkipSubmodulesCheckout *bool `json:"skip_submodules_checkout,omitempty"`
}

TemplateRepoResponse : Information about the Template repository used by the workspace.

type TemplateRepoTarUploadResponse

type TemplateRepoTarUploadResponse struct {
	// Tar file value.
	FileValue *string `json:"file_value,omitempty"`

	// Has received tar file?.
	HasReceivedFile *bool `json:"has_received_file,omitempty"`

	// Template ID.
	ID *string `json:"id,omitempty"`
}

TemplateRepoTarUploadResponse : Response after uploading Template in tar file format.

type TemplateRepoUpdateRequest

type TemplateRepoUpdateRequest struct {
	// The repository branch.
	Branch *string `json:"branch,omitempty"`

	// The repository release.
	Release *string `json:"release,omitempty"`

	// The repository SHA value.
	RepoShaValue *string `json:"repo_sha_value,omitempty"`

	// The repository URL.
	RepoURL *string `json:"repo_url,omitempty"`

	// The source URL.
	URL *string `json:"url,omitempty"`

	// Set this variable to checkout git sub-modules.
	SkipSubmodulesCheckout *bool `json:"skip_submodules_checkout,omitempty"`
}

TemplateRepoUpdateRequest : Input to update the template repository data.

type TemplateRepoUploadOptions

type TemplateRepoUploadOptions struct {
	// The ID of the workspace where you want to upload your `.tar` file. To find the workspace ID, use the `GET
	// /v1/workspaces` API.
	WID *string `json:"w_id" validate:"required,ne="`

	// The ID of the Terraform template in your workspace. When you create a workspace, a unique ID is assigned to your
	// Terraform template, even if no template was provided during workspace creation. To find this ID, use the `GET
	// /v1/workspaces` API and review the `template_data.id` value.
	TID *string `json:"t_id" validate:"required,ne="`

	// Template tar file.
	File io.ReadCloser `json:"file,omitempty"`

	// The content type of file.
	FileContentType *string `json:"file_content_type,omitempty"`

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

TemplateRepoUploadOptions : The TemplateRepoUpload options.

func (*TemplateRepoUploadOptions) SetFile

func (_options *TemplateRepoUploadOptions) SetFile(file io.ReadCloser) *TemplateRepoUploadOptions

SetFile : Allow user to set File

func (*TemplateRepoUploadOptions) SetFileContentType

func (_options *TemplateRepoUploadOptions) SetFileContentType(fileContentType string) *TemplateRepoUploadOptions

SetFileContentType : Allow user to set FileContentType

func (*TemplateRepoUploadOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

func (*TemplateRepoUploadOptions) SetTID

func (_options *TemplateRepoUploadOptions) SetTID(tID string) *TemplateRepoUploadOptions

SetTID : Allow user to set TID

func (*TemplateRepoUploadOptions) SetWID

func (_options *TemplateRepoUploadOptions) SetWID(wID string) *TemplateRepoUploadOptions

SetWID : Allow user to set WID

type TemplateResources

type TemplateResources struct {
	// The subfolder in GitHub or GitLab where your Terraform templates are stored.  If your template is stored in the root
	// directory, `.` is returned.
	Folder *string `json:"folder,omitempty"`

	// The ID that was assigned to your Terraform template or IBM Cloud catalog software template.
	ID *string `json:"id,omitempty"`

	// Last refreshed timestamp of the terraform resource.
	GeneratedAt *strfmt.DateTime `json:"generated_at,omitempty"`

	// List of null resources.
	NullResources []map[string]interface{} `json:"null_resources,omitempty"`

	// Information about the IBM Cloud resources that are associated with your workspace.
	RelatedResources []map[string]interface{} `json:"related_resources,omitempty"`

	// Information about the IBM Cloud resources that are associated with your workspace. **Note** The `resource_tainted`
	// flag marks `true` when an instance is times out after few hours, if your resource provisioning takes longer
	// duration. When you rerun the apply plan, based on the `resource_taint` flag result the provisioning continues from
	// the state where the provisioning has stopped.
	Resources []map[string]interface{} `json:"resources,omitempty"`

	// Number of resources.
	ResourcesCount *int64 `json:"resources_count,omitempty"`

	// The Terraform version that was used to apply your template.
	Type *string `json:"type,omitempty"`
}

TemplateResources : Information about the resources provisioned by the Terraform template.

type TemplateRunTimeDataResponse

type TemplateRunTimeDataResponse struct {
	// The command that was used to apply the Terraform template or IBM Cloud catalog software template.
	EngineCmd *string `json:"engine_cmd,omitempty"`

	// The provisioning engine that was used to apply the Terraform template or IBM Cloud catalog software template.
	EngineName *string `json:"engine_name,omitempty"`

	// The version of the provisioning engine that was used.
	EngineVersion *string `json:"engine_version,omitempty"`

	// The ID that was assigned to your Terraform template or IBM Cloud catalog software template.
	ID *string `json:"id,omitempty"`

	// The URL to access the logs that were created during the creation, update, or deletion of your IBM Cloud resources.
	LogStoreURL *string `json:"log_store_url,omitempty"`

	// List of Output values.
	OutputValues []map[string]interface{} `json:"output_values,omitempty"`

	// List of resources.
	Resources [][]map[string]interface{} `json:"resources,omitempty"`

	// The URL where the Terraform statefile (`terraform.tfstate`) is stored. You can use the statefile to find an overview
	// of IBM Cloud resources that were created by Schematics. Schematics uses the statefile as an inventory list to
	// determine future create, update, or deletion jobs.
	StateStoreURL *string `json:"state_store_url,omitempty"`
}

TemplateRunTimeDataResponse : Information about the provisioning engine, state file, and runtime logs.

type TemplateSourceDataRequest

type TemplateSourceDataRequest struct {
	// A list of environment variables that you want to apply during the execution of a bash script or Terraform job. This
	// field must be provided as a list of key-value pairs, for example, **TF_LOG=debug**. Each entry will be a map with
	// one entry where `key is the environment variable name and value is value`. You can define environment variables for
	// IBM Cloud catalog offerings that are provisioned by using a bash script. See [example to use special environment
	// variable](https://cloud.ibm.com/docs/schematics?topic=schematics-set-parallelism#parallelism-example)  that are
	// supported by Schematics.
	EnvValues []map[string]interface{} `json:"env_values,omitempty"`

	// Environment variables metadata.
	EnvValuesMetadata []EnvironmentValuesMetadata `json:"env_values_metadata,omitempty"`

	// The subfolder in your GitHub or GitLab repository where your Terraform template is stored.
	Folder *string `json:"folder,omitempty"`

	// True, to use the files from the specified folder & subfolder in your GitHub or GitLab repository and ignore the
	// other folders in the repository. For more information, see [Compact download for Schematics
	// workspace](https://cloud.ibm.com/docs/schematics?topic=schematics-compact-download&interface=ui).
	Compact *bool `json:"compact,omitempty"`

	// The content of an existing Terraform statefile that you want to import in to your workspace. To get the content of a
	// Terraform statefile for a specific Terraform template in an existing workspace, run `ibmcloud terraform state pull
	// --id <workspace_id> --template <template_id>`.
	InitStateFile *string `json:"init_state_file,omitempty"`

	// Array of injectable terraform blocks.
	Injectors []InjectTerraformTemplateInner `json:"injectors,omitempty"`

	// The Terraform version that you want to use to run your Terraform code. Enter `terraform_v1.1` to use Terraform
	// version 1.1, and `terraform_v1.0` to use Terraform version 1.0. This is a required variable. If the Terraform
	// version is not specified, By default, Schematics selects the version from your template. For more information, refer
	// to [Terraform
	// version](https://cloud.ibm.com/docs/schematics?topic=schematics-workspace-setup&interface=ui#create-workspace_ui).
	Type *string `json:"type,omitempty"`

	// Uninstall script name.
	UninstallScriptName *string `json:"uninstall_script_name,omitempty"`

	// A list of variable values that you want to apply during the Helm chart installation. The list must be provided in
	// JSON format, such as `"autoscaling: enabled: true minReplicas: 2"`. The values that you define here override the
	// default Helm chart values. This field is supported only for IBM Cloud catalog offerings that are provisioned by
	// using the Terraform Helm provider.
	Values *string `json:"values,omitempty"`

	// List of values metadata.
	ValuesMetadata []map[string]interface{} `json:"values_metadata,omitempty"`

	// VariablesRequest -.
	Variablestore []WorkspaceVariableRequest `json:"variablestore,omitempty"`
}

TemplateSourceDataRequest : Input parameters to define input variables for your Terraform template.

type TemplateSourceDataResponse

type TemplateSourceDataResponse struct {
	// List of environment values.
	EnvValues []EnvVariableResponse `json:"env_values,omitempty"`

	// The subfolder in your GitHub or GitLab repository where your Terraform template is stored. If your template is
	// stored in the root directory, `.` is returned.
	Folder *string `json:"folder,omitempty"`

	// True, to use the files from the specified folder & subfolder in your GitHub or GitLab repository and ignore the
	// other folders in the repository.
	Compact *bool `json:"compact,omitempty"`

	// Has github token.
	HasGithubtoken *bool `json:"has_githubtoken,omitempty"`

	// The ID that was assigned to your Terraform template or IBM Cloud catalog software template.
	ID *string `json:"id,omitempty"`

	// The Terraform version that was used to run your Terraform code.
	Type *string `json:"type,omitempty"`

	// Uninstall script name.
	UninstallScriptName *string `json:"uninstall_script_name,omitempty"`

	// A list of variable values that you want to apply during the Helm chart installation. The list must be provided in
	// JSON format, such as `"autoscaling: enabled: true minReplicas: 2"`. The values that you define here override the
	// default Helm chart values. This field is supported only for IBM Cloud catalog offerings that are provisioned by
	// using the Terraform Helm provider.
	Values *string `json:"values,omitempty"`

	// A list of input variables that are associated with the workspace.
	ValuesMetadata []map[string]interface{} `json:"values_metadata,omitempty"`

	// The API endpoint to access the input variables that you defined for your template.
	ValuesURL *string `json:"values_url,omitempty"`

	// Information about the input variables that your template uses.
	Variablestore []WorkspaceVariableResponse `json:"variablestore,omitempty"`
}

TemplateSourceDataResponse : Information about the input variables that are used in the template.

type TemplateStateStore

type TemplateStateStore struct {
	Version *float64 `json:"version,omitempty"`

	TerraformVersion *string `json:"terraform_version,omitempty"`

	Serial *float64 `json:"serial,omitempty"`

	Lineage *string `json:"lineage,omitempty"`

	Modules []map[string]interface{} `json:"modules,omitempty"`
}

TemplateStateStore : The content of the Terraform statefile (`terraform.tfstate`).

type TemplateValues

type TemplateValues struct {
	// Information about workspace variable metadata.
	ValuesMetadata []map[string]interface{} `json:"values_metadata,omitempty"`
}

TemplateValues : Information about the input variables that are declared in the template that your workspace points to.

type TerraformCommand

type TerraformCommand struct {
	// You must provide the command to execute. Supported commands are `show`,`taint`, `untaint`, `state`, `import`,
	// `output`, `drift`.
	Command *string `json:"command,omitempty"`

	// The required address parameters for the command name. You can send the option flag and address parameter in the
	// payload. **Syntax ** "command_params": "<option>=<flag>", "<address>". **Example ** "command_params":
	// "-allow-missing=true", "-lock=true", "data.template_file.test".
	CommandParams *string `json:"command_params,omitempty"`

	// The optional name for the command block.
	CommandName *string `json:"command_name,omitempty"`

	// The optional text to describe the command block.
	CommandDesc *string `json:"command_desc,omitempty"`

	// Instruction to continue or break in case of error.
	CommandOnError *string `json:"command_on_error,omitempty"`

	// Dependency on previous commands.
	CommandDependsOn *string `json:"command_depends_on,omitempty"`

	// Displays the command executed status, either `success` or `failure`.
	CommandStatus *string `json:"command_status,omitempty"`
}

TerraformCommand : Inputs for running a Terraform command on the workspace.

type UpdateActionOptions

type UpdateActionOptions struct {
	// Action Id.  Use GET /actions API to look up the Action Ids in your IBM Cloud account.
	ActionID *string `json:"action_id" validate:"required,ne="`

	// The unique name of your action. The name can be up to 128 characters long and can include alphanumeric characters,
	// spaces, dashes, and underscores. **Example** you can use the name to stop action.
	Name *string `json:"name,omitempty"`

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

	// List of locations supported by IBM Cloud Schematics service.  While creating your workspace or action, choose the
	// right region, since it cannot be changed.  Note, this does not limit the location of the IBM Cloud resources,
	// provisioned using Schematics.
	Location *string `json:"location,omitempty"`

	// Resource-group name for an action. By default, an action is created in `Default` resource group.
	ResourceGroup *string `json:"resource_group,omitempty"`

	// Type of connection to be used when connecting to bastion host.  If the `inventory_connection_type=winrm`, then
	// `bastion_connection_type` is not supported.
	BastionConnectionType *string `json:"bastion_connection_type,omitempty"`

	// Type of connection to be used when connecting to remote host.  **Note** Currently, WinRM supports only Windows
	// system with the public IPs and do not support Bastion host.
	InventoryConnectionType *string `json:"inventory_connection_type,omitempty"`

	// Action tags.
	Tags []string `json:"tags,omitempty"`

	// User defined status of the Schematics object.
	UserState *UserState `json:"user_state,omitempty"`

	// URL of the `README` file, for the source URL.
	SourceReadmeURL *string `json:"source_readme_url,omitempty"`

	// Source of templates, playbooks, or controls.
	Source *ExternalSource `json:"source,omitempty"`

	// Type of source for the Template.
	SourceType *string `json:"source_type,omitempty"`

	// Schematics job command parameter (playbook-name).
	CommandParameter *string `json:"command_parameter,omitempty"`

	// Target inventory record ID, used by the action or ansible playbook.
	Inventory *string `json:"inventory,omitempty"`

	// credentials of the Action.
	Credentials []CredentialVariableData `json:"credentials,omitempty"`

	// Describes a bastion resource.
	Bastion *BastionResourceDefinition `json:"bastion,omitempty"`

	// User editable credential variable data and system generated reference to the value.
	BastionCredential *CredentialVariableData `json:"bastion_credential,omitempty"`

	// Inventory of host and host group for the playbook in `INI` file format. For example, `"targets_ini":
	// "[webserverhost]
	//  172.22.192.6
	//  [dbhost]
	//  172.22.192.5"`. For more information, about an inventory host group syntax, see [Inventory host
	// groups](https://cloud.ibm.com/docs/schematics?topic=schematics-schematics-cli-reference#schematics-inventory-host-grps).
	TargetsIni *string `json:"targets_ini,omitempty"`

	// Input variables for the Action.
	Inputs []VariableData `json:"inputs,omitempty"`

	// Output variables for the Action.
	Outputs []VariableData `json:"outputs,omitempty"`

	// Environment variables for the Action.
	Settings []VariableData `json:"settings,omitempty"`

	// The personal access token to authenticate with your private GitHub or GitLab repository and access your Terraform
	// template.
	XGithubToken *string `json:"X-Github-token,omitempty"`

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

UpdateActionOptions : The UpdateAction options.

func (*UpdateActionOptions) SetActionID

func (_options *UpdateActionOptions) SetActionID(actionID string) *UpdateActionOptions

SetActionID : Allow user to set ActionID

func (*UpdateActionOptions) SetBastion

func (_options *UpdateActionOptions) SetBastion(bastion *BastionResourceDefinition) *UpdateActionOptions

SetBastion : Allow user to set Bastion

func (*UpdateActionOptions) SetBastionConnectionType

func (_options *UpdateActionOptions) SetBastionConnectionType(bastionConnectionType string) *UpdateActionOptions

SetBastionConnectionType : Allow user to set BastionConnectionType

func (*UpdateActionOptions) SetBastionCredential

func (_options *UpdateActionOptions) SetBastionCredential(bastionCredential *CredentialVariableData) *UpdateActionOptions

SetBastionCredential : Allow user to set BastionCredential

func (*UpdateActionOptions) SetCommandParameter

func (_options *UpdateActionOptions) SetCommandParameter(commandParameter string) *UpdateActionOptions

SetCommandParameter : Allow user to set CommandParameter

func (*UpdateActionOptions) SetCredentials

func (_options *UpdateActionOptions) SetCredentials(credentials []CredentialVariableData) *UpdateActionOptions

SetCredentials : Allow user to set Credentials

func (*UpdateActionOptions) SetDescription

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

SetDescription : Allow user to set Description

func (*UpdateActionOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

func (*UpdateActionOptions) SetInputs

func (_options *UpdateActionOptions) SetInputs(inputs []VariableData) *UpdateActionOptions

SetInputs : Allow user to set Inputs

func (*UpdateActionOptions) SetInventory

func (_options *UpdateActionOptions) SetInventory(inventory string) *UpdateActionOptions

SetInventory : Allow user to set Inventory

func (*UpdateActionOptions) SetInventoryConnectionType

func (_options *UpdateActionOptions) SetInventoryConnectionType(inventoryConnectionType string) *UpdateActionOptions

SetInventoryConnectionType : Allow user to set InventoryConnectionType

func (*UpdateActionOptions) SetLocation

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

SetLocation : Allow user to set Location

func (*UpdateActionOptions) SetName

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

SetName : Allow user to set Name

func (*UpdateActionOptions) SetOutputs

func (_options *UpdateActionOptions) SetOutputs(outputs []VariableData) *UpdateActionOptions

SetOutputs : Allow user to set Outputs

func (*UpdateActionOptions) SetResourceGroup

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

SetResourceGroup : Allow user to set ResourceGroup

func (*UpdateActionOptions) SetSettings

func (_options *UpdateActionOptions) SetSettings(settings []VariableData) *UpdateActionOptions

SetSettings : Allow user to set Settings

func (*UpdateActionOptions) SetSource

func (_options *UpdateActionOptions) SetSource(source *ExternalSource) *UpdateActionOptions

SetSource : Allow user to set Source

func (*UpdateActionOptions) SetSourceReadmeURL

func (_options *UpdateActionOptions) SetSourceReadmeURL(sourceReadmeURL string) *UpdateActionOptions

SetSourceReadmeURL : Allow user to set SourceReadmeURL

func (*UpdateActionOptions) SetSourceType

func (_options *UpdateActionOptions) SetSourceType(sourceType string) *UpdateActionOptions

SetSourceType : Allow user to set SourceType

func (*UpdateActionOptions) SetTags

func (_options *UpdateActionOptions) SetTags(tags []string) *UpdateActionOptions

SetTags : Allow user to set Tags

func (*UpdateActionOptions) SetTargetsIni

func (_options *UpdateActionOptions) SetTargetsIni(targetsIni string) *UpdateActionOptions

SetTargetsIni : Allow user to set TargetsIni

func (*UpdateActionOptions) SetUserState

func (_options *UpdateActionOptions) SetUserState(userState *UserState) *UpdateActionOptions

SetUserState : Allow user to set UserState

func (*UpdateActionOptions) SetXGithubToken

func (_options *UpdateActionOptions) SetXGithubToken(xGithubToken string) *UpdateActionOptions

SetXGithubToken : Allow user to set XGithubToken

type UpdateAgentDataOptions

type UpdateAgentDataOptions struct {
	// Agent ID to get the details of agent.
	AgentID *string `json:"agent_id" validate:"required,ne="`

	// The name of the agent (must be unique, for an account).
	Name *string `json:"name" validate:"required"`

	// The resource-group name for the agent.  By default, agent will be registered in Default Resource Group.
	ResourceGroup *string `json:"resource_group" validate:"required"`

	// Agent version.
	Version *string `json:"version" validate:"required"`

	// List of locations supported by IBM Cloud Schematics service.  While creating your workspace or action, choose the
	// right region, since it cannot be changed.  Note, this does not limit the location of the IBM Cloud resources,
	// provisioned using Schematics.
	SchematicsLocation *string `json:"schematics_location" validate:"required"`

	// The location where agent is deployed in the user environment.
	AgentLocation *string `json:"agent_location" validate:"required"`

	// The infrastructure parameters used by the agent.
	AgentInfrastructure *AgentInfrastructure `json:"agent_infrastructure" validate:"required"`

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

	// Tags for the agent.
	Tags []string `json:"tags,omitempty"`

	// The metadata of an agent.
	AgentMetadata []AgentMetadataInfo `json:"agent_metadata,omitempty"`

	// Additional input variables for the agent.
	AgentInputs []VariableData `json:"agent_inputs,omitempty"`

	// User defined status of the agent.
	UserState *AgentUserState `json:"user_state,omitempty"`

	// Schematics Agent key performance indicators.
	AgentKpi *AgentKPIData `json:"agent_kpi,omitempty"`

	// This IAM token is required only when trying to update an agent from one version to other.
	//
	//   **Retrieving refresh token**:
	//   * Use `export IBMCLOUD_API_KEY=<ibmcloud_api_key>`, and execute `curl -X POST
	// "https://iam.cloud.ibm.com/identity/token" -H "Content-Type: application/x-www-form-urlencoded" -d
	// "grant_type=urn:ibm:params:oauth:grant-type:apikey&apikey=$IBMCLOUD_API_KEY" -u bx:bx`.
	//   * For more information, about creating IAM access token and API Docs, refer, [IAM access
	// token](/apidocs/iam-identity-token-api#gettoken-password) and [Create API
	// key](/apidocs/iam-identity-token-api#create-api-key).
	//
	//   **Limitation**:
	//   * If the token is expired, you can use `refresh token` to get a new IAM access token.
	//   * The `refresh_token` parameter cannot be used to retrieve a new IAM access token.
	//   * When the IAM access token is about to expire, use the API key to create a new access token.
	RefreshToken *string `json:"refresh_token,omitempty"`

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

UpdateAgentDataOptions : The UpdateAgentData options.

func (*UpdateAgentDataOptions) SetAgentID

func (_options *UpdateAgentDataOptions) SetAgentID(agentID string) *UpdateAgentDataOptions

SetAgentID : Allow user to set AgentID

func (*UpdateAgentDataOptions) SetAgentInfrastructure

func (_options *UpdateAgentDataOptions) SetAgentInfrastructure(agentInfrastructure *AgentInfrastructure) *UpdateAgentDataOptions

SetAgentInfrastructure : Allow user to set AgentInfrastructure

func (*UpdateAgentDataOptions) SetAgentInputs

func (_options *UpdateAgentDataOptions) SetAgentInputs(agentInputs []VariableData) *UpdateAgentDataOptions

SetAgentInputs : Allow user to set AgentInputs

func (*UpdateAgentDataOptions) SetAgentKpi

func (_options *UpdateAgentDataOptions) SetAgentKpi(agentKpi *AgentKPIData) *UpdateAgentDataOptions

SetAgentKpi : Allow user to set AgentKpi

func (*UpdateAgentDataOptions) SetAgentLocation

func (_options *UpdateAgentDataOptions) SetAgentLocation(agentLocation string) *UpdateAgentDataOptions

SetAgentLocation : Allow user to set AgentLocation

func (*UpdateAgentDataOptions) SetAgentMetadata

func (_options *UpdateAgentDataOptions) SetAgentMetadata(agentMetadata []AgentMetadataInfo) *UpdateAgentDataOptions

SetAgentMetadata : Allow user to set AgentMetadata

func (*UpdateAgentDataOptions) SetDescription

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

SetDescription : Allow user to set Description

func (*UpdateAgentDataOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

func (*UpdateAgentDataOptions) SetName

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

SetName : Allow user to set Name

func (*UpdateAgentDataOptions) SetRefreshToken

func (_options *UpdateAgentDataOptions) SetRefreshToken(refreshToken string) *UpdateAgentDataOptions

SetRefreshToken : Allow user to set RefreshToken

func (*UpdateAgentDataOptions) SetResourceGroup

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

SetResourceGroup : Allow user to set ResourceGroup

func (*UpdateAgentDataOptions) SetSchematicsLocation

func (_options *UpdateAgentDataOptions) SetSchematicsLocation(schematicsLocation string) *UpdateAgentDataOptions

SetSchematicsLocation : Allow user to set SchematicsLocation

func (*UpdateAgentDataOptions) SetTags

func (_options *UpdateAgentDataOptions) SetTags(tags []string) *UpdateAgentDataOptions

SetTags : Allow user to set Tags

func (*UpdateAgentDataOptions) SetUserState

func (_options *UpdateAgentDataOptions) SetUserState(userState *AgentUserState) *UpdateAgentDataOptions

SetUserState : Allow user to set UserState

func (*UpdateAgentDataOptions) SetVersion

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

SetVersion : Allow user to set Version

type UpdateAgentRegistrationOptions

type UpdateAgentRegistrationOptions struct {
	// Agent ID to get the details of agent.
	AgentID *string `json:"agent_id" validate:"required,ne="`

	// The name of the agent (must be unique, for an account).
	Name *string `json:"name" validate:"required"`

	// The location where agent is deployed in the user environment.
	AgentLocation *string `json:"agent_location" validate:"required"`

	// List of locations supported by IBM Cloud Schematics service.  While creating your workspace or action, choose the
	// right region, since it cannot be changed.  Note, this does not limit the location of the IBM Cloud resources,
	// provisioned using Schematics.
	Location *string `json:"location" validate:"required"`

	// The IAM trusted profile id, used by the Agent instance.
	ProfileID *string `json:"profile_id" validate:"required"`

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

	// The resource-group name for the agent.  By default, Agent will be registered in Default Resource Group.
	ResourceGroup *string `json:"resource_group,omitempty"`

	// Tags for the agent.
	Tags []string `json:"tags,omitempty"`

	// User defined status of the agent.
	UserState *AgentUserState `json:"user_state,omitempty"`

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

UpdateAgentRegistrationOptions : The UpdateAgentRegistration options.

func (*UpdateAgentRegistrationOptions) SetAgentID

func (_options *UpdateAgentRegistrationOptions) SetAgentID(agentID string) *UpdateAgentRegistrationOptions

SetAgentID : Allow user to set AgentID

func (*UpdateAgentRegistrationOptions) SetAgentLocation

func (_options *UpdateAgentRegistrationOptions) SetAgentLocation(agentLocation string) *UpdateAgentRegistrationOptions

SetAgentLocation : Allow user to set AgentLocation

func (*UpdateAgentRegistrationOptions) SetDescription

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

SetDescription : Allow user to set Description

func (*UpdateAgentRegistrationOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

func (*UpdateAgentRegistrationOptions) SetLocation

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

SetLocation : Allow user to set Location

func (*UpdateAgentRegistrationOptions) SetName

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

SetName : Allow user to set Name

func (*UpdateAgentRegistrationOptions) SetProfileID

func (_options *UpdateAgentRegistrationOptions) SetProfileID(profileID string) *UpdateAgentRegistrationOptions

SetProfileID : Allow user to set ProfileID

func (*UpdateAgentRegistrationOptions) SetResourceGroup

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

SetResourceGroup : Allow user to set ResourceGroup

func (*UpdateAgentRegistrationOptions) SetTags

func (_options *UpdateAgentRegistrationOptions) SetTags(tags []string) *UpdateAgentRegistrationOptions

SetTags : Allow user to set Tags

func (*UpdateAgentRegistrationOptions) SetUserState

func (_options *UpdateAgentRegistrationOptions) SetUserState(userState *AgentUserState) *UpdateAgentRegistrationOptions

SetUserState : Allow user to set UserState

type UpdateJobOptions

type UpdateJobOptions struct {
	// Job Id. Use `GET /v2/jobs` API to look up the Job Ids in your IBM Cloud account.
	JobID *string `json:"job_id" validate:"required,ne="`

	// The IAM refresh token for the user or service identity.
	//
	//   **Retrieving refresh token**:
	//   * Use `export IBMCLOUD_API_KEY=<ibmcloud_api_key>`, and execute `curl -X POST
	// "https://iam.cloud.ibm.com/identity/token" -H "Content-Type: application/x-www-form-urlencoded" -d
	// "grant_type=urn:ibm:params:oauth:grant-type:apikey&apikey=$IBMCLOUD_API_KEY" -u bx:bx`.
	//   * For more information, about creating IAM access token and API Docs, refer, [IAM access
	// token](/apidocs/iam-identity-token-api#gettoken-password) and [Create API
	// key](/apidocs/iam-identity-token-api#create-api-key).
	//
	//   **Limitation**:
	//   * If the token is expired, you can use `refresh token` to get a new IAM access token.
	//   * The `refresh_token` parameter cannot be used to retrieve a new IAM access token.
	//   * When the IAM access token is about to expire, use the API key to create a new access token.
	RefreshToken *string `json:"refresh_token" validate:"required"`

	// Name of the Schematics automation resource.
	CommandObject *string `json:"command_object,omitempty"`

	// Job command object id (workspace-id, action-id).
	CommandObjectID *string `json:"command_object_id,omitempty"`

	// Schematics job command name.
	CommandName *string `json:"command_name,omitempty"`

	// Schematics job command parameter (playbook-name).
	CommandParameter *string `json:"command_parameter,omitempty"`

	// Command line options for the command.
	CommandOptions []string `json:"command_options,omitempty"`

	// Job inputs used by Action or Workspace.
	Inputs []VariableData `json:"inputs,omitempty"`

	// Environment variables used by the Job while performing Action or Workspace.
	Settings []VariableData `json:"settings,omitempty"`

	// User defined tags, while running the job.
	Tags []string `json:"tags,omitempty"`

	// List of locations supported by IBM Cloud Schematics service.  While creating your workspace or action, choose the
	// right region, since it cannot be changed.  Note, this does not limit the location of the IBM Cloud resources,
	// provisioned using Schematics.
	Location *string `json:"location,omitempty"`

	// Job Status.
	Status *JobStatus `json:"status,omitempty"`

	// Contains the cart order data which can be used for different purpose for eg. service tagging.
	CartOrderData []CartOrderData `json:"cart_order_data,omitempty"`

	// Job data.
	Data *JobData `json:"data,omitempty"`

	// Describes a bastion resource.
	Bastion *BastionResourceDefinition `json:"bastion,omitempty"`

	// Job log summary record.
	LogSummary *JobLogSummary `json:"log_summary,omitempty"`

	// Agent name, Agent id and associated policy ID information.
	Agent *AgentInfo `json:"agent,omitempty"`

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

UpdateJobOptions : The UpdateJob options.

func (*UpdateJobOptions) SetAgent

func (_options *UpdateJobOptions) SetAgent(agent *AgentInfo) *UpdateJobOptions

SetAgent : Allow user to set Agent

func (*UpdateJobOptions) SetBastion

func (_options *UpdateJobOptions) SetBastion(bastion *BastionResourceDefinition) *UpdateJobOptions

SetBastion : Allow user to set Bastion

func (*UpdateJobOptions) SetCartOrderData

func (_options *UpdateJobOptions) SetCartOrderData(cartOrderData []CartOrderData) *UpdateJobOptions

SetCartOrderData : Allow user to set CartOrderData

func (*UpdateJobOptions) SetCommandName

func (_options *UpdateJobOptions) SetCommandName(commandName string) *UpdateJobOptions

SetCommandName : Allow user to set CommandName

func (*UpdateJobOptions) SetCommandObject

func (_options *UpdateJobOptions) SetCommandObject(commandObject string) *UpdateJobOptions

SetCommandObject : Allow user to set CommandObject

func (*UpdateJobOptions) SetCommandObjectID

func (_options *UpdateJobOptions) SetCommandObjectID(commandObjectID string) *UpdateJobOptions

SetCommandObjectID : Allow user to set CommandObjectID

func (*UpdateJobOptions) SetCommandOptions

func (_options *UpdateJobOptions) SetCommandOptions(commandOptions []string) *UpdateJobOptions

SetCommandOptions : Allow user to set CommandOptions

func (*UpdateJobOptions) SetCommandParameter

func (_options *UpdateJobOptions) SetCommandParameter(commandParameter string) *UpdateJobOptions

SetCommandParameter : Allow user to set CommandParameter

func (*UpdateJobOptions) SetData

func (_options *UpdateJobOptions) SetData(data *JobData) *UpdateJobOptions

SetData : Allow user to set Data

func (*UpdateJobOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

func (*UpdateJobOptions) SetInputs

func (_options *UpdateJobOptions) SetInputs(inputs []VariableData) *UpdateJobOptions

SetInputs : Allow user to set Inputs

func (*UpdateJobOptions) SetJobID

func (_options *UpdateJobOptions) SetJobID(jobID string) *UpdateJobOptions

SetJobID : Allow user to set JobID

func (*UpdateJobOptions) SetLocation

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

SetLocation : Allow user to set Location

func (*UpdateJobOptions) SetLogSummary

func (_options *UpdateJobOptions) SetLogSummary(logSummary *JobLogSummary) *UpdateJobOptions

SetLogSummary : Allow user to set LogSummary

func (*UpdateJobOptions) SetRefreshToken

func (_options *UpdateJobOptions) SetRefreshToken(refreshToken string) *UpdateJobOptions

SetRefreshToken : Allow user to set RefreshToken

func (*UpdateJobOptions) SetSettings

func (_options *UpdateJobOptions) SetSettings(settings []VariableData) *UpdateJobOptions

SetSettings : Allow user to set Settings

func (*UpdateJobOptions) SetStatus

func (_options *UpdateJobOptions) SetStatus(status *JobStatus) *UpdateJobOptions

SetStatus : Allow user to set Status

func (*UpdateJobOptions) SetTags

func (_options *UpdateJobOptions) SetTags(tags []string) *UpdateJobOptions

SetTags : Allow user to set Tags

type UpdateKmsSettingsOptions

type UpdateKmsSettingsOptions struct {
	// The location to integrate kms instance. For example, location can be `US` and `EU`.
	Location *string `json:"location,omitempty"`

	// The encryption scheme values. **Allowable values** [`byok`,`kyok`].
	EncryptionScheme *string `json:"encryption_scheme,omitempty"`

	// The kms instance resource group to integrate.
	ResourceGroup *string `json:"resource_group,omitempty"`

	// The primary kms instance details.
	PrimaryCrk *KMSSettingsPrimaryCrk `json:"primary_crk,omitempty"`

	// The secondary kms instance details.
	SecondaryCrk *KMSSettingsSecondaryCrk `json:"secondary_crk,omitempty"`

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

UpdateKmsSettingsOptions : The UpdateKmsSettings options.

func (*UpdateKmsSettingsOptions) SetEncryptionScheme

func (_options *UpdateKmsSettingsOptions) SetEncryptionScheme(encryptionScheme string) *UpdateKmsSettingsOptions

SetEncryptionScheme : Allow user to set EncryptionScheme

func (*UpdateKmsSettingsOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

func (*UpdateKmsSettingsOptions) SetLocation

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

SetLocation : Allow user to set Location

func (*UpdateKmsSettingsOptions) SetPrimaryCrk

func (_options *UpdateKmsSettingsOptions) SetPrimaryCrk(primaryCrk *KMSSettingsPrimaryCrk) *UpdateKmsSettingsOptions

SetPrimaryCrk : Allow user to set PrimaryCrk

func (*UpdateKmsSettingsOptions) SetResourceGroup

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

SetResourceGroup : Allow user to set ResourceGroup

func (*UpdateKmsSettingsOptions) SetSecondaryCrk

func (_options *UpdateKmsSettingsOptions) SetSecondaryCrk(secondaryCrk *KMSSettingsSecondaryCrk) *UpdateKmsSettingsOptions

SetSecondaryCrk : Allow user to set SecondaryCrk

type UpdatePolicyOptions

type UpdatePolicyOptions struct {
	// ID to get the details of policy.
	PolicyID *string `json:"policy_id" validate:"required,ne="`

	// Name of Schematics customization policy.
	Name *string `json:"name,omitempty"`

	// The description of Schematics customization policy.
	Description *string `json:"description,omitempty"`

	// The resource group name for the policy.  By default, Policy will be created in `default` Resource Group.
	ResourceGroup *string `json:"resource_group,omitempty"`

	// Tags for the Schematics customization policy.
	Tags []string `json:"tags,omitempty"`

	// List of locations supported by IBM Cloud Schematics service.  While creating your workspace or action, choose the
	// right region, since it cannot be changed.  Note, this does not limit the location of the IBM Cloud resources,
	// provisioned using Schematics.
	Location *string `json:"location,omitempty"`

	// User defined status of the Schematics object.
	State *UserState `json:"state,omitempty"`

	// Policy kind or categories for managing and deriving policy decision
	//   * `agent_assignment_policy` Agent assignment policy for job execution.
	Kind *string `json:"kind,omitempty"`

	// The objects for the Schematics policy.
	Target *PolicyObjects `json:"target,omitempty"`

	// The parameter to tune the Schematics policy.
	Parameter *PolicyParameter `json:"parameter,omitempty"`

	// List of scoped Schematics resources targeted by the policy.
	ScopedResources []ScopedResource `json:"scoped_resources,omitempty"`

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

UpdatePolicyOptions : The UpdatePolicy options.

func (*UpdatePolicyOptions) SetDescription

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

SetDescription : Allow user to set Description

func (*UpdatePolicyOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

func (*UpdatePolicyOptions) SetKind

func (_options *UpdatePolicyOptions) SetKind(kind string) *UpdatePolicyOptions

SetKind : Allow user to set Kind

func (*UpdatePolicyOptions) SetLocation

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

SetLocation : Allow user to set Location

func (*UpdatePolicyOptions) SetName

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

SetName : Allow user to set Name

func (*UpdatePolicyOptions) SetParameter

func (_options *UpdatePolicyOptions) SetParameter(parameter *PolicyParameter) *UpdatePolicyOptions

SetParameter : Allow user to set Parameter

func (*UpdatePolicyOptions) SetPolicyID

func (_options *UpdatePolicyOptions) SetPolicyID(policyID string) *UpdatePolicyOptions

SetPolicyID : Allow user to set PolicyID

func (*UpdatePolicyOptions) SetResourceGroup

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

SetResourceGroup : Allow user to set ResourceGroup

func (*UpdatePolicyOptions) SetScopedResources

func (_options *UpdatePolicyOptions) SetScopedResources(scopedResources []ScopedResource) *UpdatePolicyOptions

SetScopedResources : Allow user to set ScopedResources

func (*UpdatePolicyOptions) SetState

func (_options *UpdatePolicyOptions) SetState(state *UserState) *UpdatePolicyOptions

SetState : Allow user to set State

func (*UpdatePolicyOptions) SetTags

func (_options *UpdatePolicyOptions) SetTags(tags []string) *UpdatePolicyOptions

SetTags : Allow user to set Tags

func (*UpdatePolicyOptions) SetTarget

func (_options *UpdatePolicyOptions) SetTarget(target *PolicyObjects) *UpdatePolicyOptions

SetTarget : Allow user to set Target

type UpdateWorkspaceOptions

type UpdateWorkspaceOptions struct {
	// The ID of the workspace.  To find the workspace ID, use the `GET /v1/workspaces` API.
	WID *string `json:"w_id" validate:"required,ne="`

	// Information about the software template that you chose from the IBM Cloud catalog. This information is returned for
	// IBM Cloud catalog offerings only.
	CatalogRef *CatalogRef `json:"catalog_ref,omitempty"`

	// The description of the workspace.
	Description *string `json:"description,omitempty"`

	// Workspace dependencies.
	Dependencies *Dependencies `json:"dependencies,omitempty"`

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

	// Information about the Target used by the templates originating from the  IBM Cloud catalog offerings. This
	// information is not relevant for workspace created using your own Terraform template.
	SharedData *SharedTargetData `json:"shared_data,omitempty"`

	// A list of tags that you want to associate with your workspace.
	Tags []string `json:"tags,omitempty"`

	// Input data for the Template.
	TemplateData []TemplateSourceDataRequest `json:"template_data,omitempty"`

	// Input to update the template repository data.
	TemplateRepo *TemplateRepoUpdateRequest `json:"template_repo,omitempty"`

	// List of Workspace type.
	Type []string `json:"type,omitempty"`

	// Input to update the workspace status.
	WorkspaceStatus *WorkspaceStatusUpdateRequest `json:"workspace_status,omitempty"`

	// Information about the last job that ran against the workspace. -.
	WorkspaceStatusMsg *WorkspaceStatusMessage `json:"workspace_status_msg,omitempty"`

	// agent id that process workspace jobs.
	AgentID *string `json:"agent_id,omitempty"`

	// Input settings to be applied to the workspace, for example, `job_timeout_override`.
	Settings []VariableData `json:"settings,omitempty"`

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

UpdateWorkspaceOptions : The UpdateWorkspace options.

func (*UpdateWorkspaceOptions) SetAgentID

func (_options *UpdateWorkspaceOptions) SetAgentID(agentID string) *UpdateWorkspaceOptions

SetAgentID : Allow user to set AgentID

func (*UpdateWorkspaceOptions) SetCatalogRef

func (_options *UpdateWorkspaceOptions) SetCatalogRef(catalogRef *CatalogRef) *UpdateWorkspaceOptions

SetCatalogRef : Allow user to set CatalogRef

func (*UpdateWorkspaceOptions) SetDependencies

func (_options *UpdateWorkspaceOptions) SetDependencies(dependencies *Dependencies) *UpdateWorkspaceOptions

SetDependencies : Allow user to set Dependencies

func (*UpdateWorkspaceOptions) SetDescription

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

SetDescription : Allow user to set Description

func (*UpdateWorkspaceOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

func (*UpdateWorkspaceOptions) SetName

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

SetName : Allow user to set Name

func (*UpdateWorkspaceOptions) SetSettings

func (_options *UpdateWorkspaceOptions) SetSettings(settings []VariableData) *UpdateWorkspaceOptions

SetSettings : Allow user to set Settings

func (*UpdateWorkspaceOptions) SetSharedData

func (_options *UpdateWorkspaceOptions) SetSharedData(sharedData *SharedTargetData) *UpdateWorkspaceOptions

SetSharedData : Allow user to set SharedData

func (*UpdateWorkspaceOptions) SetTags

func (_options *UpdateWorkspaceOptions) SetTags(tags []string) *UpdateWorkspaceOptions

SetTags : Allow user to set Tags

func (*UpdateWorkspaceOptions) SetTemplateData

func (_options *UpdateWorkspaceOptions) SetTemplateData(templateData []TemplateSourceDataRequest) *UpdateWorkspaceOptions

SetTemplateData : Allow user to set TemplateData

func (*UpdateWorkspaceOptions) SetTemplateRepo

func (_options *UpdateWorkspaceOptions) SetTemplateRepo(templateRepo *TemplateRepoUpdateRequest) *UpdateWorkspaceOptions

SetTemplateRepo : Allow user to set TemplateRepo

func (*UpdateWorkspaceOptions) SetType

func (_options *UpdateWorkspaceOptions) SetType(typeVar []string) *UpdateWorkspaceOptions

SetType : Allow user to set Type

func (*UpdateWorkspaceOptions) SetWID

func (_options *UpdateWorkspaceOptions) SetWID(wID string) *UpdateWorkspaceOptions

SetWID : Allow user to set WID

func (*UpdateWorkspaceOptions) SetWorkspaceStatus

func (_options *UpdateWorkspaceOptions) SetWorkspaceStatus(workspaceStatus *WorkspaceStatusUpdateRequest) *UpdateWorkspaceOptions

SetWorkspaceStatus : Allow user to set WorkspaceStatus

func (*UpdateWorkspaceOptions) SetWorkspaceStatusMsg

func (_options *UpdateWorkspaceOptions) SetWorkspaceStatusMsg(workspaceStatusMsg *WorkspaceStatusMessage) *UpdateWorkspaceOptions

SetWorkspaceStatusMsg : Allow user to set WorkspaceStatusMsg

type UploadTemplateTarActionOptions

type UploadTemplateTarActionOptions struct {
	// Action Id.  Use GET /actions API to look up the Action Ids in your IBM Cloud account.
	ActionID *string `json:"action_id" validate:"required,ne="`

	// Template tar file.
	File io.ReadCloser `json:"file,omitempty"`

	// The content type of file.
	FileContentType *string `json:"file_content_type,omitempty"`

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

UploadTemplateTarActionOptions : The UploadTemplateTarAction options.

func (*UploadTemplateTarActionOptions) SetActionID

func (_options *UploadTemplateTarActionOptions) SetActionID(actionID string) *UploadTemplateTarActionOptions

SetActionID : Allow user to set ActionID

func (*UploadTemplateTarActionOptions) SetFile

func (_options *UploadTemplateTarActionOptions) SetFile(file io.ReadCloser) *UploadTemplateTarActionOptions

SetFile : Allow user to set File

func (*UploadTemplateTarActionOptions) SetFileContentType

func (_options *UploadTemplateTarActionOptions) SetFileContentType(fileContentType string) *UploadTemplateTarActionOptions

SetFileContentType : Allow user to set FileContentType

func (*UploadTemplateTarActionOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

type UserState

type UserState struct {
	// User-defined states
	//   * `draft` Object can be modified; can be used by Jobs run by the author, during execution
	//   * `live` Object can be modified; can be used by Jobs during execution
	//   * `locked` Object cannot be modified; can be used by Jobs during execution
	//   * `disable` Object can be modified. cannot be used by Jobs during execution.
	State *string `json:"state,omitempty"`

	// Name of the User who set the state of the Object.
	SetBy *string `json:"set_by,omitempty"`

	// When the User who set the state of the Object.
	SetAt *strfmt.DateTime `json:"set_at,omitempty"`
}

UserState : User defined status of the Schematics object.

type UserValues

type UserValues struct {
	// A list of environment variables that you want to apply during the execution of a bash script or Terraform job. This
	// field must be provided as a list of key-value pairs, for example, **TF_LOG=debug**. Each entry will be a map with
	// one entry where `key is the environment variable name and value is value`. You can define environment variables for
	// IBM Cloud catalog offerings that are provisioned by using a bash script. See [example to use special environment
	// variable](https://cloud.ibm.com/docs/schematics?topic=schematics-set-parallelism#parallelism-example)  that are
	// supported by Schematics.
	EnvValues []map[string]interface{} `json:"env_values,omitempty"`

	// A list of environment variables that you want to apply during the execution of a bash script or Terraform job. This
	// field must be provided as a list of key-value pairs, for example, **TF_LOG=debug**. Each entry will be a map with
	// one entry where `key is the environment variable name and value is value`. You can define environment variables for
	// IBM Cloud catalog offerings that are provisioned by using a bash script. See [example to use special environment
	// variable](https://cloud.ibm.com/docs/schematics?topic=schematics-set-parallelism#parallelism-example)  that are
	// supported by Schematics.
	EnvValuesMap []EnvVariableRequestMap `json:"env_values_map,omitempty"`

	// User values.
	Values *string `json:"values,omitempty"`

	// Information about the input variables that your template uses.
	Variablestore []WorkspaceVariableResponse `json:"variablestore,omitempty"`
}

UserValues : UserValues -.

type VariableData

type VariableData struct {
	// The name of the variable. For example, `name = "inventory username"`.
	Name *string `json:"name,omitempty"`

	// The value for the variable or reference to the value. For example, `value = "<provide your ssh_key_value with \n>"`.
	Value *string `json:"value,omitempty"`

	// True, will ignore the data in the value attribute, instead the data in metadata.default_value will be used.
	UseDefault *bool `json:"use_default,omitempty"`

	// An user editable metadata for the variables.
	Metadata *VariableMetadata `json:"metadata,omitempty"`

	// The reference link to the variable value By default the expression points to `$self.value`.
	Link *string `json:"link,omitempty"`
}

VariableData : User editable variable data and system generated reference to the value.

type VariableMetadata

type VariableMetadata struct {
	// Type of the variable.
	Type *string `json:"type,omitempty"`

	// The list of aliases for the variable name.
	Aliases []string `json:"aliases,omitempty"`

	// The description of the meta data.
	Description *string `json:"description,omitempty"`

	// Cloud data type of the variable. eg. resource_group_id, region, vpc_id.
	CloudDataType *string `json:"cloud_data_type,omitempty"`

	// Default value for the variable only if the override value is not specified.
	DefaultValue *string `json:"default_value,omitempty"`

	// The status of the link.
	LinkStatus *string `json:"link_status,omitempty"`

	// Is the variable secure or sensitive ?.
	Secure *bool `json:"secure,omitempty"`

	// Is the variable readonly ?.
	Immutable *bool `json:"immutable,omitempty"`

	// If **true**, the variable is not displayed on UI or Command line.
	Hidden *bool `json:"hidden,omitempty"`

	// If the variable required?.
	Required *bool `json:"required,omitempty"`

	// The list of possible values for this variable.  If type is **integer** or **date**, then the array of string is
	// converted to array of integers or date during the runtime.
	Options []string `json:"options,omitempty"`

	// The minimum value of the variable. Applicable for the integer type.
	MinValue *int64 `json:"min_value,omitempty"`

	// The maximum value of the variable. Applicable for the integer type.
	MaxValue *int64 `json:"max_value,omitempty"`

	// The minimum length of the variable value. Applicable for the string type.
	MinLength *int64 `json:"min_length,omitempty"`

	// The maximum length of the variable value. Applicable for the string type.
	MaxLength *int64 `json:"max_length,omitempty"`

	// The regex for the variable value.
	Matches *string `json:"matches,omitempty"`

	// The relative position of this variable in a list.
	Position *int64 `json:"position,omitempty"`

	// The display name of the group this variable belongs to.
	GroupBy *string `json:"group_by,omitempty"`

	// The source of this meta-data.
	Source *string `json:"source,omitempty"`
}

VariableMetadata : An user editable metadata for the variables.

type VersionResponse

type VersionResponse struct {
	// The date when the API version was built.
	Builddate *string `json:"builddate,omitempty"`

	// The build number that the API is based on.
	Buildno *string `json:"buildno,omitempty"`

	// The SHA value for the Git commit that represents the latest version of the API.
	Commitsha *string `json:"commitsha,omitempty"`

	// The Terraform Helm provider version that is used when you install Helm charts with Schematics.
	HelmProviderVersion *string `json:"helm_provider_version,omitempty"`

	// The Helm version that is used when you install Helm charts with Schematics.
	HelmVersion *string `json:"helm_version,omitempty"`

	// Supported template types.
	SupportedTemplateTypes map[string]interface{} `json:"supported_template_types,omitempty"`

	// The version of the IBM Cloud Terraform provider plug-in that is used when you apply Terraform templates with
	// Schematics.
	TerraformProviderVersion *string `json:"terraform_provider_version,omitempty"`

	// The Terraform version that is used when you apply Terraform templates with Schematics.
	TerraformVersion *string `json:"terraform_version,omitempty"`
}

VersionResponse : Successful response when you retrieve detailed information about the IBM Cloud Schematics API.

type WorkspaceActivities

type WorkspaceActivities struct {
	// List of workspace jobs.
	Actions []WorkspaceActivity `json:"actions,omitempty"`

	// The ID of the workspace.
	WorkspaceID *string `json:"workspace_id,omitempty"`

	// The name of the workspace.
	WorkspaceName *string `json:"workspace_name,omitempty"`
}

WorkspaceActivities : List of workspace jobs.

type WorkspaceActivity

type WorkspaceActivity struct {
	// The ID of the activity or job.  You can use the ID to retrieve the logs for that job by using the `GET
	// /v1/workspaces/{id}/actions/{action_id}/logs` API.
	ActionID *string `json:"action_id,omitempty"`

	// Information about the success or failure of your job,  including a success or error code and the timestamp when the
	// job succeeded or failed.
	Message []string `json:"message,omitempty"`

	// The type of actovoty or job that ran against your workspace.
	//
	//  * **APPLY**: The apply job was created when you used the `PUT /v1/workspaces/{id}/apply` API to apply a Terraform
	// template in IBM Cloud.
	//  * **DESTROY**: The destroy job was created when you used the `DELETE /v1/workspaces/{id}/destroy` API to remove all
	// resources that are associated with your workspace.
	//  * **PLAN**: The plan job was created when you used the `POST /v1/workspaces/{id}/plan` API to create a Terraform
	// execution plan.
	Name *string `json:"name,omitempty"`

	// The timestamp when the job was initiated.
	PerformedAt *strfmt.DateTime `json:"performed_at,omitempty"`

	// The user ID who initiated the job.
	PerformedBy *string `json:"performed_by,omitempty"`

	// The status of your activity or job. To retrieve the URL to your job logs, use the GET
	// /v1/workspaces/{id}/actions/{action_id}/logs API.
	//
	// * **COMPLETED**: The job completed successfully.
	// * **CREATED**: The job was created, but the provisioning, modification, or removal of IBM Cloud resources has not
	// started yet.
	// * **FAILED**: An error occurred during the plan, apply, or destroy job. Use the job ID to retrieve the URL to the
	// log files for your job.
	// * **IN PROGRESS**: The job is in progress. You can use the log_url to access the logs.
	Status *string `json:"status,omitempty"`

	// List of template activities.
	Templates []WorkspaceActivityTemplate `json:"templates,omitempty"`
}

WorkspaceActivity : Information about the workspace jobs.

type WorkspaceActivityApplyResult

type WorkspaceActivityApplyResult struct {
	// The ID of the activity or job that was created when you initiated a request to `apply` a Terraform template.  You
	// can use the ID to retrieve log file by using the `GET /v1/workspaces/{id}/actions/{action_id}/logs` API.
	Activityid *string `json:"activityid,omitempty"`
}

WorkspaceActivityApplyResult : Response after successfully initiating a request to `apply` the Terraform template in IBM Cloud.

type WorkspaceActivityCommandResult

type WorkspaceActivityCommandResult struct {
	// The ID of the job that was created when you initiated a request to `apply` a Terraform template.  You can use the ID
	// to retrieve log file by using the `GET /v1/workspaces/{id}/actions/{action_id}/logs` API.
	Activityid *string `json:"activityid,omitempty"`
}

WorkspaceActivityCommandResult : Response after successfully initiating a request to run a workspace command on the stack of resources provisioned using Terraform.

type WorkspaceActivityDestroyResult

type WorkspaceActivityDestroyResult struct {
	// The ID of the activity or job that was created when you initiated a request to `destroy` a Terraform template.  You
	// can use the ID to retrieve log file by using the `GET /v1/workspaces/{id}/actions/{action_id}/logs` API.
	Activityid *string `json:"activityid,omitempty"`
}

WorkspaceActivityDestroyResult : Response after successfully initiating a request to `destroy` the stack of resources provisioned using Terraform.

type WorkspaceActivityLogs

type WorkspaceActivityLogs struct {
	// The ID of the activity or job that ran against your workspace.
	ActionID *string `json:"action_id,omitempty"`

	// The type of actovoty or job that ran against your workspace.
	//
	//  * **APPLY**: The apply job was created when you used the `PUT /v1/workspaces/{id}/apply` API to apply a Terraform
	// template in IBM Cloud.
	//  * **DESTROY**: The destroy job was created when you used the `DELETE /v1/workspaces/{id}/destroy` API to remove all
	// resources that are associated with your workspace.
	//  * **PLAN**: The plan job was created when you used the `POST /v1/workspaces/{id}/plan` API to create a Terraform
	// execution plan.
	Name *string `json:"name,omitempty"`

	// List of templates in the workspace.
	Templates []WorkspaceActivityTemplateLogs `json:"templates,omitempty"`
}

WorkspaceActivityLogs : Workspace job logs for all the templates in the workspace.

type WorkspaceActivityOptionsTemplate

type WorkspaceActivityOptionsTemplate struct {
	// A list of Terraform resources to target.
	Target []string `json:"target,omitempty"`

	// Terraform variables for the workspace job options.
	TfVars []string `json:"tf_vars,omitempty"`
}

WorkspaceActivityOptionsTemplate : Workspace job options template.

type WorkspaceActivityPlanResult

type WorkspaceActivityPlanResult struct {
	// The ID of the activity or job that was created when you initiated a request to `plan` a Terraform template.  You can
	// use the ID to retrieve log file by using the `GET /v1/workspaces/{id}/actions/{action_id}/logs` API.
	Activityid *string `json:"activityid,omitempty"`
}

WorkspaceActivityPlanResult : Response after successfully initiating a request to `plan` the Terraform template in IBM Cloud.

type WorkspaceActivityRefreshResult

type WorkspaceActivityRefreshResult struct {
	// The ID of the activity or job that was created for your workspace `refresh` activity or job.  You can use the ID to
	// retrieve the log file by using the `GET /v1/workspaces/{id}/actions/{action_id}/logs` API.
	Activityid *string `json:"activityid,omitempty"`
}

WorkspaceActivityRefreshResult : Response after successfully initiating a request to `refresh` the Terraform template in IBM Cloud.

type WorkspaceActivityTemplate

type WorkspaceActivityTemplate struct {
	// End time for the job.
	EndTime *strfmt.DateTime `json:"end_time,omitempty"`

	// Summary information extracted from the job logs.
	LogSummary *LogSummary `json:"log_summary,omitempty"`

	// Log URL.
	LogURL *string `json:"log_url,omitempty"`

	// Message.
	Message *string `json:"message,omitempty"`

	// Job start time.
	StartTime *strfmt.DateTime `json:"start_time,omitempty"`

	// The status of your activity or job. To retrieve the URL to your job logs, use the GET
	// /v1/workspaces/{id}/actions/{action_id}/logs API.
	//
	// * **COMPLETED**: The job completed successfully.
	// * **CREATED**: The job was created, but the provisioning, modification, or removal of IBM Cloud resources has not
	// started yet.
	// * **FAILED**: An error occurred during the plan, apply, or destroy job. Use the job ID to retrieve the URL to the
	// log files for your job.
	// * **IN PROGRESS**: The job is in progress. You can use the log_url to access the logs.
	Status *string `json:"status,omitempty"`

	// The ID that was assigned to your Terraform template or IBM Cloud catalog software template.
	TemplateID *string `json:"template_id,omitempty"`

	// The type of template.
	TemplateType *string `json:"template_type,omitempty"`
}

WorkspaceActivityTemplate : Information about the template in the workspace.

type WorkspaceActivityTemplateLogs

type WorkspaceActivityTemplateLogs struct {
	// The URL to access the logs that were created during the plan, apply, or destroy job.
	LogURL *string `json:"log_url,omitempty"`

	// The ID that was assigned to your Terraform template or IBM Cloud catalog software template.
	TemplateID *string `json:"template_id,omitempty"`

	// The type of template.
	TemplateType *string `json:"template_type,omitempty"`
}

WorkspaceActivityTemplateLogs : Information about the log URL for a job that ran for a template against your workspace.

type WorkspaceBulkDeleteResponse

type WorkspaceBulkDeleteResponse struct {
	// The workspace deletion job name.
	Job *string `json:"job,omitempty"`

	// The workspace deletion job id.
	JobID *string `json:"job_id,omitempty"`
}

WorkspaceBulkDeleteResponse : The response after successfully initiating the bulk job to delete multiple workspaces.

type WorkspaceJobResponse

type WorkspaceJobResponse struct {
	// Status of the workspace bulk job.
	JobStatus *WorkspaceJobStatusType `json:"job_status,omitempty"`
}

WorkspaceJobResponse : The response from the workspace bulk job status.

type WorkspaceJobStatusType

type WorkspaceJobStatusType struct {
	// List of failed workspace jobs.
	Failed []string `json:"failed,omitempty"`

	// List of in_progress workspace jobs.
	InProgress []string `json:"in_progress,omitempty"`

	// List of successful workspace jobs.
	Success []string `json:"success,omitempty"`

	// Workspace job status updated at.
	LastUpdatedOn *strfmt.DateTime `json:"last_updated_on,omitempty"`
}

WorkspaceJobStatusType : Status of the workspace bulk job.

type WorkspaceResponse

type WorkspaceResponse struct {
	// List of applied shared dataset ID.
	// Deprecated: this field is deprecated and may be removed in a future release.
	AppliedShareddataIds []string `json:"applied_shareddata_ids,omitempty"`

	// Information about the software template that you chose from the IBM Cloud catalog. This information is returned for
	// IBM Cloud catalog offerings only.
	CatalogRef *CatalogRef `json:"catalog_ref,omitempty"`

	// The timestamp when the workspace was created.
	CreatedAt *strfmt.DateTime `json:"created_at,omitempty"`

	// The user ID that created the workspace.
	CreatedBy *string `json:"created_by,omitempty"`

	// The workspace CRN.
	Crn *string `json:"crn,omitempty"`

	// Workspace dependencies.
	Dependencies *Dependencies `json:"dependencies,omitempty"`

	// The description of the workspace.
	Description *string `json:"description,omitempty"`

	// The unique identifier of the workspace.
	ID *string `json:"id,omitempty"`

	// The timestamp when the last health check was performed by Schematics.
	LastHealthCheckAt *strfmt.DateTime `json:"last_health_check_at,omitempty"`

	// The IBM Cloud location where your workspace was provisioned.
	Location *string `json:"location,omitempty"`

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

	// The resource group the workspace was provisioned in.
	ResourceGroup *string `json:"resource_group,omitempty"`

	// Information about the provisioning engine, state file, and runtime logs.
	RuntimeData []TemplateRunTimeDataResponse `json:"runtime_data,omitempty"`

	// Information about the Target used by the templates originating from IBM Cloud catalog offerings. This information is
	// not relevant when you create a workspace from your own Terraform template.
	SharedData *SharedTargetDataResponse `json:"shared_data,omitempty"`

	// The status of the workspace.
	//
	//   **Active**: After you successfully ran your infrastructure code by applying your Terraform execution plan, the
	// state of your workspace changes to `Active`.
	//
	//   **Connecting**: Schematics tries to connect to the template in your source repo. If successfully connected, the
	// template is downloaded and metadata, such as input parameters, is extracted. After the template is downloaded, the
	// state of the workspace changes to `Scanning`.
	//
	//   **Draft**: The workspace is created without a reference to a GitHub or GitLab repository.
	//
	//   **Failed**: If errors occur during the execution of your infrastructure code in IBM Cloud Schematics, your
	// workspace status is set to `Failed`.
	//
	//   **Inactive**: The Terraform template was scanned successfully and the workspace creation is complete. You can now
	// start running Schematics plan and apply jobs to provision the IBM Cloud resources that you specified in your
	// template. If you have an `Active` workspace and decide to remove all your resources, your workspace is set to
	// `Inactive` after all your resources are removed.
	//
	//   **In progress**: When you instruct IBM Cloud Schematics to run your infrastructure code by applying your Terraform
	// execution plan, the status of our workspace changes to `In progress`.
	//
	//   **Scanning**: The download of the Terraform template is complete and vulnerability scanning started. If the scan
	// is successful, the workspace state changes to `Inactive`. If errors in your template are found, the state changes to
	// `Template Error`.
	//
	//   **Stopped**: The Schematics plan, apply, or destroy job was cancelled manually.
	//
	//   **Template Error**: The Schematics template contains errors and cannot be processed.
	Status *string `json:"status,omitempty"`

	// A list of tags that are associated with the workspace.
	Tags []string `json:"tags,omitempty"`

	// Information about the Terraform or IBM Cloud software template that you want to use.
	TemplateData []TemplateSourceDataResponse `json:"template_data,omitempty"`

	// Workspace template reference.
	TemplateRef *string `json:"template_ref,omitempty"`

	// Information about the Template repository used by the workspace.
	TemplateRepo *TemplateRepoResponse `json:"template_repo,omitempty"`

	// The Terraform version that was used to run your Terraform code.
	Type []string `json:"type,omitempty"`

	// The timestamp when the workspace was last updated.
	UpdatedAt *strfmt.DateTime `json:"updated_at,omitempty"`

	// The user ID that updated the workspace.
	UpdatedBy *string `json:"updated_by,omitempty"`

	// The associate cart order ID.
	CartID *string `json:"cart_id,omitempty"`

	// The associate project ID.
	ProjectID *string `json:"project_id,omitempty"`

	// Name of the last Action performed on workspace.
	LastActionName *string `json:"last_action_name,omitempty"`

	// ID of last Activity performed.
	LastActivityID *string `json:"last_activity_id,omitempty"`

	// Last job details.
	LastJob *LastJob `json:"last_job,omitempty"`

	// Response that indicate the status of the workspace as either frozen or locked.
	WorkspaceStatus *WorkspaceStatusResponse `json:"workspace_status,omitempty"`

	// Information about the last job that ran against the workspace. -.
	WorkspaceStatusMsg *WorkspaceStatusMessage `json:"workspace_status_msg,omitempty"`

	// Agent name, Agent id and associated policy ID information.
	Agent *AgentInfo `json:"agent,omitempty"`

	// Input settings to be applied to the workspace, for example, `job_timeout_override`.
	Settings []VariableData `json:"settings,omitempty"`

	// secrets manager reference to git token.
	GitTokenRef *string `json:"git_token_ref,omitempty"`

	// Encryption details about the workspace such as scheme (byok/kyok) and key CRN.
	Encryption *EncryptionInfo `json:"encryption,omitempty"`
}

WorkspaceResponse : Workspace details.

type WorkspaceResponseList

type WorkspaceResponseList struct {
	// The number of workspaces in the IBM Cloud account that you have access to and that matched your search criteria.
	Count *int64 `json:"count,omitempty"`

	// The `limit` value that you set in your API request and that represents the maximum number of workspaces that you
	// wanted to list.
	Limit *int64 `json:"limit" validate:"required"`

	// The `offset` value that you set in your API request. The offset value represents the position number of the
	// workspace from which you wanted to start listing your workspaces.
	Offset *int64 `json:"offset" validate:"required"`

	// The list of workspaces that was included in your API response.
	Workspaces []WorkspaceResponse `json:"workspaces,omitempty"`
}

WorkspaceResponseList : List of workspaces.

type WorkspaceStatusMessage

type WorkspaceStatusMessage struct {
	// The success or error code that was returned for the last plan, apply, or destroy job that ran against your
	// workspace.
	StatusCode *string `json:"status_code,omitempty"`

	// The success or error message that was returned for the last plan, apply, or destroy job that ran against your
	// workspace.
	StatusMsg *string `json:"status_msg,omitempty"`
}

WorkspaceStatusMessage : Information about the last job that ran against the workspace. -.

type WorkspaceStatusRequest

type WorkspaceStatusRequest struct {
	// If set to true, the workspace is frozen and changes to the workspace are disabled.
	Frozen *bool `json:"frozen,omitempty"`

	// The timestamp when the workspace was frozen.
	FrozenAt *strfmt.DateTime `json:"frozen_at,omitempty"`

	// The user ID that froze the workspace.
	FrozenBy *string `json:"frozen_by,omitempty"`

	// If set to true, the workspace is locked and disabled for changes.
	Locked *bool `json:"locked,omitempty"`

	// The user ID that initiated a resource-related job, such as applying or destroying resources, that locked the
	// workspace.
	LockedBy *string `json:"locked_by,omitempty"`

	// The timestamp when the workspace was locked.
	LockedTime *strfmt.DateTime `json:"locked_time,omitempty"`
}

WorkspaceStatusRequest : WorkspaceStatusRequest -.

type WorkspaceStatusResponse

type WorkspaceStatusResponse struct {
	// If set to true, the workspace is frozen and changes to the workspace are disabled.
	Frozen *bool `json:"frozen,omitempty"`

	// The timestamp when the workspace was frozen.
	FrozenAt *strfmt.DateTime `json:"frozen_at,omitempty"`

	// The user ID that froze the workspace.
	FrozenBy *string `json:"frozen_by,omitempty"`

	// If set to true, the workspace is locked and disabled for changes.
	Locked *bool `json:"locked,omitempty"`

	// The user ID that initiated a resource-related job, such as applying or destroying resources, that locked the
	// workspace.
	LockedBy *string `json:"locked_by,omitempty"`

	// The timestamp when the workspace was locked.
	LockedTime *strfmt.DateTime `json:"locked_time,omitempty"`
}

WorkspaceStatusResponse : Response that indicate the status of the workspace as either frozen or locked.

type WorkspaceStatusUpdateRequest

type WorkspaceStatusUpdateRequest struct {
	// If set to true, the workspace is frozen and changes to the workspace are disabled.
	Frozen *bool `json:"frozen,omitempty"`

	// Frozen at.
	FrozenAt *strfmt.DateTime `json:"frozen_at,omitempty"`

	// Frozen by.
	FrozenBy *string `json:"frozen_by,omitempty"`

	// Locked status.
	Locked *bool `json:"locked,omitempty"`

	// Locked by.
	LockedBy *string `json:"locked_by,omitempty"`

	// Locked at.
	LockedTime *strfmt.DateTime `json:"locked_time,omitempty"`
}

WorkspaceStatusUpdateRequest : Input to update the workspace status.

type WorkspaceTemplateValuesResponse

type WorkspaceTemplateValuesResponse struct {
	// Information about the provisioning engine, state file, and runtime logs.
	RuntimeData []TemplateRunTimeDataResponse `json:"runtime_data,omitempty"`

	// Information about the Target used by the templates originating from the  IBM Cloud catalog offerings. This
	// information is not relevant for workspace created using your own Terraform template.
	SharedData *SharedTargetData `json:"shared_data,omitempty"`

	// Information about the input variables that are used in the template.
	TemplateData []TemplateSourceDataResponse `json:"template_data,omitempty"`
}

WorkspaceTemplateValuesResponse : Response with the template details in your workspace.

type WorkspaceVariableRequest

type WorkspaceVariableRequest struct {
	// The description of your input variable.
	Description *string `json:"description,omitempty"`

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

	// If set to `true`, the value of your input variable is protected and not returned in your API response.
	Secure *bool `json:"secure,omitempty"`

	// `Terraform v0.11` supports `string`, `list`, `map` data type. For more information, about the syntax, see
	// [Configuring input variables](https://www.terraform.io/docs/configuration-0-11/variables.html).
	// <br> `Terraform v0.12` additionally, supports `bool`, `number` and complex data types such as `list(type)`,
	// `map(type)`,
	// `object({attribute name=type,..})`, `set(type)`, `tuple([type])`. For more information, about the syntax to use the
	// complex data type, see [Configuring
	// variables](https://www.terraform.io/docs/configuration/variables.html#type-constraints).
	Type *string `json:"type,omitempty"`

	// Variable uses default value; and is not over-ridden.
	UseDefault *bool `json:"use_default,omitempty"`

	// Enter the value as a string for the primitive types such as `bool`, `number`, `string`, and `HCL` format for the
	// complex variables, as you provide in a `.tfvars` file. **You need to enter escaped string of `HCL` format for the
	// complex variable value**. For more information, about how to declare variables in a terraform configuration file and
	// provide value to schematics, see [Providing values for the declared
	// variables](https://cloud.ibm.com/docs/schematics?topic=schematics-create-tf-config#declare-variable).
	Value *string `json:"value,omitempty"`
}

WorkspaceVariableRequest : Input variables for your workspace.

type WorkspaceVariableResponse

type WorkspaceVariableResponse struct {
	// The description of your input variable.
	Description *string `json:"description,omitempty"`

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

	// If set to `true`, the value of your input variable is protected and not returned in your API response.
	Secure *bool `json:"secure,omitempty"`

	// `Terraform v0.11` supports `string`, `list`, `map` data type. For more information, about the syntax, see
	// [Configuring input variables](https://www.terraform.io/docs/configuration-0-11/variables.html).
	// <br> `Terraform v0.12` additionally, supports `bool`, `number` and complex data types such as `list(type)`,
	// `map(type)`,
	// `object({attribute name=type,..})`, `set(type)`, `tuple([type])`. For more information, about the syntax to use the
	// complex data type, see [Configuring
	// variables](https://www.terraform.io/docs/configuration/variables.html#type-constraints).
	Type *string `json:"type,omitempty"`

	// Enter the value as a string for the primitive types such as `bool`, `number`, `string`, and `HCL` format for the
	// complex variables, as you provide in a `.tfvars` file. **You need to enter escaped string of `HCL` format for the
	// complex variable value**. For more information, about how to declare variables in a terraform configuration file and
	// provide value to schematics, see [Providing values for the declared
	// variables](https://cloud.ibm.com/docs/schematics?topic=schematics-create-tf-config#declare-variable).
	Value *string `json:"value,omitempty"`
}

WorkspaceVariableResponse : The description of your input variable.