/**
* (C) Copyright IBM Corp. 2024.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
///
///
import { IncomingHttpHeaders, OutgoingHttpHeaders } from 'http';
import { BaseService, SDKLogger, UserOptions } from 'ibm-cloud-sdk-core';
/**
* 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
*/
declare class SchematicsV1 extends BaseService {
static _logger: SDKLogger;
static DEFAULT_SERVICE_URL: string;
static DEFAULT_SERVICE_NAME: string;
/*************************
* Factory method
************************/
/**
* Constructs an instance of SchematicsV1 with passed in options and external configuration.
*
* @param {UserOptions} [options] - The parameters to send to the service.
* @param {string} [options.serviceName] - The name of the service to configure
* @param {Authenticator} [options.authenticator] - The Authenticator object used to authenticate requests to the service
* @param {string} [options.serviceUrl] - The base URL for the service
* @returns {SchematicsV1}
*/
static newInstance(options: UserOptions): SchematicsV1;
/**
* Construct a SchematicsV1 object.
*
* @param {Object} options - Options for the service.
* @param {string} [options.serviceUrl] - The base URL for the service
* @param {OutgoingHttpHeaders} [options.headers] - Default headers that shall be included with every request to the service.
* @param {Authenticator} options.authenticator - The Authenticator object used to authenticate requests to the service
* @constructor
* @returns {SchematicsV1}
*/
constructor(options: UserOptions);
/*************************
* util
************************/
/**
* List supported schematics locations.
*
* Retrieve a list of IBM Cloud locations where you can create the Schematics workspace or action. workspaces.
*
*
Authorization
*
* 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).
*
* @param {Object} [params] - The parameters to send to the service.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
listSchematicsLocation(params?: SchematicsV1.ListSchematicsLocationParams): Promise>;
/**
* List supported locations.
*
* Retrieve a list of IBM Cloud locations where you can work with the Schematics objects.
*
*
Authorization
*
* 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).
*
* @param {Object} [params] - The parameters to send to the service.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
listLocations(params?: SchematicsV1.ListLocationsParams): Promise>;
/**
* List resource groups.
*
* Retrieve a list of IBM Cloud resource groups that your account has access to.
*
*
Authorization
*
* 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).
*
* @param {Object} [params] - The parameters to send to the service.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
listResourceGroup(params?: SchematicsV1.ListResourceGroupParams): Promise>;
/**
* 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.
*
* @param {Object} [params] - The parameters to send to the service.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
getSchematicsVersion(params?: SchematicsV1.GetSchematicsVersionParams): Promise>;
/**
* 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.
*
*
Authorization
*
* 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).
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.templateType - Template type such as **terraform**, **ansible**, **helm**, **cloudpak**, or
* **bash script**.
* @param {ExternalSource} params.source - Source of templates, playbooks, or controls.
* @param {string} [params.region] - Region on which request should process. Applicable only on global endpoint.
* @param {string} [params.sourceType] - Type of source for the Template.
* @param {string} [params.xGithubToken] - The personal access token to authenticate with your private GitHub or
* GitLab repository and access your Terraform template.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
processTemplateMetaData(params: SchematicsV1.ProcessTemplateMetaDataParams): Promise>;
/*************************
* workspaces
************************/
/**
* 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).
*
*
Authorization
*
* 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).
*
* @param {Object} [params] - The parameters to send to the service.
* @param {number} [params.offset] - 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.
* @param {number} [params.limit] - 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.
* @param {string} [params.profile] - Level of details returned by the get method.
* @param {string} [params.resourceGroup] - The resource group (by default, fetch from all resource groups) name or
* ID.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
listWorkspaces(params?: SchematicsV1.ListWorkspacesParams): Promise>;
/**
* 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=` 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=` and `export
* REFRESH_TOKEN=`.
* * You can use the obtained IAM access token in create workspace `curl` command.
*
*
Authorization
*
* 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).
*
* @param {Object} [params] - The parameters to send to the service.
* @param {string[]} [params.appliedShareddataIds] - Deprecated: List of applied shared dataset ID.
* @param {CatalogRef} [params.catalogRef] - Information about the software template that you chose from the IBM Cloud
* catalog. This information is returned for IBM Cloud catalog offerings only.
* @param {Dependencies} [params.dependencies] - Workspace dependencies.
* @param {string} [params.description] - The description of the workspace.
* @param {string} [params.location] - 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.
* @param {string} [params.name] - 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.
* @param {string} [params.resourceGroup] - The ID of the resource group where you want to provision the workspace.
* @param {SharedTargetData} [params.sharedData] - 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.
* @param {string[]} [params.tags] - A list of tags that are associated with the workspace.
* @param {TemplateSourceDataRequest[]} [params.templateData] - Input data for the Template.
* @param {string} [params.templateRef] - Workspace template ref.
* @param {TemplateRepoRequest} [params.templateRepo] - Input variables for the Template repoository, while creating a
* workspace.
* @param {string[]} [params.type] - List of Workspace type.
* @param {WorkspaceStatusRequest} [params.workspaceStatus] - WorkspaceStatusRequest -.
* @param {string} [params.agentId] - agent id which is binded to with the workspace.
* @param {VariableData[]} [params.settings] - Input settings to be applied to the workspace, for example,
* `job_timeout_override`.
* @param {string} [params.xGithubToken] - The personal access token to authenticate with your private GitHub or
* GitLab repository and access your Terraform template.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
createWorkspace(params?: SchematicsV1.CreateWorkspaceParams): Promise>;
/**
* Get workspace details.
*
* Retrieve detailed information for a workspace in your IBM Cloud account.
*
*
Authorization
*
* 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).
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.wId - The ID of the workspace. To find the workspace ID, use the `GET /v1/workspaces` API.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
getWorkspace(params: SchematicsV1.GetWorkspaceParams): Promise>;
/**
* 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.
*
*
Authorization
*
* 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).
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.wId - The ID of the workspace. To find the workspace ID, use the `GET /v1/workspaces` API.
* @param {CatalogRef} [params.catalogRef] - Information about the software template that you chose from the IBM Cloud
* catalog. This information is returned for IBM Cloud catalog offerings only.
* @param {string} [params.description] - The description of the workspace.
* @param {Dependencies} [params.dependencies] - Workspace dependencies.
* @param {string} [params.name] - The name of the workspace.
* @param {SharedTargetData} [params.sharedData] - 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.
* @param {string[]} [params.tags] - A list of tags that you want to associate with your workspace.
* @param {TemplateSourceDataRequest[]} [params.templateData] - Input data for the Template.
* @param {TemplateRepoUpdateRequest} [params.templateRepo] - Input to update the template repository data.
* @param {string[]} [params.type] - List of Workspace type.
* @param {WorkspaceStatusUpdateRequest} [params.workspaceStatus] - Input to update the workspace status.
* @param {WorkspaceStatusMessage} [params.workspaceStatusMsg] - Information about the last job that ran against the
* workspace. -.
* @param {string} [params.agentId] - agent id that process workspace jobs.
* @param {VariableData[]} [params.settings] - Input settings to be applied to the workspace, for example,
* `job_timeout_override`.
* @param {string} [params.xGithubToken] - The personal access token to authenticate with your private GitHub or
* GitLab repository and access your Terraform template.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
replaceWorkspace(params: SchematicsV1.ReplaceWorkspaceParams): Promise>;
/**
* 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.
*
*
Authorization
*
* 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).
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.refreshToken - 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=`, 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.
* @param {string} params.wId - The ID of the workspace. To find the workspace ID, use the `GET /v1/workspaces` API.
* @param {string} [params.destroyResources] - 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.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
deleteWorkspace(params: SchematicsV1.DeleteWorkspaceParams): Promise>;
/**
* 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.
*
*
Authorization
*
* 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).
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.wId - The ID of the workspace. To find the workspace ID, use the `GET /v1/workspaces` API.
* @param {CatalogRef} [params.catalogRef] - Information about the software template that you chose from the IBM Cloud
* catalog. This information is returned for IBM Cloud catalog offerings only.
* @param {string} [params.description] - The description of the workspace.
* @param {Dependencies} [params.dependencies] - Workspace dependencies.
* @param {string} [params.name] - The name of the workspace.
* @param {SharedTargetData} [params.sharedData] - 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.
* @param {string[]} [params.tags] - A list of tags that you want to associate with your workspace.
* @param {TemplateSourceDataRequest[]} [params.templateData] - Input data for the Template.
* @param {TemplateRepoUpdateRequest} [params.templateRepo] - Input to update the template repository data.
* @param {string[]} [params.type] - List of Workspace type.
* @param {WorkspaceStatusUpdateRequest} [params.workspaceStatus] - Input to update the workspace status.
* @param {WorkspaceStatusMessage} [params.workspaceStatusMsg] - Information about the last job that ran against the
* workspace. -.
* @param {string} [params.agentId] - agent id that process workspace jobs.
* @param {VariableData[]} [params.settings] - Input settings to be applied to the workspace, for example,
* `job_timeout_override`.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
updateWorkspace(params: SchematicsV1.UpdateWorkspaceParams): Promise>;
/**
* Show workspace template readme.
*
* Retrieve the `README.md` file of the Terraform of IBM Cloud catalog template that your workspace points to.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.wId - The ID of the workspace. To find the workspace ID, use the `GET /v1/workspaces` API.
* @param {string} [params.ref] - 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.
* @param {string} [params.formatted] - The format of the readme file. Value ''markdown'' will give markdown,
* otherwise html.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
* @deprecated this method is deprecated and may be removed in a future release
*/
getWorkspaceReadme(params: SchematicsV1.GetWorkspaceReadmeParams): Promise>;
/**
* 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.
*
*
Authorization
*
* 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).
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.wId - The ID of the workspace where you want to upload your `.tar` file. To find the
* workspace ID, use the `GET /v1/workspaces` API.
* @param {string} params.tId - 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.
* @param {NodeJS.ReadableStream | Buffer} [params.file] - Template tar file.
* @param {string} [params.fileContentType] - The content type of file.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
templateRepoUpload(params: SchematicsV1.TemplateRepoUploadParams): Promise>;
/**
* List workspace input variables.
*
* Retrieve a list of input variables that are declared in your Terraform or IBM Cloud catalog template.
*
*
Authorization
*
* 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).
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.wId - The ID of the workspace. To find the workspace ID, use the `GET /v1/workspaces` API.
* @param {string} params.tId - 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.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
getWorkspaceInputs(params: SchematicsV1.GetWorkspaceInputsParams): Promise>;
/**
* Replace workspace input variables.
*
* Replace or Update the input variables for the template that your workspace points to.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.wId - The ID of the workspace. To find the workspace ID, use the `GET /v1/workspaces` API.
* @param {string} params.tId - 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.
* @param {JsonObject[]} [params.envValues] - 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.
* @param {string} [params.values] - User values.
* @param {WorkspaceVariableRequest[]} [params.variablestore] - VariablesRequest -.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
replaceWorkspaceInputs(params: SchematicsV1.ReplaceWorkspaceInputsParams): Promise>;
/**
* Get workspace template details.
*
* Retrieve detailed information about the Terraform template that your workspace points to.
*
*
Authorization
*
* 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).
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.wId - 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.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
getAllWorkspaceInputs(params: SchematicsV1.GetAllWorkspaceInputsParams): Promise>;
/**
* List workspace variable metadata.
*
* Retrieve the metadata for all the workspace input variables that are declared in the template that your workspace
* points to.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.wId - 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.
* @param {string} params.tId - 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.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
getWorkspaceInputMetadata(params: SchematicsV1.GetWorkspaceInputMetadataParams): Promise>;
/**
* 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.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.wId - 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.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
getWorkspaceOutputs(params: SchematicsV1.GetWorkspaceOutputsParams): Promise>;
/**
* List workspace resources.
*
* Retrieve a list of IBM Cloud resources that you created with your workspace.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.wId - The ID of the workspace. To find the workspace ID, use the `GET /v1/workspaces` API.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
getWorkspaceResources(params: SchematicsV1.GetWorkspaceResourcesParams): Promise>;
/**
* 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.
*
*
Authorization
*
* 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).
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.wId - 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.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
* @deprecated this method is deprecated and may be removed in a future release
*/
getWorkspaceState(params: SchematicsV1.GetWorkspaceStateParams): Promise>;
/**
* 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.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.wId - 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.
* @param {string} params.tId - 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.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
* @deprecated this method is deprecated and may be removed in a future release
*/
getWorkspaceTemplateState(params: SchematicsV1.GetWorkspaceTemplateStateParams): Promise>;
/**
* 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.
*
*
Authorization
*
* 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).
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.wId - 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.
* @param {string} params.activityId - 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.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
* @deprecated this method is deprecated and may be removed in a future release
*/
getWorkspaceActivityLogs(params: SchematicsV1.GetWorkspaceActivityLogsParams): Promise>;
/**
* 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.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.wId - The ID of the workspace. To find the workspace ID, use the `GET /v1/workspaces` API.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
* @deprecated this method is deprecated and may be removed in a future release
*/
getWorkspaceLogUrls(params: SchematicsV1.GetWorkspaceLogUrlsParams): Promise>;
/**
* Show latest logs for a workspace template.
*
* Show the Terraform logs for the most recent job of a template that ran against your workspace.
*
*
Authorization
*
* 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).
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.wId - The ID of the workspace. To find the workspace ID, use the `GET /v1/workspaces` API.
* @param {string} params.tId - 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`.
* @param {boolean} [params.logTfCmd] - 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.
* @param {boolean} [params.logTfPrefix] - `false` will hide all the terraform command prefix in the log statements.
* @param {boolean} [params.logTfNullResource] - `false` will hide all the null resource prefix in the log statements.
* @param {boolean} [params.logTfAnsible] - `true` will format all logs to withhold the original format of ansible
* output in the log statements.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
getTemplateLogs(params: SchematicsV1.GetTemplateLogsParams): Promise>;
/**
* Show logs for a workspace job.
*
* Show the Terraform logs for an job that ran against your workspace.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.wId - The ID of the workspace. To find the workspace ID, use the `GET /v1/workspaces` API.
* @param {string} params.tId - 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`.
* @param {string} params.activityId - 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.
* @param {boolean} [params.logTfCmd] - 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.
* @param {boolean} [params.logTfPrefix] - `false` will hide all the terraform command prefix in the log statements.
* @param {boolean} [params.logTfNullResource] - `false` will hide all the null resource prefix in the log statements.
* @param {boolean} [params.logTfAnsible] - `true` will format all logs to withhold the original format of ansible
* output in the log statements.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
getTemplateActivityLog(params: SchematicsV1.GetTemplateActivityLogParams): Promise>;
/*************************
* actions
************************/
/**
* 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).
*
*
Authorization
*
* 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).
*
* @param {Object} [params] - The parameters to send to the service.
* @param {number} [params.offset] - 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.
* @param {number} [params.limit] - 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.
* @param {string} [params.sort] - 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.
* @param {string} [params.profile] - Level of details returned by the get method.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
listActions(params?: SchematicsV1.ListActionsParams): Promise>;
/**
* 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).
*
*
Authorization
*
* 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).
*
* @param {Object} [params] - The parameters to send to the service.
* @param {string} [params.name] - 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.
* @param {string} [params.description] - Action description.
* @param {string} [params.location] - 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.
* @param {string} [params.resourceGroup] - Resource-group name for an action. By default, an action is created in
* `Default` resource group.
* @param {string} [params.bastionConnectionType] - Type of connection to be used when connecting to bastion host. If
* the `inventory_connection_type=winrm`, then `bastion_connection_type` is not supported.
* @param {string} [params.inventoryConnectionType] - 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.
* @param {string[]} [params.tags] - Action tags.
* @param {UserState} [params.userState] - User defined status of the Schematics object.
* @param {string} [params.sourceReadmeUrl] - URL of the `README` file, for the source URL.
* @param {ExternalSource} [params.source] - Source of templates, playbooks, or controls.
* @param {string} [params.sourceType] - Type of source for the Template.
* @param {string} [params.commandParameter] - Schematics job command parameter (playbook-name).
* @param {string} [params.inventory] - Target inventory record ID, used by the action or ansible playbook.
* @param {CredentialVariableData[]} [params.credentials] - credentials of the Action.
* @param {BastionResourceDefinition} [params.bastion] - Describes a bastion resource.
* @param {CredentialVariableData} [params.bastionCredential] - User editable credential variable data and system
* generated reference to the value.
* @param {string} [params.targetsIni] - 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).
* @param {VariableData[]} [params.inputs] - Input variables for the Action.
* @param {VariableData[]} [params.outputs] - Output variables for the Action.
* @param {VariableData[]} [params.settings] - Environment variables for the Action.
* @param {string} [params.xGithubToken] - The personal access token to authenticate with your private GitHub or
* GitLab repository and access your Terraform template.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
createAction(params?: SchematicsV1.CreateActionParams): Promise>;
/**
* 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.
*
*
Authorization
*
* 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).
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.actionId - Action Id. Use GET /actions API to look up the Action Ids in your IBM Cloud
* account.
* @param {string} [params.profile] - Level of details returned by the get method.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
getAction(params: SchematicsV1.GetActionParams): Promise>;
/**
* 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).
*
*
Authorization
*
* 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).
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.actionId - Action Id. Use GET /actions API to look up the Action Ids in your IBM Cloud
* account.
* @param {boolean} [params.force] - Equivalent to -force options in the command line.
* @param {boolean} [params.propagate] - Auto propagate the chaange or deletion to the dependent resources.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
deleteAction(params: SchematicsV1.DeleteActionParams): Promise>;
/**
* 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].
*
*
Authorization
*
* 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).
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.actionId - Action Id. Use GET /actions API to look up the Action Ids in your IBM Cloud
* account.
* @param {string} [params.name] - 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.
* @param {string} [params.description] - Action description.
* @param {string} [params.location] - 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.
* @param {string} [params.resourceGroup] - Resource-group name for an action. By default, an action is created in
* `Default` resource group.
* @param {string} [params.bastionConnectionType] - Type of connection to be used when connecting to bastion host. If
* the `inventory_connection_type=winrm`, then `bastion_connection_type` is not supported.
* @param {string} [params.inventoryConnectionType] - 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.
* @param {string[]} [params.tags] - Action tags.
* @param {UserState} [params.userState] - User defined status of the Schematics object.
* @param {string} [params.sourceReadmeUrl] - URL of the `README` file, for the source URL.
* @param {ExternalSource} [params.source] - Source of templates, playbooks, or controls.
* @param {string} [params.sourceType] - Type of source for the Template.
* @param {string} [params.commandParameter] - Schematics job command parameter (playbook-name).
* @param {string} [params.inventory] - Target inventory record ID, used by the action or ansible playbook.
* @param {CredentialVariableData[]} [params.credentials] - credentials of the Action.
* @param {BastionResourceDefinition} [params.bastion] - Describes a bastion resource.
* @param {CredentialVariableData} [params.bastionCredential] - User editable credential variable data and system
* generated reference to the value.
* @param {string} [params.targetsIni] - 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).
* @param {VariableData[]} [params.inputs] - Input variables for the Action.
* @param {VariableData[]} [params.outputs] - Output variables for the Action.
* @param {VariableData[]} [params.settings] - Environment variables for the Action.
* @param {string} [params.xGithubToken] - The personal access token to authenticate with your private GitHub or
* GitLab repository and access your Terraform template.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
updateAction(params: SchematicsV1.UpdateActionParams): Promise>;
/**
* 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.
*
*
Authorization
*
* 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).
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.actionId - Action Id. Use GET /actions API to look up the Action Ids in your IBM Cloud
* account.
* @param {NodeJS.ReadableStream | Buffer} [params.file] - Template tar file.
* @param {string} [params.fileContentType] - The content type of file.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
uploadTemplateTarAction(params: SchematicsV1.UploadTemplateTarActionParams): Promise>;
/*************************
* jobs
************************/
/**
* 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.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.wId - The ID of the workspace. To find the workspace ID, use the `GET /v1/workspaces` API.
* @param {number} [params.offset] - 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.
* @param {number} [params.limit] - 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.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
listWorkspaceActivities(params: SchematicsV1.ListWorkspaceActivitiesParams): Promise>;
/**
* 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.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.wId - The ID of the workspace. To find the workspace ID, use the `GET /v1/workspaces` API.
* @param {string} params.activityId - 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.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
getWorkspaceActivity(params: SchematicsV1.GetWorkspaceActivityParams): Promise>;
/**
* 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.
*
Authorization
*
* 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).
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.wId - The ID of the workspace. To find the workspace ID, use the `GET /v1/workspaces` API.
* @param {string} params.activityId - 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.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
deleteWorkspaceActivity(params: SchematicsV1.DeleteWorkspaceActivityParams): Promise>;
/**
* Run Terraform Commands.
*
* Run Terraform state commands to modify the workspace state file, by using the IBM Cloud Schematics API.
*
*
Authorization
*
* 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).
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.wId - The ID of the workspace. To find the workspace ID, use the `GET /v1/workspaces` API.
* @param {string} params.refreshToken - The IAM refresh token for the user or service identity.
*
* **Retrieving refresh token**:
* * Use `export 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.
* @param {TerraformCommand[]} [params.commands] - 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).
* @param {string} [params.operationName] - Command name.
* @param {string} [params.description] - Command description.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
runWorkspaceCommands(params: SchematicsV1.RunWorkspaceCommandsParams): Promise>;
/**
* 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.
*
*
Authorization
*
* 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).
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.wId - 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.
* @param {string} params.refreshToken - The IAM refresh token for the user or service identity.
*
* **Retrieving refresh token**:
* * Use `export 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.
* @param {WorkspaceActivityOptionsTemplate} [params.actionOptions] - Workspace job options template.
* @param {string} [params.delegatedToken] - The IAM delegated token for your IBM Cloud account. This token is
* required for requests that are sent via the UI only.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
applyWorkspaceCommand(params: SchematicsV1.ApplyWorkspaceCommandParams): Promise>;
/**
* 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.
*
*
Authorization
*
* 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).
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.wId - 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.
* @param {string} params.refreshToken - The IAM refresh token for the user or service identity.
*
* **Retrieving refresh token**:
* * Use `export 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.
* @param {WorkspaceActivityOptionsTemplate} [params.actionOptions] - Workspace job options template.
* @param {string} [params.delegatedToken] - The IAM delegated token for your IBM Cloud account. This token is
* required for requests that are sent via the UI only.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
destroyWorkspaceCommand(params: SchematicsV1.DestroyWorkspaceCommandParams): Promise>;
/**
* 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.
*
*
Authorization
*
* 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).
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.wId - 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.
* @param {string} params.refreshToken - The IAM refresh token for the user or service identity.
*
* **Retrieving refresh token**:
* * Use `export 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.
* @param {WorkspaceActivityOptionsTemplate} [params.actionOptions] - Workspace job options template.
* @param {string} [params.delegatedToken] - The IAM delegated token for your IBM Cloud account. This token is
* required for requests that are sent via the UI only.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
planWorkspaceCommand(params: SchematicsV1.PlanWorkspaceCommandParams): Promise>;
/**
* 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.
*
*
Authorization
*
* 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).
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.wId - 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.
* @param {string} params.refreshToken - The IAM refresh token for the user or service identity.
*
* **Retrieving refresh token**:
* * Use `export 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.
* @param {string} [params.delegatedToken] - The IAM delegated token for your IBM Cloud account. This token is
* required for requests that are sent via the UI only.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
refreshWorkspaceCommand(params: SchematicsV1.RefreshWorkspaceCommandParams): Promise>;
/**
* 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}`.
*
*
Authorization
*
* 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).
*
* @param {Object} [params] - The parameters to send to the service.
* @param {number} [params.offset] - 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.
* @param {number} [params.limit] - 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.
* @param {string} [params.sort] - 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.
* @param {string} [params.profile] - Level of details returned by the get method.
* @param {string} [params.resource] - Name of the resource (workspaces, actions, environment or controls).
* @param {string} [params.resourceId] - The Resource Id. It could be an Action-id or Workspace-id.
* @param {string} [params.actionId] - Action Id.
* @param {string} [params.workspaceId] - Workspace Id.
* @param {string} [params.list] - list jobs.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
listJobs(params?: SchematicsV1.ListJobsParams): Promise>;
/**
* 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`.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.refreshToken - The IAM refresh token for the user or service identity.
*
* **Retrieving refresh token**:
* * Use `export 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.
* @param {string} [params.commandObject] - Name of the Schematics automation resource.
* @param {string} [params.commandObjectId] - Job command object id (workspace-id, action-id).
* @param {string} [params.commandName] - Schematics job command name.
* @param {string} [params.commandParameter] - Schematics job command parameter (playbook-name).
* @param {string[]} [params.commandOptions] - Command line options for the command.
* @param {VariableData[]} [params.inputs] - Job inputs used by Action or Workspace.
* @param {VariableData[]} [params.settings] - Environment variables used by the Job while performing Action or
* Workspace.
* @param {string[]} [params.tags] - User defined tags, while running the job.
* @param {string} [params.location] - 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.
* @param {JobStatus} [params.status] - Job Status.
* @param {CartOrderData[]} [params.cartOrderData] - Contains the cart order data which can be used for different
* purpose for eg. service tagging.
* @param {JobData} [params.data] - Job data.
* @param {BastionResourceDefinition} [params.bastion] - Describes a bastion resource.
* @param {JobLogSummary} [params.logSummary] - Job log summary record.
* @param {AgentInfo} [params.agent] - Agent name, Agent id and associated policy ID information.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
createJob(params: SchematicsV1.CreateJobParams): Promise>;
/**
* Get a job.
*
* Retrieve the detailed information of Job
*
*
Authorization
*
* 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).
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.jobId - Job Id. Use `GET /v2/jobs` API to look up the Job Ids in your IBM Cloud account.
* @param {string} [params.profile] - Level of details returned by the get method.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
getJob(params: SchematicsV1.GetJobParams): Promise>;
/**
* Update a job.
*
* Creates a copy of the Schematics job and relaunches an existing job by updating the information of an existing
* Schematics job.
*
*
Authorization
*
* 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).
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.jobId - Job Id. Use `GET /v2/jobs` API to look up the Job Ids in your IBM Cloud account.
* @param {string} params.refreshToken - The IAM refresh token for the user or service identity.
*
* **Retrieving refresh token**:
* * Use `export 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.
* @param {string} [params.commandObject] - Name of the Schematics automation resource.
* @param {string} [params.commandObjectId] - Job command object id (workspace-id, action-id).
* @param {string} [params.commandName] - Schematics job command name.
* @param {string} [params.commandParameter] - Schematics job command parameter (playbook-name).
* @param {string[]} [params.commandOptions] - Command line options for the command.
* @param {VariableData[]} [params.inputs] - Job inputs used by Action or Workspace.
* @param {VariableData[]} [params.settings] - Environment variables used by the Job while performing Action or
* Workspace.
* @param {string[]} [params.tags] - User defined tags, while running the job.
* @param {string} [params.location] - 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.
* @param {JobStatus} [params.status] - Job Status.
* @param {CartOrderData[]} [params.cartOrderData] - Contains the cart order data which can be used for different
* purpose for eg. service tagging.
* @param {JobData} [params.data] - Job data.
* @param {BastionResourceDefinition} [params.bastion] - Describes a bastion resource.
* @param {JobLogSummary} [params.logSummary] - Job log summary record.
* @param {AgentInfo} [params.agent] - Agent name, Agent id and associated policy ID information.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
updateJob(params: SchematicsV1.UpdateJobParams): Promise>;
/**
* 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.
*
*
Authorization
*
* 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).
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.jobId - Job Id. Use `GET /v2/jobs` API to look up the Job Ids in your IBM Cloud account.
* @param {string} params.refreshToken - The IAM refresh token for the user or service identity.
*
* **Retrieving refresh token**:
* * Use `export 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.
* @param {boolean} [params.force] - Equivalent to -force options in the command line.
* @param {boolean} [params.propagate] - Auto propagate the chaange or deletion to the dependent resources.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
deleteJob(params: SchematicsV1.DeleteJobParams): Promise>;
/**
* Get job logs.
*
* Retrieve the job logs
Authorization
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).
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.jobId - Job Id. Use `GET /v2/jobs` API to look up the Job Ids in your IBM Cloud account.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
listJobLogs(params: SchematicsV1.ListJobLogsParams): Promise>;
/**
* 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).
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.jobId - Job Id. Use `GET /v2/jobs` API to look up the Job Ids in your IBM Cloud account.
* @param {string} params.fileType - The type of file you want to download eg.state_file, plan_json.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
getJobFiles(params: SchematicsV1.GetJobFilesParams): Promise>;
/*************************
* bulkJobs
************************/
/**
* Delete one or more workspace.
*
* Delete one or multiple Schematics workspace. Deleting a workspace does not destroy the resources from the
* Schematics workspace.
*
*
Authorization
*
* 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).
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.refreshToken - The IAM refresh token for the user or service identity.
*
* **Retrieving refresh token**:
* * Use `export 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.
* @param {string} [params.job] - Job type such as delete of a batch operation.
* @param {string} [params.version] - A version of the terraform template.
* @param {string[]} [params.workspaces] - The List of workspaces to be deleted.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
createWorkspaceDeletionJob(params: SchematicsV1.CreateWorkspaceDeletionJobParams): Promise>;
/**
* Get the workspace deletion job status.
*
* Retrieve detailed information for a workspace deletion job status.
*
*
Authorization
*
* 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).
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.wjId - The workspace job ID.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
getWorkspaceDeletionJobStatus(params: SchematicsV1.GetWorkspaceDeletionJobStatusParams): Promise>;
/*************************
* inventory
************************/
/**
* 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).
*
*
Authorization
*
* 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).
*
* @param {Object} [params] - The parameters to send to the service.
* @param {number} [params.offset] - 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.
* @param {number} [params.limit] - 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.
* @param {string} [params.sort] - 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.
* @param {string} [params.profile] - Level of details returned by the get method.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
listInventories(params?: SchematicsV1.ListInventoriesParams): Promise>;
/**
* 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.
*
*
Authorization
*
* 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).
*
* @param {Object} [params] - The parameters to send to the service.
* @param {string} [params.name] - 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.
* @param {string} [params.description] - The description of your Inventory definition. The description can be up to
* 2048 characters long in size.
* @param {string} [params.location] - 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.
* @param {string} [params.resourceGroup] - Resource-group name for the Inventory definition. By default, Inventory
* definition will be created in Default Resource Group.
* @param {string} [params.inventoriesIni] - Input inventory of host and host group for the playbook, in the `.ini`
* file format.
* @param {string[]} [params.resourceQueries] - Input resource query definitions that is used to dynamically generate
* the inventory of host and host group for the playbook.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
createInventory(params?: SchematicsV1.CreateInventoryParams): Promise>;
/**
* 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).
*
*
Authorization
*
* 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).
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.inventoryId - Resource Inventory Id. Use `GET /v2/inventories` API to look up the Resource
* Inventory definition Ids in your IBM Cloud account.
* @param {string} [params.profile] - Level of details returned by the get method.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
getInventory(params: SchematicsV1.GetInventoryParams): Promise>;
/**
* 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).
*
*
Authorization
*
* 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).
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.inventoryId - Resource Inventory Id. Use `GET /v2/inventories` API to look up the Resource
* Inventory definition Ids in your IBM Cloud account.
* @param {string} [params.name] - 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.
* @param {string} [params.description] - The description of your Inventory definition. The description can be up to
* 2048 characters long in size.
* @param {string} [params.location] - 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.
* @param {string} [params.resourceGroup] - Resource-group name for the Inventory definition. By default, Inventory
* definition will be created in Default Resource Group.
* @param {string} [params.inventoriesIni] - Input inventory of host and host group for the playbook, in the `.ini`
* file format.
* @param {string[]} [params.resourceQueries] - Input resource query definitions that is used to dynamically generate
* the inventory of host and host group for the playbook.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
replaceInventory(params: SchematicsV1.ReplaceInventoryParams): Promise>;
/**
* 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).
*
*
Authorization
*
* 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).
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.inventoryId - Resource Inventory Id. Use `GET /v2/inventories` API to look up the Resource
* Inventory definition Ids in your IBM Cloud account.
* @param {boolean} [params.force] - Equivalent to -force options in the command line.
* @param {boolean} [params.propagate] - Auto propagate the chaange or deletion to the dependent resources.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
deleteInventory(params: SchematicsV1.DeleteInventoryParams): Promise>;
/**
* 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).
*
Authorization
*
* 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).
*
* @param {Object} [params] - The parameters to send to the service.
* @param {number} [params.offset] - 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.
* @param {number} [params.limit] - 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.
* @param {string} [params.sort] - 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.
* @param {string} [params.profile] - Level of details returned by the get method.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
listResourceQuery(params?: SchematicsV1.ListResourceQueryParams): Promise>;
/**
* 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.
*
Authorization
*
* 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).
*
* @param {Object} [params] - The parameters to send to the service.
* @param {string} [params.type] - Resource type (cluster, vsi, icd, vpc).
* @param {string} [params.name] - Resource query name.
* @param {ResourceQuery[]} [params.queries] -
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
createResourceQuery(params?: SchematicsV1.CreateResourceQueryParams): Promise>;
/**
* 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).
*
Authorization
*
* 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).
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.queryId - Resource query Id. Use `GET /v2/resource_query` API to look up the Resource query
* definition Ids in your IBM Cloud account.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
getResourcesQuery(params: SchematicsV1.GetResourcesQueryParams): Promise>;
/**
* 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).
*
Authorization
*
* 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).
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.queryId - Resource query Id. Use `GET /v2/resource_query` API to look up the Resource query
* definition Ids in your IBM Cloud account.
* @param {string} [params.type] - Resource type (cluster, vsi, icd, vpc).
* @param {string} [params.name] - Resource query name.
* @param {ResourceQuery[]} [params.queries] -
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
replaceResourcesQuery(params: SchematicsV1.ReplaceResourcesQueryParams): Promise>;
/**
* Run the resource query.
*
* Run the resource query.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.queryId - Resource query Id. Use `GET /v2/resource_query` API to look up the Resource query
* definition Ids in your IBM Cloud account.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
executeResourceQuery(params: SchematicsV1.ExecuteResourceQueryParams): Promise>;
/**
* 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).
*
*
Authorization
*
* 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).
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.queryId - Resource query Id. Use `GET /v2/resource_query` API to look up the Resource query
* definition Ids in your IBM Cloud account.
* @param {boolean} [params.force] - Equivalent to -force options in the command line.
* @param {boolean} [params.propagate] - Auto propagate the chaange or deletion to the dependent resources.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
deleteResourcesQuery(params: SchematicsV1.DeleteResourcesQueryParams): Promise>;
/*************************
* agent
************************/
/**
* Get all registered/unregistered agents in the Account.
*
* Get all registered or unregistered agents, in the Account.
*
*
Authorization
*
* 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).
*
* @param {Object} [params] - The parameters to send to the service.
* @param {number} [params.offset] - 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.
* @param {number} [params.limit] - 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.
* @param {string} [params.profile] - Level of details returned by the get method.
* @param {string} [params.filter] - Use `new` to get all unregistered agents; use `saved` to get all registered
* agents.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
* @deprecated this method is deprecated and may be removed in a future release
*/
listAgent(params?: SchematicsV1.ListAgentParams): Promise>;
/**
* Register the agent with schematics.
*
* Register the agent with schematics
*
*
Authorization
*
* 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).
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.name - The name of the agent (must be unique, for an account).
* @param {string} params.agentLocation - The location where agent is deployed in the user environment.
* @param {string} params.location - 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.
* @param {string} params.profileId - The IAM trusted profile id, used by the Agent instance.
* @param {string} [params.description] - Agent description.
* @param {string} [params.resourceGroup] - The resource-group name for the agent. By default, Agent will be
* registered in Default Resource Group.
* @param {string[]} [params.tags] - Tags for the agent.
* @param {AgentUserState} [params.userState] - User defined status of the agent.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
* @deprecated this method is deprecated and may be removed in a future release
*/
registerAgent(params: SchematicsV1.RegisterAgentParams): Promise>;
/**
* Get the registered agent details.
*
* Reterive list the registered agent details
*
*
Authorization
*
* 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).
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.agentId - Agent ID to get the details of agent.
* @param {string} [params.profile] - Level of details returned by the get method.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
* @deprecated this method is deprecated and may be removed in a future release
*/
getAgent(params: SchematicsV1.GetAgentParams): Promise>;
/**
* Deregister the agent.
*
* Deregistering an agent.
*
*
Authorization
*
* 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).
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.agentId - Agent ID to get the details of agent.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
* @deprecated this method is deprecated and may be removed in a future release
*/
deleteAgent(params: SchematicsV1.DeleteAgentParams): Promise>;
/**
* Update the agent registration.
*
* Update the agent registeration.
*
*
Authorization
*
* 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).
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.agentId - Agent ID to get the details of agent.
* @param {string} params.name - The name of the agent (must be unique, for an account).
* @param {string} params.agentLocation - The location where agent is deployed in the user environment.
* @param {string} params.location - 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.
* @param {string} params.profileId - The IAM trusted profile id, used by the Agent instance.
* @param {string} [params.description] - Agent description.
* @param {string} [params.resourceGroup] - The resource-group name for the agent. By default, Agent will be
* registered in Default Resource Group.
* @param {string[]} [params.tags] - Tags for the agent.
* @param {AgentUserState} [params.userState] - User defined status of the agent.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
* @deprecated this method is deprecated and may be removed in a future release
*/
updateAgentRegistration(params: SchematicsV1.UpdateAgentRegistrationParams): Promise>;
/**
* 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).
*
*
Authorization
*
* 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).
*
* @param {Object} [params] - The parameters to send to the service.
* @param {number} [params.offset] - 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.
* @param {number} [params.limit] - 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.
* @param {string} [params.profile] - Level of details returned by the get method.
* @param {string} [params.filter] - Use `new` to get all unregistered agents; use `saved` to get all registered agents.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
listAgentData(params?: SchematicsV1.ListAgentDataParams): Promise>;
/**
* 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.
* 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).
*
*
Authorization
*
* 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).
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.name - The name of the agent (must be unique, for an account).
* @param {string} params.resourceGroup - The resource-group name for the agent. By default, agent will be registered
* in Default Resource Group.
* @param {string} params.version - Agent version.
* @param {string} params.schematicsLocation - 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.
* @param {string} params.agentLocation - The location where agent is deployed in the user environment.
* @param {AgentInfrastructure} params.agentInfrastructure - The infrastructure parameters used by the agent.
* @param {string} [params.description] - Agent description.
* @param {string[]} [params.tags] - Tags for the agent.
* @param {AgentMetadataInfo[]} [params.agentMetadata] - The metadata of an agent.
* @param {VariableData[]} [params.agentInputs] - Additional input variables for the agent.
* @param {AgentUserState} [params.userState] - User defined status of the agent.
* @param {AgentKPIData} [params.agentKpi] - Schematics Agent key performance indicators.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
createAgentData(params: SchematicsV1.CreateAgentDataParams): Promise>;
/**
* 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).
*
*
Authorization
*
* 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).
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.agentId - Agent ID to get the details of agent.
* @param {string} [params.profile] - Level of details returned by the get method.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
getAgentData(params: SchematicsV1.GetAgentDataParams): Promise>;
/**
* 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).
*
*
Authorization
*
* 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).
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.agentId - Agent ID to get the details of agent.
* @param {string} params.name - The name of the agent (must be unique, for an account).
* @param {string} params.resourceGroup - The resource-group name for the agent. By default, agent will be registered
* in Default Resource Group.
* @param {string} params.version - Agent version.
* @param {string} params.schematicsLocation - 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.
* @param {string} params.agentLocation - The location where agent is deployed in the user environment.
* @param {AgentInfrastructure} params.agentInfrastructure - The infrastructure parameters used by the agent.
* @param {string} [params.description] - Agent description.
* @param {string[]} [params.tags] - Tags for the agent.
* @param {AgentMetadataInfo[]} [params.agentMetadata] - The metadata of an agent.
* @param {VariableData[]} [params.agentInputs] - Additional input variables for the agent.
* @param {AgentUserState} [params.userState] - User defined status of the agent.
* @param {AgentKPIData} [params.agentKpi] - Schematics Agent key performance indicators.
* @param {string} [params.refreshToken] - 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=`, 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.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
updateAgentData(params: SchematicsV1.UpdateAgentDataParams): Promise>;
/**
* 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).
*
*
Authorization
*
* 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).
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.agentId - Agent ID to get the details of agent.
* @param {boolean} [params.force] - Equivalent to -force options in the command line, default is false.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
deleteAgentData(params: SchematicsV1.DeleteAgentDataParams): Promise>;
/**
* 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).
*
*
Authorization
*
* 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).
*
* @param {Object} [params] - The parameters to send to the service.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
getAgentVersions(params?: SchematicsV1.GetAgentVersionsParams): Promise>;
/**
* 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).
*
Authorization
*
* 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).
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.agentId - Agent ID to get the details of agent.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
getPrsAgentJob(params: SchematicsV1.GetPrsAgentJobParams): Promise>;
/**
* 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).
*
Authorization
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).
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.agentId - Agent ID to get the details of agent.
* @param {boolean} [params.force] - Equivalent to -force options in the command line, default is false.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
prsAgentJob(params: SchematicsV1.PrsAgentJobParams): Promise>;
/**
* 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).
*
Authorization
*
* 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).
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.agentId - Agent ID to get the details of agent.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
getHealthCheckAgentJob(params: SchematicsV1.GetHealthCheckAgentJobParams): Promise>;
/**
* 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).
*
Authorization
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).
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.agentId - Agent ID to get the details of agent.
* @param {boolean} [params.force] - Equivalent to -force options in the command line, default is false.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
healthCheckAgentJob(params: SchematicsV1.HealthCheckAgentJobParams): Promise>;
/**
* 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).
*
Authorization
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).
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.agentId - Agent ID to get the details of agent.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
getDeployAgentJob(params: SchematicsV1.GetDeployAgentJobParams): Promise>;
/**
* 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).
*
Authorization
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).
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.agentId - Agent ID to get the details of agent.
* @param {boolean} [params.force] - Equivalent to -force options in the command line, default is false.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
deployAgentJob(params: SchematicsV1.DeployAgentJobParams): Promise>;
/**
* Delete resources provisioned by agent.
*
* Use this API to destroy the resources provisioned for running an agent.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.agentId - Agent ID to get the details of agent.
* @param {string} params.refreshToken - The IAM refresh token for the user or service identity.
*
* **Retrieving refresh token**:
* * Use `export 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.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
deleteAgentResources(params: SchematicsV1.DeleteAgentResourcesParams): Promise>;
/*************************
* settingsKms
************************/
/**
* 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.
*
Authorization
*
* 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).
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.location - The location of the Resource.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
getKmsSettings(params: SchematicsV1.GetKmsSettingsParams): Promise>;
/**
* 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.
*
Authorization
*
* 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).
*
* @param {Object} [params] - The parameters to send to the service.
* @param {string} [params.location] - The location to integrate kms instance. For example, location can be `US` and
* `EU`.
* @param {string} [params.encryptionScheme] - The encryption scheme values. **Allowable values** [`byok`,`kyok`].
* @param {string} [params.resourceGroup] - The kms instance resource group to integrate.
* @param {KMSSettingsPrimaryCrk} [params.primaryCrk] - The primary kms instance details.
* @param {KMSSettingsSecondaryCrk} [params.secondaryCrk] - The secondary kms instance details.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
updateKmsSettings(params?: SchematicsV1.UpdateKmsSettingsParams): Promise>;
/**
* 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.
*
*
Authorization
*
* 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).
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.encryptionScheme - The encryption scheme to be used.
* @param {string} params.location - The location of the Resource.
* @param {string} [params.resourceGroup] - The resource group (by default, fetch from all resource groups) name or
* ID.
* @param {number} [params.limit] - 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.
* @param {string} [params.sort] - 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.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
listKms(params: SchematicsV1.ListKmsParams): Promise>;
/*************************
* policy
************************/
/**
* 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).
*
*
Authorization
*
* 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).
*
* @param {Object} [params] - The parameters to send to the service.
* @param {number} [params.offset] - 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.
* @param {number} [params.limit] - 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.
* @param {string} [params.profile] - Level of details returned by the get method.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
listPolicy(params?: SchematicsV1.ListPolicyParams): Promise>;
/**
* 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).
*
*
*
Authorization
*
* 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).
*
* @param {Object} [params] - The parameters to send to the service.
* @param {string} [params.name] - Name of Schematics customization policy.
* @param {string} [params.description] - The description of Schematics customization policy.
* @param {string} [params.resourceGroup] - The resource group name for the policy. By default, Policy will be
* created in `default` Resource Group.
* @param {string[]} [params.tags] - Tags for the Schematics customization policy.
* @param {string} [params.location] - 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.
* @param {UserState} [params.state] - User defined status of the Schematics object.
* @param {string} [params.kind] - Policy kind or categories for managing and deriving policy decision
* * `agent_assignment_policy` Agent assignment policy for job execution.
* @param {PolicyObjects} [params.target] - The objects for the Schematics policy.
* @param {PolicyParameter} [params.parameter] - The parameter to tune the Schematics policy.
* @param {ScopedResource[]} [params.scopedResources] - List of scoped Schematics resources targeted by the policy.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
createPolicy(params?: SchematicsV1.CreatePolicyParams): Promise>;
/**
* 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).
*
*
Authorization
*
* 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).
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.policyId - ID to get the details of policy.
* @param {string} [params.profile] - Level of details returned by the get method.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
getPolicy(params: SchematicsV1.GetPolicyParams): Promise>;
/**
* 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).
*
*
Authorization
*
* 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).
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.policyId - ID to get the details of policy.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
deletePolicy(params: SchematicsV1.DeletePolicyParams): Promise>;
/**
* 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).
*
*
*
Authorization
*
* 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).
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.policyId - ID to get the details of policy.
* @param {string} [params.name] - Name of Schematics customization policy.
* @param {string} [params.description] - The description of Schematics customization policy.
* @param {string} [params.resourceGroup] - The resource group name for the policy. By default, Policy will be
* created in `default` Resource Group.
* @param {string[]} [params.tags] - Tags for the Schematics customization policy.
* @param {string} [params.location] - 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.
* @param {UserState} [params.state] - User defined status of the Schematics object.
* @param {string} [params.kind] - Policy kind or categories for managing and deriving policy decision
* * `agent_assignment_policy` Agent assignment policy for job execution.
* @param {PolicyObjects} [params.target] - The objects for the Schematics policy.
* @param {PolicyParameter} [params.parameter] - The parameter to tune the Schematics policy.
* @param {ScopedResource[]} [params.scopedResources] - List of scoped Schematics resources targeted by the policy.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
updatePolicy(params: SchematicsV1.UpdatePolicyParams): Promise>;
}
/*************************
* interfaces
************************/
declare namespace SchematicsV1 {
/** An operation response. */
interface Response {
result: T;
status: number;
statusText: string;
headers: IncomingHttpHeaders;
}
/** The callback for a service request. */
type Callback = (error: any, response?: Response) => void;
/** The body of a service request that returns no response data. */
interface EmptyObject {
}
/** A standard JS object, defined to avoid the limitations of `Object` and `object` */
interface JsonObject {
[key: string]: any;
}
/*************************
* request interfaces
************************/
/** Parameters for the `listSchematicsLocation` operation. */
interface ListSchematicsLocationParams {
headers?: OutgoingHttpHeaders;
}
/** Parameters for the `listLocations` operation. */
interface ListLocationsParams {
headers?: OutgoingHttpHeaders;
}
/** Parameters for the `listResourceGroup` operation. */
interface ListResourceGroupParams {
headers?: OutgoingHttpHeaders;
}
/** Parameters for the `getSchematicsVersion` operation. */
interface GetSchematicsVersionParams {
headers?: OutgoingHttpHeaders;
}
/** Parameters for the `processTemplateMetaData` operation. */
interface ProcessTemplateMetaDataParams {
/** Template type such as **terraform**, **ansible**, **helm**, **cloudpak**, or **bash script**. */
templateType: string;
/** Source of templates, playbooks, or controls. */
source: ExternalSource;
/** Region on which request should process. Applicable only on global endpoint. */
region?: string;
/** Type of source for the Template. */
sourceType?: ProcessTemplateMetaDataConstants.SourceType | string;
/** The personal access token to authenticate with your private GitHub or GitLab repository and access your
* Terraform template.
*/
xGithubToken?: string;
headers?: OutgoingHttpHeaders;
}
/** Constants for the `processTemplateMetaData` operation. */
namespace ProcessTemplateMetaDataConstants {
/** Type of source for the Template. */
enum SourceType {
LOCAL = "local",
GIT_HUB = "git_hub",
GIT_HUB_ENTERPRISE = "git_hub_enterprise",
GIT_LAB = "git_lab",
IBM_GIT_LAB = "ibm_git_lab",
IBM_CLOUD_CATALOG = "ibm_cloud_catalog"
}
}
/** Parameters for the `listWorkspaces` operation. */
interface ListWorkspacesParams {
/** 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?: number;
/** 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?: number;
/** Level of details returned by the get method. */
profile?: ListWorkspacesConstants.Profile | string;
/** The resource group (by default, fetch from all resource groups) name or ID. */
resourceGroup?: string;
headers?: OutgoingHttpHeaders;
}
/** Constants for the `listWorkspaces` operation. */
namespace ListWorkspacesConstants {
/** Level of details returned by the get method. */
enum Profile {
IDS = "ids",
SUMMARY = "summary"
}
}
/** Parameters for the `createWorkspace` operation. */
interface CreateWorkspaceParams {
/** Deprecated: List of applied shared dataset ID. */
appliedShareddataIds?: string[];
/** 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;
/** Workspace dependencies. */
dependencies?: Dependencies;
/** The description of the workspace. */
description?: string;
/** 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;
/** 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;
/** The ID of the resource group where you want to provision the workspace. */
resourceGroup?: string;
/** 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;
/** A list of tags that are associated with the workspace. */
tags?: string[];
/** Input data for the Template. */
templateData?: TemplateSourceDataRequest[];
/** Workspace template ref. */
templateRef?: string;
/** Input variables for the Template repoository, while creating a workspace. */
templateRepo?: TemplateRepoRequest;
/** List of Workspace type. */
type?: string[];
/** WorkspaceStatusRequest -. */
workspaceStatus?: WorkspaceStatusRequest;
/** agent id which is binded to with the workspace. */
agentId?: string;
/** Input settings to be applied to the workspace, for example, `job_timeout_override`. */
settings?: VariableData[];
/** The personal access token to authenticate with your private GitHub or GitLab repository and access your
* Terraform template.
*/
xGithubToken?: string;
headers?: OutgoingHttpHeaders;
}
/** Parameters for the `getWorkspace` operation. */
interface GetWorkspaceParams {
/** The ID of the workspace. To find the workspace ID, use the `GET /v1/workspaces` API. */
wId: string;
headers?: OutgoingHttpHeaders;
}
/** Parameters for the `replaceWorkspace` operation. */
interface ReplaceWorkspaceParams {
/** The ID of the workspace. To find the workspace ID, use the `GET /v1/workspaces` API. */
wId: string;
/** 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;
/** The description of the workspace. */
description?: string;
/** Workspace dependencies. */
dependencies?: Dependencies;
/** The name of the workspace. */
name?: string;
/** 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;
/** A list of tags that you want to associate with your workspace. */
tags?: string[];
/** Input data for the Template. */
templateData?: TemplateSourceDataRequest[];
/** Input to update the template repository data. */
templateRepo?: TemplateRepoUpdateRequest;
/** List of Workspace type. */
type?: string[];
/** Input to update the workspace status. */
workspaceStatus?: WorkspaceStatusUpdateRequest;
/** Information about the last job that ran against the workspace. -. */
workspaceStatusMsg?: WorkspaceStatusMessage;
/** agent id that process workspace jobs. */
agentId?: string;
/** Input settings to be applied to the workspace, for example, `job_timeout_override`. */
settings?: VariableData[];
/** The personal access token to authenticate with your private GitHub or GitLab repository and access your
* Terraform template.
*/
xGithubToken?: string;
headers?: OutgoingHttpHeaders;
}
/** Parameters for the `deleteWorkspace` operation. */
interface DeleteWorkspaceParams {
/** 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=`, 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;
/** The ID of the workspace. To find the workspace ID, use the `GET /v1/workspaces` API. */
wId: string;
/** 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;
headers?: OutgoingHttpHeaders;
}
/** Parameters for the `updateWorkspace` operation. */
interface UpdateWorkspaceParams {
/** The ID of the workspace. To find the workspace ID, use the `GET /v1/workspaces` API. */
wId: string;
/** 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;
/** The description of the workspace. */
description?: string;
/** Workspace dependencies. */
dependencies?: Dependencies;
/** The name of the workspace. */
name?: string;
/** 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;
/** A list of tags that you want to associate with your workspace. */
tags?: string[];
/** Input data for the Template. */
templateData?: TemplateSourceDataRequest[];
/** Input to update the template repository data. */
templateRepo?: TemplateRepoUpdateRequest;
/** List of Workspace type. */
type?: string[];
/** Input to update the workspace status. */
workspaceStatus?: WorkspaceStatusUpdateRequest;
/** Information about the last job that ran against the workspace. -. */
workspaceStatusMsg?: WorkspaceStatusMessage;
/** agent id that process workspace jobs. */
agentId?: string;
/** Input settings to be applied to the workspace, for example, `job_timeout_override`. */
settings?: VariableData[];
headers?: OutgoingHttpHeaders;
}
/** Parameters for the `getWorkspaceReadme` operation. */
interface GetWorkspaceReadmeParams {
/** The ID of the workspace. To find the workspace ID, use the `GET /v1/workspaces` API. */
wId: string;
/** 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;
/** The format of the readme file. Value ''markdown'' will give markdown, otherwise html. */
formatted?: GetWorkspaceReadmeConstants.Formatted | string;
headers?: OutgoingHttpHeaders;
}
/** Constants for the `getWorkspaceReadme` operation. */
namespace GetWorkspaceReadmeConstants {
/** The format of the readme file. Value ''markdown'' will give markdown, otherwise html. */
enum Formatted {
MARKDOWN = "markdown",
HTML = "html"
}
}
/** Parameters for the `templateRepoUpload` operation. */
interface TemplateRepoUploadParams {
/** 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;
/** 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;
/** Template tar file. */
file?: NodeJS.ReadableStream | Buffer;
/** The content type of file. */
fileContentType?: string;
headers?: OutgoingHttpHeaders;
}
/** Parameters for the `getWorkspaceInputs` operation. */
interface GetWorkspaceInputsParams {
/** The ID of the workspace. To find the workspace ID, use the `GET /v1/workspaces` API. */
wId: string;
/** 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;
headers?: OutgoingHttpHeaders;
}
/** Parameters for the `replaceWorkspaceInputs` operation. */
interface ReplaceWorkspaceInputsParams {
/** The ID of the workspace. To find the workspace ID, use the `GET /v1/workspaces` API. */
wId: string;
/** 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;
/** 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?: JsonObject[];
/** User values. */
values?: string;
/** VariablesRequest -. */
variablestore?: WorkspaceVariableRequest[];
headers?: OutgoingHttpHeaders;
}
/** Parameters for the `getAllWorkspaceInputs` operation. */
interface GetAllWorkspaceInputsParams {
/** 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;
headers?: OutgoingHttpHeaders;
}
/** Parameters for the `getWorkspaceInputMetadata` operation. */
interface GetWorkspaceInputMetadataParams {
/** 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;
/** 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;
headers?: OutgoingHttpHeaders;
}
/** Parameters for the `getWorkspaceOutputs` operation. */
interface GetWorkspaceOutputsParams {
/** 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;
headers?: OutgoingHttpHeaders;
}
/** Parameters for the `getWorkspaceResources` operation. */
interface GetWorkspaceResourcesParams {
/** The ID of the workspace. To find the workspace ID, use the `GET /v1/workspaces` API. */
wId: string;
headers?: OutgoingHttpHeaders;
}
/** Parameters for the `getWorkspaceState` operation. */
interface GetWorkspaceStateParams {
/** 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;
headers?: OutgoingHttpHeaders;
}
/** Parameters for the `getWorkspaceTemplateState` operation. */
interface GetWorkspaceTemplateStateParams {
/** 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;
/** 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;
headers?: OutgoingHttpHeaders;
}
/** Parameters for the `getWorkspaceActivityLogs` operation. */
interface GetWorkspaceActivityLogsParams {
/** 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;
/** 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;
headers?: OutgoingHttpHeaders;
}
/** Parameters for the `getWorkspaceLogUrls` operation. */
interface GetWorkspaceLogUrlsParams {
/** The ID of the workspace. To find the workspace ID, use the `GET /v1/workspaces` API. */
wId: string;
headers?: OutgoingHttpHeaders;
}
/** Parameters for the `getTemplateLogs` operation. */
interface GetTemplateLogsParams {
/** The ID of the workspace. To find the workspace ID, use the `GET /v1/workspaces` API. */
wId: string;
/** 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;
/** 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?: boolean;
/** `false` will hide all the terraform command prefix in the log statements. */
logTfPrefix?: boolean;
/** `false` will hide all the null resource prefix in the log statements. */
logTfNullResource?: boolean;
/** `true` will format all logs to withhold the original format of ansible output in the log statements. */
logTfAnsible?: boolean;
headers?: OutgoingHttpHeaders;
}
/** Parameters for the `getTemplateActivityLog` operation. */
interface GetTemplateActivityLogParams {
/** The ID of the workspace. To find the workspace ID, use the `GET /v1/workspaces` API. */
wId: string;
/** 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;
/** 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;
/** 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?: boolean;
/** `false` will hide all the terraform command prefix in the log statements. */
logTfPrefix?: boolean;
/** `false` will hide all the null resource prefix in the log statements. */
logTfNullResource?: boolean;
/** `true` will format all logs to withhold the original format of ansible output in the log statements. */
logTfAnsible?: boolean;
headers?: OutgoingHttpHeaders;
}
/** Parameters for the `listActions` operation. */
interface ListActionsParams {
/** 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?: number;
/** 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?: number;
/** 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;
/** Level of details returned by the get method. */
profile?: ListActionsConstants.Profile | string;
headers?: OutgoingHttpHeaders;
}
/** Constants for the `listActions` operation. */
namespace ListActionsConstants {
/** Level of details returned by the get method. */
enum Profile {
IDS = "ids",
SUMMARY = "summary"
}
}
/** Parameters for the `createAction` operation. */
interface CreateActionParams {
/** 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;
/** Action description. */
description?: string;
/** 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?: CreateActionConstants.Location | string;
/** Resource-group name for an action. By default, an action is created in `Default` resource group. */
resourceGroup?: string;
/** 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?: CreateActionConstants.BastionConnectionType | string;
/** 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?: CreateActionConstants.InventoryConnectionType | string;
/** Action tags. */
tags?: string[];
/** User defined status of the Schematics object. */
userState?: UserState;
/** URL of the `README` file, for the source URL. */
sourceReadmeUrl?: string;
/** Source of templates, playbooks, or controls. */
source?: ExternalSource;
/** Type of source for the Template. */
sourceType?: CreateActionConstants.SourceType | string;
/** Schematics job command parameter (playbook-name). */
commandParameter?: string;
/** Target inventory record ID, used by the action or ansible playbook. */
inventory?: string;
/** credentials of the Action. */
credentials?: CredentialVariableData[];
/** Describes a bastion resource. */
bastion?: BastionResourceDefinition;
/** User editable credential variable data and system generated reference to the value. */
bastionCredential?: CredentialVariableData;
/** 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;
/** Input variables for the Action. */
inputs?: VariableData[];
/** Output variables for the Action. */
outputs?: VariableData[];
/** Environment variables for the Action. */
settings?: VariableData[];
/** The personal access token to authenticate with your private GitHub or GitLab repository and access your
* Terraform template.
*/
xGithubToken?: string;
headers?: OutgoingHttpHeaders;
}
/** Constants for the `createAction` operation. */
namespace CreateActionConstants {
/** 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. */
enum Location {
US_SOUTH = "us-south",
US_EAST = "us-east",
EU_GB = "eu-gb",
EU_DE = "eu-de"
}
/** Type of connection to be used when connecting to bastion host. If the `inventory_connection_type=winrm`, then `bastion_connection_type` is not supported. */
enum BastionConnectionType {
SSH = "ssh"
}
/** 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. */
enum InventoryConnectionType {
SSH = "ssh",
WINRM = "winrm"
}
/** Type of source for the Template. */
enum SourceType {
LOCAL = "local",
GIT_HUB = "git_hub",
GIT_HUB_ENTERPRISE = "git_hub_enterprise",
GIT_LAB = "git_lab",
IBM_GIT_LAB = "ibm_git_lab",
IBM_CLOUD_CATALOG = "ibm_cloud_catalog"
}
}
/** Parameters for the `getAction` operation. */
interface GetActionParams {
/** Action Id. Use GET /actions API to look up the Action Ids in your IBM Cloud account. */
actionId: string;
/** Level of details returned by the get method. */
profile?: GetActionConstants.Profile | string;
headers?: OutgoingHttpHeaders;
}
/** Constants for the `getAction` operation. */
namespace GetActionConstants {
/** Level of details returned by the get method. */
enum Profile {
SUMMARY = "summary",
DETAILED = "detailed",
IDS = "ids"
}
}
/** Parameters for the `deleteAction` operation. */
interface DeleteActionParams {
/** Action Id. Use GET /actions API to look up the Action Ids in your IBM Cloud account. */
actionId: string;
/** Equivalent to -force options in the command line. */
force?: boolean;
/** Auto propagate the chaange or deletion to the dependent resources. */
propagate?: boolean;
headers?: OutgoingHttpHeaders;
}
/** Parameters for the `updateAction` operation. */
interface UpdateActionParams {
/** Action Id. Use GET /actions API to look up the Action Ids in your IBM Cloud account. */
actionId: string;
/** 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;
/** Action description. */
description?: string;
/** 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?: UpdateActionConstants.Location | string;
/** Resource-group name for an action. By default, an action is created in `Default` resource group. */
resourceGroup?: string;
/** 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?: UpdateActionConstants.BastionConnectionType | string;
/** 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?: UpdateActionConstants.InventoryConnectionType | string;
/** Action tags. */
tags?: string[];
/** User defined status of the Schematics object. */
userState?: UserState;
/** URL of the `README` file, for the source URL. */
sourceReadmeUrl?: string;
/** Source of templates, playbooks, or controls. */
source?: ExternalSource;
/** Type of source for the Template. */
sourceType?: UpdateActionConstants.SourceType | string;
/** Schematics job command parameter (playbook-name). */
commandParameter?: string;
/** Target inventory record ID, used by the action or ansible playbook. */
inventory?: string;
/** credentials of the Action. */
credentials?: CredentialVariableData[];
/** Describes a bastion resource. */
bastion?: BastionResourceDefinition;
/** User editable credential variable data and system generated reference to the value. */
bastionCredential?: CredentialVariableData;
/** 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;
/** Input variables for the Action. */
inputs?: VariableData[];
/** Output variables for the Action. */
outputs?: VariableData[];
/** Environment variables for the Action. */
settings?: VariableData[];
/** The personal access token to authenticate with your private GitHub or GitLab repository and access your
* Terraform template.
*/
xGithubToken?: string;
headers?: OutgoingHttpHeaders;
}
/** Constants for the `updateAction` operation. */
namespace UpdateActionConstants {
/** 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. */
enum Location {
US_SOUTH = "us-south",
US_EAST = "us-east",
EU_GB = "eu-gb",
EU_DE = "eu-de"
}
/** Type of connection to be used when connecting to bastion host. If the `inventory_connection_type=winrm`, then `bastion_connection_type` is not supported. */
enum BastionConnectionType {
SSH = "ssh"
}
/** 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. */
enum InventoryConnectionType {
SSH = "ssh",
WINRM = "winrm"
}
/** Type of source for the Template. */
enum SourceType {
LOCAL = "local",
GIT_HUB = "git_hub",
GIT_HUB_ENTERPRISE = "git_hub_enterprise",
GIT_LAB = "git_lab",
IBM_GIT_LAB = "ibm_git_lab",
IBM_CLOUD_CATALOG = "ibm_cloud_catalog"
}
}
/** Parameters for the `uploadTemplateTarAction` operation. */
interface UploadTemplateTarActionParams {
/** Action Id. Use GET /actions API to look up the Action Ids in your IBM Cloud account. */
actionId: string;
/** Template tar file. */
file?: NodeJS.ReadableStream | Buffer;
/** The content type of file. */
fileContentType?: string;
headers?: OutgoingHttpHeaders;
}
/** Parameters for the `listWorkspaceActivities` operation. */
interface ListWorkspaceActivitiesParams {
/** The ID of the workspace. To find the workspace ID, use the `GET /v1/workspaces` API. */
wId: string;
/** 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?: number;
/** 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?: number;
headers?: OutgoingHttpHeaders;
}
/** Parameters for the `getWorkspaceActivity` operation. */
interface GetWorkspaceActivityParams {
/** The ID of the workspace. To find the workspace ID, use the `GET /v1/workspaces` API. */
wId: string;
/** 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;
headers?: OutgoingHttpHeaders;
}
/** Parameters for the `deleteWorkspaceActivity` operation. */
interface DeleteWorkspaceActivityParams {
/** The ID of the workspace. To find the workspace ID, use the `GET /v1/workspaces` API. */
wId: string;
/** 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;
headers?: OutgoingHttpHeaders;
}
/** Parameters for the `runWorkspaceCommands` operation. */
interface RunWorkspaceCommandsParams {
/** The ID of the workspace. To find the workspace ID, use the `GET /v1/workspaces` API. */
wId: string;
/** The IAM refresh token for the user or service identity.
*
* **Retrieving refresh token**:
* * Use `export 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;
/** 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[];
/** Command name. */
operationName?: string;
/** Command description. */
description?: string;
headers?: OutgoingHttpHeaders;
}
/** Parameters for the `applyWorkspaceCommand` operation. */
interface ApplyWorkspaceCommandParams {
/** 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;
/** The IAM refresh token for the user or service identity.
*
* **Retrieving refresh token**:
* * Use `export 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;
/** Workspace job options template. */
actionOptions?: WorkspaceActivityOptionsTemplate;
/** The IAM delegated token for your IBM Cloud account. This token is required for requests that are sent via
* the UI only.
*/
delegatedToken?: string;
headers?: OutgoingHttpHeaders;
}
/** Parameters for the `destroyWorkspaceCommand` operation. */
interface DestroyWorkspaceCommandParams {
/** 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;
/** The IAM refresh token for the user or service identity.
*
* **Retrieving refresh token**:
* * Use `export 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;
/** Workspace job options template. */
actionOptions?: WorkspaceActivityOptionsTemplate;
/** The IAM delegated token for your IBM Cloud account. This token is required for requests that are sent via
* the UI only.
*/
delegatedToken?: string;
headers?: OutgoingHttpHeaders;
}
/** Parameters for the `planWorkspaceCommand` operation. */
interface PlanWorkspaceCommandParams {
/** 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;
/** The IAM refresh token for the user or service identity.
*
* **Retrieving refresh token**:
* * Use `export 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;
/** Workspace job options template. */
actionOptions?: WorkspaceActivityOptionsTemplate;
/** The IAM delegated token for your IBM Cloud account. This token is required for requests that are sent via
* the UI only.
*/
delegatedToken?: string;
headers?: OutgoingHttpHeaders;
}
/** Parameters for the `refreshWorkspaceCommand` operation. */
interface RefreshWorkspaceCommandParams {
/** 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;
/** The IAM refresh token for the user or service identity.
*
* **Retrieving refresh token**:
* * Use `export 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;
/** The IAM delegated token for your IBM Cloud account. This token is required for requests that are sent via
* the UI only.
*/
delegatedToken?: string;
headers?: OutgoingHttpHeaders;
}
/** Parameters for the `listJobs` operation. */
interface ListJobsParams {
/** 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?: number;
/** 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?: number;
/** 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;
/** Level of details returned by the get method. */
profile?: ListJobsConstants.Profile | string;
/** Name of the resource (workspaces, actions, environment or controls). */
resource?: ListJobsConstants.Resource | string;
/** The Resource Id. It could be an Action-id or Workspace-id. */
resourceId?: string;
/** Action Id. */
actionId?: string;
/** Workspace Id. */
workspaceId?: string;
/** list jobs. */
list?: ListJobsConstants.List | string;
headers?: OutgoingHttpHeaders;
}
/** Constants for the `listJobs` operation. */
namespace ListJobsConstants {
/** Level of details returned by the get method. */
enum Profile {
IDS = "ids",
SUMMARY = "summary"
}
/** Name of the resource (workspaces, actions, environment or controls). */
enum Resource {
WORKSPACES = "workspaces",
ACTION = "action",
ACTIONS = "actions",
ENVIRONMENT = "environment"
}
/** list jobs. */
enum List {
ALL = "all"
}
}
/** Parameters for the `createJob` operation. */
interface CreateJobParams {
/** The IAM refresh token for the user or service identity.
*
* **Retrieving refresh token**:
* * Use `export 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;
/** Name of the Schematics automation resource. */
commandObject?: CreateJobConstants.CommandObject | string;
/** Job command object id (workspace-id, action-id). */
commandObjectId?: string;
/** Schematics job command name. */
commandName?: CreateJobConstants.CommandName | string;
/** Schematics job command parameter (playbook-name). */
commandParameter?: string;
/** Command line options for the command. */
commandOptions?: string[];
/** Job inputs used by Action or Workspace. */
inputs?: VariableData[];
/** Environment variables used by the Job while performing Action or Workspace. */
settings?: VariableData[];
/** User defined tags, while running the job. */
tags?: string[];
/** 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?: CreateJobConstants.Location | string;
/** Job Status. */
status?: JobStatus;
/** Contains the cart order data which can be used for different purpose for eg. service tagging. */
cartOrderData?: CartOrderData[];
/** Job data. */
data?: JobData;
/** Describes a bastion resource. */
bastion?: BastionResourceDefinition;
/** Job log summary record. */
logSummary?: JobLogSummary;
/** Agent name, Agent id and associated policy ID information. */
agent?: AgentInfo;
headers?: OutgoingHttpHeaders;
}
/** Constants for the `createJob` operation. */
namespace CreateJobConstants {
/** Name of the Schematics automation resource. */
enum CommandObject {
WORKSPACE = "workspace",
ACTION = "action",
SYSTEM = "system",
ENVIRONMENT = "environment"
}
/** Schematics job command name. */
enum CommandName {
WORKSPACE_PLAN = "workspace_plan",
WORKSPACE_APPLY = "workspace_apply",
WORKSPACE_DESTROY = "workspace_destroy",
WORKSPACE_REFRESH = "workspace_refresh",
ANSIBLE_PLAYBOOK_RUN = "ansible_playbook_run",
ANSIBLE_PLAYBOOK_CHECK = "ansible_playbook_check",
CREATE_ACTION = "create_action",
PUT_ACTION = "put_action",
PATCH_ACTION = "patch_action",
DELETE_ACTION = "delete_action",
SYSTEM_KEY_ENABLE = "system_key_enable",
SYSTEM_KEY_DELETE = "system_key_delete",
SYSTEM_KEY_DISABLE = "system_key_disable",
SYSTEM_KEY_ROTATE = "system_key_rotate",
SYSTEM_KEY_RESTORE = "system_key_restore",
CREATE_WORKSPACE = "create_workspace",
PUT_WORKSPACE = "put_workspace",
PATCH_WORKSPACE = "patch_workspace",
DELETE_WORKSPACE = "delete_workspace",
CREATE_CART = "create_cart",
REPOSITORY_PROCESS = "repository_process",
TERRAFORM_COMMANDS = "terraform_commands"
}
/** 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. */
enum Location {
US_SOUTH = "us-south",
US_EAST = "us-east",
EU_GB = "eu-gb",
EU_DE = "eu-de"
}
}
/** Parameters for the `getJob` operation. */
interface GetJobParams {
/** Job Id. Use `GET /v2/jobs` API to look up the Job Ids in your IBM Cloud account. */
jobId: string;
/** Level of details returned by the get method. */
profile?: GetJobConstants.Profile | string;
headers?: OutgoingHttpHeaders;
}
/** Constants for the `getJob` operation. */
namespace GetJobConstants {
/** Level of details returned by the get method. */
enum Profile {
SUMMARY = "summary",
DETAILED = "detailed",
IDS = "ids"
}
}
/** Parameters for the `updateJob` operation. */
interface UpdateJobParams {
/** Job Id. Use `GET /v2/jobs` API to look up the Job Ids in your IBM Cloud account. */
jobId: string;
/** The IAM refresh token for the user or service identity.
*
* **Retrieving refresh token**:
* * Use `export 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;
/** Name of the Schematics automation resource. */
commandObject?: UpdateJobConstants.CommandObject | string;
/** Job command object id (workspace-id, action-id). */
commandObjectId?: string;
/** Schematics job command name. */
commandName?: UpdateJobConstants.CommandName | string;
/** Schematics job command parameter (playbook-name). */
commandParameter?: string;
/** Command line options for the command. */
commandOptions?: string[];
/** Job inputs used by Action or Workspace. */
inputs?: VariableData[];
/** Environment variables used by the Job while performing Action or Workspace. */
settings?: VariableData[];
/** User defined tags, while running the job. */
tags?: string[];
/** 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?: UpdateJobConstants.Location | string;
/** Job Status. */
status?: JobStatus;
/** Contains the cart order data which can be used for different purpose for eg. service tagging. */
cartOrderData?: CartOrderData[];
/** Job data. */
data?: JobData;
/** Describes a bastion resource. */
bastion?: BastionResourceDefinition;
/** Job log summary record. */
logSummary?: JobLogSummary;
/** Agent name, Agent id and associated policy ID information. */
agent?: AgentInfo;
headers?: OutgoingHttpHeaders;
}
/** Constants for the `updateJob` operation. */
namespace UpdateJobConstants {
/** Name of the Schematics automation resource. */
enum CommandObject {
WORKSPACE = "workspace",
ACTION = "action",
SYSTEM = "system",
ENVIRONMENT = "environment"
}
/** Schematics job command name. */
enum CommandName {
WORKSPACE_PLAN = "workspace_plan",
WORKSPACE_APPLY = "workspace_apply",
WORKSPACE_DESTROY = "workspace_destroy",
WORKSPACE_REFRESH = "workspace_refresh",
ANSIBLE_PLAYBOOK_RUN = "ansible_playbook_run",
ANSIBLE_PLAYBOOK_CHECK = "ansible_playbook_check",
CREATE_ACTION = "create_action",
PUT_ACTION = "put_action",
PATCH_ACTION = "patch_action",
DELETE_ACTION = "delete_action",
SYSTEM_KEY_ENABLE = "system_key_enable",
SYSTEM_KEY_DELETE = "system_key_delete",
SYSTEM_KEY_DISABLE = "system_key_disable",
SYSTEM_KEY_ROTATE = "system_key_rotate",
SYSTEM_KEY_RESTORE = "system_key_restore",
CREATE_WORKSPACE = "create_workspace",
PUT_WORKSPACE = "put_workspace",
PATCH_WORKSPACE = "patch_workspace",
DELETE_WORKSPACE = "delete_workspace",
CREATE_CART = "create_cart",
REPOSITORY_PROCESS = "repository_process",
TERRAFORM_COMMANDS = "terraform_commands"
}
/** 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. */
enum Location {
US_SOUTH = "us-south",
US_EAST = "us-east",
EU_GB = "eu-gb",
EU_DE = "eu-de"
}
}
/** Parameters for the `deleteJob` operation. */
interface DeleteJobParams {
/** Job Id. Use `GET /v2/jobs` API to look up the Job Ids in your IBM Cloud account. */
jobId: string;
/** The IAM refresh token for the user or service identity.
*
* **Retrieving refresh token**:
* * Use `export 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;
/** Equivalent to -force options in the command line. */
force?: boolean;
/** Auto propagate the chaange or deletion to the dependent resources. */
propagate?: boolean;
headers?: OutgoingHttpHeaders;
}
/** Parameters for the `listJobLogs` operation. */
interface ListJobLogsParams {
/** Job Id. Use `GET /v2/jobs` API to look up the Job Ids in your IBM Cloud account. */
jobId: string;
headers?: OutgoingHttpHeaders;
}
/** Parameters for the `getJobFiles` operation. */
interface GetJobFilesParams {
/** Job Id. Use `GET /v2/jobs` API to look up the Job Ids in your IBM Cloud account. */
jobId: string;
/** The type of file you want to download eg.state_file, plan_json. */
fileType: GetJobFilesConstants.FileType | string;
headers?: OutgoingHttpHeaders;
}
/** Constants for the `getJobFiles` operation. */
namespace GetJobFilesConstants {
/** The type of file you want to download eg.state_file, plan_json. */
enum FileType {
TEMPLATE_REPO = "template_repo",
README_FILE = "readme_file",
LOG_FILE = "log_file",
STATE_FILE = "state_file",
PLAN_JSON = "plan_json"
}
}
/** Parameters for the `createWorkspaceDeletionJob` operation. */
interface CreateWorkspaceDeletionJobParams {
/** The IAM refresh token for the user or service identity.
*
* **Retrieving refresh token**:
* * Use `export 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;
/** Job type such as delete of a batch operation. */
job?: string;
/** A version of the terraform template. */
version?: string;
/** The List of workspaces to be deleted. */
workspaces?: string[];
headers?: OutgoingHttpHeaders;
}
/** Parameters for the `getWorkspaceDeletionJobStatus` operation. */
interface GetWorkspaceDeletionJobStatusParams {
/** The workspace job ID. */
wjId: string;
headers?: OutgoingHttpHeaders;
}
/** Parameters for the `listInventories` operation. */
interface ListInventoriesParams {
/** 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?: number;
/** 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?: number;
/** 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;
/** Level of details returned by the get method. */
profile?: ListInventoriesConstants.Profile | string;
headers?: OutgoingHttpHeaders;
}
/** Constants for the `listInventories` operation. */
namespace ListInventoriesConstants {
/** Level of details returned by the get method. */
enum Profile {
IDS = "ids",
SUMMARY = "summary"
}
}
/** Parameters for the `createInventory` operation. */
interface CreateInventoryParams {
/** 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;
/** The description of your Inventory definition. The description can be up to 2048 characters long in size. */
description?: string;
/** 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?: CreateInventoryConstants.Location | string;
/** Resource-group name for the Inventory definition. By default, Inventory definition will be created in
* Default Resource Group.
*/
resourceGroup?: string;
/** Input inventory of host and host group for the playbook, in the `.ini` file format. */
inventoriesIni?: string;
/** Input resource query definitions that is used to dynamically generate the inventory of host and host group
* for the playbook.
*/
resourceQueries?: string[];
headers?: OutgoingHttpHeaders;
}
/** Constants for the `createInventory` operation. */
namespace CreateInventoryConstants {
/** 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. */
enum Location {
US_SOUTH = "us-south",
US_EAST = "us-east",
EU_GB = "eu-gb",
EU_DE = "eu-de"
}
}
/** Parameters for the `getInventory` operation. */
interface GetInventoryParams {
/** Resource Inventory Id. Use `GET /v2/inventories` API to look up the Resource Inventory definition Ids in
* your IBM Cloud account.
*/
inventoryId: string;
/** Level of details returned by the get method. */
profile?: GetInventoryConstants.Profile | string;
headers?: OutgoingHttpHeaders;
}
/** Constants for the `getInventory` operation. */
namespace GetInventoryConstants {
/** Level of details returned by the get method. */
enum Profile {
SUMMARY = "summary",
DETAILED = "detailed",
IDS = "ids"
}
}
/** Parameters for the `replaceInventory` operation. */
interface ReplaceInventoryParams {
/** Resource Inventory Id. Use `GET /v2/inventories` API to look up the Resource Inventory definition Ids in
* your IBM Cloud account.
*/
inventoryId: string;
/** 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;
/** The description of your Inventory definition. The description can be up to 2048 characters long in size. */
description?: string;
/** 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?: ReplaceInventoryConstants.Location | string;
/** Resource-group name for the Inventory definition. By default, Inventory definition will be created in
* Default Resource Group.
*/
resourceGroup?: string;
/** Input inventory of host and host group for the playbook, in the `.ini` file format. */
inventoriesIni?: string;
/** Input resource query definitions that is used to dynamically generate the inventory of host and host group
* for the playbook.
*/
resourceQueries?: string[];
headers?: OutgoingHttpHeaders;
}
/** Constants for the `replaceInventory` operation. */
namespace ReplaceInventoryConstants {
/** 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. */
enum Location {
US_SOUTH = "us-south",
US_EAST = "us-east",
EU_GB = "eu-gb",
EU_DE = "eu-de"
}
}
/** Parameters for the `deleteInventory` operation. */
interface DeleteInventoryParams {
/** Resource Inventory Id. Use `GET /v2/inventories` API to look up the Resource Inventory definition Ids in
* your IBM Cloud account.
*/
inventoryId: string;
/** Equivalent to -force options in the command line. */
force?: boolean;
/** Auto propagate the chaange or deletion to the dependent resources. */
propagate?: boolean;
headers?: OutgoingHttpHeaders;
}
/** Parameters for the `listResourceQuery` operation. */
interface ListResourceQueryParams {
/** 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?: number;
/** 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?: number;
/** 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;
/** Level of details returned by the get method. */
profile?: ListResourceQueryConstants.Profile | string;
headers?: OutgoingHttpHeaders;
}
/** Constants for the `listResourceQuery` operation. */
namespace ListResourceQueryConstants {
/** Level of details returned by the get method. */
enum Profile {
IDS = "ids",
SUMMARY = "summary"
}
}
/** Parameters for the `createResourceQuery` operation. */
interface CreateResourceQueryParams {
/** Resource type (cluster, vsi, icd, vpc). */
type?: CreateResourceQueryConstants.Type | string;
/** Resource query name. */
name?: string;
queries?: ResourceQuery[];
headers?: OutgoingHttpHeaders;
}
/** Constants for the `createResourceQuery` operation. */
namespace CreateResourceQueryConstants {
/** Resource type (cluster, vsi, icd, vpc). */
enum Type {
VSI = "vsi"
}
}
/** Parameters for the `getResourcesQuery` operation. */
interface GetResourcesQueryParams {
/** Resource query Id. Use `GET /v2/resource_query` API to look up the Resource query definition Ids in your
* IBM Cloud account.
*/
queryId: string;
headers?: OutgoingHttpHeaders;
}
/** Parameters for the `replaceResourcesQuery` operation. */
interface ReplaceResourcesQueryParams {
/** Resource query Id. Use `GET /v2/resource_query` API to look up the Resource query definition Ids in your
* IBM Cloud account.
*/
queryId: string;
/** Resource type (cluster, vsi, icd, vpc). */
type?: ReplaceResourcesQueryConstants.Type | string;
/** Resource query name. */
name?: string;
queries?: ResourceQuery[];
headers?: OutgoingHttpHeaders;
}
/** Constants for the `replaceResourcesQuery` operation. */
namespace ReplaceResourcesQueryConstants {
/** Resource type (cluster, vsi, icd, vpc). */
enum Type {
VSI = "vsi"
}
}
/** Parameters for the `executeResourceQuery` operation. */
interface ExecuteResourceQueryParams {
/** Resource query Id. Use `GET /v2/resource_query` API to look up the Resource query definition Ids in your
* IBM Cloud account.
*/
queryId: string;
headers?: OutgoingHttpHeaders;
}
/** Parameters for the `deleteResourcesQuery` operation. */
interface DeleteResourcesQueryParams {
/** Resource query Id. Use `GET /v2/resource_query` API to look up the Resource query definition Ids in your
* IBM Cloud account.
*/
queryId: string;
/** Equivalent to -force options in the command line. */
force?: boolean;
/** Auto propagate the chaange or deletion to the dependent resources. */
propagate?: boolean;
headers?: OutgoingHttpHeaders;
}
/** Parameters for the `listAgent` operation. */
interface ListAgentParams {
/** 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?: number;
/** 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?: number;
/** Level of details returned by the get method. */
profile?: ListAgentConstants.Profile | string;
/** Use `new` to get all unregistered agents; use `saved` to get all registered agents. */
filter?: ListAgentConstants.Filter | string;
headers?: OutgoingHttpHeaders;
}
/** Constants for the `listAgent` operation. */
namespace ListAgentConstants {
/** Level of details returned by the get method. */
enum Profile {
SUMMARY = "summary",
DETAILED = "detailed",
IDS = "ids"
}
/** Use `new` to get all unregistered agents; use `saved` to get all registered agents. */
enum Filter {
ALL = "all",
NEW = "new",
SAVED = "saved"
}
}
/** Parameters for the `registerAgent` operation. */
interface RegisterAgentParams {
/** The name of the agent (must be unique, for an account). */
name: string;
/** The location where agent is deployed in the user environment. */
agentLocation: string;
/** 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: RegisterAgentConstants.Location | string;
/** The IAM trusted profile id, used by the Agent instance. */
profileId: string;
/** Agent description. */
description?: string;
/** The resource-group name for the agent. By default, Agent will be registered in Default Resource Group. */
resourceGroup?: string;
/** Tags for the agent. */
tags?: string[];
/** User defined status of the agent. */
userState?: AgentUserState;
headers?: OutgoingHttpHeaders;
}
/** Constants for the `registerAgent` operation. */
namespace RegisterAgentConstants {
/** 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. */
enum Location {
US_SOUTH = "us-south",
US_EAST = "us-east",
EU_GB = "eu-gb",
EU_DE = "eu-de"
}
}
/** Parameters for the `getAgent` operation. */
interface GetAgentParams {
/** Agent ID to get the details of agent. */
agentId: string;
/** Level of details returned by the get method. */
profile?: GetAgentConstants.Profile | string;
headers?: OutgoingHttpHeaders;
}
/** Constants for the `getAgent` operation. */
namespace GetAgentConstants {
/** Level of details returned by the get method. */
enum Profile {
SUMMARY = "summary",
DETAILED = "detailed",
IDS = "ids"
}
}
/** Parameters for the `deleteAgent` operation. */
interface DeleteAgentParams {
/** Agent ID to get the details of agent. */
agentId: string;
headers?: OutgoingHttpHeaders;
}
/** Parameters for the `updateAgentRegistration` operation. */
interface UpdateAgentRegistrationParams {
/** Agent ID to get the details of agent. */
agentId: string;
/** The name of the agent (must be unique, for an account). */
name: string;
/** The location where agent is deployed in the user environment. */
agentLocation: string;
/** 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: UpdateAgentRegistrationConstants.Location | string;
/** The IAM trusted profile id, used by the Agent instance. */
profileId: string;
/** Agent description. */
description?: string;
/** The resource-group name for the agent. By default, Agent will be registered in Default Resource Group. */
resourceGroup?: string;
/** Tags for the agent. */
tags?: string[];
/** User defined status of the agent. */
userState?: AgentUserState;
headers?: OutgoingHttpHeaders;
}
/** Constants for the `updateAgentRegistration` operation. */
namespace UpdateAgentRegistrationConstants {
/** 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. */
enum Location {
US_SOUTH = "us-south",
US_EAST = "us-east",
EU_GB = "eu-gb",
EU_DE = "eu-de"
}
}
/** Parameters for the `listAgentData` operation. */
interface ListAgentDataParams {
/** 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?: number;
/** 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?: number;
/** Level of details returned by the get method. */
profile?: ListAgentDataConstants.Profile | string;
/** Use `new` to get all unregistered agents; use `saved` to get all registered agents. */
filter?: ListAgentDataConstants.Filter | string;
headers?: OutgoingHttpHeaders;
}
/** Constants for the `listAgentData` operation. */
namespace ListAgentDataConstants {
/** Level of details returned by the get method. */
enum Profile {
SUMMARY = "summary",
DETAILED = "detailed",
IDS = "ids"
}
/** Use `new` to get all unregistered agents; use `saved` to get all registered agents. */
enum Filter {
ALL = "all",
NEW = "new",
SAVED = "saved"
}
}
/** Parameters for the `createAgentData` operation. */
interface CreateAgentDataParams {
/** The name of the agent (must be unique, for an account). */
name: string;
/** The resource-group name for the agent. By default, agent will be registered in Default Resource Group. */
resourceGroup: string;
/** Agent version. */
version: string;
/** 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: CreateAgentDataConstants.SchematicsLocation | string;
/** The location where agent is deployed in the user environment. */
agentLocation: string;
/** The infrastructure parameters used by the agent. */
agentInfrastructure: AgentInfrastructure;
/** Agent description. */
description?: string;
/** Tags for the agent. */
tags?: string[];
/** The metadata of an agent. */
agentMetadata?: AgentMetadataInfo[];
/** Additional input variables for the agent. */
agentInputs?: VariableData[];
/** User defined status of the agent. */
userState?: AgentUserState;
/** Schematics Agent key performance indicators. */
agentKpi?: AgentKPIData;
headers?: OutgoingHttpHeaders;
}
/** Constants for the `createAgentData` operation. */
namespace CreateAgentDataConstants {
/** 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. */
enum SchematicsLocation {
US_SOUTH = "us-south",
US_EAST = "us-east",
EU_GB = "eu-gb",
EU_DE = "eu-de"
}
}
/** Parameters for the `getAgentData` operation. */
interface GetAgentDataParams {
/** Agent ID to get the details of agent. */
agentId: string;
/** Level of details returned by the get method. */
profile?: GetAgentDataConstants.Profile | string;
headers?: OutgoingHttpHeaders;
}
/** Constants for the `getAgentData` operation. */
namespace GetAgentDataConstants {
/** Level of details returned by the get method. */
enum Profile {
SUMMARY = "summary",
DETAILED = "detailed",
IDS = "ids"
}
}
/** Parameters for the `updateAgentData` operation. */
interface UpdateAgentDataParams {
/** Agent ID to get the details of agent. */
agentId: string;
/** The name of the agent (must be unique, for an account). */
name: string;
/** The resource-group name for the agent. By default, agent will be registered in Default Resource Group. */
resourceGroup: string;
/** Agent version. */
version: string;
/** 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: UpdateAgentDataConstants.SchematicsLocation | string;
/** The location where agent is deployed in the user environment. */
agentLocation: string;
/** The infrastructure parameters used by the agent. */
agentInfrastructure: AgentInfrastructure;
/** Agent description. */
description?: string;
/** Tags for the agent. */
tags?: string[];
/** The metadata of an agent. */
agentMetadata?: AgentMetadataInfo[];
/** Additional input variables for the agent. */
agentInputs?: VariableData[];
/** User defined status of the agent. */
userState?: AgentUserState;
/** Schematics Agent key performance indicators. */
agentKpi?: AgentKPIData;
/** 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=`, 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;
headers?: OutgoingHttpHeaders;
}
/** Constants for the `updateAgentData` operation. */
namespace UpdateAgentDataConstants {
/** 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. */
enum SchematicsLocation {
US_SOUTH = "us-south",
US_EAST = "us-east",
EU_GB = "eu-gb",
EU_DE = "eu-de"
}
}
/** Parameters for the `deleteAgentData` operation. */
interface DeleteAgentDataParams {
/** Agent ID to get the details of agent. */
agentId: string;
/** Equivalent to -force options in the command line, default is false. */
force?: boolean;
headers?: OutgoingHttpHeaders;
}
/** Parameters for the `getAgentVersions` operation. */
interface GetAgentVersionsParams {
headers?: OutgoingHttpHeaders;
}
/** Parameters for the `getPrsAgentJob` operation. */
interface GetPrsAgentJobParams {
/** Agent ID to get the details of agent. */
agentId: string;
headers?: OutgoingHttpHeaders;
}
/** Parameters for the `prsAgentJob` operation. */
interface PrsAgentJobParams {
/** Agent ID to get the details of agent. */
agentId: string;
/** Equivalent to -force options in the command line, default is false. */
force?: boolean;
headers?: OutgoingHttpHeaders;
}
/** Parameters for the `getHealthCheckAgentJob` operation. */
interface GetHealthCheckAgentJobParams {
/** Agent ID to get the details of agent. */
agentId: string;
headers?: OutgoingHttpHeaders;
}
/** Parameters for the `healthCheckAgentJob` operation. */
interface HealthCheckAgentJobParams {
/** Agent ID to get the details of agent. */
agentId: string;
/** Equivalent to -force options in the command line, default is false. */
force?: boolean;
headers?: OutgoingHttpHeaders;
}
/** Parameters for the `getDeployAgentJob` operation. */
interface GetDeployAgentJobParams {
/** Agent ID to get the details of agent. */
agentId: string;
headers?: OutgoingHttpHeaders;
}
/** Parameters for the `deployAgentJob` operation. */
interface DeployAgentJobParams {
/** Agent ID to get the details of agent. */
agentId: string;
/** Equivalent to -force options in the command line, default is false. */
force?: boolean;
headers?: OutgoingHttpHeaders;
}
/** Parameters for the `deleteAgentResources` operation. */
interface DeleteAgentResourcesParams {
/** Agent ID to get the details of agent. */
agentId: string;
/** The IAM refresh token for the user or service identity.
*
* **Retrieving refresh token**:
* * Use `export 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;
headers?: OutgoingHttpHeaders;
}
/** Parameters for the `getKmsSettings` operation. */
interface GetKmsSettingsParams {
/** The location of the Resource. */
location: string;
headers?: OutgoingHttpHeaders;
}
/** Parameters for the `updateKmsSettings` operation. */
interface UpdateKmsSettingsParams {
/** The location to integrate kms instance. For example, location can be `US` and `EU`. */
location?: string;
/** The encryption scheme values. **Allowable values** [`byok`,`kyok`]. */
encryptionScheme?: string;
/** The kms instance resource group to integrate. */
resourceGroup?: string;
/** The primary kms instance details. */
primaryCrk?: KMSSettingsPrimaryCrk;
/** The secondary kms instance details. */
secondaryCrk?: KMSSettingsSecondaryCrk;
headers?: OutgoingHttpHeaders;
}
/** Parameters for the `listKms` operation. */
interface ListKmsParams {
/** The encryption scheme to be used. */
encryptionScheme: string;
/** The location of the Resource. */
location: string;
/** The resource group (by default, fetch from all resource groups) name or ID. */
resourceGroup?: string;
/** 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?: number;
/** 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;
headers?: OutgoingHttpHeaders;
}
/** Parameters for the `listPolicy` operation. */
interface ListPolicyParams {
/** 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?: number;
/** 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?: number;
/** Level of details returned by the get method. */
profile?: ListPolicyConstants.Profile | string;
headers?: OutgoingHttpHeaders;
}
/** Constants for the `listPolicy` operation. */
namespace ListPolicyConstants {
/** Level of details returned by the get method. */
enum Profile {
SUMMARY = "summary",
DETAILED = "detailed",
IDS = "ids"
}
}
/** Parameters for the `createPolicy` operation. */
interface CreatePolicyParams {
/** Name of Schematics customization policy. */
name?: string;
/** The description of Schematics customization policy. */
description?: string;
/** The resource group name for the policy. By default, Policy will be created in `default` Resource Group. */
resourceGroup?: string;
/** Tags for the Schematics customization policy. */
tags?: string[];
/** 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?: CreatePolicyConstants.Location | string;
/** User defined status of the Schematics object. */
state?: UserState;
/** Policy kind or categories for managing and deriving policy decision
* * `agent_assignment_policy` Agent assignment policy for job execution.
*/
kind?: CreatePolicyConstants.Kind | string;
/** The objects for the Schematics policy. */
target?: PolicyObjects;
/** The parameter to tune the Schematics policy. */
parameter?: PolicyParameter;
/** List of scoped Schematics resources targeted by the policy. */
scopedResources?: ScopedResource[];
headers?: OutgoingHttpHeaders;
}
/** Constants for the `createPolicy` operation. */
namespace CreatePolicyConstants {
/** 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. */
enum Location {
US_SOUTH = "us-south",
US_EAST = "us-east",
EU_GB = "eu-gb",
EU_DE = "eu-de"
}
/** Policy kind or categories for managing and deriving policy decision * `agent_assignment_policy` Agent assignment policy for job execution. */
enum Kind {
AGENT_ASSIGNMENT_POLICY = "agent_assignment_policy"
}
}
/** Parameters for the `getPolicy` operation. */
interface GetPolicyParams {
/** ID to get the details of policy. */
policyId: string;
/** Level of details returned by the get method. */
profile?: GetPolicyConstants.Profile | string;
headers?: OutgoingHttpHeaders;
}
/** Constants for the `getPolicy` operation. */
namespace GetPolicyConstants {
/** Level of details returned by the get method. */
enum Profile {
SUMMARY = "summary",
DETAILED = "detailed",
IDS = "ids"
}
}
/** Parameters for the `deletePolicy` operation. */
interface DeletePolicyParams {
/** ID to get the details of policy. */
policyId: string;
headers?: OutgoingHttpHeaders;
}
/** Parameters for the `updatePolicy` operation. */
interface UpdatePolicyParams {
/** ID to get the details of policy. */
policyId: string;
/** Name of Schematics customization policy. */
name?: string;
/** The description of Schematics customization policy. */
description?: string;
/** The resource group name for the policy. By default, Policy will be created in `default` Resource Group. */
resourceGroup?: string;
/** Tags for the Schematics customization policy. */
tags?: string[];
/** 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?: UpdatePolicyConstants.Location | string;
/** User defined status of the Schematics object. */
state?: UserState;
/** Policy kind or categories for managing and deriving policy decision
* * `agent_assignment_policy` Agent assignment policy for job execution.
*/
kind?: UpdatePolicyConstants.Kind | string;
/** The objects for the Schematics policy. */
target?: PolicyObjects;
/** The parameter to tune the Schematics policy. */
parameter?: PolicyParameter;
/** List of scoped Schematics resources targeted by the policy. */
scopedResources?: ScopedResource[];
headers?: OutgoingHttpHeaders;
}
/** Constants for the `updatePolicy` operation. */
namespace UpdatePolicyConstants {
/** 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. */
enum Location {
US_SOUTH = "us-south",
US_EAST = "us-east",
EU_GB = "eu-gb",
EU_DE = "eu-de"
}
/** Policy kind or categories for managing and deriving policy decision * `agent_assignment_policy` Agent assignment policy for job execution. */
enum Kind {
AGENT_ASSIGNMENT_POLICY = "agent_assignment_policy"
}
}
/*************************
* model interfaces
************************/
/**
* Complete Action details with user inputs and system generated data.
*/
interface Action {
/** 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;
/** Action description. */
description?: string;
/** 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?: Action.Constants.Location | string;
/** Resource-group name for an action. By default, an action is created in `Default` resource group. */
resource_group?: string;
/** Type of connection to be used when connecting to bastion host. If the `inventory_connection_type=winrm`,
* then `bastion_connection_type` is not supported.
*/
bastion_connection_type?: Action.Constants.BastionConnectionType | string;
/** 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.
*/
inventory_connection_type?: Action.Constants.InventoryConnectionType | string;
/** Action tags. */
tags?: string[];
/** User defined status of the Schematics object. */
user_state?: UserState;
/** URL of the `README` file, for the source URL. */
source_readme_url?: string;
/** Source of templates, playbooks, or controls. */
source?: ExternalSource;
/** Type of source for the Template. */
source_type?: Action.Constants.SourceType | string;
/** Schematics job command parameter (playbook-name). */
command_parameter?: string;
/** Target inventory record ID, used by the action or ansible playbook. */
inventory?: string;
/** credentials of the Action. */
credentials?: CredentialVariableData[];
/** Describes a bastion resource. */
bastion?: BastionResourceDefinition;
/** User editable credential variable data and system generated reference to the value. */
bastion_credential?: CredentialVariableData;
/** 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).
*/
targets_ini?: string;
/** Input variables for the Action. */
inputs?: VariableData[];
/** Output variables for the Action. */
outputs?: VariableData[];
/** Environment variables for the Action. */
settings?: VariableData[];
/** Action ID. */
id?: string;
/** Action Cloud Resource Name. */
crn?: string;
/** Action account ID. */
account?: string;
/** Action Playbook Source creation time. */
source_created_at?: string;
/** E-mail address of user who created the Action Playbook Source. */
source_created_by?: string;
/** The action playbook updation time. */
source_updated_at?: string;
/** E-mail address of user who updated the action playbook source. */
source_updated_by?: string;
/** Action creation time. */
created_at?: string;
/** E-mail address of the user who created an action. */
created_by?: string;
/** Action updation time. */
updated_at?: string;
/** E-mail address of the user who updated an action. */
updated_by?: string;
/** Computed state of the Action. */
state?: ActionState;
/** Playbook names retrieved from the repository. */
playbook_names?: string[];
/** System lock status. */
sys_lock?: SystemLock;
/** secrets manager reference to git token. */
git_token_ref?: string;
/** Encryption details about the workspace such as scheme (byok/kyok) and key CRN. */
encryption?: EncryptionInfo;
}
namespace Action {
namespace Constants {
/** 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. */
enum Location {
US_SOUTH = "us-south",
US_EAST = "us-east",
EU_GB = "eu-gb",
EU_DE = "eu-de"
}
/** Type of connection to be used when connecting to bastion host. If the `inventory_connection_type=winrm`, then `bastion_connection_type` is not supported. */
enum BastionConnectionType {
SSH = "ssh"
}
/** 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. */
enum InventoryConnectionType {
SSH = "ssh",
WINRM = "winrm"
}
/** Type of source for the Template. */
enum SourceType {
LOCAL = "local",
GIT_HUB = "git_hub",
GIT_HUB_ENTERPRISE = "git_hub_enterprise",
GIT_LAB = "git_lab",
IBM_GIT_LAB = "ibm_git_lab",
IBM_CLOUD_CATALOG = "ibm_cloud_catalog"
}
}
}
/**
* List of Action definition response.
*/
interface ActionList {
/** Total number of records. */
total_count?: number;
/** Number of records returned. */
limit: number;
/** Skipped number of records. */
offset: number;
/** List of action records. */
actions?: ActionLite[];
}
/**
* Action summary profile with user inputs and system generated data.
*/
interface ActionLite {
/** Action name (unique for an account). */
name?: string;
/** Action description. */
description?: string;
/** Action Id. */
id?: string;
/** Action Cloud Resource Name. */
crn?: string;
/** 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?: ActionLite.Constants.Location | string;
/** Resource-group name for the Action. By default, Action will be created in Default Resource Group. */
resource_group?: string;
/** name of the namespace. */
namespace?: string;
/** Action tags. */
tags?: string[];
/** Name of the selected playbook. */
playbook_name?: string;
/** User defined status of the Schematics object. */
user_state?: UserState;
/** Computed state of the Action. */
state?: ActionLiteState;
/** System lock status. */
sys_lock?: SystemLock;
/** Action creation time. */
created_at?: string;
/** Email address of user who created the action. */
created_by?: string;
/** Action updation time. */
updated_at?: string;
/** Email address of user who updated the action. */
updated_by?: string;
/** Agent name, Agent id and associated policy ID information. */
agent?: AgentInfo;
/** Encryption details about the workspace such as scheme (byok/kyok) and key CRN. */
encryption?: EncryptionInfo;
}
namespace ActionLite {
namespace Constants {
/** 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. */
enum Location {
US_SOUTH = "us-south",
US_EAST = "us-east",
EU_GB = "eu-gb",
EU_DE = "eu-de"
}
}
}
/**
* Computed state of the Action.
*/
interface ActionLiteState {
/** Status of automation (workspace or action). */
status_code?: ActionLiteState.Constants.StatusCode | string;
/** Automation status message - to be displayed along with the status_code. */
status_message?: string;
}
namespace ActionLiteState {
namespace Constants {
/** Status of automation (workspace or action). */
enum StatusCode {
NORMAL = "normal",
PENDING = "pending",
DISABLED = "disabled",
CRITICAL = "critical"
}
}
}
/**
* Computed state of the Action.
*/
interface ActionState {
/** Status of automation (workspace or action). */
status_code?: ActionState.Constants.StatusCode | string;
/** Job id reference for this status. */
status_job_id?: string;
/** Automation status message - to be displayed along with the status_code. */
status_message?: string;
}
namespace ActionState {
namespace Constants {
/** Status of automation (workspace or action). */
enum StatusCode {
NORMAL = "normal",
PENDING = "pending",
DISABLED = "disabled",
CRITICAL = "critical"
}
}
}
/**
* The agent registration details, with user inputs and system generated data.
*/
interface Agent {
/** The name of the agent (must be unique, for an account). */
name: string;
/** Agent description. */
description?: string;
/** The resource-group name for the agent. By default, Agent will be registered in Default Resource Group. */
resource_group?: string;
/** Tags for the agent. */
tags?: string[];
/** The location where agent is deployed in the user environment. */
agent_location: string;
/** 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: Agent.Constants.Location | string;
/** The IAM trusted profile id, used by the Agent instance. */
profile_id: string;
/** The Agent crn, obtained from the Schematics Agent deployment configuration. */
agent_crn?: string;
/** The Agent registration id. */
id?: string;
/** The Agent registration date-time. */
registered_at?: string;
/** The email address of an user who registered the Agent. */
registered_by?: string;
/** The Agent registration updation time. */
updated_at?: string;
/** Email address of user who updated the Agent registration. */
updated_by?: string;
/** User defined status of the agent. */
user_state?: AgentUserState;
/** Connection status of the agent. */
connection_state?: ConnectionState;
/** Computed state of the agent. */
system_state?: AgentSystemState;
}
namespace Agent {
namespace Constants {
/** 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. */
enum Location {
US_SOUTH = "us-south",
US_EAST = "us-east",
EU_GB = "eu-gb",
EU_DE = "eu-de"
}
}
}
/**
* Parameters for the `agent_assignment_policy`.
*/
interface AgentAssignmentPolicyParameter {
/** Types of schematics object selector. */
selector_kind?: AgentAssignmentPolicyParameter.Constants.SelectorKind | string;
/** The static selectors of schematics object ids (workspace or action) for the Schematics policy. */
selector_ids?: string[];
/** The selectors to dynamically list of schematics object ids (workspace or action) for the Schematics policy. */
selector_scope?: PolicyObjectSelector[];
}
namespace AgentAssignmentPolicyParameter {
namespace Constants {
/** Types of schematics object selector. */
enum SelectorKind {
IDS = "ids",
SCOPED = "scoped"
}
}
}
/**
* The agent details, with user inputs and system generated data.
*/
interface AgentData {
/** The name of the agent (must be unique, for an account). */
name: string;
/** Agent description. */
description?: string;
/** The resource-group name for the agent. By default, agent will be registered in Default Resource Group. */
resource_group: string;
/** Tags for the agent. */
tags?: string[];
/** Agent version. */
version: string;
/** 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.
*/
schematics_location: AgentData.Constants.SchematicsLocation | string;
/** The location where agent is deployed in the user environment. */
agent_location: string;
/** The infrastructure parameters used by the agent. */
agent_infrastructure: AgentInfrastructure;
/** The metadata of an agent. */
agent_metadata?: AgentMetadataInfo[];
/** Additional input variables for the agent. */
agent_inputs?: VariableData[];
/** User defined status of the agent. */
user_state?: AgentUserState;
/** The agent crn, obtained from the Schematics agent deployment configuration. */
agent_crn?: string;
/** The agent resource id. */
id?: string;
/** The agent creation date-time. */
created_at?: string;
/** The email address of an user who created the agent. */
creation_by?: string;
/** The agent registration updation time. */
updated_at?: string;
/** Email address of user who updated the agent registration. */
updated_by?: string;
/** Computed state of the agent. */
system_state?: AgentSystemStatus;
/** Schematics Agent key performance indicators. */
agent_kpi?: AgentKPIData;
/** Run a pre-requisite scanner for deploying agent. */
recent_prs_job?: AgentDataRecentPrsJob;
/** Post-installations checks for Agent health. */
recent_deploy_job?: AgentDataRecentDeployJob;
/** Agent health check. */
recent_health_job?: AgentDataRecentHealthJob;
/** destroy resource provisoned by agent deploy method. */
recent_destroy_job?: AgentDataRecentDestroyJob;
/** Encryption details about the workspace such as scheme (byok/kyok) and key CRN. */
encryption?: EncryptionInfo;
}
namespace AgentData {
namespace Constants {
/** 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. */
enum SchematicsLocation {
US_SOUTH = "us-south",
US_EAST = "us-east",
EU_GB = "eu-gb",
EU_DE = "eu-de"
}
}
}
/**
* The list of agents.
*/
interface AgentDataList {
/** The total number of records. */
total_count?: number;
/** The number of records returned. */
limit?: number;
/** The skipped number of records. */
offset: number;
/** The list of agents in the account. */
agents?: AgentDataLite[];
}
/**
* The agent details for a list view.
*/
interface AgentDataLite {
/** The name of the agent (must be unique, for an account). */
name?: string;
/** Agent description. */
description?: string;
/** The resource-group name for the agent. By default, agent will be registered in Default Resource Group. */
resource_group?: string;
/** Tags for the agent. */
tags?: string[];
/** The agent version. */
version?: string;
/** 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.
*/
schematics_location?: AgentDataLite.Constants.SchematicsLocation | string;
/** The location where agent is deployed in the user environment. */
agent_location?: string;
/** The metadata of an agent. */
agent_metadata?: AgentMetadataInfo[];
/** User defined status of the agent. */
user_state?: AgentUserState;
/** The agent crn, obtained from the Schematics agent deployment configuration. */
agent_crn?: string;
/** The agent resource id. */
id?: string;
/** The agent creation date-time. */
created_at?: string;
/** The email address of an user who created the agent. */
creation_by?: string;
/** The agent registration updation time. */
updated_at?: string;
/** Email address of user who updated the agent registration. */
updated_by?: string;
/** Computed state of the agent. */
system_state?: AgentSystemStatus;
/** Schematics Agent key performance indicators' summary. */
agent_kpi?: AgentKPIDataLite;
}
namespace AgentDataLite {
namespace Constants {
/** 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. */
enum SchematicsLocation {
US_SOUTH = "us-south",
US_EAST = "us-east",
EU_GB = "eu-gb",
EU_DE = "eu-de"
}
}
}
/**
* Post-installations checks for Agent health.
*/
interface AgentDataRecentDeployJob {
/** Id of the agent. */
agent_id?: string;
/** Job Id. */
job_id?: string;
/** The agent deploy job updation time. */
updated_at?: string;
/** Email address of user who ran the agent deploy job. */
updated_by?: string;
/** True, when the same version of the agent was redeployed. */
is_redeployed?: boolean;
/** Agent version. */
agent_version?: string;
/** Status of Jobs. */
status_code?: AgentDataRecentDeployJob.Constants.StatusCode | string;
/** The outcome of the agent deployment job, in a formatted log string. */
status_message?: string;
/** URL to the full agent deployment job logs. */
log_url?: string;
}
namespace AgentDataRecentDeployJob {
namespace Constants {
/** Status of Jobs. */
enum StatusCode {
JOB_PENDING = "job_pending",
JOB_IN_PROGRESS = "job_in_progress",
JOB_FINISHED = "job_finished",
JOB_FAILED = "job_failed",
JOB_CANCELLED = "job_cancelled",
JOB_STOPPED = "job_stopped",
JOB_STOP_IN_PROGRESS = "job_stop_in_progress",
JOB_READY_TO_EXECUTE = "job_ready_to_execute"
}
}
}
/**
* destroy resource provisoned by agent deploy method.
*/
interface AgentDataRecentDestroyJob {
/** Id of the agent. */
agent_id?: string;
/** Job Id. */
job_id?: string;
/** The agent resources destroy job updation time. */
updated_at?: string;
/** Email address of user who ran the agent resources destroy job. */
updated_by?: string;
/** Agent version. */
agent_version?: string;
/** Status of Jobs. */
status_code?: AgentDataRecentDestroyJob.Constants.StatusCode | string;
/** The outcome of the agent resources destroy job, in a formatted log string. */
status_message?: string;
/** URL to the full agent resources destroy job logs. */
log_url?: string;
}
namespace AgentDataRecentDestroyJob {
namespace Constants {
/** Status of Jobs. */
enum StatusCode {
JOB_PENDING = "job_pending",
JOB_IN_PROGRESS = "job_in_progress",
JOB_FINISHED = "job_finished",
JOB_FAILED = "job_failed",
JOB_CANCELLED = "job_cancelled",
JOB_STOPPED = "job_stopped",
JOB_STOP_IN_PROGRESS = "job_stop_in_progress",
JOB_READY_TO_EXECUTE = "job_ready_to_execute"
}
}
}
/**
* Agent health check.
*/
interface AgentDataRecentHealthJob {
/** Id of the agent. */
agent_id?: string;
/** Job Id. */
job_id?: string;
/** The agent health check job updation time. */
updated_at?: string;
/** Email address of user who ran the agent health check job. */
updated_by?: string;
/** Agent version. */
agent_version?: string;
/** Status of Jobs. */
status_code?: AgentDataRecentHealthJob.Constants.StatusCode | string;
/** The outcome of the health-check job, in a formatted log string. */
status_message?: string;
/** URL to the full health-check job logs. */
log_url?: string;
}
namespace AgentDataRecentHealthJob {
namespace Constants {
/** Status of Jobs. */
enum StatusCode {
JOB_PENDING = "job_pending",
JOB_IN_PROGRESS = "job_in_progress",
JOB_FINISHED = "job_finished",
JOB_FAILED = "job_failed",
JOB_CANCELLED = "job_cancelled",
JOB_STOPPED = "job_stopped",
JOB_STOP_IN_PROGRESS = "job_stop_in_progress",
JOB_READY_TO_EXECUTE = "job_ready_to_execute"
}
}
}
/**
* Run a pre-requisite scanner for deploying agent.
*/
interface AgentDataRecentPrsJob {
/** Id of the agent. */
agent_id?: string;
/** Job Id. */
job_id?: string;
/** The agent prs job updation time. */
updated_at?: string;
/** Email address of user who ran the agent prs job. */
updated_by?: string;
/** Agent version. */
agent_version?: string;
/** Status of Jobs. */
status_code?: AgentDataRecentPrsJob.Constants.StatusCode | string;
/** The outcome of the pre-requisite scanner job, in a formatted log string. */
status_message?: string;
/** URL to the full pre-requisite scanner job logs. */
log_url?: string;
}
namespace AgentDataRecentPrsJob {
namespace Constants {
/** Status of Jobs. */
enum StatusCode {
JOB_PENDING = "job_pending",
JOB_IN_PROGRESS = "job_in_progress",
JOB_FINISHED = "job_finished",
JOB_FAILED = "job_failed",
JOB_CANCELLED = "job_cancelled",
JOB_STOPPED = "job_stopped",
JOB_STOP_IN_PROGRESS = "job_stop_in_progress",
JOB_READY_TO_EXECUTE = "job_ready_to_execute"
}
}
}
/**
* Post-installations checks for Agent health.
*/
interface AgentDeployJob {
/** Id of the agent. */
agent_id?: string;
/** Job Id. */
job_id?: string;
/** The agent deploy job updation time. */
updated_at?: string;
/** Email address of user who ran the agent deploy job. */
updated_by?: string;
/** True, when the same version of the agent was redeployed. */
is_redeployed?: boolean;
/** Agent version. */
agent_version?: string;
/** Status of Jobs. */
status_code?: AgentDeployJob.Constants.StatusCode | string;
/** The outcome of the agent deployment job, in a formatted log string. */
status_message?: string;
/** URL to the full agent deployment job logs. */
log_url?: string;
}
namespace AgentDeployJob {
namespace Constants {
/** Status of Jobs. */
enum StatusCode {
JOB_PENDING = "job_pending",
JOB_IN_PROGRESS = "job_in_progress",
JOB_FINISHED = "job_finished",
JOB_FAILED = "job_failed",
JOB_CANCELLED = "job_cancelled",
JOB_STOPPED = "job_stopped",
JOB_STOP_IN_PROGRESS = "job_stop_in_progress",
JOB_READY_TO_EXECUTE = "job_ready_to_execute"
}
}
}
/**
* Agent health check.
*/
interface AgentHealthJob {
/** Id of the agent. */
agent_id?: string;
/** Job Id. */
job_id?: string;
/** The agent health check job updation time. */
updated_at?: string;
/** Email address of user who ran the agent health check job. */
updated_by?: string;
/** Agent version. */
agent_version?: string;
/** Status of Jobs. */
status_code?: AgentHealthJob.Constants.StatusCode | string;
/** The outcome of the health-check job, in a formatted log string. */
status_message?: string;
/** URL to the full health-check job logs. */
log_url?: string;
}
namespace AgentHealthJob {
namespace Constants {
/** Status of Jobs. */
enum StatusCode {
JOB_PENDING = "job_pending",
JOB_IN_PROGRESS = "job_in_progress",
JOB_FINISHED = "job_finished",
JOB_FAILED = "job_failed",
JOB_CANCELLED = "job_cancelled",
JOB_STOPPED = "job_stopped",
JOB_STOP_IN_PROGRESS = "job_stop_in_progress",
JOB_READY_TO_EXECUTE = "job_ready_to_execute"
}
}
}
/**
* Agent name, Agent id and associated policy ID information.
*/
interface AgentInfo {
/** ID of the Agent bound to the schematics object (workspace, action). */
id?: string;
/** Name of the Agent bound to the schematics object. */
name?: string;
/** ID of the agent assignment policy, that is used to bind the Agent to schematics object. */
assignment_policy_id?: string;
}
/**
* The infrastructure parameters used by the agent.
*/
interface AgentInfrastructure {
/** Type of target agent infrastructure. */
infra_type?: AgentInfrastructure.Constants.InfraType | string;
/** The cluster ID where agent services will be running. */
cluster_id?: string;
/** The resource group of the cluster (is it required?). */
cluster_resource_group?: string;
/** The COS instance name to store the agent logs. */
cos_instance_name?: string;
/** The COS bucket name used to store the logs. */
cos_bucket_name?: string;
/** The COS bucket region. */
cos_bucket_region?: string;
}
namespace AgentInfrastructure {
namespace Constants {
/** Type of target agent infrastructure. */
enum InfraType {
IBM_KUBERNETES = "ibm_kubernetes",
IBM_OPENSHIFT = "ibm_openshift",
IBM_SATELLITE = "ibm_satellite"
}
}
}
/**
* Schematics Agent key performance indicators.
*/
interface AgentKPIData {
/** Overall availability indicator reported by the agent. */
availability_indicator?: AgentKPIData.Constants.AvailabilityIndicator | string;
/** Overall lifecycle indicator reported by the agents. */
lifecycle_indicator?: AgentKPIData.Constants.LifecycleIndicator | string;
/** Percentage usage of the agent resources. */
percent_usage_indicator?: string;
/** Agent application key performance indicators. */
application_indicators?: any[];
/** Agent infrastructure key performance indicators. */
infra_indicators?: any[];
}
namespace AgentKPIData {
namespace Constants {
/** Overall availability indicator reported by the agent. */
enum AvailabilityIndicator {
AVAILABLE = "available",
UNAVAILABLE = "unavailable",
ERROR = "error"
}
/** Overall lifecycle indicator reported by the agents. */
enum LifecycleIndicator {
CONSISTENT = "consistent",
INCONSISTENT = "inconsistent",
OBSELETE = "obselete"
}
}
}
/**
* Schematics Agent key performance indicators' summary.
*/
interface AgentKPIDataLite {
/** Overall availability indicator reported by the agent. */
availability_indicator?: AgentKPIDataLite.Constants.AvailabilityIndicator | string;
/** Overall lifecycle indicator reported by the agents. */
lifecycle_indicator?: AgentKPIDataLite.Constants.LifecycleIndicator | string;
/** Percentage usage of the agent resources. */
percent_usage_indicator?: string;
}
namespace AgentKPIDataLite {
namespace Constants {
/** Overall availability indicator reported by the agent. */
enum AvailabilityIndicator {
AVAILABLE = "available",
UNAVAILABLE = "unavailable",
ERROR = "error"
}
/** Overall lifecycle indicator reported by the agents. */
enum LifecycleIndicator {
CONSISTENT = "consistent",
INCONSISTENT = "inconsistent",
OBSELETE = "obselete"
}
}
}
/**
* The list of agent details.
*/
interface AgentList {
/** The total number of records. */
total_count?: number;
/** The number of records returned. */
limit?: number;
/** The skipped number of records. */
offset: number;
/** The list of agents in the account. */
agents?: Agent[];
}
/**
* AgentMetadataInfo.
*/
interface AgentMetadataInfo {
/** Name of the metadata. */
name?: string;
/** Value of the metadata name. */
value?: string[];
}
/**
* Run a pre-requisite scanner for deploying agent.
*/
interface AgentPRSJob {
/** Id of the agent. */
agent_id?: string;
/** Job Id. */
job_id?: string;
/** The agent prs job updation time. */
updated_at?: string;
/** Email address of user who ran the agent prs job. */
updated_by?: string;
/** Agent version. */
agent_version?: string;
/** Status of Jobs. */
status_code?: AgentPRSJob.Constants.StatusCode | string;
/** The outcome of the pre-requisite scanner job, in a formatted log string. */
status_message?: string;
/** URL to the full pre-requisite scanner job logs. */
log_url?: string;
}
namespace AgentPRSJob {
namespace Constants {
/** Status of Jobs. */
enum StatusCode {
JOB_PENDING = "job_pending",
JOB_IN_PROGRESS = "job_in_progress",
JOB_FINISHED = "job_finished",
JOB_FAILED = "job_failed",
JOB_CANCELLED = "job_cancelled",
JOB_STOPPED = "job_stopped",
JOB_STOP_IN_PROGRESS = "job_stop_in_progress",
JOB_READY_TO_EXECUTE = "job_ready_to_execute"
}
}
}
/**
* Computed state of the agent.
*/
interface AgentSystemStatus {
/** Agent Status. */
status_code?: AgentSystemStatus.Constants.StatusCode | string;
/** The agent status message. */
status_message?: string;
}
namespace AgentSystemStatus {
namespace Constants {
/** Agent Status. */
enum StatusCode {
ERROR = "error",
NORMAL = "normal",
IN_PROGRESS = "in_progress",
PENDING = "pending",
DRAFT = "draft"
}
}
}
/**
* User defined status of the agent.
*/
interface AgentUserState {
/** User-defined states * `enable` Agent is enabled by the user. * `disable` Agent is disbaled by the user. */
state?: AgentUserState.Constants.State | string;
/** Name of the User who set the state of the Object. */
set_by?: string;
/** When the User who set the state of the Object. */
set_at?: string;
}
namespace AgentUserState {
namespace Constants {
/** User-defined states * `enable` Agent is enabled by the user. * `disable` Agent is disbaled by the user. */
enum State {
ENABLE = "enable",
DISABLE = "disable"
}
}
}
/**
* An item in list of all the versions available.
*/
interface AgentVersionInfo {
/** The display name of the agent version. */
display_name?: string;
/** The version of the agent. */
agent_version?: string;
}
/**
* Agent versions available to be deployed.
*/
interface AgentVersions {
/** list of the versions supported. */
supported_agent_versions?: AgentVersionInfo[];
}
/**
* Computed state of the agent.
*/
interface AgentSystemState {
/** Agent Status. */
state?: AgentSystemState.Constants.State | string;
/** The Agent status message. */
message?: string;
}
namespace AgentSystemState {
namespace Constants {
/** Agent Status. */
enum State {
ERROR = "error",
NORMAL = "normal",
IN_PROGRESS = "in_progress",
PENDING = "pending",
DRAFT = "draft"
}
}
}
/**
* Describes a bastion resource.
*/
interface BastionResourceDefinition {
/** Bastion Name; the name must be unique. */
name?: string;
/** Reference to the Inventory resource definition. */
host?: string;
}
/**
* Schematics Cart Order Data.
*/
interface CartOrderData {
/** Name of the property. */
name?: string;
/** Value of the property. */
value?: string;
/** Type of the values(string, int etc). */
type?: string;
/** List of usage kind how the cart data can be used. */
usage_kind?: CartOrderData.Constants.UsageKind[] | string[];
}
namespace CartOrderData {
namespace Constants {
/** List of usage kind how the cart data can be used. */
enum UsageKind {
SERVICETAGS = "servicetags"
}
}
}
/**
* Information about the software template that you chose from the IBM Cloud catalog. This information is returned for
* IBM Cloud catalog offerings only.
*/
interface CatalogRef {
/** Dry run. */
dry_run?: boolean;
/** Owning account ID of the catalog. */
owning_account?: string;
/** The URL to the icon of the software template in the IBM Cloud catalog. */
item_icon_url?: string;
/** The ID of the software template that you chose to install from the IBM Cloud catalog. This software is
* provisioned with Schematics.
*/
item_id?: string;
/** The name of the software that you chose to install from the IBM Cloud catalog. */
item_name?: string;
/** The URL to the readme file of the software template in the IBM Cloud catalog. */
item_readme_url?: string;
/** The URL to the software template in the IBM Cloud catalog. */
item_url?: string;
/** The URL to the dashboard to access your software. */
launch_url?: string;
/** The version of the software template that you chose to install from the IBM Cloud catalog. */
offering_version?: string;
service_extensions?: ServiceExtensions[];
}
/**
* The connection details to the IBM Cloud Catalog source.
*/
interface CatalogSource {
/** The name of the private catalog. */
catalog_name?: string;
/** The ID of a private catalog. */
catalog_id?: string;
/** The name of an offering in the IBM Cloud Catalog. */
offering_name?: string;
/** The version of the software template that you chose to install from the IBM Cloud catalog. */
offering_version?: string;
/** The type of an offering, in the IBM Cloud Catalog. */
offering_kind?: string;
/** Offering Target Kind. */
offering_target_kind?: string;
/** The ID of an offering in the IBM Cloud Catalog. */
offering_id?: string;
/** The ID of an offering version the IBM Cloud Catalog. */
offering_version_id?: string;
/** Offering version flavour name. */
offering_version_flavour_name?: string;
/** The repository URL of an offering, in the IBM Cloud Catalog. */
offering_repo_url?: string;
/** Root folder name in .tgz file. */
offering_provisioner_working_directory?: string;
/** Dry run. */
dry_run?: boolean;
/** Owning account ID of the catalog. */
owning_account?: string;
/** The URL to the icon of the software template in the IBM Cloud catalog. */
item_icon_url?: string;
/** The ID of the software template that you chose to install from the IBM Cloud catalog. This software is
* provisioned with Schematics.
*/
item_id?: string;
/** The name of the software that you chose to install from the IBM Cloud catalog. */
item_name?: string;
/** The URL to the readme file of the software template in the IBM Cloud catalog. */
item_readme_url?: string;
/** The URL to the software template in the IBM Cloud catalog. */
item_url?: string;
/** The URL to the dashboard to access your software. */
launch_url?: string;
}
/**
* Workspace commands run as part of the job.
*/
interface CommandsInfo {
/** Name of the command. */
name?: string;
/** outcome of the command. */
outcome?: string;
}
/**
* Connection status of the agent.
*/
interface ConnectionState {
/** Agent Connection Status
* * `Connected` When Schematics is able to connect to the agent.
* * `Disconnected` When Schematics is able not connect to the agent.
*/
state?: ConnectionState.Constants.State | string;
/** When the connection state is modified. */
checked_at?: string;
}
namespace ConnectionState {
namespace Constants {
/** Agent Connection Status * `Connected` When Schematics is able to connect to the agent. * `Disconnected` When Schematics is able not connect to the agent. */
enum State {
CONNECTED = "Connected",
DISCONNECTED = "Disconnected"
}
}
}
/**
* User editable credential variable data and system generated reference to the value.
*/
interface CredentialVariableData {
/** The name of the credential variable. */
name?: string;
/** 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;
/** True, will ignore the data in the value attribute, instead the data in metadata.default_value will be used. */
use_default?: boolean;
/** An user editable metadata for the credential variables. */
metadata?: CredentialVariableMetadata;
/** The reference link to the variable value By default the expression points to `$self.value`. */
link?: string;
}
/**
* An user editable metadata for the credential variables.
*/
interface CredentialVariableMetadata {
/** Type of the variable. */
type?: CredentialVariableMetadata.Constants.Type | string;
/** The list of aliases for the variable name. */
aliases?: string[];
/** The description of the meta data. */
description?: string;
/** Cloud data type of the credential variable. eg. api_key, iam_token, profile_id. */
cloud_data_type?: string;
/** Default value for the variable only if the override value is not specified. */
default_value?: string;
/** The status of the link. */
link_status?: CredentialVariableMetadata.Constants.LinkStatus | string;
/** Is the variable readonly ?. */
immutable?: boolean;
/** If **true**, the variable is not displayed on UI or Command line. */
hidden?: boolean;
/** If the variable required?. */
required?: boolean;
/** The relative position of this variable in a list. */
position?: number;
/** The display name of the group this variable belongs to. */
group_by?: string;
/** The source of this meta-data. */
source?: string;
}
namespace CredentialVariableMetadata {
namespace Constants {
/** Type of the variable. */
enum Type {
STRING = "string",
LINK = "link"
}
/** The status of the link. */
enum LinkStatus {
NORMAL = "normal",
BROKEN = "broken"
}
}
}
/**
* Workspace dependencies.
*/
interface Dependencies {
/** List of workspace parents CRN identifiers. */
parents?: string[];
/** List of workspace children CRN identifiers. */
children?: string[];
}
/**
* Encryption details about the workspace such as scheme (byok/kyok) and key CRN.
*/
interface EncryptionInfo {
/** Key CRN. */
crn?: string;
/** Encryption scheme. */
scheme?: string;
}
/**
* One variable is a map where one entry is there with key as name of the env var and the value as value.
*/
interface EnvVariableRequestMap {
/** Environment variable is hidden. */
hidden?: boolean;
/** Environment variable name. */
name?: string;
/** Environment variable is secure. */
secure?: boolean;
/** Value for environment variable. */
value?: string;
}
/**
* List of environment values.
*/
interface EnvVariableResponse {
/** Environment variable is hidden. */
hidden?: boolean;
/** Environment variable name. */
name?: string;
/** Environment variable is secure. */
secure?: boolean;
/** Value for environment variable. */
value?: string;
}
/**
* Environment variables metadata.
*/
interface EnvironmentValuesMetadata {
/** Environment variable is hidden. */
hidden?: boolean;
/** Environment variable name. */
name?: string;
/** Environment variable is secure. */
secure?: boolean;
}
/**
* Source of templates, playbooks, or controls.
*/
interface ExternalSource {
/** Type of source for the Template. */
source_type: ExternalSource.Constants.SourceType | string;
/** The connection details to the Git source repository. */
git?: GitSource;
/** The connection details to the IBM Cloud Catalog source. */
catalog?: CatalogSource;
}
namespace ExternalSource {
namespace Constants {
/** Type of source for the Template. */
enum SourceType {
LOCAL = "local",
GIT_HUB = "git_hub",
GIT_HUB_ENTERPRISE = "git_hub_enterprise",
GIT_LAB = "git_lab",
IBM_GIT_LAB = "ibm_git_lab",
IBM_CLOUD_CATALOG = "ibm_cloud_catalog"
}
}
}
/**
* The connection details to the Git source repository.
*/
interface GitSource {
/** The complete URL which is computed by the **git_repo_url**, **git_repo_folder**, and **branch**. */
computed_git_repo_url?: string;
/** The URL to the Git repository that can be used to clone the template. */
git_repo_url?: string;
/** The Personal Access Token (PAT) to connect to the Git URLs. */
git_token?: string;
/** The name of the folder in the Git repository, that contains the template. */
git_repo_folder?: string;
/** The name of the release tag that are used to fetch the Git repository. */
git_release?: string;
/** The name of the branch that are used to fetch the Git repository. */
git_branch?: string;
/** The git commit hash used to fetch the repository. */
git_commit?: string;
/** The timestamp of the git commit hash used to fetch the repository. */
git_commit_timestamp?: string;
}
/**
* InjectTerraformTemplateInnerTftParametersItem.
*/
interface InjectTerraformTemplateInnerTftParametersItem {
/** Key name to replace. */
name?: string;
/** Value to replace. */
value?: string;
}
/**
* InjectTerraformTemplateInner.
*/
interface InjectTerraformTemplateInner {
/** Git repo url hosting terraform template files. */
tft_git_url?: string;
/** Token to access the git repository (Optional). */
tft_git_token?: string;
/** Optional prefix word to append to files (Optional). */
tft_prefix?: string;
/** Injection type. Default is 'override'. */
injection_type?: string;
/** Terraform template name. Maps to folder name in git repo. */
tft_name?: string;
tft_parameters?: InjectTerraformTemplateInnerTftParametersItem[];
}
/**
* Complete inventory definition details.
*/
interface InventoryResourceRecord {
/** 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;
/** Inventory id. */
id?: string;
/** The description of your Inventory. The description can be up to 2048 characters long in size. */
description?: string;
/** 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?: InventoryResourceRecord.Constants.Location | string;
/** Resource-group name for the Inventory definition. By default, Inventory will be created in Default Resource
* Group.
*/
resource_group?: string;
/** Inventory creation time. */
created_at?: string;
/** Email address of user who created the Inventory. */
created_by?: string;
/** Inventory updation time. */
updated_at?: string;
/** Email address of user who updated the Inventory. */
updated_by?: string;
/** Input inventory of host and host group for the playbook, in the .ini file format. */
inventories_ini?: string;
/** Input resource queries that is used to dynamically generate the inventory of host and host group for the
* playbook.
*/
resource_queries?: string[];
}
namespace InventoryResourceRecord {
namespace Constants {
/** 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. */
enum Location {
US_SOUTH = "us-south",
US_EAST = "us-east",
EU_GB = "eu-gb",
EU_DE = "eu-de"
}
}
}
/**
* List of Inventory definition records.
*/
interface InventoryResourceRecordList {
/** Total number of records. */
total_count?: number;
/** Number of records returned. */
limit: number;
/** Skipped number of records. */
offset: number;
/** List of inventory definition records. */
inventories?: InventoryResourceRecord[];
}
/**
* Complete Job with user inputs and system generated data.
*/
interface Job {
/** Name of the Schematics automation resource. */
command_object?: Job.Constants.CommandObject | string;
/** Job command object id (workspace-id, action-id). */
command_object_id?: string;
/** Schematics job command name. */
command_name?: Job.Constants.CommandName | string;
/** Schematics job command parameter (playbook-name). */
command_parameter?: string;
/** Command line options for the command. */
command_options?: string[];
/** Job inputs used by Action or Workspace. */
inputs?: VariableData[];
/** Environment variables used by the Job while performing Action or Workspace. */
settings?: VariableData[];
/** User defined tags, while running the job. */
tags?: string[];
/** Job ID. */
id?: string;
/** Job name, uniquely derived from the related Workspace or Action. */
name?: string;
/** 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;
/** 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?: Job.Constants.Location | string;
/** Resource-group name derived from the related Workspace or Action. */
resource_group?: string;
/** Job submission time. */
submitted_at?: string;
/** Email address of user who submitted the job. */
submitted_by?: string;
/** Job start time. */
start_at?: string;
/** Job end time. */
end_at?: string;
/** Duration of job execution; example 40 sec. */
duration?: string;
/** Job Status. */
status?: JobStatus;
/** Contains the cart order data which can be used for different purpose for eg. service tagging. */
cart_order_data?: CartOrderData[];
/** Job data. */
data?: JobData;
/** Describes a bastion resource. */
bastion?: BastionResourceDefinition;
/** Job log summary record. */
log_summary?: JobLogSummary;
/** Job log store URL. */
log_store_url?: string;
/** Job state store URL. */
state_store_url?: string;
/** Job results store URL. */
results_url?: string;
/** Job status updation timestamp. */
updated_at?: string;
/** ID of the Job Runner. */
job_runner_id?: string;
/** Agent name, Agent id and associated policy ID information. */
agent?: AgentInfo;
}
namespace Job {
namespace Constants {
/** Name of the Schematics automation resource. */
enum CommandObject {
WORKSPACE = "workspace",
ACTION = "action",
SYSTEM = "system",
ENVIRONMENT = "environment"
}
/** Schematics job command name. */
enum CommandName {
WORKSPACE_PLAN = "workspace_plan",
WORKSPACE_APPLY = "workspace_apply",
WORKSPACE_DESTROY = "workspace_destroy",
WORKSPACE_REFRESH = "workspace_refresh",
ANSIBLE_PLAYBOOK_RUN = "ansible_playbook_run",
ANSIBLE_PLAYBOOK_CHECK = "ansible_playbook_check",
CREATE_ACTION = "create_action",
PUT_ACTION = "put_action",
PATCH_ACTION = "patch_action",
DELETE_ACTION = "delete_action",
SYSTEM_KEY_ENABLE = "system_key_enable",
SYSTEM_KEY_DELETE = "system_key_delete",
SYSTEM_KEY_DISABLE = "system_key_disable",
SYSTEM_KEY_ROTATE = "system_key_rotate",
SYSTEM_KEY_RESTORE = "system_key_restore",
CREATE_WORKSPACE = "create_workspace",
PUT_WORKSPACE = "put_workspace",
PATCH_WORKSPACE = "patch_workspace",
DELETE_WORKSPACE = "delete_workspace",
CREATE_CART = "create_cart",
REPOSITORY_PROCESS = "repository_process",
TERRAFORM_COMMANDS = "terraform_commands"
}
/** 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. */
enum Location {
US_SOUTH = "us-south",
US_EAST = "us-east",
EU_GB = "eu-gb",
EU_DE = "eu-de"
}
}
}
/**
* Job data.
*/
interface JobData {
/** Type of Job. */
job_type: JobData.Constants.JobType | string;
/** Workspace Job data. */
workspace_job_data?: JobDataWorkspace;
/** Action Job data. */
action_job_data?: JobDataAction;
/** Controls Job data. */
system_job_data?: JobDataSystem;
/** Flow Job data. */
flow_job_data?: JobDataFlow;
}
namespace JobData {
namespace Constants {
/** Type of Job. */
enum JobType {
REPO_DOWNLOAD_JOB = "repo_download_job",
WORKSPACE_JOB = "workspace_job",
ACTION_JOB = "action_job",
SYSTEM_JOB = "system_job",
FLOW_JOB = "flow-job"
}
}
}
/**
* Action Job data.
*/
interface JobDataAction {
/** Flow name. */
action_name?: string;
/** Input variables data used by the Action Job. */
inputs?: VariableData[];
/** Output variables data from the Action Job. */
outputs?: VariableData[];
/** Environment variables used by all the templates in the Action. */
settings?: VariableData[];
/** Job status updation timestamp. */
updated_at?: string;
/** Complete inventory definition details. */
inventory_record?: InventoryResourceRecord;
/** Materialized inventory details used by the Action Job, in .ini format. */
materialized_inventory?: string;
}
/**
* Flow Job data.
*/
interface JobDataFlow {
/** Flow ID. */
flow_id?: string;
/** Flow Name. */
flow_name?: string;
/** Job data used by each workitem Job. */
workitems?: JobDataWorkItem[];
/** Job status updation timestamp. */
updated_at?: string;
}
/**
* Controls Job data.
*/
interface JobDataSystem {
/** Key ID for which key event is generated. */
key_id?: string;
/** List of the schematics resource id. */
schematics_resource_id?: string[];
/** Job status updation timestamp. */
updated_at?: string;
}
/**
* Template Job data.
*/
interface JobDataTemplate {
/** Template Id. */
template_id?: string;
/** Template name. */
template_name?: string;
/** Index of the template in the Flow. */
flow_index?: number;
/** Job inputs used by the Templates. */
inputs?: VariableData[];
/** Job output from the Templates. */
outputs?: VariableData[];
/** Environment variables used by the template. */
settings?: VariableData[];
/** Job status updation timestamp. */
updated_at?: string;
}
/**
* Environment work items.
*/
interface JobDataWorkItem {
/** command object id. */
command_object_id?: string;
/** command object name. */
command_object_name?: string;
/** layer name. */
layers?: string;
/** Type of source for the Template. */
source_type?: JobDataWorkItem.Constants.SourceType | string;
/** Source of templates, playbooks, or controls. */
source?: ExternalSource;
/** Input variables data for the workItem used in FlowJob. */
inputs?: VariableData[];
/** Output variables for the workItem. */
outputs?: VariableData[];
/** Environment variables for the workItem. */
settings?: VariableData[];
/** Status of the last job executed by the workitem. */
last_job?: JobDataWorkItemLastJob;
/** Job status updation timestamp. */
updated_at?: string;
}
namespace JobDataWorkItem {
namespace Constants {
/** Type of source for the Template. */
enum SourceType {
LOCAL = "local",
GIT_HUB = "git_hub",
GIT_HUB_ENTERPRISE = "git_hub_enterprise",
GIT_LAB = "git_lab",
IBM_GIT_LAB = "ibm_git_lab",
IBM_CLOUD_CATALOG = "ibm_cloud_catalog"
}
}
}
/**
* Status of the last job executed by the workitem.
*/
interface JobDataWorkItemLastJob {
/** Name of the Schematics automation resource. */
command_object?: JobDataWorkItemLastJob.Constants.CommandObject | string;
/** command object name (workspace_name/action_name). */
command_object_name?: string;
/** Workitem command object id, maps to workspace_id or action_id. */
command_object_id?: string;
/** Schematics job command name. */
command_name?: JobDataWorkItemLastJob.Constants.CommandName | string;
/** Workspace job id. */
job_id?: string;
/** Status of Jobs. */
job_status?: JobDataWorkItemLastJob.Constants.JobStatus | string;
}
namespace JobDataWorkItemLastJob {
namespace Constants {
/** Name of the Schematics automation resource. */
enum CommandObject {
WORKSPACE = "workspace",
ACTION = "action",
SYSTEM = "system",
ENVIRONMENT = "environment"
}
/** Schematics job command name. */
enum CommandName {
WORKSPACE_PLAN = "workspace_plan",
WORKSPACE_APPLY = "workspace_apply",
WORKSPACE_DESTROY = "workspace_destroy",
WORKSPACE_REFRESH = "workspace_refresh",
ANSIBLE_PLAYBOOK_RUN = "ansible_playbook_run",
ANSIBLE_PLAYBOOK_CHECK = "ansible_playbook_check",
CREATE_ACTION = "create_action",
PUT_ACTION = "put_action",
PATCH_ACTION = "patch_action",
DELETE_ACTION = "delete_action",
SYSTEM_KEY_ENABLE = "system_key_enable",
SYSTEM_KEY_DELETE = "system_key_delete",
SYSTEM_KEY_DISABLE = "system_key_disable",
SYSTEM_KEY_ROTATE = "system_key_rotate",
SYSTEM_KEY_RESTORE = "system_key_restore",
CREATE_WORKSPACE = "create_workspace",
PUT_WORKSPACE = "put_workspace",
PATCH_WORKSPACE = "patch_workspace",
DELETE_WORKSPACE = "delete_workspace",
CREATE_CART = "create_cart",
REPOSITORY_PROCESS = "repository_process",
TERRAFORM_COMMANDS = "terraform_commands"
}
/** Status of Jobs. */
enum JobStatus {
JOB_PENDING = "job_pending",
JOB_IN_PROGRESS = "job_in_progress",
JOB_FINISHED = "job_finished",
JOB_FAILED = "job_failed",
JOB_CANCELLED = "job_cancelled",
JOB_STOPPED = "job_stopped",
JOB_STOP_IN_PROGRESS = "job_stop_in_progress",
JOB_READY_TO_EXECUTE = "job_ready_to_execute"
}
}
}
/**
* Workspace Job data.
*/
interface JobDataWorkspace {
/** Workspace name. */
workspace_name?: string;
/** Flow Id. */
flow_id?: string;
/** Flow name. */
flow_name?: string;
/** Input variables data used by the Workspace Job. */
inputs?: VariableData[];
/** Output variables data from the Workspace Job. */
outputs?: VariableData[];
/** Environment variables used by all the templates in the Workspace. */
settings?: VariableData[];
/** Input / output data of the Template in the Workspace Job. */
template_data?: JobDataTemplate[];
/** Job status updation timestamp. */
updated_at?: string;
}
/**
* JobFileContent.
*/
interface JobFileContent {
/** Name of the file. */
file_name?: string;
/** Content of the file, generated by the job. */
file_content?: string;
}
/**
* Output files from the Job record.
*/
interface JobFileData {
/** Job Id. */
job_id?: string;
/** Job name, uniquely derived from the related Workspace and Action. */
job_name?: string;
/** Summary metadata in the output files. */
summary?: JobFileDataSummary[];
/** The type of output file generated by the Job. */
file_type?: JobFileData.Constants.FileType | string;
/** Content of the file, generated by the job. */
file_content?: string;
/** Content of the additional files, generated by the child job. */
additional_files?: JobFileContent[];
/** Job file updation timestamp. */
updated_at?: string;
}
namespace JobFileData {
namespace Constants {
/** The type of output file generated by the Job. */
enum FileType {
STATE_FILE = "state_file",
PLAN_JSON = "plan_json",
QUOTE_JSON = "quote_json",
DRAFT_PLAN_JSON = "draft_plan_json",
GIT_FILES = "git_files",
COST_JSON = "cost_json",
LOG_INSIGHTS_FILE = "log_insights_file"
}
}
}
/**
* JobFileDataSummary.
*/
interface JobFileDataSummary {
/** Summary feature name. */
name?: string;
/** Summary feature type. */
type?: JobFileDataSummary.Constants.Type | string;
/** Summary feature value. */
value?: string;
}
namespace JobFileDataSummary {
namespace Constants {
/** Summary feature type. */
enum Type {
NUMBER = "number",
STRING = "string"
}
}
}
/**
* List of Job details.
*/
interface JobList {
/** Total number of records. */
total_count?: number;
/** Number of records returned. */
limit: number;
/** Skipped number of records. */
offset: number;
/** List of job records. */
jobs?: JobLite[];
}
/**
* Job summary profile with system generated data.
*/
interface JobLite {
/** Job ID. */
id?: string;
/** Job name, uniquely derived from the related Workspace or Action. */
name?: string;
/** Job description derived from the related Workspace or Action. */
description?: string;
/** Name of the Schematics automation resource. */
command_object?: JobLite.Constants.CommandObject | string;
/** Job command object id (workspace-id, action-id). */
command_object_id?: string;
/** Schematics job command name. */
command_name?: JobLite.Constants.CommandName | string;
/** User defined tags, while running the job. */
tags?: string[];
/** 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?: JobLite.Constants.Location | string;
/** Resource-group name derived from the related Workspace or Action. */
resource_group?: string;
/** Job submission time. */
submitted_at?: string;
/** Email address of user who submitted the job. */
submitted_by?: string;
/** Duration of job execution; example 40 sec. */
duration?: string;
/** Job start time. */
start_at?: string;
/** Job end time. */
end_at?: string;
/** Job Status. */
status?: JobStatus;
/** Job log summary record. */
log_summary?: JobLogSummary;
/** Job status updation timestamp. */
updated_at?: string;
/** ID of the Job Runner. */
job_runner_id?: string;
/** Agent name, Agent id and associated policy ID information. */
agent?: AgentInfo;
}
namespace JobLite {
namespace Constants {
/** Name of the Schematics automation resource. */
enum CommandObject {
WORKSPACE = "workspace",
ACTION = "action",
SYSTEM = "system",
ENVIRONMENT = "environment"
}
/** Schematics job command name. */
enum CommandName {
WORKSPACE_PLAN = "workspace_plan",
WORKSPACE_APPLY = "workspace_apply",
WORKSPACE_DESTROY = "workspace_destroy",
WORKSPACE_REFRESH = "workspace_refresh",
ANSIBLE_PLAYBOOK_RUN = "ansible_playbook_run",
ANSIBLE_PLAYBOOK_CHECK = "ansible_playbook_check",
CREATE_ACTION = "create_action",
PUT_ACTION = "put_action",
PATCH_ACTION = "patch_action",
DELETE_ACTION = "delete_action",
SYSTEM_KEY_ENABLE = "system_key_enable",
SYSTEM_KEY_DELETE = "system_key_delete",
SYSTEM_KEY_DISABLE = "system_key_disable",
SYSTEM_KEY_ROTATE = "system_key_rotate",
SYSTEM_KEY_RESTORE = "system_key_restore",
CREATE_WORKSPACE = "create_workspace",
PUT_WORKSPACE = "put_workspace",
PATCH_WORKSPACE = "patch_workspace",
DELETE_WORKSPACE = "delete_workspace",
CREATE_CART = "create_cart",
REPOSITORY_PROCESS = "repository_process",
TERRAFORM_COMMANDS = "terraform_commands"
}
/** 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. */
enum Location {
US_SOUTH = "us-south",
US_EAST = "us-east",
EU_GB = "eu-gb",
EU_DE = "eu-de"
}
}
}
/**
* Job Log details.
*/
interface JobLog {
/** Job Id. */
job_id?: string;
/** Job name, uniquely derived from the related Workspace, Action or Controls. */
job_name?: string;
/** Job log summary record. */
log_summary?: JobLogSummary;
/** Format of the Log text. */
format?: JobLog.Constants.Format | string;
/** Log text, generated by the Job. */
details?: string;
/** Job status updation timestamp. */
updated_at?: string;
}
namespace JobLog {
namespace Constants {
/** Format of the Log text. */
enum Format {
JSON = "json",
HTML = "html",
MARKDOWN = "markdown",
RTF = "rtf"
}
}
}
/**
* Job log summary record.
*/
interface JobLogSummary {
/** Workspace Id. */
job_id?: string;
/** Type of Job. */
job_type?: JobLogSummary.Constants.JobType | string;
/** Job log start timestamp. */
log_start_at?: string;
/** Job log update timestamp. */
log_analyzed_till?: string;
/** Job log elapsed time (log_analyzed_till - log_start_at). */
elapsed_time?: number;
/** Job log errors. */
log_errors?: JobLogSummaryLogErrors[];
/** Repo download Job log summary. */
repo_download_job?: JobLogSummaryRepoDownloadJob;
/** Workspace Job log summary. */
workspace_job?: JobLogSummaryWorkspaceJob;
/** Flow Job log summary. */
flow_job?: JobLogSummaryFlowJob;
/** Flow Job log summary. */
action_job?: JobLogSummaryActionJob;
/** System Job log summary. */
system_job?: JobLogSummarySystemJob;
}
namespace JobLogSummary {
namespace Constants {
/** Type of Job. */
enum JobType {
REPO_DOWNLOAD_JOB = "repo_download_job",
WORKSPACE_JOB = "workspace_job",
ACTION_JOB = "action_job",
SYSTEM_JOB = "system_job",
FLOW_JOB = "flow_job"
}
}
}
/**
* Job log summary of the flow workitem.
*/
interface JobLogSummaryWorkitems {
/** workspace ID. */
workspace_id?: string;
/** workspace JOB ID. */
job_id?: string;
/** Number of resources add. */
resources_add?: number;
/** Number of resources modify. */
resources_modify?: number;
/** Number of resources destroy. */
resources_destroy?: number;
/** Log url for job. */
log_url?: string;
}
/**
* Flow Job log summary.
*/
interface JobLogSummaryActionJob {
/** number of targets or hosts. */
target_count?: number;
/** number of tasks in playbook. */
task_count?: number;
/** number of plays in playbook. */
play_count?: number;
/** Recap records. */
recap?: JobLogSummaryActionJobRecap;
}
/**
* Recap records.
*/
interface JobLogSummaryActionJobRecap {
/** List of target or host name. */
target?: string[];
/** Number of OK. */
ok?: number;
/** Number of changed. */
changed?: number;
/** Number of failed. */
failed?: number;
/** Number of skipped. */
skipped?: number;
/** Number of unreachable. */
unreachable?: number;
}
/**
* Flow Job log summary.
*/
interface JobLogSummaryFlowJob {
/** Number of workitems completed successfully. */
workitems_completed?: number;
/** Number of workitems pending in the flow. */
workitems_pending?: number;
/** Number of workitems failed. */
workitems_failed?: number;
workitems?: JobLogSummaryWorkitems[];
}
/**
* JobLogSummaryLogErrors.
*/
interface JobLogSummaryLogErrors {
/** Error code in the Log. */
error_code?: string;
/** Summary error message in the log. */
error_msg?: string;
/** Number of occurrence. */
error_count?: number;
}
/**
* Repo download Job log summary.
*/
interface JobLogSummaryRepoDownloadJob {
/** Number of files scanned. */
scanned_file_count?: number;
/** Number of files quarantined. */
quarantined_file_count?: number;
/** Detected template or data file type. */
detected_filetype?: string;
/** Number of inputs detected. */
inputs_count?: string;
/** Number of outputs detected. */
outputs_count?: string;
}
/**
* System Job log summary.
*/
interface JobLogSummarySystemJob {
/** number of targets or hosts. */
target_count?: number;
/** Number of passed. */
success?: number;
/** Number of failed. */
failed?: number;
}
/**
* Workspace Job log summary.
*/
interface JobLogSummaryWorkspaceJob {
/** Number of resources add. */
resources_add?: number;
/** Number of resources modify. */
resources_modify?: number;
/** Number of resources destroy. */
resources_destroy?: number;
}
/**
* Job Status.
*/
interface JobStatus {
/** Position of job in pending queue. */
position_in_queue?: number;
/** Total no. of jobs in pending queue. */
total_in_queue?: number;
/** Workspace Job Status. */
workspace_job_status?: JobStatusWorkspace;
/** Action Job Status. */
action_job_status?: JobStatusAction;
/** System Job Status. */
system_job_status?: JobStatusSystem;
/** Environment Flow JOB Status. */
flow_job_status?: JobStatusFlow;
}
/**
* Action Job Status.
*/
interface JobStatusAction {
/** Action name. */
action_name?: string;
/** Status of Jobs. */
status_code?: JobStatusAction.Constants.StatusCode | string;
/** Action Job status message - to be displayed along with the action_status_code. */
status_message?: string;
/** Status of Resources. */
bastion_status_code?: JobStatusAction.Constants.BastionStatusCode | string;
/** Bastion status message - to be displayed along with the bastion_status_code;. */
bastion_status_message?: string;
/** Status of Resources. */
targets_status_code?: JobStatusAction.Constants.TargetsStatusCode | string;
/** Aggregated status message for all target resources, to be displayed along with the targets_status_code;. */
targets_status_message?: string;
/** Job status updation timestamp. */
updated_at?: string;
}
namespace JobStatusAction {
namespace Constants {
/** Status of Jobs. */
enum StatusCode {
JOB_PENDING = "job_pending",
JOB_IN_PROGRESS = "job_in_progress",
JOB_FINISHED = "job_finished",
JOB_FAILED = "job_failed",
JOB_CANCELLED = "job_cancelled",
JOB_STOPPED = "job_stopped",
JOB_STOP_IN_PROGRESS = "job_stop_in_progress",
JOB_READY_TO_EXECUTE = "job_ready_to_execute"
}
/** Status of Resources. */
enum BastionStatusCode {
NONE = "none",
READY = "ready",
PROCESSING = "processing",
ERROR = "error"
}
/** Status of Resources. */
enum TargetsStatusCode {
NONE = "none",
READY = "ready",
PROCESSING = "processing",
ERROR = "error"
}
}
}
/**
* Environment Flow JOB Status.
*/
interface JobStatusFlow {
/** flow id. */
flow_id?: string;
/** flow name. */
flow_name?: string;
/** Status of Jobs. */
status_code?: JobStatusFlow.Constants.StatusCode | string;
/** Flow Job status message - to be displayed along with the status_code;. */
status_message?: string;
/** Environment's individual workItem status details;. */
workitems?: JobStatusWorkitem[];
/** Job status updation timestamp. */
updated_at?: string;
}
namespace JobStatusFlow {
namespace Constants {
/** Status of Jobs. */
enum StatusCode {
JOB_PENDING = "job_pending",
JOB_IN_PROGRESS = "job_in_progress",
JOB_FINISHED = "job_finished",
JOB_FAILED = "job_failed",
JOB_CANCELLED = "job_cancelled",
JOB_STOPPED = "job_stopped",
JOB_STOP_IN_PROGRESS = "job_stop_in_progress",
JOB_READY_TO_EXECUTE = "job_ready_to_execute"
}
}
}
/**
* schematics Resources Job Status.
*/
interface JobStatusSchematicsResources {
/** Status of Jobs. */
status_code?: JobStatusSchematicsResources.Constants.StatusCode | string;
/** system job status message. */
status_message?: string;
/** id for each resource which is targeted as a part of system job. */
schematics_resource_id?: string;
/** Job status updation timestamp. */
updated_at?: string;
}
namespace JobStatusSchematicsResources {
namespace Constants {
/** Status of Jobs. */
enum StatusCode {
JOB_PENDING = "job_pending",
JOB_IN_PROGRESS = "job_in_progress",
JOB_FINISHED = "job_finished",
JOB_FAILED = "job_failed",
JOB_CANCELLED = "job_cancelled",
JOB_STOPPED = "job_stopped",
JOB_STOP_IN_PROGRESS = "job_stop_in_progress",
JOB_READY_TO_EXECUTE = "job_ready_to_execute"
}
}
}
/**
* System Job Status.
*/
interface JobStatusSystem {
/** System job message. */
system_status_message?: string;
/** Status of Jobs. */
system_status_code?: JobStatusSystem.Constants.SystemStatusCode | string;
/** job staus for each schematics resource. */
schematics_resource_status?: JobStatusSchematicsResources[];
/** Job status updation timestamp. */
updated_at?: string;
}
namespace JobStatusSystem {
namespace Constants {
/** Status of Jobs. */
enum SystemStatusCode {
JOB_PENDING = "job_pending",
JOB_IN_PROGRESS = "job_in_progress",
JOB_FINISHED = "job_finished",
JOB_FAILED = "job_failed",
JOB_CANCELLED = "job_cancelled",
JOB_STOPPED = "job_stopped",
JOB_STOP_IN_PROGRESS = "job_stop_in_progress",
JOB_READY_TO_EXECUTE = "job_ready_to_execute"
}
}
}
/**
* Template Job Status.
*/
interface JobStatusTemplate {
/** Template Id. */
template_id?: string;
/** Template name. */
template_name?: string;
/** Index of the template in the Flow. */
flow_index?: number;
/** Status of Jobs. */
status_code?: JobStatusTemplate.Constants.StatusCode | string;
/** Template job status message (eg. VPCt1_Apply_Pending, for a 'VPCt1' Template). */
status_message?: string;
/** Job status updation timestamp. */
updated_at?: string;
}
namespace JobStatusTemplate {
namespace Constants {
/** Status of Jobs. */
enum StatusCode {
JOB_PENDING = "job_pending",
JOB_IN_PROGRESS = "job_in_progress",
JOB_FINISHED = "job_finished",
JOB_FAILED = "job_failed",
JOB_CANCELLED = "job_cancelled",
JOB_STOPPED = "job_stopped",
JOB_STOP_IN_PROGRESS = "job_stop_in_progress",
JOB_READY_TO_EXECUTE = "job_ready_to_execute"
}
}
}
/**
* Individual workitem status info.
*/
interface JobStatusWorkitem {
/** Workspace id. */
workspace_id?: string;
/** workspace name. */
workspace_name?: string;
/** workspace job id. */
job_id?: string;
/** Status of Jobs. */
status_code?: JobStatusWorkitem.Constants.StatusCode | string;
/** workitem job status message;. */
status_message?: string;
/** workitem job status updation timestamp. */
updated_at?: string;
}
namespace JobStatusWorkitem {
namespace Constants {
/** Status of Jobs. */
enum StatusCode {
JOB_PENDING = "job_pending",
JOB_IN_PROGRESS = "job_in_progress",
JOB_FINISHED = "job_finished",
JOB_FAILED = "job_failed",
JOB_CANCELLED = "job_cancelled",
JOB_STOPPED = "job_stopped",
JOB_STOP_IN_PROGRESS = "job_stop_in_progress",
JOB_READY_TO_EXECUTE = "job_ready_to_execute"
}
}
}
/**
* Workspace Job Status.
*/
interface JobStatusWorkspace {
/** Workspace name. */
workspace_name?: string;
/** Status of Jobs. */
status_code?: JobStatusWorkspace.Constants.StatusCode | string;
/** Workspace job status message (eg. App1_Setup_Pending, for a 'Setup' flow in the 'App1' Workspace). */
status_message?: string;
/** Environment Flow JOB Status. */
flow_status?: JobStatusFlow;
/** Workspace Flow Template job status. */
template_status?: JobStatusTemplate[];
/** Job status updation timestamp. */
updated_at?: string;
/** List of terraform commands executed and their status. */
commands?: CommandsInfo[];
}
namespace JobStatusWorkspace {
namespace Constants {
/** Status of Jobs. */
enum StatusCode {
JOB_PENDING = "job_pending",
JOB_IN_PROGRESS = "job_in_progress",
JOB_FINISHED = "job_finished",
JOB_FAILED = "job_failed",
JOB_CANCELLED = "job_cancelled",
JOB_STOPPED = "job_stopped",
JOB_STOP_IN_PROGRESS = "job_stop_in_progress",
JOB_READY_TO_EXECUTE = "job_ready_to_execute"
}
}
}
/**
* Discover kms instances in the account based on location.
*/
interface KMSDiscovery {
/** The total number of records. */
total_count?: number;
/** The number of records returned. */
limit: number;
/** The skipped number of records. */
offset: number;
/** The list of kms instances. */
kms_instances?: KMSInstances[];
}
/**
* User defined kms instances.
*/
interface KMSInstances {
/** The location to integrate kms instance. For example, location can be `US` and `EU`. */
location?: string;
/** The encryption scheme values. **Allowable values** [`byok`,`kyok`]. */
encryption_scheme?: string;
/** The kms instance resource group to integrate. */
resource_group?: string;
/** The primary kms CRN information. */
kms_crn?: string;
/** The kms instance name. */
kms_name?: string;
/** The kms instance private endpoints. */
kms_private_endpoint?: string;
/** The kms instance public endpoints. */
kms_public_endpoint?: string;
/** Detailed list of keys. */
keys?: KMSInstancesKeys[];
}
/**
* KMSInstancesKeys.
*/
interface KMSInstancesKeys {
/** The name of the root key. */
name?: string;
/** The kms CRN of the root key. */
crn?: string;
/** The error message details. */
error?: string;
}
/**
* User defined kms settings information.
*/
interface KMSSettings {
/** The location to integrate kms instance. For example, location can be `US` and `EU`. */
location?: string;
/** The encryption scheme values. **Allowable values** [`byok`,`kyok`]. */
encryption_scheme?: string;
/** The kms instance resource group to integrate. */
resource_group?: string;
/** The primary kms instance details. */
primary_crk?: KMSSettingsPrimaryCrk;
/** The secondary kms instance details. */
secondary_crk?: KMSSettingsSecondaryCrk;
}
/**
* The primary kms instance details.
*/
interface KMSSettingsPrimaryCrk {
/** The primary kms instance name. */
kms_name?: string;
/** The primary kms instance private endpoint. */
kms_private_endpoint?: string;
/** The CRN of the primary root key. */
key_crn?: string;
}
/**
* The secondary kms instance details.
*/
interface KMSSettingsSecondaryCrk {
/** The secondary kms instance name. */
kms_name?: string;
/** The secondary kms instance private endpoint. */
kms_private_endpoint?: string;
/** The CRN of the secondary key. */
key_crn?: string;
}
/**
* Last job details.
*/
interface LastJob {
/** ID of last job. */
job_id?: string;
/** Name of the last job. */
job_name?: string;
/** Status of the last job. */
job_status?: string;
}
/**
* Log file URL for job that ran against your workspace.
*/
interface LogStoreResponse {
/** The provisioning engine that was used for the job. */
engine_name?: string;
/** The version of the provisioning engine that was used for the job. */
engine_version?: string;
/** The ID that was assigned to your Terraform template of IBM Cloud catalog software template. */
id?: string;
/** The URL to access the logs that were created during the plan, apply, or destroy job. */
log_store_url?: string;
}
/**
* List of log file URL that ran against your workspace.
*/
interface LogStoreResponseList {
/** Runtime data. */
runtime_data?: LogStoreResponse[];
}
/**
* Summary information extracted from the job logs.
*/
interface LogSummary {
/** 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.
*/
activity_status?: string;
/** Template detected type. */
detected_template_type?: string;
/** Numner of discarded files. */
discarded_files?: number;
/** Numner of errors in log. */
error?: string;
/** Numner of resources added. */
resources_added?: number;
/** Numner of resources destroyed. */
resources_destroyed?: number;
/** Numner of resources modified. */
resources_modified?: number;
/** Numner of filed scanned. */
scanned_files?: number;
/** Numner of template variables. */
template_variable_count?: number;
/** Elapsed time to run the job. */
time_taken?: number;
}
/**
* OutputValuesInner.
*/
interface OutputValuesInner {
/** 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;
/** The ID that was assigned to your Terraform template or IBM Cloud catalog software template. */
id?: string;
/** A list of Terraform output values. */
output_values?: JsonObject[];
/** The Terraform version that was used to apply your template. */
value_type?: string;
}
/**
* Detailed information about the Schematics customization policy. This policy can be used to customize the behaviour
* or the core Schematics service.
*/
interface Policy {
/** Name of Schematics customization policy. */
name?: string;
/** The description of Schematics customization policy. */
description?: string;
/** The resource group name for the policy. By default, Policy will be created in `default` Resource Group. */
resource_group?: string;
/** Tags for the Schematics customization policy. */
tags?: string[];
/** 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?: Policy.Constants.Location | string;
/** User defined status of the Schematics object. */
state?: UserState;
/** Policy kind or categories for managing and deriving policy decision
* * `agent_assignment_policy` Agent assignment policy for job execution.
*/
kind?: Policy.Constants.Kind | string;
/** The objects for the Schematics policy. */
target?: PolicyObjects;
/** The parameter to tune the Schematics policy. */
parameter?: PolicyParameter;
/** The system generated policy Id. */
id?: string;
/** The policy CRN. */
crn?: string;
/** The Account id. */
account?: string;
/** List of scoped Schematics resources targeted by the policy. */
scoped_resources?: ScopedResource[];
/** The policy creation time. */
created_at?: string;
/** The user who created the policy. */
created_by?: string;
/** The policy updation time. */
updated_at?: string;
}
namespace Policy {
namespace Constants {
/** 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. */
enum Location {
US_SOUTH = "us-south",
US_EAST = "us-east",
EU_GB = "eu-gb",
EU_DE = "eu-de"
}
/** Policy kind or categories for managing and deriving policy decision * `agent_assignment_policy` Agent assignment policy for job execution. */
enum Kind {
AGENT_ASSIGNMENT_POLICY = "agent_assignment_policy"
}
}
}
/**
* The list of Schematics customization policies.
*/
interface PolicyList {
/** The total number of policy records. */
total_count?: number;
/** The number of policy records returned. */
limit?: number;
/** The skipped number of policy records. */
offset: number;
/** The list of Schematics policies. */
policies?: PolicyLite[];
}
/**
* The summary of Schematics policy.
*/
interface PolicyLite {
/** The name of Schematics customization policy. */
name?: string;
/** The system generated Policy Id. */
id?: string;
/** The policy CRN. */
crn?: string;
/** The Account id. */
account?: string;
/** The description of Schematics customization policy. */
description?: string;
/** Resource-group name for the Policy. By default, Policy will be created in Default Resource Group. */
resource_group?: string;
/** Tags for the Schematics customization policy. */
tags?: string[];
/** 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?: PolicyLite.Constants.Location | string;
/** User defined status of the Schematics object. */
state?: UserState;
/** Policy kind or categories for managing and deriving policy decision
* * `agent_assignment_policy` Agent assignment policy for job execution.
*/
policy_kind?: PolicyLite.Constants.PolicyKind | string;
/** The policy creation time. */
created_at?: string;
/** The user who created the Policy. */
created_by?: string;
/** The policy updation time. */
updated_at?: string;
/** The user who updated the policy. */
updated_by?: string;
}
namespace PolicyLite {
namespace Constants {
/** 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. */
enum Location {
US_SOUTH = "us-south",
US_EAST = "us-east",
EU_GB = "eu-gb",
EU_DE = "eu-de"
}
/** Policy kind or categories for managing and deriving policy decision * `agent_assignment_policy` Agent assignment policy for job execution. */
enum PolicyKind {
AGENT_ASSIGNMENT_POLICY = "agent_assignment_policy"
}
}
}
/**
* 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"])).
*/
interface PolicyObjectSelector {
/** Name of the Schematics automation resource. */
kind?: PolicyObjectSelector.Constants.Kind | string;
/** The tag based selector. */
tags?: string[];
/** The resource group based selector. */
resource_groups?: string[];
/** The location based selector. */
locations?: PolicyObjectSelector.Constants.Locations[] | string[];
}
namespace PolicyObjectSelector {
namespace Constants {
/** Name of the Schematics automation resource. */
enum Kind {
WORKSPACE = "workspace",
ACTION = "action",
SYSTEM = "system",
ENVIRONMENT = "environment"
}
/** The location based selector. */
enum Locations {
US_SOUTH = "us-south",
US_EAST = "us-east",
EU_GB = "eu-gb",
EU_DE = "eu-de"
}
}
}
/**
* The objects for the Schematics policy.
*/
interface PolicyObjects {
/** Types of schematics object selector. */
selector_kind?: PolicyObjects.Constants.SelectorKind | string;
/** Static selectors of schematics object ids (agent, workspace or action) for the Schematics policy. */
selector_ids?: string[];
/** Selectors to dynamically list of schematics object ids (agent, workspace or action) for the Schematics
* policy.
*/
selector_scope?: PolicyObjectSelector[];
}
namespace PolicyObjects {
namespace Constants {
/** Types of schematics object selector. */
enum SelectorKind {
IDS = "ids",
SCOPED = "scoped"
}
}
}
/**
* The parameter to tune the Schematics policy.
*/
interface PolicyParameter {
/** Parameters for the `agent_assignment_policy`. */
agent_assignment_policy_parameter?: AgentAssignmentPolicyParameter;
}
/**
* A list of resource groups that your account has access to.
*/
interface ResourceGroupResponse {
/** The ID of the account for which you listed the resource groups. */
account_id?: string;
/** The CRN of the resource group. */
crn?: string;
/** 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?: boolean;
/** The name of the resource group. */
name?: string;
/** The ID of the resource group. */
resource_group_id?: string;
/** The state of the resource group. */
state?: string;
}
/**
* Describe resource query.
*/
interface ResourceQuery {
/** Type of the query(workspaces). */
query_type?: ResourceQuery.Constants.QueryType | string;
query_condition?: ResourceQueryParam[];
/** List of query selection parameters. */
query_select?: string[];
}
namespace ResourceQuery {
namespace Constants {
/** Type of the query(workspaces). */
enum QueryType {
WORKSPACES = "workspaces"
}
}
}
/**
* Describe resource query param.
*/
interface ResourceQueryParam {
/** Name of the resource query param. */
name?: string;
/** Value of the resource query param. */
value?: string;
/** Description of resource query param variable. */
description?: string;
}
/**
* Describe resource query record.
*/
interface ResourceQueryRecord {
/** Resource type (cluster, vsi, icd, vpc). */
type?: ResourceQueryRecord.Constants.Type | string;
/** Resource query name. */
name?: string;
/** Resource Query id. */
id?: string;
/** Resource query creation time. */
created_at?: string;
/** Email address of user who created the Resource query. */
created_by?: string;
/** Resource query updation time. */
updated_at?: string;
/** Email address of user who updated the Resource query. */
updated_by?: string;
queries?: ResourceQuery[];
}
namespace ResourceQueryRecord {
namespace Constants {
/** Resource type (cluster, vsi, icd, vpc). */
enum Type {
VSI = "vsi"
}
}
}
/**
* List of Resource query records.
*/
interface ResourceQueryRecordList {
/** Total number of records. */
total_count?: number;
/** Number of records returned. */
limit: number;
/** Skipped number of records. */
offset: number;
/** List of resource query records. (Deprecated ResourceQueries. Instead, use resource_queries.). */
resource_queries?: ResourceQueryRecord[];
}
/**
* Describe resource query.
*/
interface ResourceQueryResponseRecord {
response?: ResourceQueryResponseRecordResponse[];
}
/**
* List of query output values.
*/
interface ResourceQueryResponseRecordQueryOutput {
/** Name of the output param. */
name?: string;
/** value of the output param. */
value?: string;
}
/**
* ResourceQueryResponseRecordResponse.
*/
interface ResourceQueryResponseRecordResponse {
/** Type of the query(workspaces). */
query_type?: ResourceQueryResponseRecordResponse.Constants.QueryType | string;
query_condition?: ResourceQueryParam[];
/** List of query selection parameters. */
query_select?: string[];
query_output?: ResourceQueryResponseRecordQueryOutput[];
}
namespace ResourceQueryResponseRecordResponse {
namespace Constants {
/** Type of the query(workspaces). */
enum QueryType {
WORKSPACES = "workspaces"
}
}
}
/**
* Information about the location.
*/
interface SchematicsLocations {
/** The name of the location. */
name?: string;
/** The ID of the location. */
id?: string;
/** The country where the location is located. */
country?: string;
/** The geography that the location belongs to. */
geography?: string;
/** Geographical continent locations code having the data centres of IBM Cloud Schematics service. */
geography_code?: string;
/** The metro area that the location belongs to. */
metro?: string;
/** The multizone metro area that the location belongs to. */
multizone_metro?: string;
/** The kind of location. */
kind?: string;
/** The list of paired regions used by Schematics. */
paired_region?: string[];
/** The restricted region. */
restricted?: boolean;
/** The metadata of an agent. */
agent_metadata?: AgentMetadataInfo[];
}
/**
* The list of locations details.
*/
interface SchematicsLocationsList {
/** The list of locations. */
locations?: SchematicsLocationsLite[];
}
/**
* An individual location details.
*/
interface SchematicsLocationsLite {
/** The Geographical region code having the data centres of the IBM Cloud Schematics service. */
region?: string;
/** The Geographical city locations having the data centres of the IBM Cloud Schematics service. */
metro?: string;
/** The Geographical continent locations code having the data centres of the IBM Cloud Schematics service. */
geography_code?: string;
/** The Geographical continent locations having the data centres of the IBM Cloud Schematics service. */
geography?: string;
/** The Country locations having the data centres of the IBM Cloud Schematics service. */
country?: string;
/** The kind of location. */
kind?: string;
/** The list of paired regions used by the Schematics. */
paired_region?: string[];
/** The restricted region. */
restricted?: boolean;
/** Display name for the region. */
display_name?: string;
/** Schematics public endpoint for the region. */
schematics_regional_public_endpoint?: string;
/** Schematics private endpoint for the region. */
schematics_regional_private_endpoint?: string;
}
/**
* scoped Schematics resource.
*/
interface ScopedResource {
/** Name of the Schematics automation resource. */
kind?: ScopedResource.Constants.Kind | string;
/** Schematics resource Id. */
id?: string;
}
namespace ScopedResource {
namespace Constants {
/** Name of the Schematics automation resource. */
enum Kind {
WORKSPACE = "workspace",
ACTION = "action",
SYSTEM = "system",
ENVIRONMENT = "environment"
}
}
}
/**
* Service Extensions.
*/
interface ServiceExtensions {
/** Name of the Service Data. */
name?: string;
/** Values of service data. */
value?: any;
/** Type of the value string, int, bool. */
type?: string;
}
/**
* 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.
*/
interface SharedTargetData {
/** Cluster created on. */
cluster_created_on?: string;
/** 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.
*/
cluster_id?: string;
/** The cluster name. */
cluster_name?: string;
/** The cluster type. */
cluster_type?: string;
/** The entitlement key that you want to use to install IBM Cloud entitled software. */
entitlement_keys?: JsonObject[];
/** 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;
/** 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;
/** 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.
*/
resource_group_id?: string;
/** The cluster worker count. */
worker_count?: number;
/** The cluster worker type. */
worker_machine_type?: string;
}
/**
* 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.
*/
interface SharedTargetDataResponse {
/** 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.
*/
cluster_id?: string;
/** Target cluster name. */
cluster_name?: string;
/** The entitlement key that you want to use to install IBM Cloud entitled software. */
entitlement_keys?: JsonObject[];
/** 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;
/** 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;
/** 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.
*/
resource_group_id?: string;
}
/**
* Information about workspace runtime data.
*/
interface StateStoreResponse {
/** The provisioning engine that was used to apply the Terraform template or IBM Cloud catalog software
* template.
*/
engine_name?: string;
/** The version of the provisioning engine that was used. */
engine_version?: string;
/** The ID that was assigned to your Terraform template or IBM Cloud catalog software template. */
id?: string;
/** 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.
*/
state_store_url?: string;
}
/**
* Information about the Terraform statefile URL.
*/
interface StateStoreResponseList {
/** Information about workspace runtime data. */
runtime_data?: StateStoreResponse[];
}
/**
* System lock status.
*/
interface SystemLock {
/** Is the automation locked by a Schematic job ?. */
sys_locked?: boolean;
/** Name of the User who performed the job, that lead to the locking of the automation. */
sys_locked_by?: string;
/** When the User performed the job that lead to locking of the automation ?. */
sys_locked_at?: string;
}
/**
* Template metadata response.
*/
interface TemplateMetaDataResponse {
/** The template type such as **terraform**, **ansible**, **helm**, **cloudpak**, or **bash script**. */
type?: string;
/** List of variables and its metadata. */
variables: VariableData[];
}
/**
* The `README.md` file for the template used by the workspace.
*/
interface TemplateReadme {
/** The `README.md` file for the template used by the workspace. */
readme?: string;
}
/**
* Input variables for the Template repoository, while creating a workspace.
*/
interface TemplateRepoRequest {
/** The repository branch. */
branch?: string;
/** The repository release. */
release?: string;
/** The repository SHA value. */
repo_sha_value?: string;
/** The repository URL. */
repo_url?: string;
/** The source URL. */
url?: string;
/** Set this variable to checkout git sub-modules. */
skip_submodules_checkout?: boolean;
}
/**
* Information about the Template repository used by the workspace.
*/
interface TemplateRepoResponse {
/** The repository branch. */
branch?: string;
/** Full repository URL. */
full_url?: string;
/** Has uploaded Git repository tar. */
has_uploadedgitrepotar?: boolean;
/** The repository release. */
release?: string;
/** The repository SHA value. */
repo_sha_value?: string;
/** 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).
*/
repo_url?: string;
/** The source URL. */
url?: string;
/** Set this variable to checkout git sub-modules. */
skip_submodules_checkout?: boolean;
}
/**
* Response after uploading Template in tar file format.
*/
interface TemplateRepoTarUploadResponse {
/** Tar file value. */
file_value?: string;
/** Has received tar file?. */
has_received_file?: boolean;
/** Template ID. */
id?: string;
}
/**
* Input to update the template repository data.
*/
interface TemplateRepoUpdateRequest {
/** The repository branch. */
branch?: string;
/** The repository release. */
release?: string;
/** The repository SHA value. */
repo_sha_value?: string;
/** The repository URL. */
repo_url?: string;
/** The source URL. */
url?: string;
/** Set this variable to checkout git sub-modules. */
skip_submodules_checkout?: boolean;
}
/**
* Information about the resources provisioned by the Terraform template.
*/
interface TemplateResources {
/** 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;
/** The ID that was assigned to your Terraform template or IBM Cloud catalog software template. */
id?: string;
/** Last refreshed timestamp of the terraform resource. */
generated_at?: string;
/** List of null resources. */
null_resources?: JsonObject[];
/** Information about the IBM Cloud resources that are associated with your workspace. */
related_resources?: JsonObject[];
/** 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?: JsonObject[];
/** Number of resources. */
resources_count?: number;
/** The Terraform version that was used to apply your template. */
type?: string;
}
/**
* Information about the provisioning engine, state file, and runtime logs.
*/
interface TemplateRunTimeDataResponse {
/** The command that was used to apply the Terraform template or IBM Cloud catalog software template. */
engine_cmd?: string;
/** The provisioning engine that was used to apply the Terraform template or IBM Cloud catalog software
* template.
*/
engine_name?: string;
/** The version of the provisioning engine that was used. */
engine_version?: string;
/** The ID that was assigned to your Terraform template or IBM Cloud catalog software template. */
id?: string;
/** The URL to access the logs that were created during the creation, update, or deletion of your IBM Cloud
* resources.
*/
log_store_url?: string;
/** List of Output values. */
output_values?: JsonObject[];
/** List of resources. */
resources?: JsonObject[][];
/** 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.
*/
state_store_url?: string;
}
/**
* Input parameters to define input variables for your Terraform template.
*/
interface TemplateSourceDataRequest {
/** 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.
*/
env_values?: JsonObject[];
/** Environment variables metadata. */
env_values_metadata?: EnvironmentValuesMetadata[];
/** The subfolder in your GitHub or GitLab repository where your Terraform template is stored. */
folder?: string;
/** 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?: boolean;
/** 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 --template `.
*/
init_state_file?: string;
/** Array of injectable terraform blocks. */
injectors?: InjectTerraformTemplateInner[];
/** 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;
/** Uninstall script name. */
uninstall_script_name?: string;
/** 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;
/** List of values metadata. */
values_metadata?: JsonObject[];
/** VariablesRequest -. */
variablestore?: WorkspaceVariableRequest[];
}
/**
* Information about the input variables that are used in the template.
*/
interface TemplateSourceDataResponse {
/** List of environment values. */
env_values?: EnvVariableResponse[];
/** 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;
/** 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?: boolean;
/** Has github token. */
has_githubtoken?: boolean;
/** The ID that was assigned to your Terraform template or IBM Cloud catalog software template. */
id?: string;
/** The Terraform version that was used to run your Terraform code. */
type?: string;
/** Uninstall script name. */
uninstall_script_name?: string;
/** 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;
/** A list of input variables that are associated with the workspace. */
values_metadata?: JsonObject[];
/** The API endpoint to access the input variables that you defined for your template. */
values_url?: string;
/** Information about the input variables that your template uses. */
variablestore?: WorkspaceVariableResponse[];
}
/**
* The content of the Terraform statefile (`terraform.tfstate`).
*/
interface TemplateStateStore {
version?: number;
terraform_version?: string;
serial?: number;
lineage?: string;
modules?: JsonObject[];
}
/**
* Information about the input variables that are declared in the template that your workspace points to.
*/
interface TemplateValues {
/** Information about workspace variable metadata. */
values_metadata?: JsonObject[];
}
/**
* Inputs for running a Terraform command on the workspace.
*/
interface TerraformCommand {
/** You must provide the command to execute. Supported commands are `show`,`taint`, `untaint`, `state`,
* `import`, `output`, `drift`.
*/
command?: string;
/** The required address parameters for the command name. You can send the option flag and address parameter in
* the payload. **Syntax ** "command_params": "