schematicsv1

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

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

	// List of workspace locations supported by IBM Cloud Schematics service.  Note, this does not limit the location of
	// the 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"`

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

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

	// Inventory ID.
	Inventory *string `json:"inventory,omitempty"`

	// User editable variable data & system generated reference to value.
	BastionCredential *VariableData `json:"bastion_credential,omitempty"`

	// credentials of the Action.
	Credentials []VariableData `json:"credentials,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"`

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

	// Action Playbook updation time.
	SourceUpdatedAt *strfmt.DateTime `json:"source_updated_at,omitempty"`

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

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

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

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

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

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

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 workspace locations supported by IBM Cloud Schematics service.  Note, this does not limit the location of
	// the 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"`
}

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

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

type ApplyWorkspaceCommandOptions struct {
	// The workspace ID for the workspace that you want to query.  You can run the GET /workspaces call if you need to look
	// up the  workspace IDs in your IBM Cloud account.
	WID *string `json:"w_id" validate:"required,ne="`

	// The IAM refresh token associated with the IBM Cloud account.
	RefreshToken *string `json:"refresh_token" validate:"required"`

	// Workspace Activity Options Template.
	ActionOptions *WorkspaceActivityOptionsTemplate `json:"action_options,omitempty"`

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

type BastionResourceDefinition struct {
	// Bastion Name(Unique).
	Name *string `json:"name,omitempty"`

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

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

	// Catalog item icon url.
	ItemIconURL *string `json:"item_icon_url,omitempty"`

	// Catalog item id.
	ItemID *string `json:"item_id,omitempty"`

	// Catalog item name.
	ItemName *string `json:"item_name,omitempty"`

	// Catalog item readme url.
	ItemReadmeURL *string `json:"item_readme_url,omitempty"`

	// Catalog item url.
	ItemURL *string `json:"item_url,omitempty"`

	// Catalog item launch url.
	LaunchURL *string `json:"launch_url,omitempty"`

	// Catalog item offering version.
	OfferingVersion *string `json:"offering_version,omitempty"`
}

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

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

	// List of workspace locations supported by IBM Cloud Schematics service.  Note, this does not limit the location of
	// the 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"`

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

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

	// Inventory ID.
	Inventory *string `json:"inventory,omitempty"`

	// User editable variable data & system generated reference to value.
	BastionCredential *VariableData `json:"bastion_credential,omitempty"`

	// credentials of the Action.
	Credentials []VariableData `json:"credentials,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"`

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

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

	// The github token associated with the GIT. Required for cloning of repo.
	XGithubToken *string `json:"X-Github-token,omitempty"`

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

type CreateInventoryOptions struct {
	// Inventory name.
	Name *string `json:"name,omitempty"`

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

	// List of workspace locations supported by IBM Cloud Schematics service.  Note, this does not limit the location of
	// the resources provisioned using Schematics.
	Location *string `json:"location,omitempty"`

	// Resource-group name for the Inventory definition.  By default, Action 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 queries 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
}

type CreateJobOptions struct {
	// The IAM refresh token associated with the IBM Cloud account.
	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, capsule-name or flow-name).
	CommandParameter *string `json:"command_parameter,omitempty"`

	// Command line options for the command.
	CommandOptions []string `json:"command_options,omitempty"`

	// Job inputs used by Action.
	Inputs []VariableData `json:"inputs,omitempty"`

	// Environment variables used by the Job while performing Action.
	Settings []VariableData `json:"settings,omitempty"`

	// User defined tags, while running the job.
	Tags []string `json:"tags,omitempty"`

	// List of workspace locations supported by IBM Cloud Schematics service.  Note, this does not limit the location of
	// the resources provisioned using Schematics.
	Location *string `json:"location,omitempty"`

	// Job Status.
	Status *JobStatus `json:"status,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"`

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

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
}

type CreateSharedDatasetOptions struct {
	// Automatically propagate changes to consumers.
	AutoPropagateChange *bool `json:"auto_propagate_change,omitempty"`

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

	// Affected workspaces.
	EffectedWorkspaceIds []string `json:"effected_workspace_ids,omitempty"`

	// Resource group name.
	ResourceGroup *string `json:"resource_group,omitempty"`

	// Shared dataset data.
	SharedDatasetData []SharedDatasetData `json:"shared_dataset_data,omitempty"`

	// Shared dataset name.
	SharedDatasetName *string `json:"shared_dataset_name,omitempty"`

	// Shared dataset source name.
	SharedDatasetSourceName *string `json:"shared_dataset_source_name,omitempty"`

	// Shared dataset type.
	SharedDatasetType []string `json:"shared_dataset_type,omitempty"`

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

	// Shared dataset version.
	Version *string `json:"version,omitempty"`

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

type CreateWorkspaceDeletionJobOptions struct {
	// The IAM refresh token associated with the IBM Cloud account.
	RefreshToken *string `json:"refresh_token" validate:"required"`

	// True to delete workspace.
	NewDeleteWorkspaces *bool `json:"new_delete_workspaces,omitempty"`

	// True to destroy the resources managed by this workspace.
	NewDestroyResources *bool `json:"new_destroy_resources,omitempty"`

	// Workspace deletion job name.
	NewJob *string `json:"new_job,omitempty"`

	// Version.
	NewVersion *string `json:"new_version,omitempty"`

	// List of workspaces to be deleted.
	NewWorkspaces []string `json:"new_workspaces,omitempty"`

	// true or 1 - to destroy resources before deleting workspace;  If this is true, refresh_token is mandatory.
	DestroyResources *string `json:"destroy_resources,omitempty"`

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

type CreateWorkspaceOptions struct {
	// List of applied shared dataset id.
	AppliedShareddataIds []string `json:"applied_shareddata_ids,omitempty"`

	// CatalogRef -.
	CatalogRef *CatalogRef `json:"catalog_ref,omitempty"`

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

	// Workspace location.
	Location *string `json:"location,omitempty"`

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

	// Workspace resource group.
	ResourceGroup *string `json:"resource_group,omitempty"`

	// SharedTargetData -.
	SharedData *SharedTargetData `json:"shared_data,omitempty"`

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

	// TemplateData -.
	TemplateData []TemplateSourceDataRequest `json:"template_data,omitempty"`

	// Workspace template ref.
	TemplateRef *string `json:"template_ref,omitempty"`

	// TemplateRepoRequest -.
	TemplateRepo *TemplateRepoRequest `json:"template_repo,omitempty"`

	// List of Workspace type.
	Type []string `json:"type,omitempty"`

	// WorkspaceStatusRequest -.
	WorkspaceStatus *WorkspaceStatusRequest `json:"workspace_status,omitempty"`

	// The github token associated with the GIT. Required for cloning of repo.
	XGithubToken *string `json:"X-Github-token,omitempty"`

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

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
}

type DeleteInventoryOptions struct {
	// Resource Inventory Id.  Use GET /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
}

type DeleteJobOptions struct {
	// Job Id. Use GET /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 associated with the IBM Cloud account.
	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
}

type DeleteResourcesQueryOptions struct {
	// Resource query Id.  Use GET /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
}

type DeleteSharedDatasetOptions struct {
	// The shared dataset ID Use the GET /shared_datasets to look up the shared dataset IDs  in your IBM Cloud account.
	SdID *string `json:"sd_id" validate:"required,ne="`

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

type DeleteWorkspaceActivityOptions struct {
	// The workspace ID for the workspace that you want to query.  You can run the GET /workspaces call if you need to look
	// up the  workspace IDs in your IBM Cloud account.
	WID *string `json:"w_id" validate:"required,ne="`

	// The activity ID that you want to see additional details.
	ActivityID *string `json:"activity_id" validate:"required,ne="`

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

type DeleteWorkspaceOptions struct {
	// The workspace ID for the workspace that you want to query.  You can run the GET /workspaces call if you need to look
	// up the  workspace IDs in your IBM Cloud account.
	WID *string `json:"w_id" validate:"required,ne="`

	// The IAM refresh token associated with the IBM Cloud account.
	RefreshToken *string `json:"refresh_token" validate:"required"`

	// true or 1 - to destroy resources before deleting workspace;  If this is true, refresh_token is mandatory.
	DestroyResources *string `json:"destroy_resources,omitempty"`

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

type DestroyWorkspaceCommandOptions struct {
	// The workspace ID for the workspace that you want to query.  You can run the GET /workspaces call if you need to look
	// up the  workspace IDs in your IBM Cloud account.
	WID *string `json:"w_id" validate:"required,ne="`

	// The IAM refresh token associated with the IBM Cloud account.
	RefreshToken *string `json:"refresh_token" validate:"required"`

	// Workspace Activity Options Template.
	ActionOptions *WorkspaceActivityOptionsTemplate `json:"action_options,omitempty"`

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

type EnvVariableResponse struct {
	// Env variable is hidden.
	Hidden *bool `json:"hidden,omitempty"`

	// Env variable name.
	Name *string `json:"name,omitempty"`

	// Env variable is secure.
	Secure *bool `json:"secure,omitempty"`

	// Value for env variable.
	Value *string `json:"value,omitempty"`
}

type ExecuteResourceQueryOptions struct {
	// Resource query Id.  Use GET /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
}

type ExternalSource struct {
	// Type of source for the Template.
	SourceType *string `json:"source_type" validate:"required"`

	// Connection details to Git source.
	Git *ExternalSourceGit `json:"git,omitempty"`
}

type ExternalSourceGit struct {
	// URL to the GIT Repo that can be used to clone the template.
	GitRepoURL *string `json:"git_repo_url,omitempty"`

	// Personal Access Token to connect to Git URLs.
	GitToken *string `json:"git_token,omitempty"`

	// Name of the folder in the Git Repo, that contains the template.
	GitRepoFolder *string `json:"git_repo_folder,omitempty"`

	// Name of the release tag, used to fetch the Git Repo.
	GitRelease *string `json:"git_release,omitempty"`

	// Name of the branch, used to fetch the Git Repo.
	GitBranch *string `json:"git_branch,omitempty"`
}

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
}

type GetAllWorkspaceInputsOptions struct {
	// The workspace ID for the workspace that you want to query.  You can run the GET /workspaces call if you need to look
	// up the  workspace IDs in your IBM Cloud account.
	WID *string `json:"w_id" validate:"required,ne="`

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

type GetDiscoveredKmsInstancesOptions 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).
	ResourceGroup *string `json:"resource_group,omitempty"`

	// The numbers of items to return.
	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
}

type GetInventoryOptions struct {
	// Resource Inventory Id.  Use GET /inventories API to look up the Resource Inventory definition Ids  in your IBM Cloud
	// account.
	InventoryID *string `json:"inventory_id" validate:"required,ne="`

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

type GetInventoryValueOptions struct {
	// Resource Inventory Id.  Use GET /inventories API to look up the Resource Inventory definition Ids  in your IBM Cloud
	// account.
	InventoryID *string `json:"inventory_id" validate:"required,ne="`

	// Name of the variable.
	VarName *string `json:"var_name" validate:"required,ne="`

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

type GetJobOptions struct {
	// Job Id. Use GET /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
}

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
}

type GetResourcesQueryOptions struct {
	// Resource query Id.  Use GET /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
}

type GetSchematicsVersionOptions struct {

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

type GetSharedDatasetOptions struct {
	// The shared dataset ID Use the GET /shared_datasets to look up the shared dataset IDs  in your IBM Cloud account.
	SdID *string `json:"sd_id" validate:"required,ne="`

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

type GetTemplateActivityLogOptions struct {
	// The workspace ID for the workspace that you want to query.  You can run the GET /workspaces call if you need to look
	// up the  workspace IDs in your IBM Cloud account.
	WID *string `json:"w_id" validate:"required,ne="`

	// The Template ID for which you want to get the values.  Use the GET /workspaces to look up the workspace IDs  or
	// template IDs in your IBM Cloud account.
	TID *string `json:"t_id" validate:"required,ne="`

	// The activity ID that you want to see additional details.
	ActivityID *string `json:"activity_id" validate:"required,ne="`

	// `false` will hide the terraform command header in the logs.
	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
}

type GetTemplateLogsOptions struct {
	// The workspace ID for the workspace that you want to query.  You can run the GET /workspaces call if you need to look
	// up the  workspace IDs in your IBM Cloud account.
	WID *string `json:"w_id" validate:"required,ne="`

	// The Template ID for which you want to get the values.  Use the GET /workspaces to look up the workspace IDs  or
	// template IDs in your IBM Cloud account.
	TID *string `json:"t_id" validate:"required,ne="`

	// `false` will hide the terraform command header in the logs.
	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
}

type GetWorkspaceActivityLogsOptions struct {
	// The workspace ID for the workspace that you want to query.  You can run the GET /workspaces call if you need to look
	// up the  workspace IDs in your IBM Cloud account.
	WID *string `json:"w_id" validate:"required,ne="`

	// The activity ID that you want to see additional details.
	ActivityID *string `json:"activity_id" validate:"required,ne="`

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

type GetWorkspaceActivityOptions struct {
	// The workspace ID for the workspace that you want to query.  You can run the GET /workspaces call if you need to look
	// up the  workspace IDs in your IBM Cloud account.
	WID *string `json:"w_id" validate:"required,ne="`

	// The activity ID that you want to see additional details.
	ActivityID *string `json:"activity_id" validate:"required,ne="`

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

type GetWorkspaceDeletionJobStatusOptions struct {
	// The workspace job deletion ID.
	WjID *string `json:"wj_id" validate:"required,ne="`

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

type GetWorkspaceInputMetadataOptions struct {
	// The workspace ID for the workspace that you want to query.  You can run the GET /workspaces call if you need to look
	// up the  workspace IDs in your IBM Cloud account.
	WID *string `json:"w_id" validate:"required,ne="`

	// The Template ID for which you want to get the values.  Use the GET /workspaces to look up the workspace IDs  or
	// template IDs 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
}

type GetWorkspaceInputsOptions struct {
	// The workspace ID for the workspace that you want to query.  You can run the GET /workspaces call if you need to look
	// up the  workspace IDs in your IBM Cloud account.
	WID *string `json:"w_id" validate:"required,ne="`

	// The Template ID for which you want to get the values.  Use the GET /workspaces to look up the workspace IDs  or
	// template IDs 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
}

type GetWorkspaceLogUrlsOptions struct {
	// The workspace ID for the workspace that you want to query.  You can run the GET /workspaces call if you need to look
	// up the  workspace IDs in your IBM Cloud account.
	WID *string `json:"w_id" validate:"required,ne="`

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

type GetWorkspaceOptions struct {
	// The workspace ID for the workspace that you want to query.  You can run the GET /workspaces call if you need to look
	// up the  workspace IDs in your IBM Cloud account.
	WID *string `json:"w_id" validate:"required,ne="`

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

type GetWorkspaceOutputsOptions struct {
	// The workspace ID for the workspace that you want to query.  You can run the GET /workspaces call if you need to look
	// up the  workspace IDs in your IBM Cloud account.
	WID *string `json:"w_id" validate:"required,ne="`

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

type GetWorkspaceReadmeOptions struct {
	// The workspace ID for the workspace that you want to query.  You can run the GET /workspaces call if you need to look
	// up the  workspace IDs in your IBM Cloud account.
	WID *string `json:"w_id" validate:"required,ne="`

	// The name of the commit/branch/tag.  Default, the repository’s default branch (usually master).
	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
}

type GetWorkspaceResourcesOptions struct {
	// The workspace ID for the workspace that you want to query.  You can run the GET /workspaces call if you need to look
	// up the  workspace IDs in your IBM Cloud account.
	WID *string `json:"w_id" validate:"required,ne="`

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

type GetWorkspaceStateOptions struct {
	// The workspace ID for the workspace that you want to query.  You can run the GET /workspaces call if you need to look
	// up the  workspace IDs in your IBM Cloud account.
	WID *string `json:"w_id" validate:"required,ne="`

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

type GetWorkspaceTemplateStateOptions struct {
	// The workspace ID for the workspace that you want to query.  You can run the GET /workspaces call if you need to look
	// up the  workspace IDs in your IBM Cloud account.
	WID *string `json:"w_id" validate:"required,ne="`

	// The Template ID for which you want to get the values.  Use the GET /workspaces to look up the workspace IDs  or
	// template IDs 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
}

type InventoryResourceRecord struct {
	// Inventory name.
	Name *string `json:"name,omitempty"`

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

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

	// List of workspace locations supported by IBM Cloud Schematics service.  Note, this does not limit the location of
	// the resources provisioned using Schematics.
	Location *string `json:"location,omitempty"`

	// Resource-group name for the Inventory definition.  By default, Action 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"`
}

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 resource records.
	Inventories []InventoryResourceRecord `json:"inventories,omitempty"`
}

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, capsule-name or flow-name).
	CommandParameter *string `json:"command_parameter,omitempty"`

	// Command line options for the command.
	CommandOptions []string `json:"command_options,omitempty"`

	// Job inputs used by Action.
	Inputs []VariableData `json:"inputs,omitempty"`

	// Environment variables used by the Job while performing Action.
	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 Action.
	Name *string `json:"name,omitempty"`

	// Job description derived from the related Action.
	Description *string `json:"description,omitempty"`

	// List of workspace locations supported by IBM Cloud Schematics service.  Note, this does not limit the location of
	// the resources provisioned using Schematics.
	Location *string `json:"location,omitempty"`

	// Resource-group name derived from the related 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"`

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

type JobData struct {
	// Type of Job.
	JobType *string `json:"job_type" validate:"required"`

	// Action Job data.
	ActionJobData *JobDataAction `json:"action_job_data,omitempty"`
}

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 resource details with user inputs and system generated data.
	InventoryRecord *InventoryResourceRecord `json:"inventory_record,omitempty"`

	// Materialized inventory details used by the Action Job, in .ini format.
	MaterializedInventory *string `json:"materialized_inventory,omitempty"`
}

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

type JobLite struct {
	// Job ID.
	ID *string `json:"id,omitempty"`

	// Job name, uniquely derived from the related Action.
	Name *string `json:"name,omitempty"`

	// Job description derived from the related Action.
	Description *string `json:"description,omitempty"`

	// Name of the Schematics automation resource.
	CommandObject *string `json:"command_object,omitempty"`

	// Job command object 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 workspace locations supported by IBM Cloud Schematics service.  Note, this does not limit the location of
	// the resources provisioned using Schematics.
	Location *string `json:"location,omitempty"`

	// Resource-group name derived from the related 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"`
}

type JobLog struct {
	// Job Id.
	JobID *string `json:"job_id,omitempty"`

	// Job name, uniquely derived from the related Action.
	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"`
}

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 []JobLogSummaryLogErrorsItem `json:"log_errors,omitempty"`

	// Repo download Job log summary.
	RepoDownloadJob *JobLogSummaryRepoDownloadJob `json:"repo_download_job,omitempty"`

	// Action Job.
	ActionJob *JobLogSummaryActionJob `json:"action_job,omitempty"`
}

type JobLogSummaryActionJob struct {
	// number of hosts.
	HostCount *float64 `json:"host_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"`
}

type JobLogSummaryActionJobRecap struct {
	// List of host name.
	Hosts []string `json:"hosts,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"`
}

type JobLogSummaryLogErrorsItem 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"`
}

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

type JobStateData struct {
	// Job Id.
	JobID *string `json:"job_id,omitempty"`

	// Job name, uniquely derived from the related Action.
	JobName *string `json:"job_name,omitempty"`

	// Job state summary.
	Summary []JobStateDataSummaryItem `json:"summary,omitempty"`

	// Format of the State data (eg. tfstate).
	Format *string `json:"format,omitempty"`

	// State data file.
	Details *[]byte `json:"details,omitempty"`

	// Job status updation timestamp.
	UpdatedAt *strfmt.DateTime `json:"updated_at,omitempty"`
}

type JobStateDataSummaryItem struct {
	// State summary feature name.
	Name *string `json:"name,omitempty"`

	// State summary feature type.
	Type *string `json:"type,omitempty"`

	// State summary feature value.
	Value *string `json:"value,omitempty"`
}

type JobStatus struct {
	// Action Job Status.
	ActionJobStatus *JobStatusAction `json:"action_job_status,omitempty"`
}

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.
	InventoryStatusCode *string `json:"inventory_status_code,omitempty"`

	// Aggregated status message for all inventory resources,  to be displayed along with the inventory_status_code;.
	InventoryStatusMessage *string `json:"inventory_status_message,omitempty"`

	// Job status updation timestamp.
	UpdatedAt *strfmt.DateTime `json:"updated_at,omitempty"`
}

type JobStatusType 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"`
}

type KMSDiscovery 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 KMS instances.
	KmsInstances []KMSInstances `json:"kms_instances,omitempty"`
}

type KMSInstances struct {
	// Location.
	Location *string `json:"location,omitempty"`

	// Encryption schema.
	EncryptionScheme *string `json:"encryption_scheme,omitempty"`

	// Resource groups.
	ResourceGroup *string `json:"resource_group,omitempty"`

	// KMS CRN.
	KmsCrn *string `json:"kms_crn,omitempty"`

	// KMS Name.
	KmsName *string `json:"kms_name,omitempty"`

	// KMS private endpoint.
	KmsPrivateEndpoint *string `json:"kms_private_endpoint,omitempty"`

	// KMS public endpoint.
	KmsPublicEndpoint *string `json:"kms_public_endpoint,omitempty"`

	// List of keys.
	Keys []KMSInstancesKeysItem `json:"keys,omitempty"`
}

type KMSInstancesKeysItem struct {
	// Key name.
	Name *string `json:"name,omitempty"`

	// CRN of the Key.
	Crn *string `json:"crn,omitempty"`

	// Error message.
	Error *string `json:"error,omitempty"`
}

type KMSSettings struct {
	// Location.
	Location *string `json:"location,omitempty"`

	// Encryption scheme.
	EncryptionScheme *string `json:"encryption_scheme,omitempty"`

	// Resource group.
	ResourceGroup *string `json:"resource_group,omitempty"`

	// Primary CRK details.
	PrimaryCrk *KMSSettingsPrimaryCrk `json:"primary_crk,omitempty"`

	// Secondary CRK details.
	SecondaryCrk *KMSSettingsSecondaryCrk `json:"secondary_crk,omitempty"`
}

type KMSSettingsPrimaryCrk struct {
	// Primary KMS name.
	KmsName *string `json:"kms_name,omitempty"`

	// Primary KMS endpoint.
	KmsPrivateEndpoint *string `json:"kms_private_endpoint,omitempty"`

	// CRN of the Primary Key.
	KeyCrn *string `json:"key_crn,omitempty"`
}

type KMSSettingsSecondaryCrk struct {
	// Secondary KMS name.
	KmsName *string `json:"kms_name,omitempty"`

	// Secondary KMS endpoint.
	KmsPrivateEndpoint *string `json:"kms_private_endpoint,omitempty"`

	// CRN of the Secondary Key.
	KeyCrn *string `json:"key_crn,omitempty"`
}

type ListActionsOptions struct {
	// The number of items to skip before starting to collect the result set.
	Offset *int64 `json:"offset,omitempty"`

	// The numbers of items to return.
	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
}

type ListInventoriesOptions struct {
	// The number of items to skip before starting to collect the result set.
	Offset *int64 `json:"offset,omitempty"`

	// The numbers of items to return.
	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
}

type ListInventoryValuesOptions struct {
	// Resource Inventory Id.  Use GET /inventories API to look up the Resource Inventory definition Ids  in your IBM Cloud
	// account.
	InventoryID *string `json:"inventory_id" validate:"required,ne="`

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

type ListJobLogsOptions struct {
	// Job Id. Use GET /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
}

type ListJobStatesOptions struct {
	// Job Id. Use GET /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
}