v1

package
v0.0.0-...-af3a870 Latest Latest
Warning

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

 Go to latest Published: Feb 18, 2021 License: Apache-2.0 Imports: 11 Imported by: 0

Documentation

Overview

Package v1 provides primitives to interact the openapi HTTP API.

Code generated by github.com/deepmap/oapi-codegen DO NOT EDIT.

Index

Constants

View Source 
const APIVersion = "1.0"

APIVersion is the API version, it is located in the JSON OpenAPI in info.version

Variables

This section is empty.

Functions

func NewApplyWorkspaceCommandRequest 

func NewApplyWorkspaceCommandRequest(server string, wId string, params *ApplyWorkspaceCommandParams, body ApplyWorkspaceCommandJSONRequestBody) (*http.Request, error)

NewApplyWorkspaceCommandRequest calls the generic ApplyWorkspaceCommand builder with application/json body

func NewApplyWorkspaceCommandRequestWithBody 

func NewApplyWorkspaceCommandRequestWithBody(server string, wId string, params *ApplyWorkspaceCommandParams, contentType string, body io.Reader) (*http.Request, error)

NewApplyWorkspaceCommandRequestWithBody generates requests for ApplyWorkspaceCommand with any type of body

func NewCreateWorkspaceRequest 

func NewCreateWorkspaceRequest(server string, params *CreateWorkspaceParams, body CreateWorkspaceJSONRequestBody) (*http.Request, error)

NewCreateWorkspaceRequest calls the generic CreateWorkspace builder with application/json body

func NewCreateWorkspaceRequestWithBody 

func NewCreateWorkspaceRequestWithBody(server string, params *CreateWorkspaceParams, contentType string, body io.Reader) (*http.Request, error)

NewCreateWorkspaceRequestWithBody generates requests for CreateWorkspace with any type of body

func NewDeleteWorkspaceActivityRequest 

func NewDeleteWorkspaceActivityRequest(server string, wId string, activityId string, params *DeleteWorkspaceActivityParams) (*http.Request, error)

NewDeleteWorkspaceActivityRequest generates requests for DeleteWorkspaceActivity

func NewDeleteWorkspaceRequest 

func NewDeleteWorkspaceRequest(server string, wId string, params *DeleteWorkspaceParams) (*http.Request, error)

NewDeleteWorkspaceRequest generates requests for DeleteWorkspace

func NewDestroyWorkspaceCommandRequest 

func NewDestroyWorkspaceCommandRequest(server string, wId string, params *DestroyWorkspaceCommandParams, body DestroyWorkspaceCommandJSONRequestBody) (*http.Request, error)

NewDestroyWorkspaceCommandRequest calls the generic DestroyWorkspaceCommand builder with application/json body

func NewDestroyWorkspaceCommandRequestWithBody 

func NewDestroyWorkspaceCommandRequestWithBody(server string, wId string, params *DestroyWorkspaceCommandParams, contentType string, body io.Reader) (*http.Request, error)

NewDestroyWorkspaceCommandRequestWithBody generates requests for DestroyWorkspaceCommand with any type of body

func NewGetAllWorkspaceInputsRequest 

func NewGetAllWorkspaceInputsRequest(server string, wId string, params *GetAllWorkspaceInputsParams) (*http.Request, error)

NewGetAllWorkspaceInputsRequest generates requests for GetAllWorkspaceInputs

func NewGetSchematicsVersionRequest 

func NewGetSchematicsVersionRequest(server string) (*http.Request, error)

NewGetSchematicsVersionRequest generates requests for GetSchematicsVersion

func NewGetTemplateActivityLogRequest 

func NewGetTemplateActivityLogRequest(server string, wId string, tId string, activityId string, params *GetTemplateActivityLogParams) (*http.Request, error)

NewGetTemplateActivityLogRequest generates requests for GetTemplateActivityLog

func NewGetTemplateLogsRequest 

func NewGetTemplateLogsRequest(server string, wId string, tId string, params *GetTemplateLogsParams) (*http.Request, error)

NewGetTemplateLogsRequest generates requests for GetTemplateLogs

func NewGetWorkspaceActivityLogsRequest 

func NewGetWorkspaceActivityLogsRequest(server string, wId string, activityId string, params *GetWorkspaceActivityLogsParams) (*http.Request, error)

NewGetWorkspaceActivityLogsRequest generates requests for GetWorkspaceActivityLogs

func NewGetWorkspaceActivityRequest 

func NewGetWorkspaceActivityRequest(server string, wId string, activityId string, params *GetWorkspaceActivityParams) (*http.Request, error)

NewGetWorkspaceActivityRequest generates requests for GetWorkspaceActivity

func NewGetWorkspaceInputMetadataRequest 

func NewGetWorkspaceInputMetadataRequest(server string, wId string, tId string, params *GetWorkspaceInputMetadataParams) (*http.Request, error)

NewGetWorkspaceInputMetadataRequest generates requests for GetWorkspaceInputMetadata

func NewGetWorkspaceInputsRequest 

func NewGetWorkspaceInputsRequest(server string, wId string, tId string, params *GetWorkspaceInputsParams) (*http.Request, error)

NewGetWorkspaceInputsRequest generates requests for GetWorkspaceInputs

func NewGetWorkspaceLogUrlsRequest 

func NewGetWorkspaceLogUrlsRequest(server string, wId string, params *GetWorkspaceLogUrlsParams) (*http.Request, error)

NewGetWorkspaceLogUrlsRequest generates requests for GetWorkspaceLogUrls

func NewGetWorkspaceOutputsRequest 

func NewGetWorkspaceOutputsRequest(server string, wId string, params *GetWorkspaceOutputsParams) (*http.Request, error)

NewGetWorkspaceOutputsRequest generates requests for GetWorkspaceOutputs

func NewGetWorkspaceReadmeRequest 

func NewGetWorkspaceReadmeRequest(server string, wId string, params *GetWorkspaceReadmeParams) (*http.Request, error)

NewGetWorkspaceReadmeRequest generates requests for GetWorkspaceReadme

func NewGetWorkspaceRequest 

func NewGetWorkspaceRequest(server string, wId string, params *GetWorkspaceParams) (*http.Request, error)

NewGetWorkspaceRequest generates requests for GetWorkspace

func NewGetWorkspaceResourcesRequest 

func NewGetWorkspaceResourcesRequest(server string, wId string, params *GetWorkspaceResourcesParams) (*http.Request, error)

NewGetWorkspaceResourcesRequest generates requests for GetWorkspaceResources

func NewGetWorkspaceStateRequest 

func NewGetWorkspaceStateRequest(server string, wId string, params *GetWorkspaceStateParams) (*http.Request, error)

NewGetWorkspaceStateRequest generates requests for GetWorkspaceState

func NewGetWorkspaceTemplateStateRequest 

func NewGetWorkspaceTemplateStateRequest(server string, wId string, tId string, params *GetWorkspaceTemplateStateParams) (*http.Request, error)

NewGetWorkspaceTemplateStateRequest generates requests for GetWorkspaceTemplateState

func NewListResourceGroupRequest 

func NewListResourceGroupRequest(server string, params *ListResourceGroupParams) (*http.Request, error)

NewListResourceGroupRequest generates requests for ListResourceGroup

func NewListSchematicsLocationRequest 

func NewListSchematicsLocationRequest(server string, params *ListSchematicsLocationParams) (*http.Request, error)

NewListSchematicsLocationRequest generates requests for ListSchematicsLocation

func NewListWorkspaceActivitiesRequest 

func NewListWorkspaceActivitiesRequest(server string, wId string, params *ListWorkspaceActivitiesParams) (*http.Request, error)

NewListWorkspaceActivitiesRequest generates requests for ListWorkspaceActivities

func NewListWorkspacesRequest 

func NewListWorkspacesRequest(server string, params *ListWorkspacesParams) (*http.Request, error)

NewListWorkspacesRequest generates requests for ListWorkspaces

func NewPlanWorkspaceCommandRequest 

func NewPlanWorkspaceCommandRequest(server string, wId string, params *PlanWorkspaceCommandParams) (*http.Request, error)

NewPlanWorkspaceCommandRequest generates requests for PlanWorkspaceCommand

func NewRefreshWorkspaceCommandRequest 

func NewRefreshWorkspaceCommandRequest(server string, wId string, params *RefreshWorkspaceCommandParams) (*http.Request, error)

NewRefreshWorkspaceCommandRequest generates requests for RefreshWorkspaceCommand

func NewReplaceWorkspaceInputsRequest 

func NewReplaceWorkspaceInputsRequest(server string, wId string, tId string, params *ReplaceWorkspaceInputsParams, body ReplaceWorkspaceInputsJSONRequestBody) (*http.Request, error)

NewReplaceWorkspaceInputsRequest calls the generic ReplaceWorkspaceInputs builder with application/json body

func NewReplaceWorkspaceInputsRequestWithBody 

func NewReplaceWorkspaceInputsRequestWithBody(server string, wId string, tId string, params *ReplaceWorkspaceInputsParams, contentType string, body io.Reader) (*http.Request, error)

NewReplaceWorkspaceInputsRequestWithBody generates requests for ReplaceWorkspaceInputs with any type of body

func NewReplaceWorkspaceRequest 

func NewReplaceWorkspaceRequest(server string, wId string, params *ReplaceWorkspaceParams, body ReplaceWorkspaceJSONRequestBody) (*http.Request, error)

NewReplaceWorkspaceRequest calls the generic ReplaceWorkspace builder with application/json body

func NewReplaceWorkspaceRequestWithBody 

func NewReplaceWorkspaceRequestWithBody(server string, wId string, params *ReplaceWorkspaceParams, contentType string, body io.Reader) (*http.Request, error)

NewReplaceWorkspaceRequestWithBody generates requests for ReplaceWorkspace with any type of body

func NewUpdateWorkspaceRequest 

func NewUpdateWorkspaceRequest(server string, wId string, params *UpdateWorkspaceParams, body UpdateWorkspaceJSONRequestBody) (*http.Request, error)

NewUpdateWorkspaceRequest calls the generic UpdateWorkspace builder with application/json body

func NewUpdateWorkspaceRequestWithBody 

func NewUpdateWorkspaceRequestWithBody(server string, wId string, params *UpdateWorkspaceParams, contentType string, body io.Reader) (*http.Request, error)

NewUpdateWorkspaceRequestWithBody generates requests for UpdateWorkspace with any type of body

func NewUploadTemplateTarRequestWithBody 

func NewUploadTemplateTarRequestWithBody(server string, wId string, tId string, params *UploadTemplateTarParams, contentType string, body io.Reader) (*http.Request, error)

NewUploadTemplateTarRequestWithBody generates requests for UploadTemplateTar with any type of body

Types

type APIMessagePayload 

type APIMessagePayload struct {

	// Response status message
	Message *string `json:"message,omitempty"`

	// Response status message id
	Messageid *string `json:"messageid,omitempty"`

	// Response request id
	Requestid *string `json:"requestid,omitempty"`

	// Response status code
	Statuscode *int64 `json:"statuscode,omitempty"`

	// Response time-stamp
	Timestamp *time.Time `json:"timestamp,omitempty"`
}

APIMessagePayload defines model for APIMessagePayload.

type ApplyWorkspaceCommandJSONBody 

type ApplyWorkspaceCommandJSONBody WorkspaceActivityOptions

ApplyWorkspaceCommandJSONBody defines parameters for ApplyWorkspaceCommand.

type ApplyWorkspaceCommandJSONRequestBody 

type ApplyWorkspaceCommandJSONRequestBody ApplyWorkspaceCommandJSONBody

ApplyWorkspaceCommandRequestBody defines body for ApplyWorkspaceCommand for application/json ContentType.

type ApplyWorkspaceCommandParams 

type ApplyWorkspaceCommandParams struct {

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

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

	// The IAM access token for your IBM Cloud account. To retrieve the token, run `ibmcloud iam oauth-tokens` in the IBM Cloud CLI.
	Authorization string `json:"Authorization"`
}

ApplyWorkspaceCommandParams defines parameters for ApplyWorkspaceCommand.

type ApplyWorkspaceCommandResponse 

type ApplyWorkspaceCommandResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON202      *WorkspaceActivityApplyResult
	JSON401      *APIMessagePayload
	JSON403      *APIMessagePayload
	JSON404      *APIMessagePayload
	JSON409      *APIMessagePayload
	JSON429      *APIMessagePayload
	JSON500      *APIMessagePayload
	JSON503      *APIMessagePayload
}

func ParseApplyWorkspaceCommandResponse 

func ParseApplyWorkspaceCommandResponse(rsp *http.Response) (*ApplyWorkspaceCommandResponse, error)

ParseApplyWorkspaceCommandResponse parses an HTTP response from a ApplyWorkspaceCommandWithResponse call

func (ApplyWorkspaceCommandResponse) Status 

func (r ApplyWorkspaceCommandResponse) Status() string

Status returns HTTPResponse.Status

func (ApplyWorkspaceCommandResponse) StatusCode 

func (r ApplyWorkspaceCommandResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CatalogRef 

type CatalogRef struct {

	// Dry run
	DryRun *bool `json:"dry_run,omitempty"`

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

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

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

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

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

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

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

CatalogRef defines model for CatalogRef.

type Client 

type Client struct {
	// The endpoint of the server conforming to this interface, with scheme,
	// https://api.deepmap.com for example. This can contain a path relative
	// to the server, such as https://api.deepmap.com/dev-test, and all the
	// paths in the swagger spec will be appended to the server.
	Server string

	// Doer for performing requests, typically a *http.Client with any
	// customized settings, such as certificate chains.
	Client HttpRequestDoer

	// A callback for modifying requests which are generated before sending over
	// the network.
	RequestEditor RequestEditorFn
}

Client which conforms to the OpenAPI3 specification for this service.

func NewClient 

func NewClient(server string, opts ...ClientOption) (*Client, error)

Creates a new Client, with reasonable defaults

func (*Client) ApplyWorkspaceCommand 

func (c *Client) ApplyWorkspaceCommand(ctx context.Context, wId string, params *ApplyWorkspaceCommandParams, body ApplyWorkspaceCommandJSONRequestBody) (*http.Response, error)

func (*Client) ApplyWorkspaceCommandWithBody 

func (c *Client) ApplyWorkspaceCommandWithBody(ctx context.Context, wId string, params *ApplyWorkspaceCommandParams, contentType string, body io.Reader) (*http.Response, error)

func (*Client) CreateWorkspace 

func (c *Client) CreateWorkspace(ctx context.Context, params *CreateWorkspaceParams, body CreateWorkspaceJSONRequestBody) (*http.Response, error)

func (*Client) CreateWorkspaceWithBody 

func (c *Client) CreateWorkspaceWithBody(ctx context.Context, params *CreateWorkspaceParams, contentType string, body io.Reader) (*http.Response, error)

func (*Client) DeleteWorkspace 

func (c *Client) DeleteWorkspace(ctx context.Context, wId string, params *DeleteWorkspaceParams) (*http.Response, error)

func (*Client) DeleteWorkspaceActivity 

func (c *Client) DeleteWorkspaceActivity(ctx context.Context, wId string, activityId string, params *DeleteWorkspaceActivityParams) (*http.Response, error)

func (*Client) DestroyWorkspaceCommand 

func (c *Client) DestroyWorkspaceCommand(ctx context.Context, wId string, params *DestroyWorkspaceCommandParams, body DestroyWorkspaceCommandJSONRequestBody) (*http.Response, error)

func (*Client) DestroyWorkspaceCommandWithBody 

func (c *Client) DestroyWorkspaceCommandWithBody(ctx context.Context, wId string, params *DestroyWorkspaceCommandParams, contentType string, body io.Reader) (*http.Response, error)

func (*Client) GetAllWorkspaceInputs 

func (c *Client) GetAllWorkspaceInputs(ctx context.Context, wId string, params *GetAllWorkspaceInputsParams) (*http.Response, error)

func (*Client) GetSchematicsVersion 

func (c *Client) GetSchematicsVersion(ctx context.Context) (*http.Response, error)

func (*Client) GetTemplateActivityLog 

func (c *Client) GetTemplateActivityLog(ctx context.Context, wId string, tId string, activityId string, params *GetTemplateActivityLogParams) (*http.Response, error)

func (*Client) GetTemplateLogs 

func (c *Client) GetTemplateLogs(ctx context.Context, wId string, tId string, params *GetTemplateLogsParams) (*http.Response, error)

func (*Client) GetWorkspace 

func (c *Client) GetWorkspace(ctx context.Context, wId string, params *GetWorkspaceParams) (*http.Response, error)

func (*Client) GetWorkspaceActivity 

func (c *Client) GetWorkspaceActivity(ctx context.Context, wId string, activityId string, params *GetWorkspaceActivityParams) (*http.Response, error)

func (*Client) GetWorkspaceActivityLogs 

func (c *Client) GetWorkspaceActivityLogs(ctx context.Context, wId string, activityId string, params *GetWorkspaceActivityLogsParams) (*http.Response, error)

func (*Client) GetWorkspaceInputMetadata 

func (c *Client) GetWorkspaceInputMetadata(ctx context.Context, wId string, tId string, params *GetWorkspaceInputMetadataParams) (*http.Response, error)

func (*Client) GetWorkspaceInputs 

func (c *Client) GetWorkspaceInputs(ctx context.Context, wId string, tId string, params *GetWorkspaceInputsParams) (*http.Response, error)

func (*Client) GetWorkspaceLogUrls 

func (c *Client) GetWorkspaceLogUrls(ctx context.Context, wId string, params *GetWorkspaceLogUrlsParams) (*http.Response, error)

func (*Client) GetWorkspaceOutputs 

func (c *Client) GetWorkspaceOutputs(ctx context.Context, wId string, params *GetWorkspaceOutputsParams) (*http.Response, error)

func (*Client) GetWorkspaceReadme 

func (c *Client) GetWorkspaceReadme(ctx context.Context, wId string, params *GetWorkspaceReadmeParams) (*http.Response, error)

func (*Client) GetWorkspaceResources 

func (c *Client) GetWorkspaceResources(ctx context.Context, wId string, params *GetWorkspaceResourcesParams) (*http.Response, error)

func (*Client) GetWorkspaceState 

func (c *Client) GetWorkspaceState(ctx context.Context, wId string, params *GetWorkspaceStateParams) (*http.Response, error)

func (*Client) GetWorkspaceTemplateState 

func (c *Client) GetWorkspaceTemplateState(ctx context.Context, wId string, tId string, params *GetWorkspaceTemplateStateParams) (*http.Response, error)

func (*Client) ListResourceGroup 

func (c *Client) ListResourceGroup(ctx context.Context, params *ListResourceGroupParams) (*http.Response, error)

func (*Client) ListSchematicsLocation 

func (c *Client) ListSchematicsLocation(ctx context.Context, params *ListSchematicsLocationParams) (*http.Response, error)

func (*Client) ListWorkspaceActivities 

func (c *Client) ListWorkspaceActivities(ctx context.Context, wId string, params *ListWorkspaceActivitiesParams) (*http.Response, error)

func (*Client) ListWorkspaces 

func (c *Client) ListWorkspaces(ctx context.Context, params *ListWorkspacesParams) (*http.Response, error)

func (*Client) PlanWorkspaceCommand 

func (c *Client) PlanWorkspaceCommand(ctx context.Context, wId string, params *PlanWorkspaceCommandParams) (*http.Response, error)

func (*Client) RefreshWorkspaceCommand 

func (c *Client) RefreshWorkspaceCommand(ctx context.Context, wId string, params *RefreshWorkspaceCommandParams) (*http.Response, error)

func (*Client) ReplaceWorkspace 

func (c *Client) ReplaceWorkspace(ctx context.Context, wId string, params *ReplaceWorkspaceParams, body ReplaceWorkspaceJSONRequestBody) (*http.Response, error)

func (*Client) ReplaceWorkspaceInputs 

func (c *Client) ReplaceWorkspaceInputs(ctx context.Context, wId string, tId string, params *ReplaceWorkspaceInputsParams, body ReplaceWorkspaceInputsJSONRequestBody) (*http.Response, error)

func (*Client) ReplaceWorkspaceInputsWithBody 

func (c *Client) ReplaceWorkspaceInputsWithBody(ctx context.Context, wId string, tId string, params *ReplaceWorkspaceInputsParams, contentType string, body io.Reader) (*http.Response, error)

func (*Client) ReplaceWorkspaceWithBody 

func (c *Client) ReplaceWorkspaceWithBody(ctx context.Context, wId string, params *ReplaceWorkspaceParams, contentType string, body io.Reader) (*http.Response, error)

func (*Client) UpdateWorkspace 

func (c *Client) UpdateWorkspace(ctx context.Context, wId string, params *UpdateWorkspaceParams, body UpdateWorkspaceJSONRequestBody) (*http.Response, error)

func (*Client) UpdateWorkspaceWithBody 

func (c *Client) UpdateWorkspaceWithBody(ctx context.Context, wId string, params *UpdateWorkspaceParams, contentType string, body io.Reader) (*http.Response, error)

func (*Client) UploadTemplateTarWithBody 

func (c *Client) UploadTemplateTarWithBody(ctx context.Context, wId string, tId string, params *UploadTemplateTarParams, contentType string, body io.Reader) (*http.Response, error)

type ClientInterface 

type ClientInterface interface {
	// ListSchematicsLocation request
	ListSchematicsLocation(ctx context.Context, params *ListSchematicsLocationParams) (*http.Response, error)

	// ListResourceGroup request
	ListResourceGroup(ctx context.Context, params *ListResourceGroupParams) (*http.Response, error)

	// GetSchematicsVersion request
	GetSchematicsVersion(ctx context.Context) (*http.Response, error)

	// ListWorkspaces request
	ListWorkspaces(ctx context.Context, params *ListWorkspacesParams) (*http.Response, error)

	// CreateWorkspace request  with any body
	CreateWorkspaceWithBody(ctx context.Context, params *CreateWorkspaceParams, contentType string, body io.Reader) (*http.Response, error)

	CreateWorkspace(ctx context.Context, params *CreateWorkspaceParams, body CreateWorkspaceJSONRequestBody) (*http.Response, error)

	// DeleteWorkspace request
	DeleteWorkspace(ctx context.Context, wId string, params *DeleteWorkspaceParams) (*http.Response, error)

	// GetWorkspace request
	GetWorkspace(ctx context.Context, wId string, params *GetWorkspaceParams) (*http.Response, error)

	// UpdateWorkspace request  with any body
	UpdateWorkspaceWithBody(ctx context.Context, wId string, params *UpdateWorkspaceParams, contentType string, body io.Reader) (*http.Response, error)

	UpdateWorkspace(ctx context.Context, wId string, params *UpdateWorkspaceParams, body UpdateWorkspaceJSONRequestBody) (*http.Response, error)

	// ReplaceWorkspace request  with any body
	ReplaceWorkspaceWithBody(ctx context.Context, wId string, params *ReplaceWorkspaceParams, contentType string, body io.Reader) (*http.Response, error)

	ReplaceWorkspace(ctx context.Context, wId string, params *ReplaceWorkspaceParams, body ReplaceWorkspaceJSONRequestBody) (*http.Response, error)

	// ListWorkspaceActivities request
	ListWorkspaceActivities(ctx context.Context, wId string, params *ListWorkspaceActivitiesParams) (*http.Response, error)

	// DeleteWorkspaceActivity request
	DeleteWorkspaceActivity(ctx context.Context, wId string, activityId string, params *DeleteWorkspaceActivityParams) (*http.Response, error)

	// GetWorkspaceActivity request
	GetWorkspaceActivity(ctx context.Context, wId string, activityId string, params *GetWorkspaceActivityParams) (*http.Response, error)

	// GetWorkspaceActivityLogs request
	GetWorkspaceActivityLogs(ctx context.Context, wId string, activityId string, params *GetWorkspaceActivityLogsParams) (*http.Response, error)

	// ApplyWorkspaceCommand request  with any body
	ApplyWorkspaceCommandWithBody(ctx context.Context, wId string, params *ApplyWorkspaceCommandParams, contentType string, body io.Reader) (*http.Response, error)

	ApplyWorkspaceCommand(ctx context.Context, wId string, params *ApplyWorkspaceCommandParams, body ApplyWorkspaceCommandJSONRequestBody) (*http.Response, error)

	// DestroyWorkspaceCommand request  with any body
	DestroyWorkspaceCommandWithBody(ctx context.Context, wId string, params *DestroyWorkspaceCommandParams, contentType string, body io.Reader) (*http.Response, error)

	DestroyWorkspaceCommand(ctx context.Context, wId string, params *DestroyWorkspaceCommandParams, body DestroyWorkspaceCommandJSONRequestBody) (*http.Response, error)

	// GetWorkspaceLogUrls request
	GetWorkspaceLogUrls(ctx context.Context, wId string, params *GetWorkspaceLogUrlsParams) (*http.Response, error)

	// GetWorkspaceOutputs request
	GetWorkspaceOutputs(ctx context.Context, wId string, params *GetWorkspaceOutputsParams) (*http.Response, error)

	// PlanWorkspaceCommand request
	PlanWorkspaceCommand(ctx context.Context, wId string, params *PlanWorkspaceCommandParams) (*http.Response, error)

	// RefreshWorkspaceCommand request
	RefreshWorkspaceCommand(ctx context.Context, wId string, params *RefreshWorkspaceCommandParams) (*http.Response, error)

	// GetWorkspaceResources request
	GetWorkspaceResources(ctx context.Context, wId string, params *GetWorkspaceResourcesParams) (*http.Response, error)

	// GetTemplateLogs request
	GetTemplateLogs(ctx context.Context, wId string, tId string, params *GetTemplateLogsParams) (*http.Response, error)

	// GetTemplateActivityLog request
	GetTemplateActivityLog(ctx context.Context, wId string, tId string, activityId string, params *GetTemplateActivityLogParams) (*http.Response, error)

	// GetWorkspaceTemplateState request
	GetWorkspaceTemplateState(ctx context.Context, wId string, tId string, params *GetWorkspaceTemplateStateParams) (*http.Response, error)

	// GetWorkspaceState request
	GetWorkspaceState(ctx context.Context, wId string, params *GetWorkspaceStateParams) (*http.Response, error)

	// GetWorkspaceInputs request
	GetWorkspaceInputs(ctx context.Context, wId string, tId string, params *GetWorkspaceInputsParams) (*http.Response, error)

	// ReplaceWorkspaceInputs request  with any body
	ReplaceWorkspaceInputsWithBody(ctx context.Context, wId string, tId string, params *ReplaceWorkspaceInputsParams, contentType string, body io.Reader) (*http.Response, error)

	ReplaceWorkspaceInputs(ctx context.Context, wId string, tId string, params *ReplaceWorkspaceInputsParams, body ReplaceWorkspaceInputsJSONRequestBody) (*http.Response, error)

	// GetWorkspaceInputMetadata request
	GetWorkspaceInputMetadata(ctx context.Context, wId string, tId string, params *GetWorkspaceInputMetadataParams) (*http.Response, error)

	// GetWorkspaceReadme request
	GetWorkspaceReadme(ctx context.Context, wId string, params *GetWorkspaceReadmeParams) (*http.Response, error)

	// GetAllWorkspaceInputs request
	GetAllWorkspaceInputs(ctx context.Context, wId string, params *GetAllWorkspaceInputsParams) (*http.Response, error)

	// UploadTemplateTar request  with any body
	UploadTemplateTarWithBody(ctx context.Context, wId string, tId string, params *UploadTemplateTarParams, contentType string, body io.Reader) (*http.Response, error)
}

The interface specification for the client above.

type ClientOption 

type ClientOption func(*Client) error

ClientOption allows setting custom parameters during construction

func WithBaseURL 

func WithBaseURL(baseURL string) ClientOption

WithBaseURL overrides the baseURL.

func WithHTTPClient 

func WithHTTPClient(doer HttpRequestDoer) ClientOption

WithHTTPClient allows overriding the default Doer, which is automatically created using http.Client. This is useful for tests.

func WithRequestEditorFn 

func WithRequestEditorFn(fn RequestEditorFn) ClientOption

WithRequestEditorFn allows setting up a callback function, which will be called right before sending the request. This can be used to mutate the request.

type ClientWithResponses 

type ClientWithResponses struct {
	ClientInterface
}

ClientWithResponses builds on ClientInterface to offer response payloads

func NewClientWithResponses 

func NewClientWithResponses(server string, opts ...ClientOption) (*ClientWithResponses, error)

NewClientWithResponses creates a new ClientWithResponses, which wraps Client with return type handling

func (*ClientWithResponses) ApplyWorkspaceCommandWithBodyWithResponse 

func (c *ClientWithResponses) ApplyWorkspaceCommandWithBodyWithResponse(ctx context.Context, wId string, params *ApplyWorkspaceCommandParams, contentType string, body io.Reader) (*ApplyWorkspaceCommandResponse, error)

ApplyWorkspaceCommandWithBodyWithResponse request with arbitrary body returning *ApplyWorkspaceCommandResponse

func (*ClientWithResponses) ApplyWorkspaceCommandWithResponse 

func (c *ClientWithResponses) ApplyWorkspaceCommandWithResponse(ctx context.Context, wId string, params *ApplyWorkspaceCommandParams, body ApplyWorkspaceCommandJSONRequestBody) (*ApplyWorkspaceCommandResponse, error)

func (*ClientWithResponses) CreateWorkspaceWithBodyWithResponse 

func (c *ClientWithResponses) CreateWorkspaceWithBodyWithResponse(ctx context.Context, params *CreateWorkspaceParams, contentType string, body io.Reader) (*CreateWorkspaceResponse, error)

CreateWorkspaceWithBodyWithResponse request with arbitrary body returning *CreateWorkspaceResponse

func (*ClientWithResponses) CreateWorkspaceWithResponse 

func (c *ClientWithResponses) CreateWorkspaceWithResponse(ctx context.Context, params *CreateWorkspaceParams, body CreateWorkspaceJSONRequestBody) (*CreateWorkspaceResponse, error)

func (*ClientWithResponses) DeleteWorkspaceActivityWithResponse 

func (c *ClientWithResponses) DeleteWorkspaceActivityWithResponse(ctx context.Context, wId string, activityId string, params *DeleteWorkspaceActivityParams) (*DeleteWorkspaceActivityResponse, error)

DeleteWorkspaceActivityWithResponse request returning *DeleteWorkspaceActivityResponse

func (*ClientWithResponses) DeleteWorkspaceWithResponse 

func (c *ClientWithResponses) DeleteWorkspaceWithResponse(ctx context.Context, wId string, params *DeleteWorkspaceParams) (*DeleteWorkspaceResponse, error)

DeleteWorkspaceWithResponse request returning *DeleteWorkspaceResponse

func (*ClientWithResponses) DestroyWorkspaceCommandWithBodyWithResponse 

func (c *ClientWithResponses) DestroyWorkspaceCommandWithBodyWithResponse(ctx context.Context, wId string, params *DestroyWorkspaceCommandParams, contentType string, body io.Reader) (*DestroyWorkspaceCommandResponse, error)

DestroyWorkspaceCommandWithBodyWithResponse request with arbitrary body returning *DestroyWorkspaceCommandResponse

func (*ClientWithResponses) DestroyWorkspaceCommandWithResponse 

func (c *ClientWithResponses) DestroyWorkspaceCommandWithResponse(ctx context.Context, wId string, params *DestroyWorkspaceCommandParams, body DestroyWorkspaceCommandJSONRequestBody) (*DestroyWorkspaceCommandResponse, error)

func (*ClientWithResponses) GetAllWorkspaceInputsWithResponse 

func (c *ClientWithResponses) GetAllWorkspaceInputsWithResponse(ctx context.Context, wId string, params *GetAllWorkspaceInputsParams) (*GetAllWorkspaceInputsResponse, error)

GetAllWorkspaceInputsWithResponse request returning *GetAllWorkspaceInputsResponse

func (*ClientWithResponses) GetSchematicsVersionWithResponse 

func (c *ClientWithResponses) GetSchematicsVersionWithResponse(ctx context.Context) (*GetSchematicsVersionResponse, error)

GetSchematicsVersionWithResponse request returning *GetSchematicsVersionResponse

func (*ClientWithResponses) GetTemplateActivityLogWithResponse 

func (c *ClientWithResponses) GetTemplateActivityLogWithResponse(ctx context.Context, wId string, tId string, activityId string, params *GetTemplateActivityLogParams) (*GetTemplateActivityLogResponse, error)

GetTemplateActivityLogWithResponse request returning *GetTemplateActivityLogResponse

func (*ClientWithResponses) GetTemplateLogsWithResponse 

func (c *ClientWithResponses) GetTemplateLogsWithResponse(ctx context.Context, wId string, tId string, params *GetTemplateLogsParams) (*GetTemplateLogsResponse, error)

GetTemplateLogsWithResponse request returning *GetTemplateLogsResponse

func (*ClientWithResponses) GetWorkspaceActivityLogsWithResponse 

func (c *ClientWithResponses) GetWorkspaceActivityLogsWithResponse(ctx context.Context, wId string, activityId string, params *GetWorkspaceActivityLogsParams) (*GetWorkspaceActivityLogsResponse, error)

GetWorkspaceActivityLogsWithResponse request returning *GetWorkspaceActivityLogsResponse

func (*ClientWithResponses) GetWorkspaceActivityWithResponse 

func (c *ClientWithResponses) GetWorkspaceActivityWithResponse(ctx context.Context, wId string, activityId string, params *GetWorkspaceActivityParams) (*GetWorkspaceActivityResponse, error)

GetWorkspaceActivityWithResponse request returning *GetWorkspaceActivityResponse

func (*ClientWithResponses) GetWorkspaceInputMetadataWithResponse 

func (c *ClientWithResponses) GetWorkspaceInputMetadataWithResponse(ctx context.Context, wId string, tId string, params *GetWorkspaceInputMetadataParams) (*GetWorkspaceInputMetadataResponse, error)

GetWorkspaceInputMetadataWithResponse request returning *GetWorkspaceInputMetadataResponse

func (*ClientWithResponses) GetWorkspaceInputsWithResponse 

func (c *ClientWithResponses) GetWorkspaceInputsWithResponse(ctx context.Context, wId string, tId string, params *GetWorkspaceInputsParams) (*GetWorkspaceInputsResponse, error)

GetWorkspaceInputsWithResponse request returning *GetWorkspaceInputsResponse

func (*ClientWithResponses) GetWorkspaceLogUrlsWithResponse 

func (c *ClientWithResponses) GetWorkspaceLogUrlsWithResponse(ctx context.Context, wId string, params *GetWorkspaceLogUrlsParams) (*GetWorkspaceLogUrlsResponse, error)

GetWorkspaceLogUrlsWithResponse request returning *GetWorkspaceLogUrlsResponse

func (*ClientWithResponses) GetWorkspaceOutputsWithResponse 

func (c *ClientWithResponses) GetWorkspaceOutputsWithResponse(ctx context.Context, wId string, params *GetWorkspaceOutputsParams) (*GetWorkspaceOutputsResponse, error)

GetWorkspaceOutputsWithResponse request returning *GetWorkspaceOutputsResponse

func (*ClientWithResponses) GetWorkspaceReadmeWithResponse 

func (c *ClientWithResponses) GetWorkspaceReadmeWithResponse(ctx context.Context, wId string, params *GetWorkspaceReadmeParams) (*GetWorkspaceReadmeResponse, error)

GetWorkspaceReadmeWithResponse request returning *GetWorkspaceReadmeResponse

func (*ClientWithResponses) GetWorkspaceResourcesWithResponse 

func (c *ClientWithResponses) GetWorkspaceResourcesWithResponse(ctx context.Context, wId string, params *GetWorkspaceResourcesParams) (*GetWorkspaceResourcesResponse, error)

GetWorkspaceResourcesWithResponse request returning *GetWorkspaceResourcesResponse

func (*ClientWithResponses) GetWorkspaceStateWithResponse 

func (c *ClientWithResponses) GetWorkspaceStateWithResponse(ctx context.Context, wId string, params *GetWorkspaceStateParams) (*GetWorkspaceStateResponse, error)

GetWorkspaceStateWithResponse request returning *GetWorkspaceStateResponse

func (*ClientWithResponses) GetWorkspaceTemplateStateWithResponse 

func (c *ClientWithResponses) GetWorkspaceTemplateStateWithResponse(ctx context.Context, wId string, tId string, params *GetWorkspaceTemplateStateParams) (*GetWorkspaceTemplateStateResponse, error)

GetWorkspaceTemplateStateWithResponse request returning *GetWorkspaceTemplateStateResponse

func (*ClientWithResponses) GetWorkspaceWithResponse 

func (c *ClientWithResponses) GetWorkspaceWithResponse(ctx context.Context, wId string, params *GetWorkspaceParams) (*GetWorkspaceResponse, error)

GetWorkspaceWithResponse request returning *GetWorkspaceResponse

func (*ClientWithResponses) ListResourceGroupWithResponse 

func (c *ClientWithResponses) ListResourceGroupWithResponse(ctx context.Context, params *ListResourceGroupParams) (*ListResourceGroupResponse, error)

ListResourceGroupWithResponse request returning *ListResourceGroupResponse

func (*ClientWithResponses) ListSchematicsLocationWithResponse 

func (c *ClientWithResponses) ListSchematicsLocationWithResponse(ctx context.Context, params *ListSchematicsLocationParams) (*ListSchematicsLocationResponse, error)

ListSchematicsLocationWithResponse request returning *ListSchematicsLocationResponse

func (*ClientWithResponses) ListWorkspaceActivitiesWithResponse 

func (c *ClientWithResponses) ListWorkspaceActivitiesWithResponse(ctx context.Context, wId string, params *ListWorkspaceActivitiesParams) (*ListWorkspaceActivitiesResponse, error)

ListWorkspaceActivitiesWithResponse request returning *ListWorkspaceActivitiesResponse

func (*ClientWithResponses) ListWorkspacesWithResponse 

func (c *ClientWithResponses) ListWorkspacesWithResponse(ctx context.Context, params *ListWorkspacesParams) (*ListWorkspacesResponse, error)

ListWorkspacesWithResponse request returning *ListWorkspacesResponse

func (*ClientWithResponses) PlanWorkspaceCommandWithResponse 

func (c *ClientWithResponses) PlanWorkspaceCommandWithResponse(ctx context.Context, wId string, params *PlanWorkspaceCommandParams) (*PlanWorkspaceCommandResponse, error)

PlanWorkspaceCommandWithResponse request returning *PlanWorkspaceCommandResponse

func (*ClientWithResponses) RefreshWorkspaceCommandWithResponse 

func (c *ClientWithResponses) RefreshWorkspaceCommandWithResponse(ctx context.Context, wId string, params *RefreshWorkspaceCommandParams) (*RefreshWorkspaceCommandResponse, error)

RefreshWorkspaceCommandWithResponse request returning *RefreshWorkspaceCommandResponse

func (*ClientWithResponses) ReplaceWorkspaceInputsWithBodyWithResponse 

func (c *ClientWithResponses) ReplaceWorkspaceInputsWithBodyWithResponse(ctx context.Context, wId string, tId string, params *ReplaceWorkspaceInputsParams, contentType string, body io.Reader) (*ReplaceWorkspaceInputsResponse, error)

ReplaceWorkspaceInputsWithBodyWithResponse request with arbitrary body returning *ReplaceWorkspaceInputsResponse

func (*ClientWithResponses) ReplaceWorkspaceInputsWithResponse 

func (c *ClientWithResponses) ReplaceWorkspaceInputsWithResponse(ctx context.Context, wId string, tId string, params *ReplaceWorkspaceInputsParams, body ReplaceWorkspaceInputsJSONRequestBody) (*ReplaceWorkspaceInputsResponse, error)

func (*ClientWithResponses) ReplaceWorkspaceWithBodyWithResponse 

func (c *ClientWithResponses) ReplaceWorkspaceWithBodyWithResponse(ctx context.Context, wId string, params *ReplaceWorkspaceParams, contentType string, body io.Reader) (*ReplaceWorkspaceResponse, error)

ReplaceWorkspaceWithBodyWithResponse request with arbitrary body returning *ReplaceWorkspaceResponse

func (*ClientWithResponses) ReplaceWorkspaceWithResponse 

func (c *ClientWithResponses) ReplaceWorkspaceWithResponse(ctx context.Context, wId string, params *ReplaceWorkspaceParams, body ReplaceWorkspaceJSONRequestBody) (*ReplaceWorkspaceResponse, error)

func (*ClientWithResponses) UpdateWorkspaceWithBodyWithResponse 

func (c *ClientWithResponses) UpdateWorkspaceWithBodyWithResponse(ctx context.Context, wId string, params *UpdateWorkspaceParams, contentType string, body io.Reader) (*UpdateWorkspaceResponse, error)

UpdateWorkspaceWithBodyWithResponse request with arbitrary body returning *UpdateWorkspaceResponse

func (*ClientWithResponses) UpdateWorkspaceWithResponse 

func (c *ClientWithResponses) UpdateWorkspaceWithResponse(ctx context.Context, wId string, params *UpdateWorkspaceParams, body UpdateWorkspaceJSONRequestBody) (*UpdateWorkspaceResponse, error)

func (*ClientWithResponses) UploadTemplateTarWithBodyWithResponse 

func (c *ClientWithResponses) UploadTemplateTarWithBodyWithResponse(ctx context.Context, wId string, tId string, params *UploadTemplateTarParams, contentType string, body io.Reader) (*UploadTemplateTarResponse, error)

UploadTemplateTarWithBodyWithResponse request with arbitrary body returning *UploadTemplateTarResponse

type ClientWithResponsesInterface 

type ClientWithResponsesInterface interface {
	// ListSchematicsLocation request
	ListSchematicsLocationWithResponse(ctx context.Context, params *ListSchematicsLocationParams) (*ListSchematicsLocationResponse, error)

	// ListResourceGroup request
	ListResourceGroupWithResponse(ctx context.Context, params *ListResourceGroupParams) (*ListResourceGroupResponse, error)

	// GetSchematicsVersion request
	GetSchematicsVersionWithResponse(ctx context.Context) (*GetSchematicsVersionResponse, error)

	// ListWorkspaces request
	ListWorkspacesWithResponse(ctx context.Context, params *ListWorkspacesParams) (*ListWorkspacesResponse, error)

	// CreateWorkspace request  with any body
	CreateWorkspaceWithBodyWithResponse(ctx context.Context, params *CreateWorkspaceParams, contentType string, body io.Reader) (*CreateWorkspaceResponse, error)

	CreateWorkspaceWithResponse(ctx context.Context, params *CreateWorkspaceParams, body CreateWorkspaceJSONRequestBody) (*CreateWorkspaceResponse, error)

	// DeleteWorkspace request
	DeleteWorkspaceWithResponse(ctx context.Context, wId string, params *DeleteWorkspaceParams) (*DeleteWorkspaceResponse, error)

	// GetWorkspace request
	GetWorkspaceWithResponse(ctx context.Context, wId string, params *GetWorkspaceParams) (*GetWorkspaceResponse, error)

	// UpdateWorkspace request  with any body
	UpdateWorkspaceWithBodyWithResponse(ctx context.Context, wId string, params *UpdateWorkspaceParams, contentType string, body io.Reader) (*UpdateWorkspaceResponse, error)

	UpdateWorkspaceWithResponse(ctx context.Context, wId string, params *UpdateWorkspaceParams, body UpdateWorkspaceJSONRequestBody) (*UpdateWorkspaceResponse, error)

	// ReplaceWorkspace request  with any body
	ReplaceWorkspaceWithBodyWithResponse(ctx context.Context, wId string, params *ReplaceWorkspaceParams, contentType string, body io.Reader) (*ReplaceWorkspaceResponse, error)

	ReplaceWorkspaceWithResponse(ctx context.Context, wId string, params *ReplaceWorkspaceParams, body ReplaceWorkspaceJSONRequestBody) (*ReplaceWorkspaceResponse, error)

	// ListWorkspaceActivities request
	ListWorkspaceActivitiesWithResponse(ctx context.Context, wId string, params *ListWorkspaceActivitiesParams) (*ListWorkspaceActivitiesResponse, error)

	// DeleteWorkspaceActivity request
	DeleteWorkspaceActivityWithResponse(ctx context.Context, wId string, activityId string, params *DeleteWorkspaceActivityParams) (*DeleteWorkspaceActivityResponse, error)

	// GetWorkspaceActivity request
	GetWorkspaceActivityWithResponse(ctx context.Context, wId string, activityId string, params *GetWorkspaceActivityParams) (*GetWorkspaceActivityResponse, error)

	// GetWorkspaceActivityLogs request
	GetWorkspaceActivityLogsWithResponse(ctx context.Context, wId string, activityId string, params *GetWorkspaceActivityLogsParams) (*GetWorkspaceActivityLogsResponse, error)

	// ApplyWorkspaceCommand request  with any body
	ApplyWorkspaceCommandWithBodyWithResponse(ctx context.Context, wId string, params *ApplyWorkspaceCommandParams, contentType string, body io.Reader) (*ApplyWorkspaceCommandResponse, error)

	ApplyWorkspaceCommandWithResponse(ctx context.Context, wId string, params *ApplyWorkspaceCommandParams, body ApplyWorkspaceCommandJSONRequestBody) (*ApplyWorkspaceCommandResponse, error)

	// DestroyWorkspaceCommand request  with any body
	DestroyWorkspaceCommandWithBodyWithResponse(ctx context.Context, wId string, params *DestroyWorkspaceCommandParams, contentType string, body io.Reader) (*DestroyWorkspaceCommandResponse, error)

	DestroyWorkspaceCommandWithResponse(ctx context.Context, wId string, params *DestroyWorkspaceCommandParams, body DestroyWorkspaceCommandJSONRequestBody) (*DestroyWorkspaceCommandResponse, error)

	// GetWorkspaceLogUrls request
	GetWorkspaceLogUrlsWithResponse(ctx context.Context, wId string, params *GetWorkspaceLogUrlsParams) (*GetWorkspaceLogUrlsResponse, error)

	// GetWorkspaceOutputs request
	GetWorkspaceOutputsWithResponse(ctx context.Context, wId string, params *GetWorkspaceOutputsParams) (*GetWorkspaceOutputsResponse, error)

	// PlanWorkspaceCommand request
	PlanWorkspaceCommandWithResponse(ctx context.Context, wId string, params *PlanWorkspaceCommandParams) (*PlanWorkspaceCommandResponse, error)

	// RefreshWorkspaceCommand request
	RefreshWorkspaceCommandWithResponse(ctx context.Context, wId string, params *RefreshWorkspaceCommandParams) (*RefreshWorkspaceCommandResponse, error)

	// GetWorkspaceResources request
	GetWorkspaceResourcesWithResponse(ctx context.Context, wId string, params *GetWorkspaceResourcesParams) (*GetWorkspaceResourcesResponse, error)

	// GetTemplateLogs request
	GetTemplateLogsWithResponse(ctx context.Context, wId string, tId string, params *GetTemplateLogsParams) (*GetTemplateLogsResponse, error)

	// GetTemplateActivityLog request
	GetTemplateActivityLogWithResponse(ctx context.Context, wId string, tId string, activityId string, params *GetTemplateActivityLogParams) (*GetTemplateActivityLogResponse, error)

	// GetWorkspaceTemplateState request
	GetWorkspaceTemplateStateWithResponse(ctx context.Context, wId string, tId string, params *GetWorkspaceTemplateStateParams) (*GetWorkspaceTemplateStateResponse, error)

	// GetWorkspaceState request
	GetWorkspaceStateWithResponse(ctx context.Context, wId string, params *GetWorkspaceStateParams) (*GetWorkspaceStateResponse, error)

	// GetWorkspaceInputs request
	GetWorkspaceInputsWithResponse(ctx context.Context, wId string, tId string, params *GetWorkspaceInputsParams) (*GetWorkspaceInputsResponse, error)

	// ReplaceWorkspaceInputs request  with any body
	ReplaceWorkspaceInputsWithBodyWithResponse(ctx context.Context, wId string, tId string, params *ReplaceWorkspaceInputsParams, contentType string, body io.Reader) (*ReplaceWorkspaceInputsResponse, error)

	ReplaceWorkspaceInputsWithResponse(ctx context.Context, wId string, tId string, params *ReplaceWorkspaceInputsParams, body ReplaceWorkspaceInputsJSONRequestBody) (*ReplaceWorkspaceInputsResponse, error)

	// GetWorkspaceInputMetadata request
	GetWorkspaceInputMetadataWithResponse(ctx context.Context, wId string, tId string, params *GetWorkspaceInputMetadataParams) (*GetWorkspaceInputMetadataResponse, error)

	// GetWorkspaceReadme request
	GetWorkspaceReadmeWithResponse(ctx context.Context, wId string, params *GetWorkspaceReadmeParams) (*GetWorkspaceReadmeResponse, error)

	// GetAllWorkspaceInputs request
	GetAllWorkspaceInputsWithResponse(ctx context.Context, wId string, params *GetAllWorkspaceInputsParams) (*GetAllWorkspaceInputsResponse, error)

	// UploadTemplateTar request  with any body
	UploadTemplateTarWithBodyWithResponse(ctx context.Context, wId string, tId string, params *UploadTemplateTarParams, contentType string, body io.Reader) (*UploadTemplateTarResponse, error)
}

ClientWithResponsesInterface is the interface specification for the client with responses above.

type CreateWorkspaceJSONBody 

type CreateWorkspaceJSONBody WorkspaceCreateRequest

CreateWorkspaceJSONBody defines parameters for CreateWorkspace.

type CreateWorkspaceJSONRequestBody 

type CreateWorkspaceJSONRequestBody CreateWorkspaceJSONBody

CreateWorkspaceRequestBody defines body for CreateWorkspace for application/json ContentType.

type CreateWorkspaceParams 

type CreateWorkspaceParams struct {

	// The IAM access token for your IBM Cloud account. To retrieve the token, you need to create the IAM access token for your IBM Cloud Account. For more information, about creating IAM access token, refer, [Get token password](https://cloud.ibm.com/apidocs/iam-identity-token-api#gettoken-password).
	Authorization string `json:"Authorization"`

	// The personal access token to authenticate with your private GitHub or GitLab repository and access your Terraform template.
	XGithubToken *string `json:"X-Github-token,omitempty"`
}

CreateWorkspaceParams defines parameters for CreateWorkspace.

type CreateWorkspaceResponse 

type CreateWorkspaceResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON201      *WorkspaceResponse
	JSON400      *APIMessagePayload
	JSON401      *APIMessagePayload
	JSON403      *APIMessagePayload
	JSON404      *APIMessagePayload
	JSON409      *APIMessagePayload
	JSON429      *APIMessagePayload
	JSON500      *APIMessagePayload
	JSON503      *APIMessagePayload
}

func ParseCreateWorkspaceResponse 

func ParseCreateWorkspaceResponse(rsp *http.Response) (*CreateWorkspaceResponse, error)

ParseCreateWorkspaceResponse parses an HTTP response from a CreateWorkspaceWithResponse call

func (CreateWorkspaceResponse) Status 

func (r CreateWorkspaceResponse) Status() string

Status returns HTTPResponse.Status

func (CreateWorkspaceResponse) StatusCode 

func (r CreateWorkspaceResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DeleteWorkspaceActivityParams 

type DeleteWorkspaceActivityParams struct {

	// The IAM access token for your IBM Cloud account. To retrieve the token, run `ibmcloud iam oauth-tokens` in the IBM Cloud CLI.
	Authorization string `json:"Authorization"`
}

DeleteWorkspaceActivityParams defines parameters for DeleteWorkspaceActivity.

type DeleteWorkspaceActivityResponse 

type DeleteWorkspaceActivityResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *WorkspaceActivityApplyResult
	JSON400      *APIMessagePayload
	JSON401      *APIMessagePayload
	JSON403      *APIMessagePayload
	JSON404      *APIMessagePayload
	JSON405      *APIMessagePayload
	JSON500      *APIMessagePayload
}

func ParseDeleteWorkspaceActivityResponse 

func ParseDeleteWorkspaceActivityResponse(rsp *http.Response) (*DeleteWorkspaceActivityResponse, error)

ParseDeleteWorkspaceActivityResponse parses an HTTP response from a DeleteWorkspaceActivityWithResponse call

func (DeleteWorkspaceActivityResponse) Status 

func (r DeleteWorkspaceActivityResponse) Status() string

Status returns HTTPResponse.Status

func (DeleteWorkspaceActivityResponse) StatusCode 

func (r DeleteWorkspaceActivityResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DeleteWorkspaceParams 

type DeleteWorkspaceParams struct {

	// 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 *bool `json:"destroyResources,omitempty"`

	// The IAM access token for your IBM Cloud account. To retrieve the token, run `ibmcloud iam oauth-tokens` in the IBM Cloud CLI.
	Authorization string `json:"Authorization"`

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

DeleteWorkspaceParams defines parameters for DeleteWorkspace.

type DeleteWorkspaceResponse 

type DeleteWorkspaceResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *WorkspaceDeleteResponse
	JSON401      *APIMessagePayload
	JSON403      *APIMessagePayload
	JSON409      *APIMessagePayload
	JSON429      *APIMessagePayload
	JSON500      *APIMessagePayload
	JSON503      *APIMessagePayload
}

func ParseDeleteWorkspaceResponse 

func ParseDeleteWorkspaceResponse(rsp *http.Response) (*DeleteWorkspaceResponse, error)

ParseDeleteWorkspaceResponse parses an HTTP response from a DeleteWorkspaceWithResponse call

func (DeleteWorkspaceResponse) Status 

func (r DeleteWorkspaceResponse) Status() string

Status returns HTTPResponse.Status

func (DeleteWorkspaceResponse) StatusCode 

func (r DeleteWorkspaceResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DestroyWorkspaceCommandJSONBody 

type DestroyWorkspaceCommandJSONBody WorkspaceActivityOptions

DestroyWorkspaceCommandJSONBody defines parameters for DestroyWorkspaceCommand.

type DestroyWorkspaceCommandJSONRequestBody 

type DestroyWorkspaceCommandJSONRequestBody DestroyWorkspaceCommandJSONBody

DestroyWorkspaceCommandRequestBody defines body for DestroyWorkspaceCommand for application/json ContentType.

type DestroyWorkspaceCommandParams 

type DestroyWorkspaceCommandParams struct {

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

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

	// The IAM access token for your IBM Cloud account. To retrieve the token, run `ibmcloud iam oauth-tokens` in the IBM Cloud CLI.
	Authorization string `json:"Authorization"`
}

DestroyWorkspaceCommandParams defines parameters for DestroyWorkspaceCommand.

type DestroyWorkspaceCommandResponse 

type DestroyWorkspaceCommandResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON202      *WorkspaceActivityDestroyResult
	JSON401      *APIMessagePayload
	JSON403      *APIMessagePayload
	JSON404      *APIMessagePayload
	JSON409      *APIMessagePayload
	JSON429      *APIMessagePayload
	JSON500      *APIMessagePayload
	JSON503      *APIMessagePayload
}

func ParseDestroyWorkspaceCommandResponse 

func ParseDestroyWorkspaceCommandResponse(rsp *http.Response) (*DestroyWorkspaceCommandResponse, error)

ParseDestroyWorkspaceCommandResponse parses an HTTP response from a DestroyWorkspaceCommandWithResponse call

func (DestroyWorkspaceCommandResponse) Status 

func (r DestroyWorkspaceCommandResponse) Status() string

Status returns HTTPResponse.Status

func (DestroyWorkspaceCommandResponse) StatusCode 

func (r DestroyWorkspaceCommandResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type EnvValueUpdateRequest 

type EnvValueUpdateRequest struct {

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

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

EnvValueUpdateRequest defines model for EnvValueUpdateRequest.

type EnvVariableRequest 

type EnvVariableRequest []map[string]interface{}

EnvVariableRequest defines model for EnvVariableRequest.

type EnvVariableResponse 

type EnvVariableResponse struct {

	// Environment variable is hidden
	Hidden *bool `json:"hidden,omitempty"`

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

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

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

EnvVariableResponse defines model for EnvVariableResponse.

type GetAllWorkspaceInputsParams 

type GetAllWorkspaceInputsParams struct {

	// The IAM access token for your IBM Cloud account. To retrieve the token, run `ibmcloud iam oauth-tokens` in the IBM Cloud CLI.
	Authorization string `json:"Authorization"`
}

GetAllWorkspaceInputsParams defines parameters for GetAllWorkspaceInputs.

type GetAllWorkspaceInputsResponse 

type GetAllWorkspaceInputsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *WorkspaceTemplateValuesResponse
	JSON401      *APIMessagePayload
	JSON403      *APIMessagePayload
	JSON404      *APIMessagePayload
	JSON500      *APIMessagePayload
}

func ParseGetAllWorkspaceInputsResponse 

func ParseGetAllWorkspaceInputsResponse(rsp *http.Response) (*GetAllWorkspaceInputsResponse, error)

ParseGetAllWorkspaceInputsResponse parses an HTTP response from a GetAllWorkspaceInputsWithResponse call

func (GetAllWorkspaceInputsResponse) Status 

func (r GetAllWorkspaceInputsResponse) Status() string

Status returns HTTPResponse.Status

func (GetAllWorkspaceInputsResponse) StatusCode 

func (r GetAllWorkspaceInputsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetSchematicsVersionResponse 

type GetSchematicsVersionResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *VersionResponse
}

func ParseGetSchematicsVersionResponse 

func ParseGetSchematicsVersionResponse(rsp *http.Response) (*GetSchematicsVersionResponse, error)

ParseGetSchematicsVersionResponse parses an HTTP response from a GetSchematicsVersionWithResponse call

func (GetSchematicsVersionResponse) Status 

func (r GetSchematicsVersionResponse) Status() string

Status returns HTTPResponse.Status

func (GetSchematicsVersionResponse) StatusCode 

func (r GetSchematicsVersionResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetTemplateActivityLogParams 

type GetTemplateActivityLogParams struct {

	// 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 *string `json:"log_tf_cmd,omitempty"`

	// Enter `false` to remove all Terraform command prefixes from each Terraform command section of your log output.
	LogTfPrefix *string `json:"log_tf_prefix,omitempty"`

	// Enter `false` to remove any `null_resource` log lines from your log output. This option can be used only if you defined a `null_resource` in your Terraform configuration file.
	LogTfNullResource *string `json:"log_tf_null_resource,omitempty"`

	// Enter `true` to show a new line instead of `\n` for multi-line Ansible logs. This option is available only if you run Ansible code that creates Ansible log output.
	LogTfAnsible *string `json:"log_tf_ansible,omitempty"`

	// The IAM access token for your IBM Cloud account. To retrieve the token, run `ibmcloud iam oauth-tokens` in the IBM Cloud CLI.
	Authorization string `json:"Authorization"`
}

GetTemplateActivityLogParams defines parameters for GetTemplateActivityLog.

type GetTemplateActivityLogResponse 

type GetTemplateActivityLogResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *WorkspaceActivityTemplateLogString
	JSON401      *APIMessagePayload
	JSON403      *APIMessagePayload
	JSON404      *APIMessagePayload
	JSON500      *APIMessagePayload
}

func ParseGetTemplateActivityLogResponse 

func ParseGetTemplateActivityLogResponse(rsp *http.Response) (*GetTemplateActivityLogResponse, error)

ParseGetTemplateActivityLogResponse parses an HTTP response from a GetTemplateActivityLogWithResponse call

func (GetTemplateActivityLogResponse) Status 

func (r GetTemplateActivityLogResponse) Status() string

Status returns HTTPResponse.Status

func (GetTemplateActivityLogResponse) StatusCode 

func (r GetTemplateActivityLogResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetTemplateLogsParams 

type GetTemplateLogsParams struct {

	// 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 *string `json:"log_tf_cmd,omitempty"`

	// Enter `false` to remove all Terraform command prefixes from each Terraform command section of your log output.
	LogTfPrefix *string `json:"log_tf_prefix,omitempty"`

	// Enter `false` to remove any `null_resource` log lines from your log output. This option can be used only if you defined a `null_resource` in your Terraform configuration file.
	LogTfNullResource *string `json:"log_tf_null_resource,omitempty"`

	// Enter `true` to show a new line instead of `
	// ` for multi-line Ansible logs. This option is available only if you run Ansible code that creates Ansible log output.
	LogTfAnsible *string `json:"log_tf_ansible,omitempty"`

	// The IAM access token for your IBM Cloud account. To retrieve the token, run `ibmcloud iam oauth-tokens` in the IBM Cloud CLI.
	Authorization string `json:"Authorization"`
}

GetTemplateLogsParams defines parameters for GetTemplateLogs.

type GetTemplateLogsResponse 

type GetTemplateLogsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *TemplateLogStoreString
	JSON401      *APIMessagePayload
	JSON403      *APIMessagePayload
	JSON404      *APIMessagePayload
	JSON500      *APIMessagePayload
}

func ParseGetTemplateLogsResponse 

func ParseGetTemplateLogsResponse(rsp *http.Response) (*GetTemplateLogsResponse, error)

ParseGetTemplateLogsResponse parses an HTTP response from a GetTemplateLogsWithResponse call

func (GetTemplateLogsResponse) Status 

func (r GetTemplateLogsResponse) Status() string

Status returns HTTPResponse.Status

func (GetTemplateLogsResponse) StatusCode 

func (r GetTemplateLogsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetWorkspaceActivityLogsParams 

type GetWorkspaceActivityLogsParams struct {

	// The IAM access token for your IBM Cloud account. To retrieve the token, run `ibmcloud iam oauth-tokens` in the IBM Cloud CLI.
	Authorization string `json:"Authorization"`
}

GetWorkspaceActivityLogsParams defines parameters for GetWorkspaceActivityLogs.

type GetWorkspaceActivityLogsResponse 

type GetWorkspaceActivityLogsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *WorkspaceActivityLogs
	JSON401      *APIMessagePayload
	JSON403      *APIMessagePayload
	JSON404      *APIMessagePayload
	JSON500      *APIMessagePayload
}

func ParseGetWorkspaceActivityLogsResponse 

func ParseGetWorkspaceActivityLogsResponse(rsp *http.Response) (*GetWorkspaceActivityLogsResponse, error)

ParseGetWorkspaceActivityLogsResponse parses an HTTP response from a GetWorkspaceActivityLogsWithResponse call

func (GetWorkspaceActivityLogsResponse) Status 

func (r GetWorkspaceActivityLogsResponse) Status() string

Status returns HTTPResponse.Status

func (GetWorkspaceActivityLogsResponse) StatusCode 

func (r GetWorkspaceActivityLogsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetWorkspaceActivityParams 

type GetWorkspaceActivityParams struct {

	// The IAM access token for your IBM Cloud account. To retrieve the token, run `ibmcloud iam oauth-tokens` in the IBM Cloud CLI.
	Authorization string `json:"Authorization"`
}

GetWorkspaceActivityParams defines parameters for GetWorkspaceActivity.

type GetWorkspaceActivityResponse 

type GetWorkspaceActivityResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *WorkspaceActivity
	JSON401      *APIMessagePayload
	JSON403      *APIMessagePayload
	JSON404      *APIMessagePayload
	JSON500      *APIMessagePayload
}

func ParseGetWorkspaceActivityResponse 

func ParseGetWorkspaceActivityResponse(rsp *http.Response) (*GetWorkspaceActivityResponse, error)

ParseGetWorkspaceActivityResponse parses an HTTP response from a GetWorkspaceActivityWithResponse call

func (GetWorkspaceActivityResponse) Status 

func (r GetWorkspaceActivityResponse) Status() string

Status returns HTTPResponse.Status

func (GetWorkspaceActivityResponse) StatusCode 

func (r GetWorkspaceActivityResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetWorkspaceInputMetadataParams 

type GetWorkspaceInputMetadataParams struct {

	// The IAM access token for your IBM Cloud account. To retrieve the token, run `ibmcloud iam oauth-tokens` in the IBM Cloud CLI.
	Authorization string `json:"Authorization"`
}

GetWorkspaceInputMetadataParams defines parameters for GetWorkspaceInputMetadata.

type GetWorkspaceInputMetadataResponse 

type GetWorkspaceInputMetadataResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *TemplateMetadata
	JSON401      *APIMessagePayload
	JSON403      *APIMessagePayload
	JSON404      *APIMessagePayload
	JSON500      *APIMessagePayload
}

func ParseGetWorkspaceInputMetadataResponse 

func ParseGetWorkspaceInputMetadataResponse(rsp *http.Response) (*GetWorkspaceInputMetadataResponse, error)

ParseGetWorkspaceInputMetadataResponse parses an HTTP response from a GetWorkspaceInputMetadataWithResponse call

func (GetWorkspaceInputMetadataResponse) Status 

func (r GetWorkspaceInputMetadataResponse) Status() string

Status returns HTTPResponse.Status

func (GetWorkspaceInputMetadataResponse) StatusCode 

func (r GetWorkspaceInputMetadataResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetWorkspaceInputsParams 

type GetWorkspaceInputsParams struct {

	// The IAM access token for your IBM Cloud account. To retrieve the token, run `ibmcloud iam oauth-tokens` in the IBM Cloud CLI.
	Authorization string `json:"Authorization"`
}

GetWorkspaceInputsParams defines parameters for GetWorkspaceInputs.

type GetWorkspaceInputsResponse 

type GetWorkspaceInputsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *TemplateValues
	JSON401      *APIMessagePayload
	JSON403      *APIMessagePayload
	JSON404      *APIMessagePayload
	JSON500      *APIMessagePayload
}

func ParseGetWorkspaceInputsResponse 

func ParseGetWorkspaceInputsResponse(rsp *http.Response) (*GetWorkspaceInputsResponse, error)

ParseGetWorkspaceInputsResponse parses an HTTP response from a GetWorkspaceInputsWithResponse call

func (GetWorkspaceInputsResponse) Status 

func (r GetWorkspaceInputsResponse) Status() string

Status returns HTTPResponse.Status

func (GetWorkspaceInputsResponse) StatusCode 

func (r GetWorkspaceInputsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetWorkspaceLogUrlsParams 

type GetWorkspaceLogUrlsParams struct {

	// The IAM access token for your IBM Cloud account. To retrieve the token, run `ibmcloud iam oauth-tokens` in the IBM Cloud CLI.
	Authorization string `json:"Authorization"`
}

GetWorkspaceLogUrlsParams defines parameters for GetWorkspaceLogUrls.

type GetWorkspaceLogUrlsResponse 

type GetWorkspaceLogUrlsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *LogStoreResponseList
	JSON401      *APIMessagePayload
	JSON403      *APIMessagePayload
	JSON404      *APIMessagePayload
	JSON500      *APIMessagePayload
}

func ParseGetWorkspaceLogUrlsResponse 

func ParseGetWorkspaceLogUrlsResponse(rsp *http.Response) (*GetWorkspaceLogUrlsResponse, error)

ParseGetWorkspaceLogUrlsResponse parses an HTTP response from a GetWorkspaceLogUrlsWithResponse call

func (GetWorkspaceLogUrlsResponse) Status 

func (r GetWorkspaceLogUrlsResponse) Status() string

Status returns HTTPResponse.Status

func (GetWorkspaceLogUrlsResponse) StatusCode 

func (r GetWorkspaceLogUrlsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetWorkspaceOutputsParams 

type GetWorkspaceOutputsParams struct {

	// The IAM access token for your IBM Cloud account. To retrieve the token, run `ibmcloud iam oauth-tokens` in the IBM Cloud CLI.
	Authorization string `json:"Authorization"`
}

GetWorkspaceOutputsParams defines parameters for GetWorkspaceOutputs.

type GetWorkspaceOutputsResponse 

type GetWorkspaceOutputsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *OutputValues
	JSON401      *APIMessagePayload
	JSON403      *APIMessagePayload
	JSON404      *APIMessagePayload
	JSON500      *APIMessagePayload
}

func ParseGetWorkspaceOutputsResponse 

func ParseGetWorkspaceOutputsResponse(rsp *http.Response) (*GetWorkspaceOutputsResponse, error)

ParseGetWorkspaceOutputsResponse parses an HTTP response from a GetWorkspaceOutputsWithResponse call

func (GetWorkspaceOutputsResponse) Status 

func (r GetWorkspaceOutputsResponse) Status() string

Status returns HTTPResponse.Status

func (GetWorkspaceOutputsResponse) StatusCode 

func (r GetWorkspaceOutputsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetWorkspaceParams 

type GetWorkspaceParams struct {

	// The IAM access token for your IBM Cloud account. To retrieve the token, run `ibmcloud iam oauth-tokens` in the IBM Cloud CLI.
	Authorization string `json:"Authorization"`
}

GetWorkspaceParams defines parameters for GetWorkspace.

type GetWorkspaceReadmeParams 

type GetWorkspaceReadmeParams struct {

	// The GitHub or GitLab branch where the `README.md` file is stored, or the commit ID or tag that references the `README.md` file that you want to retrieve. If you do not specify this option, the `README.md` file is retrieved from the master branch by default.
	Ref *string `json:"ref,omitempty"`

	// The IAM access token for your IBM Cloud account. To retrieve the token, run `ibmcloud iam oauth-tokens` in the IBM Cloud CLI.
	Authorization string `json:"Authorization"`
}

GetWorkspaceReadmeParams defines parameters for GetWorkspaceReadme.

type GetWorkspaceReadmeResponse 

type GetWorkspaceReadmeResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *TemplateReadme
	JSON400      *APIMessagePayload
	JSON401      *APIMessagePayload
	JSON403      *APIMessagePayload
	JSON404      *APIMessagePayload
	JSON500      *APIMessagePayload
}

func ParseGetWorkspaceReadmeResponse 

func ParseGetWorkspaceReadmeResponse(rsp *http.Response) (*GetWorkspaceReadmeResponse, error)

ParseGetWorkspaceReadmeResponse parses an HTTP response from a GetWorkspaceReadmeWithResponse call

func (GetWorkspaceReadmeResponse) Status 

func (r GetWorkspaceReadmeResponse) Status() string

Status returns HTTPResponse.Status

func (GetWorkspaceReadmeResponse) StatusCode 

func (r GetWorkspaceReadmeResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetWorkspaceResourcesParams 

type GetWorkspaceResourcesParams struct {

	// The IAM access token for your IBM Cloud account. To retrieve the token, run `ibmcloud iam oauth-tokens` in the IBM Cloud CLI.
	Authorization string `json:"Authorization"`
}

GetWorkspaceResourcesParams defines parameters for GetWorkspaceResources.

type GetWorkspaceResourcesResponse 

type GetWorkspaceResourcesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *TemplateResourcesList
	JSON401      *APIMessagePayload
	JSON403      *APIMessagePayload
	JSON404      *APIMessagePayload
	JSON500      *APIMessagePayload
}

func ParseGetWorkspaceResourcesResponse 

func ParseGetWorkspaceResourcesResponse(rsp *http.Response) (*GetWorkspaceResourcesResponse, error)

ParseGetWorkspaceResourcesResponse parses an HTTP response from a GetWorkspaceResourcesWithResponse call

func (GetWorkspaceResourcesResponse) Status 

func (r GetWorkspaceResourcesResponse) Status() string

Status returns HTTPResponse.Status

func (GetWorkspaceResourcesResponse) StatusCode 

func (r GetWorkspaceResourcesResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetWorkspaceResponse 

type GetWorkspaceResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *WorkspaceResponse
	JSON401      *APIMessagePayload
	JSON403      *APIMessagePayload
	JSON404      *APIMessagePayload
	JSON500      *APIMessagePayload
}

func ParseGetWorkspaceResponse 

func ParseGetWorkspaceResponse(rsp *http.Response) (*GetWorkspaceResponse, error)

ParseGetWorkspaceResponse parses an HTTP response from a GetWorkspaceWithResponse call

func (GetWorkspaceResponse) Status 

func (r GetWorkspaceResponse) Status() string

Status returns HTTPResponse.Status

func (GetWorkspaceResponse) StatusCode 

func (r GetWorkspaceResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetWorkspaceStateParams 

type GetWorkspaceStateParams struct {

	// The IAM access token for your IBM Cloud account. To retrieve the token, run `ibmcloud iam oauth-tokens` in the IBM Cloud CLI.
	Authorization string `json:"Authorization"`
}

GetWorkspaceStateParams defines parameters for GetWorkspaceState.

type GetWorkspaceStateResponse 

type GetWorkspaceStateResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *StateStoreResponseList
	JSON401      *APIMessagePayload
	JSON403      *APIMessagePayload
	JSON404      *APIMessagePayload
	JSON500      *APIMessagePayload
}

func ParseGetWorkspaceStateResponse 

func ParseGetWorkspaceStateResponse(rsp *http.Response) (*GetWorkspaceStateResponse, error)

ParseGetWorkspaceStateResponse parses an HTTP response from a GetWorkspaceStateWithResponse call

func (GetWorkspaceStateResponse) Status 

func (r GetWorkspaceStateResponse) Status() string

Status returns HTTPResponse.Status

func (GetWorkspaceStateResponse) StatusCode 

func (r GetWorkspaceStateResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetWorkspaceTemplateStateParams 

type GetWorkspaceTemplateStateParams struct {

	// The IAM access token for your IBM Cloud account. To retrieve the token, run `ibmcloud iam oauth-tokens` in the IBM Cloud CLI.
	Authorization string `json:"Authorization"`
}

GetWorkspaceTemplateStateParams defines parameters for GetWorkspaceTemplateState.

type GetWorkspaceTemplateStateResponse 

type GetWorkspaceTemplateStateResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *TemplateStateStore
	JSON401      *APIMessagePayload
	JSON403      *APIMessagePayload
	JSON404      *APIMessagePayload
	JSON500      *APIMessagePayload
}

func ParseGetWorkspaceTemplateStateResponse 

func ParseGetWorkspaceTemplateStateResponse(rsp *http.Response) (*GetWorkspaceTemplateStateResponse, error)

ParseGetWorkspaceTemplateStateResponse parses an HTTP response from a GetWorkspaceTemplateStateWithResponse call

func (GetWorkspaceTemplateStateResponse) Status 

func (r GetWorkspaceTemplateStateResponse) Status() string

Status returns HTTPResponse.Status

func (GetWorkspaceTemplateStateResponse) StatusCode 

func (r GetWorkspaceTemplateStateResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type HttpRequestDoer 

type HttpRequestDoer interface {
	Do(req *http.Request) (*http.Response, error)
}

Doer performs HTTP requests.

The standard http.Client implements this interface.

type ListResourceGroupParams 

type ListResourceGroupParams struct {

	// The IAM access token for your IBM Cloud account. To retrieve the token, run `ibmcloud iam oauth-tokens` in the IBM Cloud CLI.
	Authorization string `json:"Authorization"`
}

ListResourceGroupParams defines parameters for ListResourceGroup.

type ListResourceGroupResponse 

type ListResourceGroupResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *[]ResourceGroupResponse
	JSON401      *APIMessagePayload
}

func ParseListResourceGroupResponse 

func ParseListResourceGroupResponse(rsp *http.Response) (*ListResourceGroupResponse, error)

ParseListResourceGroupResponse parses an HTTP response from a ListResourceGroupWithResponse call

func (ListResourceGroupResponse) Status 

func (r ListResourceGroupResponse) Status() string

Status returns HTTPResponse.Status

func (ListResourceGroupResponse) StatusCode 

func (r ListResourceGroupResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListSchematicsLocationParams 

type ListSchematicsLocationParams struct {

	// The IAM access token for your IBM Cloud account. To retrieve the token, run `ibmcloud iam oauth-tokens` in the IBM Cloud CLI.
	Authorization string `json:"Authorization"`
}

ListSchematicsLocationParams defines parameters for ListSchematicsLocation.

type ListSchematicsLocationResponse 

type ListSchematicsLocationResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *[]SchematicsLocations
	JSON401      *APIMessagePayload
}

func ParseListSchematicsLocationResponse 

func ParseListSchematicsLocationResponse(rsp *http.Response) (*ListSchematicsLocationResponse, error)

ParseListSchematicsLocationResponse parses an HTTP response from a ListSchematicsLocationWithResponse call

func (ListSchematicsLocationResponse) Status 

func (r ListSchematicsLocationResponse) Status() string

Status returns HTTPResponse.Status

func (ListSchematicsLocationResponse) StatusCode 

func (r ListSchematicsLocationResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListWorkspaceActivitiesParams 

type ListWorkspaceActivitiesParams struct {

	// The maximum number of actions that you want to include in your response. The number that you enter must be between 1 and 200. If no number is provided, 100 is used by default.
	Limit *int `json:"limit,omitempty"`

	// The position of the action in the list of actions, from which you want to start listing your actions. For example, if you have three actions, the first action is assigned position number 0, the second action is assigned position number 1, and so forth. If you have 6 actions and you want to list the details for actions 2-6, enter 1. To limit the number of actions that is returned, use the `limit` option in addition to the `offset` option. Negative numbers are not supported and are ignored.
	Offset *int `json:"offset,omitempty"`

	// The IAM access token for your IBM Cloud account. To retrieve the token, run `ibmcloud iam oauth-tokens` in the IBM Cloud CLI.
	Authorization string `json:"Authorization"`
}

ListWorkspaceActivitiesParams defines parameters for ListWorkspaceActivities.

type ListWorkspaceActivitiesResponse 

type ListWorkspaceActivitiesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *WorkspaceActivities
	JSON401      *WorkspaceActivities
	JSON403      *APIMessagePayload
	JSON500      *APIMessagePayload
}

func ParseListWorkspaceActivitiesResponse 

func ParseListWorkspaceActivitiesResponse(rsp *http.Response) (*ListWorkspaceActivitiesResponse, error)

ParseListWorkspaceActivitiesResponse parses an HTTP response from a ListWorkspaceActivitiesWithResponse call

func (ListWorkspaceActivitiesResponse) Status 

func (r ListWorkspaceActivitiesResponse) Status() string

Status returns HTTPResponse.Status

func (ListWorkspaceActivitiesResponse) StatusCode 

func (r ListWorkspaceActivitiesResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListWorkspacesParams 

type ListWorkspacesParams struct {

	// The position of the workspace in the list of workspaces, from which you want to start listing your workspaces. 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 *int `json:"offset,omitempty"`

	// The maximum number of workspaces 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 *int `json:"limit,omitempty"`

	// The IAM access token for your IBM Cloud account. To retrieve the token, run `ibmcloud iam oauth-tokens` in the IBM Cloud CLI.
	Authorization string `json:"Authorization"`
}

ListWorkspacesParams defines parameters for ListWorkspaces.

type ListWorkspacesResponse 

type ListWorkspacesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *WorkspaceResponseList
	JSON401      *APIMessagePayload
	JSON403      *APIMessagePayload
	JSON500      *APIMessagePayload
}

func ParseListWorkspacesResponse 

func ParseListWorkspacesResponse(rsp *http.Response) (*ListWorkspacesResponse, error)

ParseListWorkspacesResponse parses an HTTP response from a ListWorkspacesWithResponse call

func (ListWorkspacesResponse) Status 

func (r ListWorkspacesResponse) Status() string

Status returns HTTPResponse.Status

func (ListWorkspacesResponse) StatusCode 

func (r ListWorkspacesResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type LogStoreResponse 

type LogStoreResponse struct {

	// The provisioning engine that was used for the action.
	EngineName *string `json:"engine_name,omitempty"`

	// The version of the provisioning engine that was used for the action.
	EngineVersion *string `json:"engine_version,omitempty"`

	// The ID that was assigned to your Terraform template of IBM Cloud catalog software template.
	Id *string `json:"id,omitempty"`

	// The URL to access the logs that were created during the plan, apply, or destroy action.
	LogStoreUrl *string `json:"log_store_url,omitempty"`
}

LogStoreResponse defines model for LogStoreResponse.

type LogStoreResponseList 

type LogStoreResponseList struct {

	// Runtime data
	RuntimeData *[]LogStoreResponse `json:"runtime_data,omitempty"`
}

LogStoreResponseList defines model for LogStoreResponseList.

type LogSummary 

type LogSummary struct {

	// The status of your action. To retrieve the URL to your action logs, use the `GET /v1/workspaces/{id}/actions/{action_id}/logs` API.
	//
	//
	//  * **COMPLETED**: The action completed successfully.
	// * **CREATED**: The action 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 action. Use the activity ID to retrieve the URL to the log files for your action.
	// * **IN PROGRESS**: The action is in progress. You can use the `log_url` to access the logs.
	ActivityStatus *WorkspaceActivityStatus `json:"activity_status,omitempty"`

	// Template detected type
	DetectedTemplateType *string `json:"detected_template_type,omitempty"`

	// Numner of discarded files
	DiscardedFiles *int64 `json:"discarded_files,omitempty"`

	// Numner of errors in log
	Error *string `json:"error,omitempty"`

	// Numner of resources added
	ResourcesAdded *int64 `json:"resources_added,omitempty"`

	// Numner of resources destroyed
	ResourcesDestroyed *int64 `json:"resources_destroyed,omitempty"`

	// Numner of resources modified
	ResourcesModified *int64 `json:"resources_modified,omitempty"`

	// Numner of filed scanned
	ScannedFiles *int64 `json:"scanned_files,omitempty"`

	// Numner of template variables
	TemplateVariableCount *int64 `json:"template_variable_count,omitempty"`

	// Time takemn to perform activity
	TimeTaken *float64 `json:"time_taken,omitempty"`
}

LogSummary defines model for LogSummary.

type OutputValues 

type OutputValues []OutputValuesInner

OutputValues defines model for OutputValues.

type OutputValuesInner 

type OutputValuesInner struct {

	// The subfolder in the GitHub or GitLab repository where your Terraform template is stored. If the template is stored in the root directory, `.` is returned.
	Folder *string `json:"folder,omitempty"`

	// The ID that was assigned to your Terraform template or IBM Cloud catalog software template.
	Id *string `json:"id,omitempty"`

	// A list of Terraform output values.
	OutputValues *[]map[string]interface{} `json:"output_values,omitempty"`

	// The Terraform version that was used to apply your template.
	ValueType *string `json:"value_type,omitempty"`
}

OutputValuesInner defines model for OutputValues_inner.

type PlanWorkspaceCommandParams 

type PlanWorkspaceCommandParams struct {

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

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

	// The IAM access token for your IBM Cloud account. To retrieve the token, run `ibmcloud iam oauth-tokens` in the IBM Cloud CLI.
	Authorization string `json:"Authorization"`
}

PlanWorkspaceCommandParams defines parameters for PlanWorkspaceCommand.

type PlanWorkspaceCommandResponse 

type PlanWorkspaceCommandResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON202      *WorkspaceActivityPlanResult
	JSON400      *APIMessagePayload
	JSON401      *APIMessagePayload
	JSON403      *APIMessagePayload
	JSON404      *APIMessagePayload
	JSON409      *APIMessagePayload
	JSON500      *APIMessagePayload
	JSON503      *APIMessagePayload
}

func ParsePlanWorkspaceCommandResponse 

func ParsePlanWorkspaceCommandResponse(rsp *http.Response) (*PlanWorkspaceCommandResponse, error)

ParsePlanWorkspaceCommandResponse parses an HTTP response from a PlanWorkspaceCommandWithResponse call

func (PlanWorkspaceCommandResponse) Status 

func (r PlanWorkspaceCommandResponse) Status() string

Status returns HTTPResponse.Status

func (PlanWorkspaceCommandResponse) StatusCode 

func (r PlanWorkspaceCommandResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type RefreshWorkspaceCommandParams 

type RefreshWorkspaceCommandParams struct {

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

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

	// The IAM access token for your IBM Cloud account. To retrieve the token, run `ibmcloud iam oauth-tokens` in the IBM Cloud CLI.
	Authorization string `json:"Authorization"`
}

RefreshWorkspaceCommandParams defines parameters for RefreshWorkspaceCommand.

type RefreshWorkspaceCommandResponse 

type RefreshWorkspaceCommandResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON202      *WorkspaceActivityRefreshResult
	JSON400      *APIMessagePayload
	JSON401      *APIMessagePayload
	JSON403      *APIMessagePayload
	JSON404      *APIMessagePayload
	JSON409      *APIMessagePayload
	JSON500      *APIMessagePayload
}

func ParseRefreshWorkspaceCommandResponse 

func ParseRefreshWorkspaceCommandResponse(rsp *http.Response) (*RefreshWorkspaceCommandResponse, error)

ParseRefreshWorkspaceCommandResponse parses an HTTP response from a RefreshWorkspaceCommandWithResponse call

func (RefreshWorkspaceCommandResponse) Status 

func (r RefreshWorkspaceCommandResponse) Status() string

Status returns HTTPResponse.Status

func (RefreshWorkspaceCommandResponse) StatusCode 

func (r RefreshWorkspaceCommandResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ReplaceWorkspaceInputsJSONBody 

type ReplaceWorkspaceInputsJSONBody UserValuesRequest

ReplaceWorkspaceInputsJSONBody defines parameters for ReplaceWorkspaceInputs.

type ReplaceWorkspaceInputsJSONRequestBody 

type ReplaceWorkspaceInputsJSONRequestBody ReplaceWorkspaceInputsJSONBody

ReplaceWorkspaceInputsRequestBody defines body for ReplaceWorkspaceInputs for application/json ContentType.

type ReplaceWorkspaceInputsParams 

type ReplaceWorkspaceInputsParams struct {

	// The IAM access token for your IBM Cloud account. To retrieve the token, run `ibmcloud iam oauth-tokens` in the IBM Cloud CLI.
	Authorization string `json:"Authorization"`
}

ReplaceWorkspaceInputsParams defines parameters for ReplaceWorkspaceInputs.

type ReplaceWorkspaceInputsResponse 

type ReplaceWorkspaceInputsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *UserValues
	JSON401      *APIMessagePayload
	JSON403      *APIMessagePayload
	JSON404      *APIMessagePayload
	JSON500      *APIMessagePayload
}

func ParseReplaceWorkspaceInputsResponse 

func ParseReplaceWorkspaceInputsResponse(rsp *http.Response) (*ReplaceWorkspaceInputsResponse, error)

ParseReplaceWorkspaceInputsResponse parses an HTTP response from a ReplaceWorkspaceInputsWithResponse call

func (ReplaceWorkspaceInputsResponse) Status 

func (r ReplaceWorkspaceInputsResponse) Status() string

Status returns HTTPResponse.Status

func (ReplaceWorkspaceInputsResponse) StatusCode 

func (r ReplaceWorkspaceInputsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ReplaceWorkspaceJSONBody 

type ReplaceWorkspaceJSONBody WorkspaceUpdateRequest

ReplaceWorkspaceJSONBody defines parameters for ReplaceWorkspace.

type ReplaceWorkspaceJSONRequestBody 

type ReplaceWorkspaceJSONRequestBody ReplaceWorkspaceJSONBody

ReplaceWorkspaceRequestBody defines body for ReplaceWorkspace for application/json ContentType.

type ReplaceWorkspaceParams 

type ReplaceWorkspaceParams struct {

	// The IAM access token for your IBM Cloud account. To retrieve the token, run `ibmcloud iam oauth-tokens` in the IBM Cloud CLI.
	Authorization string `json:"Authorization"`
}

ReplaceWorkspaceParams defines parameters for ReplaceWorkspace.

type ReplaceWorkspaceResponse 

type ReplaceWorkspaceResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *WorkspaceResponse
	JSON401      *APIMessagePayload
	JSON403      *APIMessagePayload
	JSON404      *APIMessagePayload
	JSON409      *APIMessagePayload
	JSON429      *APIMessagePayload
	JSON500      *APIMessagePayload
	JSON503      *APIMessagePayload
}

func ParseReplaceWorkspaceResponse 

func ParseReplaceWorkspaceResponse(rsp *http.Response) (*ReplaceWorkspaceResponse, error)

ParseReplaceWorkspaceResponse parses an HTTP response from a ReplaceWorkspaceWithResponse call

func (ReplaceWorkspaceResponse) Status 

func (r ReplaceWorkspaceResponse) Status() string

Status returns HTTPResponse.Status

func (ReplaceWorkspaceResponse) StatusCode 

func (r ReplaceWorkspaceResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type RequestEditorFn 

type RequestEditorFn func(ctx context.Context, req *http.Request) error

RequestEditorFn is the function signature for the RequestEditor callback function

type ResourceGroupResponse 

type ResourceGroupResponse struct {

	// The ID of the account for which you listed the resource groups.
	AccountId *string `json:"account_id,omitempty"`

	// The CRN of the resource group.
	Crn *string `json:"crn,omitempty"`

	// If set to **true**, the resource group is used as the default resource group for your account. If set to **false**, the resource group is not used as the default resource group in your account.
	Default *bool `json:"default,omitempty"`

	// The name of the resource group.
	Name *string `json:"name,omitempty"`

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

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

ResourceGroupResponse defines model for ResourceGroupResponse.

type SchematicsLocations 

type SchematicsLocations struct {

	// The country where the location is located.
	Country *string `json:"country,omitempty"`

	// The geography that the location belongs to.
	Geography *string `json:"geography,omitempty"`

	// The ID of the location.
	Id *string `json:"id,omitempty"`

	// The kind of location.
	Kind *string `json:"kind,omitempty"`

	// The metro area that the location belongs to.
	Metro *string `json:"metro,omitempty"`

	// The multizone metro area that the location belongs to.
	MultizoneMetro *string `json:"multizone_metro,omitempty"`

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

SchematicsLocations defines model for SchematicsLocations.

type SharedTargetData 

type SharedTargetData struct {

	// Cluster created on
	ClusterCreatedOn *string `json:"cluster_created_on,omitempty"`

	// The ID of the cluster where you want to provision the resources of all IBM Cloud catalog templates that are included in the catalog offering.
	ClusterId *string `json:"cluster_id,omitempty"`

	// Cluster name
	ClusterName *string `json:"cluster_name,omitempty"`

	// Cluster type
	ClusterType *string `json:"cluster_type,omitempty"`

	// The entitlement key that you want to use to install IBM Cloud entitled software.
	EntitlementKeys *[]map[string]interface{} `json:"entitlement_keys,omitempty"`

	// The Kubernetes namespace or OpenShift project where the resources of all IBM Cloud catalog templates that are included in the catalog offering are deployed into.
	Namespace *string `json:"namespace,omitempty"`

	// The IBM Cloud region that you want to use for the resources of all IBM Cloud catalog templates that are included in the catalog offering.
	Region *string `json:"region,omitempty"`

	// The ID of the resource group that you want to use for the resources of all IBM Cloud catalog templates that are included in the catalog offering.
	ResourceGroupId *string `json:"resource_group_id,omitempty"`

	// Cluster worker count
	WorkerCount *int64 `json:"worker_count,omitempty"`

	// Cluster worker type
	WorkerMachineType *string `json:"worker_machine_type,omitempty"`
}

SharedTargetData defines model for SharedTargetData.

type SharedTargetDataResponse 

type SharedTargetDataResponse struct {

	// The ID of the cluster where you want to provision the resources of all IBM Cloud catalog templates that are included in the catalog offering.
	ClusterId *string `json:"cluster_id,omitempty"`

	// Target cluster name
	ClusterName *string `json:"cluster_name,omitempty"`

	// The entitlement key that you want to use to install IBM Cloud entitled software.
	EntitlementKeys *[]map[string]interface{} `json:"entitlement_keys,omitempty"`

	// The Kubernetes namespace or OpenShift project where the resources of all IBM Cloud catalog templates that are included in the catalog offering are deployed into.
	Namespace *string `json:"namespace,omitempty"`

	// The IBM Cloud region that you want to use for the resources of all IBM Cloud catalog templates that are included in the catalog offering.
	Region *string `json:"region,omitempty"`

	// The ID of the resource group that you want to use for the resources of all IBM Cloud catalog templates that are included in the catalog offering.
	ResourceGroupId *string `json:"resource_group_id,omitempty"`
}

SharedTargetDataResponse defines model for SharedTargetDataResponse.

type StateStoreResponse 

type StateStoreResponse struct {

	// The provisioning engine that was used to apply the Terraform template or IBM Cloud catalog software template.
	EngineName *string `json:"engine_name,omitempty"`

	// The version of the provisioning engine that was used.
	EngineVersion *string `json:"engine_version,omitempty"`

	// The ID that was assigned to your Terraform template or IBM Cloud catalog software template.
	Id *string `json:"id,omitempty"`

	// The URL where the Terraform statefile (`terraform.tfstate`) is stored. You can use the statefile to find an overview of IBM Cloud resources that were created by Schematics. Schematics uses the statefile as an inventory list to determine future create, update, or deletion actions.
	StateStoreUrl *string `json:"state_store_url,omitempty"`
}

StateStoreResponse defines model for StateStoreResponse.

type StateStoreResponseList 

type StateStoreResponseList struct {

	// Information about workspace runtime data.
	RuntimeData *[]StateStoreResponse `json:"runtime_data,omitempty"`
}

StateStoreResponseList defines model for StateStoreResponseList.

type StatusMessages 

type StatusMessages []string

StatusMessages defines model for StatusMessages.

type Tags 

type Tags []string

Tags defines model for Tags.

type TemplateData 

type TemplateData []TemplateSourceDataRequest

TemplateData defines model for TemplateData.

type TemplateLogStoreString 

type TemplateLogStoreString string

TemplateLogStoreString defines model for TemplateLogStoreString.

type TemplateMetadata 

type TemplateMetadata []map[string]interface{}

TemplateMetadata defines model for TemplateMetadata.

type TemplateReadme 

type TemplateReadme struct {

	// The `README.md` file for the template that your workspace points to.
	Readme *string `json:"readme,omitempty"`
}

TemplateReadme defines model for TemplateReadme.

type TemplateRepoRequest 

type TemplateRepoRequest struct {

	// The branch in GitHub where your Terraform template is stored.
	Branch *string `json:"branch,omitempty"`

	// The release tag in GitHub of your Terraform template.
	Release *string `json:"release,omitempty"`

	// Repo SHA value
	RepoShaValue *string `json:"repo_sha_value,omitempty"`

	// The URL to the repository where the IBM Cloud catalog software template is stored.
	RepoUrl *string `json:"repo_url,omitempty"`

	// The URL to the GitHub or GitLab repository where your Terraform and public bit bucket template is stored. For more information of the environment variable syntax, see [Create workspace new](/docs/schematics?topic=schematics-schematics-cli-reference#schematics-workspace-new)
	Url *string `json:"url,omitempty"`
}

TemplateRepoRequest defines model for TemplateRepoRequest.

type TemplateRepoResponse 

type TemplateRepoResponse struct {

	// The branch in GitHub where your Terraform template is stored.
	Branch *string `json:"branch,omitempty"`

	// Full repo URL
	FullUrl *string `json:"full_url,omitempty"`

	// Has uploaded git repo tar
	HasUploadedgitrepotar *bool `json:"has_uploadedgitrepotar,omitempty"`

	// The release tag in GitHub of your Terraform template.
	Release *string `json:"release,omitempty"`

	// Repo SHA value
	RepoShaValue *string `json:"repo_sha_value,omitempty"`

	// The URL to the repository where the IBM Cloud catalog software template is stored.
	RepoUrl *string `json:"repo_url,omitempty"`

	// The URL to the GitHub or GitLab repository where your Terraform template is stored.
	Url *string `json:"url,omitempty"`
}

TemplateRepoResponse defines model for TemplateRepoResponse.

type TemplateRepoTarUploadResponse 

type TemplateRepoTarUploadResponse struct {

	// Tar file value
	FileValue *string `json:"file_value,omitempty"`

	// Has received tar file
	HasReceivedFile *bool `json:"has_received_file,omitempty"`

	// Template id
	Id *string `json:"id,omitempty"`
}

TemplateRepoTarUploadResponse defines model for TemplateRepoTarUploadResponse.

type TemplateRepoUpdateRequest 

type TemplateRepoUpdateRequest struct {

	// Repo branch
	Branch *string `json:"branch,omitempty"`

	// Repo release
	Release *string `json:"release,omitempty"`

	// Repo SHA value
	RepoShaValue *string `json:"repo_sha_value,omitempty"`

	// Repo URL
	RepoUrl *string `json:"repo_url,omitempty"`

	// Source URL
	Url *string `json:"url,omitempty"`
}

TemplateRepoUpdateRequest defines model for TemplateRepoUpdateRequest.

type TemplateResource 

type TemplateResource []map[string]interface{}

TemplateResource defines model for TemplateResource.

type TemplateResources 

type TemplateResources struct {

	// The subfolder in GitHub or GitLab where your Terraform templates are stored. If your template is stored in the root directory, `.` is returned.
	Folder *string `json:"folder,omitempty"`

	// The ID that was assigned to your Terraform template or IBM Cloud catalog software template.
	Id *string `json:"id,omitempty"`

	// List of null resources
	NullResources *[]map[string]interface{} `json:"null_resources,omitempty"`

	// Information about the IBM Cloud resources that are associated with your workspace.
	RelatedResources *[]map[string]interface{} `json:"related_resources,omitempty"`

	// Information about the IBM Cloud resources that are associated with your workspace.
	Resources *[]map[string]interface{} `json:"resources,omitempty"`

	// Number of resources
	ResourcesCount *int64 `json:"resources_count,omitempty"`

	// The Terraform version that was used to apply your template.
	TemplateType *string `json:"template_type,omitempty"`
}

TemplateResources defines model for TemplateResources.

type TemplateResourcesList 

type TemplateResourcesList []TemplateResources

TemplateResourcesList defines model for TemplateResourcesList.

type TemplateRunTimeDataResponse 

type TemplateRunTimeDataResponse struct {

	// The command that was used to apply the Terraform template or IBM Cloud catalog software template.
	EngineCmd *string `json:"engine_cmd,omitempty"`

	// The provisioning engine that was used to apply the Terraform template or IBM Cloud catalog software template.
	EngineName *string `json:"engine_name,omitempty"`

	// The version of the provisioning engine that was used.
	EngineVersion *string `json:"engine_version,omitempty"`

	// The ID that was assigned to your Terraform template or IBM Cloud catalog software template.
	Id *string `json:"id,omitempty"`

	// The URL to access the logs that were created during the creation, update, or deletion of your IBM Cloud resources.
	LogStoreUrl *string `json:"log_store_url,omitempty"`

	// List of Output values
	OutputValues *[]map[string]interface{} `json:"output_values,omitempty"`

	// List of resources
	Resources *[]TemplateResource `json:"resources,omitempty"`

	// The URL where the Terraform statefile (`terraform.tfstate`) is stored. You can use the statefile to find an overview of IBM Cloud resources that were created by Schematics. Schematics uses the statefile as an inventory list to determine future create, update, or deletion actions.
	StateStoreUrl *string `json:"state_store_url,omitempty"`
}

TemplateRunTimeDataResponse defines model for TemplateRunTimeDataResponse.

type TemplateSourceDataRequest 

type TemplateSourceDataRequest struct {

	// A list of environment variables that you want to apply during the
	// execution of a bash script. Environment variables must be provided as
	// key value pairs. You can define environment variables  for IBM Cloud
	//  catalog offerings that are provisioned by using a bash script.
	EnvValues *EnvVariableRequest `json:"env_values,omitempty"`

	// The subfolder in your GitHub or GitLab repository where your Terraform template is stored.
	Folder *string `json:"folder,omitempty"`

	// The content of an existing Terraform statefile that you want to import in to your workspace. To get the content of a Terraform statefile for a specific Terraform template in an existing workspace, run `ibmcloud terraform state pull --id <workspace_id> --template <template_id>`.
	InitStateFile *string `json:"init_state_file,omitempty"`

	// The Terraform version that you want to use to run your Terraform code. Enter `terraform_v0.12` to use Terraform version 0.12, and `terraform_v0.11` to use Terraform version 0.11. If no value is specified, the Terraform config files are run with Terraform version 0.11. Make sure that your Terraform config files are compatible with the Terraform version that you select.
	Type *string `json:"type,omitempty"`

	// Uninstall script name
	UninstallScriptName *string `json:"uninstall_script_name,omitempty"`

	// A list of variable values that you want to apply during the Helm chart installation. The list must be provided in JSON format, such as `"autoscaling:
	//   enabled: true
	//   minReplicas: 2"`. The values that you define here override the default Helm chart values. This field is supported only for IBM Cloud catalog offerings that are provisioned by using the Terraform Helm provider.
	Values *string `json:"values,omitempty"`

	// List of values metadata
	ValuesMetadata *[]map[string]interface{} `json:"values_metadata,omitempty"`

	// VariablesRequest -
	Variablestore *VariablesRequest `json:"variablestore,omitempty"`
}

TemplateSourceDataRequest defines model for TemplateSourceDataRequest.

type TemplateSourceDataResponse 

type TemplateSourceDataResponse struct {

	// List of environment values
	EnvValues *[]EnvVariableResponse `json:"env_values,omitempty"`

	// The subfolder in your GitHub or GitLab repository where your Terraform template is stored. If your template is stored in the root directory, `.` is returned.
	Folder *string `json:"folder,omitempty"`

	// Has github token
	HasGithubtoken *bool `json:"has_githubtoken,omitempty"`

	// The ID that was assigned to your Terraform template or IBM Cloud catalog software template.
	Id *string `json:"id,omitempty"`

	// The Terraform version that was used to run your Terraform code.
	TemplateType *string `json:"template_type,omitempty"`

	// Uninstall script name
	UninstallScriptName *string `json:"uninstall_script_name,omitempty"`

	// A list of variable values that you want to apply during the Helm chart installation. The list must be provided in JSON format, such as `""autoscaling:
	//   enabled: true
	//   minReplicas: 2"`. The values that you define here override the default Helm chart values. This field is supported only for IBM Cloud catalog offerings that are provisioned by using the Terraform Helm provider.
	Values *string `json:"values,omitempty"`

	// A list of input variables that are associated with the workspace.
	ValuesMetadata *[]map[string]interface{} `json:"values_metadata,omitempty"`

	// The API endpoint to access the input variables that you defined for your template.
	ValuesUrl *string `json:"values_url,omitempty"`

	// Information about the input variables that your template uses.
	Variablestore *VariablesResponse `json:"variablestore,omitempty"`
}

TemplateSourceDataResponse defines model for TemplateSourceDataResponse.

type TemplateStateStore 

type TemplateStateStore struct {
	Lineage          *string                   `json:"lineage,omitempty"`
	Modules          *[]map[string]interface{} `json:"modules,omitempty"`
	Serial           *float32                  `json:"serial,omitempty"`
	TerraformVersion *string                   `json:"terraform_version,omitempty"`
	Version          *float32                  `json:"version,omitempty"`
}

TemplateStateStore defines model for TemplateStateStore.

type TemplateValues 

type TemplateValues struct {
	ValuesMetadata *[]map[string]interface{} `json:"values_metadata,omitempty"`
}

TemplateValues defines model for TemplateValues.

type UpdateWorkspaceJSONBody 

type UpdateWorkspaceJSONBody WorkspaceUpdateRequest

UpdateWorkspaceJSONBody defines parameters for UpdateWorkspace.

type UpdateWorkspaceJSONRequestBody 

type UpdateWorkspaceJSONRequestBody UpdateWorkspaceJSONBody

UpdateWorkspaceRequestBody defines body for UpdateWorkspace for application/json ContentType.

type UpdateWorkspaceParams 

type UpdateWorkspaceParams struct {

	// The IAM access token for your IBM Cloud account. To retrieve the token, run `ibmcloud iam oauth-tokens` in the IBM Cloud CLI.
	Authorization string `json:"Authorization"`
}

UpdateWorkspaceParams defines parameters for UpdateWorkspace.

type UpdateWorkspaceResponse 

type UpdateWorkspaceResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *WorkspaceResponse
	JSON401      *APIMessagePayload
	JSON403      *APIMessagePayload
	JSON404      *APIMessagePayload
	JSON409      *APIMessagePayload
	JSON429      *APIMessagePayload
	JSON500      *APIMessagePayload
	JSON503      *APIMessagePayload
}

func ParseUpdateWorkspaceResponse 

func ParseUpdateWorkspaceResponse(rsp *http.Response) (*UpdateWorkspaceResponse, error)

ParseUpdateWorkspaceResponse parses an HTTP response from a UpdateWorkspaceWithResponse call

func (UpdateWorkspaceResponse) Status 

func (r UpdateWorkspaceResponse) Status() string

Status returns HTTPResponse.Status

func (UpdateWorkspaceResponse) StatusCode 

func (r UpdateWorkspaceResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type UploadTemplateTarParams 

type UploadTemplateTarParams struct {

	// The IAM access token for your IBM Cloud account. To retrieve the token, run `ibmcloud iam oauth-tokens` in the IBM Cloud CLI.
	Authorization string `json:"Authorization"`
}

UploadTemplateTarParams defines parameters for UploadTemplateTar.

type UploadTemplateTarResponse 

type UploadTemplateTarResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *TemplateRepoTarUploadResponse
	JSON400      *APIMessagePayload
	JSON401      *APIMessagePayload
	JSON403      *APIMessagePayload
	JSON404      *APIMessagePayload
	JSON500      *APIMessagePayload
}

func ParseUploadTemplateTarResponse 

func ParseUploadTemplateTarResponse(rsp *http.Response) (*UploadTemplateTarResponse, error)

ParseUploadTemplateTarResponse parses an HTTP response from a UploadTemplateTarWithResponse call

func (UploadTemplateTarResponse) Status 

func (r UploadTemplateTarResponse) Status() string

Status returns HTTPResponse.Status

func (UploadTemplateTarResponse) StatusCode 

func (r UploadTemplateTarResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type UserValues 

type UserValues struct {

	// EnvVariableResponse -
	EnvValues *EnvVariableResponse `json:"env_values,omitempty"`

	// A list of variable values that you want to apply during the Helm chart installation. The list must be provided in JSON format, such as `"autoscaling:
	//   enabled: true
	//   minReplicas: 2"`. The values that you define here override the default Helm chart values. This field is supported only for IBM Cloud catalog offerings that are provisioned by using the Terraform Helm provider.
	Values *string `json:"values,omitempty"`

	// Information about the input variables that your template uses.
	Variablestore *VariablesResponse `json:"variablestore,omitempty"`
}

UserValues defines model for UserValues.

type UserValuesRequest 

type UserValuesRequest struct {

	// List of environment variables to update
	EnvValues *[]EnvValueUpdateRequest `json:"env_values,omitempty"`

	// User values
	Values *string `json:"values,omitempty"`

	// VariablesUpdateRequest - for updating tf variables in put /values api
	Variablestore *VariablesUpdateRequest `json:"variablestore,omitempty"`
}

UserValuesRequest defines model for UserValuesRequest.

type VariablesRequest 

type VariablesRequest []WorkspaceVariableRequest

VariablesRequest defines model for VariablesRequest.

type VariablesResponse 

type VariablesResponse []WorkspaceVariableRequest

VariablesResponse defines model for VariablesResponse.

type VariablesUpdateRequest 

type VariablesUpdateRequest []WorkspaceVariableUpdateRequest

VariablesUpdateRequest defines model for VariablesUpdateRequest.

type VersionResponse 

type VersionResponse struct {

	// The date when the API version was built.
	Builddate *string `json:"builddate,omitempty"`

	// The build number that the API is based on.
	Buildno *string `json:"buildno,omitempty"`

	// The SHA value for the Git commit that represents the latest version of the API.
	Commitsha *string `json:"commitsha,omitempty"`

	// The Terraform Helm provider version that is used when you install Helm charts with Schematics.
	HelmProviderVersion *string `json:"helm_provider_version,omitempty"`

	// The Helm version that is used when you install Helm charts with Schematics.
	HelmVersion *string `json:"helm_version,omitempty"`

	// Supported template types
	SupportedTemplateTypes *[]map[string]interface{} `json:"supported_template_types,omitempty"`

	// The version of the IBM Cloud Terraform provider plug-in that is used when you apply Terraform templates with Schematics.
	TerraformProviderVersion *string `json:"terraform_provider_version,omitempty"`

	// The Terraform version that is used when you apply Terraform templates with Schematics.
	TerraformVersion *string `json:"terraform_version,omitempty"`
}

VersionResponse defines model for VersionResponse.

type WorkspaceActivities 

type WorkspaceActivities struct {

	// List of workspace activities
	Actions *[]WorkspaceActivity `json:"actions,omitempty"`

	// The ID of the workspace.
	WorkspaceId *string `json:"workspace_id,omitempty"`

	// The name of the workspace.
	WorkspaceName *string `json:"workspace_name,omitempty"`
}

WorkspaceActivities defines model for WorkspaceActivities.

type WorkspaceActivity 

type WorkspaceActivity struct {

	// The ID of the action. You can use the ID to retrieve the URL to the logs for that action by using the `GET /v1/workspaces/{id}/actions/{action_id}/logs` API.
	ActionId *string `json:"action_id,omitempty"`

	// Information about the success or failure of your action, including a success or error code and the timestamp when the action succeeded or failed.
	Message *StatusMessages `json:"message,omitempty"`

	// The type of action that ran against your workspace.
	//
	//
	//  * **APPLY**: The apply action was created when you used the `PUT /v1/workspaces/{id}/apply` API to apply a Terraform template in IBM Cloud.
	//  * **DESTROY**: The destroy action was created when you used the `DELETE /v1/workspaces/{id}/destroy` API to remove all resources that are associated with your workspace.
	//  * **PLAN**: The plan action was created when you used the `POST /v1/workspaces/{id}/plan` API to create a Terraform execution plan.
	Name *WorkspaceActivityAction `json:"name,omitempty"`

	// The timestamp when the action was initiated.
	PerformedAt *time.Time `json:"performed_at,omitempty"`

	// The user ID who initiated the action.
	PerformedBy *string `json:"performed_by,omitempty"`

	// The status of your action. To retrieve the URL to your action logs, use the `GET /v1/workspaces/{id}/actions/{action_id}/logs` API.
	//
	//
	//  * **COMPLETED**: The action completed successfully.
	// * **CREATED**: The action 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 action. Use the activity ID to retrieve the URL to the log files for your action.
	// * **IN PROGRESS**: The action is in progress. You can use the `log_url` to access the logs.
	Status *WorkspaceActivityStatus `json:"status,omitempty"`

	// List of template activities
	Templates *[]WorkspaceActivityTemplate `json:"templates,omitempty"`
}

WorkspaceActivity defines model for WorkspaceActivity.

type WorkspaceActivityAction 

type WorkspaceActivityAction string

WorkspaceActivityAction defines model for WorkspaceActivityAction.

type WorkspaceActivityApplyResult 

type WorkspaceActivityApplyResult struct {

	// The ID of the activity that was created when you initiated a request to apply a Terraform template. You can use the ID to retrieve the URL to your log file by using the `GET /v1/workspaces/{id}/actions/{action_id}/logs` API.
	Activityid *string `json:"activityid,omitempty"`
}

WorkspaceActivityApplyResult defines model for WorkspaceActivityApplyResult.

type WorkspaceActivityDestroyResult 

type WorkspaceActivityDestroyResult struct {

	// The ID of the activity that was created for your IBM Cloud resource removal action. You can use the ID to retrieve the URL to your log file by using the `GET /v1/workspaces/{id}/actions/{action_id}/logs` API.
	Activityid *string `json:"activityid,omitempty"`
}

WorkspaceActivityDestroyResult defines model for WorkspaceActivityDestroyResult.

type WorkspaceActivityLogs 

type WorkspaceActivityLogs struct {

	// The ID of the action that ran against your workspace.
	ActionId *string `json:"action_id,omitempty"`

	// The type of action that ran against your workspace.
	//
	//
	//  * **APPLY**: The apply action was created when you used the `PUT /v1/workspaces/{id}/apply` API to apply a Terraform template in IBM Cloud.
	//  * **DESTROY**: The destroy action was created when you used the `DELETE /v1/workspaces/{id}/destroy` API to remove all resources that are associated with your workspace.
	//  * **PLAN**: The plan action was created when you used the `POST /v1/workspaces/{id}/plan` API to create a Terraform execution plan.
	Name *WorkspaceActivityAction `json:"name,omitempty"`

	// List of activity logs
	Templates *[]WorkspaceActivityTemplateLogs `json:"templates,omitempty"`
}

WorkspaceActivityLogs defines model for WorkspaceActivityLogs.

type WorkspaceActivityOptions 

type WorkspaceActivityOptions struct {

	// The resources to target.
	ActionOptions *WorkspaceActivityOptionsTemplate `json:"action_options,omitempty"`
}

WorkspaceActivityOptions defines model for WorkspaceActivityOptions.

type WorkspaceActivityOptionsTemplate 

type WorkspaceActivityOptionsTemplate struct {

	// A list of Terraform resource addresses to target.
	Target *[]string `json:"target,omitempty"`

	// Action tfvars
	TfVars *[]string `json:"tf_vars,omitempty"`
}

WorkspaceActivityOptionsTemplate defines model for WorkspaceActivityOptionsTemplate.

type WorkspaceActivityPlanResult 

type WorkspaceActivityPlanResult struct {

	// The ID of the activity that ran against the workspace. This activity can be a `PLAN`, `APPLY`, or `DESTROY` action. You use the activity ID to retrieve the log URL with the `GET /v1/workspaces/{id}/actions/{action_id}/logs` API.
	Activityid *string `json:"activityid,omitempty"`
}

WorkspaceActivityPlanResult defines model for WorkspaceActivityPlanResult.

type WorkspaceActivityRefreshResult 

type WorkspaceActivityRefreshResult struct {

	// The ID of the activity that was created for your workspace refresh action. You can use the ID to retrieve the URL to your log file by using the `GET /v1/workspaces/{id}/actions/{action_id}/logs` API.
	Activityid *string `json:"activityid,omitempty"`
}

WorkspaceActivityRefreshResult defines model for WorkspaceActivityRefreshResult.

type WorkspaceActivityStatus 

type WorkspaceActivityStatus string

WorkspaceActivityStatus defines model for WorkspaceActivityStatus.

type WorkspaceActivityTemplate 

type WorkspaceActivityTemplate struct {

	// The timestamp when the action completed or failed.
	EndTime *time.Time `json:"end_time,omitempty"`

	// LogSummary ...
	LogSummary *LogSummary `json:"log_summary,omitempty"`

	// The URL to access the logs that were created during the plan, apply, or destroy action.
	LogUrl *string `json:"log_url,omitempty"`

	// Information about the success or failure of your action, including a success or error code and the timestamp when the action succeeded or failed.
	Message *string `json:"message,omitempty"`

	// The timestamp when the action started.
	StartTime *time.Time `json:"start_time,omitempty"`

	// The status of your action. To retrieve the URL to your action logs, use the `GET /v1/workspaces/{id}/actions/{action_id}/logs` API.
	//
	//
	//  * **COMPLETED**: The action completed successfully.
	// * **CREATED**: The action 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 action. Use the activity ID to retrieve the URL to the log files for your action.
	// * **IN PROGRESS**: The action is in progress. You can use the `log_url` to access the logs.
	Status *WorkspaceActivityStatus `json:"status,omitempty"`

	// The ID that was assigned to your Terraform template or IBM Cloud catalog software template.
	TemplateId *string `json:"template_id,omitempty"`

	// The type of template.
	TemplateType *string `json:"template_type,omitempty"`
}

WorkspaceActivityTemplate defines model for WorkspaceActivityTemplate.

type WorkspaceActivityTemplateLogString 

type WorkspaceActivityTemplateLogString string

WorkspaceActivityTemplateLogString defines model for WorkspaceActivityTemplateLogString.

type WorkspaceActivityTemplateLogs 

type WorkspaceActivityTemplateLogs struct {

	// The URL to access the logs that were created during the plan, apply, or destroy action.
	LogUrl *string `json:"log_url,omitempty"`

	// The ID that was assigned to your Terraform template or IBM Cloud catalog software template.
	TemplateId *string `json:"template_id,omitempty"`

	// The type of template.
	TemplateType *string `json:"template_type,omitempty"`
}

WorkspaceActivityTemplateLogs defines model for WorkspaceActivityTemplateLogs.

type WorkspaceCreateRequest 

type WorkspaceCreateRequest struct {

	// List of applied shared dataset id
	AppliedShareddataIds *[]string `json:"applied_shareddata_ids,omitempty"`

	// Information about the software template that you chose from the IBM Cloud catalog. This information is returned for IBM Cloud catalog offerings only.
	CatalogRef *CatalogRef `json:"catalog_ref,omitempty"`

	// The description of the workspace.
	Description *string `json:"description,omitempty"`

	// The location where you want to create your Schematics workspace and run Schematics actions. The location that you enter must match the API endpoint that you use. For example, if you use the Frankfurt API endpoint, you must specify `eu-de` as your location. If you use an API endpoint for a geography and you do not specify a location, Schematics determines the location based on availability.
	Location *string `json:"location,omitempty"`

	// The name of your workspace. The name can be up to 128 characters long and can include alphanumeric characters, spaces, dashes, and underscores. When you create a workspace for your own Terraform template, consider including the microservice component that you set up with your Terraform template and the IBM Cloud environment where you want to deploy your resources in your name.
	Name *string `json:"name,omitempty"`

	// The ID of the resource group where you want to provision the workspace.
	ResourceGroup *string `json:"resource_group,omitempty"`

	// Information that is shared across templates in IBM Cloud catalog offerings. This information is not provided when you create a workspace from your own Terraform template.
	SharedData *SharedTargetData `json:"shared_data,omitempty"`

	// A list of tags that are associated with the workspace.
	Tags *[]string `json:"tags,omitempty"`

	// TemplateData -
	TemplateData *TemplateData `json:"template_data,omitempty"`

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

	// Input parameter to specify the source repository where your Schematics template is stored.
	TemplateRepo *TemplateRepoRequest `json:"template_repo,omitempty"`

	// The Terraform version that you want to use to run your Terraform code. Enter `terraform_v0.12` to use Terraform version 0.12, and `terraform_v0.11` to use Terraform version 0.11. If no value is specified, the Terraform config files are run with Terraform version 0.11. Make sure that your Terraform config files are compatible with the Terraform version that you select.
	Type *[]string `json:"type,omitempty"`

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

WorkspaceCreateRequest defines model for WorkspaceCreateRequest.

type WorkspaceDeleteResponse 

type WorkspaceDeleteResponse string

WorkspaceDeleteResponse defines model for WorkspaceDeleteResponse.

type WorkspaceResponse 

type WorkspaceResponse struct {

	// List of applied shared dataset id
	AppliedShareddataIds *[]string `json:"applied_shareddata_ids,omitempty"`

	// Information about the software template that you chose from the IBM Cloud catalog. This information is returned for IBM Cloud catalog offerings only.
	CatalogRef *CatalogRef `json:"catalog_ref,omitempty"`

	// The timestamp when the workspace was created.
	CreatedAt *time.Time `json:"created_at,omitempty"`

	// The user ID that created the workspace.
	CreatedBy *string `json:"created_by,omitempty"`

	// Workspace CRN
	Crn *string `json:"crn,omitempty"`

	// The description of the workspace.
	Description *string `json:"description,omitempty"`

	// The unique identifier of the workspace.
	Id *string `json:"id,omitempty"`

	// The timestamp when the last health check was performed by Schematics.
	LastHealthCheckAt *time.Time `json:"last_health_check_at,omitempty"`

	// The IBM Cloud location where your workspace was provisioned.
	Location *string `json:"location,omitempty"`

	// The name of the workspace.
	Name *string `json:"name,omitempty"`

	// The resource group the workspace was provisioned in.
	ResourceGroup *string `json:"resource_group,omitempty"`

	// Information about the provisioning engine, state file, and runtime logs.
	RuntimeData *[]TemplateRunTimeDataResponse `json:"runtime_data,omitempty"`

	// Information that is shared across templates in IBM Cloud catalog offerings. This information is not provided when you create a workspace from your own Terraform template.
	SharedData *SharedTargetDataResponse `json:"shared_data,omitempty"`

	// The status of the workspace.
	//
	//  **Active**: After you successfully ran your infrastructure code by applying your Terraform execution plan, the state of your workspace changes to `Active`.
	//
	//  **Connecting**: Schematics tries to connect to the template in your source repo. If successfully connected, the template is downloaded and metadata, such as input parameters, is extracted. After the template is downloaded, the state of the workspace changes to `Scanning`.
	//
	//  **Draft**: The workspace is created without a reference to a GitHub or GitLab repository.
	//
	//  **Failed**: If errors occur during the execution of your infrastructure code in IBM Cloud Schematics, your workspace status is set to `Failed`.
	//
	//  **Inactive**: The Terraform template was scanned successfully and the workspace creation is complete. You can now start running Schematics plan and apply actions to provision the IBM Cloud resources that you specified in your template. If you have an `Active` workspace and decide to remove all your resources, your workspace is set to `Inactive` after all your resources are removed.
	//
	//  **In progress**: When you instruct IBM Cloud Schematics to run your infrastructure code by applying your Terraform execution plan, the status of our workspace changes to `In progress`.
	//
	//  **Scanning**: The download of the Terraform template is complete and vulnerability scanning started. If the scan is successful, the workspace state changes to `Inactive`. If errors in your template are found, the state changes to `Template Error`.
	//
	//  **Stopped**: The Schematics plan, apply, or destroy action was cancelled manually.
	//
	//  **Template Error**: The Schematics template contains errors and cannot be processed.
	Status *WorkspaceStatus `json:"status,omitempty"`

	// A list of tags that are associated with the workspace.
	Tags *[]string `json:"tags,omitempty"`

	// Information about the Terraform or IBM Cloud software template that you want to use.
	TemplateData *[]TemplateSourceDataResponse `json:"template_data,omitempty"`

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

	// Information about the Terraform template that your workspace points to.
	TemplateRepo *TemplateRepoResponse `json:"template_repo,omitempty"`

	// The Terraform version that was used to run your Terraform code.
	Type *[]string `json:"type,omitempty"`

	// The timestamp when the workspace was last updated.
	UpdatedAt *time.Time `json:"updated_at,omitempty"`

	// The user ID that updated the workspace.
	UpdatedBy *string `json:"updated_by,omitempty"`

	// Response parameter that indicate if a workspace is frozen or locked.
	WorkspaceStatus *WorkspaceStatusResponse `json:"workspace_status,omitempty"`

	// Information about the last action that ran against the workspace.
	WorkspaceStatusMsg *WorkspaceStatusMessage `json:"workspace_status_msg,omitempty"`
}

WorkspaceResponse defines model for WorkspaceResponse.

type WorkspaceResponseList 

type WorkspaceResponseList struct {

	// The number of workspaces in the IBM Cloud account that you have access to and that matched your search criteria.
	Count *int64 `json:"count,omitempty"`

	// The `limit` value that you set in your API request and that represents the maximum number of workspaces that you wanted to list.
	Limit int64 `json:"limit"`

	// The `offset` value that you set in your API request. The offset value represents the position number of the workspace from which you wanted to start listing your workspaces.
	Offset int64 `json:"offset"`

	// The list of workspaces that was included in your API response.
	Workspaces *[]WorkspaceResponse `json:"workspaces,omitempty"`
}

WorkspaceResponseList defines model for WorkspaceResponseList.

type WorkspaceStatus 

type WorkspaceStatus string

WorkspaceStatus defines model for WorkspaceStatus.

type WorkspaceStatusMessage 

type WorkspaceStatusMessage struct {

	// The success or error code that was returned for the last plan, apply, or destroy action that ran against your workspace.
	StatusCode *string `json:"status_code,omitempty"`

	// The success or error message that was returned for the last plan, apply, or destroy action that ran against your workspace.
	StatusMsg *string `json:"status_msg,omitempty"`
}

WorkspaceStatusMessage defines model for WorkspaceStatusMessage.

type WorkspaceStatusRequest 

type WorkspaceStatusRequest struct {

	// If set to true, the workspace is frozen and changes to the workspace are disabled.
	Frozen *bool `json:"frozen,omitempty"`

	// The timestamp when the workspace was frozen.
	FrozenAt *time.Time `json:"frozen_at,omitempty"`

	// The user ID that froze the workspace.
	FrozenBy *string `json:"frozen_by,omitempty"`

	// If set to true, the workspace is locked and disabled for changes.
	Locked *bool `json:"locked,omitempty"`

	// The user ID that initiated a resource-related action, such as applying or destroying resources, that locked the workspace.
	LockedBy *string `json:"locked_by,omitempty"`

	// The timestamp when the workspace was locked.
	LockedTime *time.Time `json:"locked_time,omitempty"`
}

WorkspaceStatusRequest defines model for WorkspaceStatusRequest.

type WorkspaceStatusResponse 

type WorkspaceStatusResponse struct {

	// If set to true, the workspace is frozen and changes to the workspace are disabled.
	Frozen *bool `json:"frozen,omitempty"`

	// The timestamp when the workspace was frozen.
	FrozenAt *time.Time `json:"frozen_at,omitempty"`

	// The user ID that froze the workspace.
	FrozenBy *string `json:"frozen_by,omitempty"`

	// If set to true, the workspace is locked and disabled for changes.
	Locked *bool `json:"locked,omitempty"`

	// The user ID that initiated a resource-related action, such as applying or destroying resources, that locked the workspace.
	LockedBy *string `json:"locked_by,omitempty"`

	// The timestamp when the workspace was locked.
	LockedTime *time.Time `json:"locked_time,omitempty"`
}

WorkspaceStatusResponse defines model for WorkspaceStatusResponse.

type WorkspaceStatusUpdateRequest 

type WorkspaceStatusUpdateRequest struct {

	// If set to true, the workspace is frozen and changes to the workspace are disabled.
	Frozen *bool `json:"frozen,omitempty"`

	// Frozen at
	FrozenAt *time.Time `json:"frozen_at,omitempty"`

	// Frozen by
	FrozenBy *string `json:"frozen_by,omitempty"`

	// Locked status
	Locked *bool `json:"locked,omitempty"`

	// Locked by
	LockedBy *string `json:"locked_by,omitempty"`

	// Locked at
	LockedTime *time.Time `json:"locked_time,omitempty"`
}

WorkspaceStatusUpdateRequest defines model for WorkspaceStatusUpdateRequest.

type WorkspaceTemplateValuesResponse 

type WorkspaceTemplateValuesResponse struct {

	// Information about the provisioning engine, state file, and runtime logs.
	RuntimeData *[]TemplateRunTimeDataResponse `json:"runtime_data,omitempty"`

	// Information that is shared across templates in IBM Cloud catalog offerings. This information is not provided when you create a workspace from your own Terraform template.
	SharedData *SharedTargetData `json:"shared_data,omitempty"`

	// Information about the input variables that are used in the template.
	TemplateData *[]TemplateSourceDataResponse `json:"template_data,omitempty"`
}

WorkspaceTemplateValuesResponse defines model for WorkspaceTemplateValuesResponse.

type WorkspaceUpdateRequest 

type WorkspaceUpdateRequest struct {

	// Information about the software template that you chose from the IBM Cloud catalog. This information is returned for IBM Cloud catalog offerings only.
	CatalogRef *CatalogRef `json:"catalog_ref,omitempty"`

	// The description of the workspace.
	Description *string `json:"description,omitempty"`

	// The name of the workspace.
	Name *string `json:"name,omitempty"`

	// Information that is shared across templates in IBM Cloud catalog offerings. This information is not provided when you create a workspace from your own Terraform template.
	SharedData *SharedTargetData `json:"shared_data,omitempty"`

	// A list of tags that you want to associate with your workspace.
	Tags *Tags `json:"tags,omitempty"`

	// TemplateData -
	TemplateData *TemplateData `json:"template_data,omitempty"`

	// TemplateRepoUpdateRequest -
	TemplateRepo *TemplateRepoUpdateRequest `json:"template_repo,omitempty"`

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

	// Information about the updated workspace status.
	WorkspaceStatus *WorkspaceStatusUpdateRequest `json:"workspace_status,omitempty"`

	// Information about the last action that ran against the workspace.
	WorkspaceStatusMsg *WorkspaceStatusMessage `json:"workspace_status_msg,omitempty"`
}

WorkspaceUpdateRequest defines model for WorkspaceUpdateRequest.

type WorkspaceVariableRequest 

type WorkspaceVariableRequest struct {

	// The description of your input variable.
	Description *string `json:"description,omitempty"`

	// The name of the variable.
	Name *string `json:"name,omitempty"`

	// If set to `true`, the value of your input variable is protected and not returned in your API response.
	Secure *bool `json:"secure,omitempty"`

	// `Terraform v0.11` supports `string`, `list`, `map` data type. For more information, about the syntax, see [Configuring input variables](https://www.terraform.io/docs/configuration-0-11/variables.html). <br> `Terraform v0.12` additionally, supports `bool`, `number` and complex data types such as `list(type)`, `map(type)`, `object({attribute name=type,..})`, `set(type)`, `tuple([type])`. For more information, about the syntax to use the complex data type, see [Configuring variables](https://www.terraform.io/docs/configuration/variables.html#type-constraints).
	Type *string `json:"type,omitempty"`

	// Enter the value as a string for the primitive types such as `bool`, `number`, `string`, and `HCL` format for the complex variables, as you provide in a `.tfvars` file. **You need to enter escaped string of `HCL` format for the complex variable value**. For more information, about how to declare variables in a terraform configuration file and provide value to schematics, see [Providing values for the declared variables](/docs/schematics?topic=schematics-create-tf-config#declare-variable).
	Value *string `json:"value,omitempty"`
}

WorkspaceVariableRequest defines model for WorkspaceVariableRequest.

type WorkspaceVariableUpdateRequest 

type WorkspaceVariableUpdateRequest struct {

	// The description of your input variable.
	Description *string `json:"description,omitempty"`

	// The name of the variable.
	Name *string `json:"name,omitempty"`

	// If set to `true`, the value of your input variable is protected and not returned in your API response.
	Secure *bool `json:"secure,omitempty"`

	// `Terraform v0.11` supports `string`, `list`, `map` data type. For more information, about the syntax, see [Configuring input variables](https://www.terraform.io/docs/configuration-0-11/variables.html). <br> `Terraform v0.12` additionally, supports `bool`, `number` and complex data types such as `list(type)`, `map(type)`, `object({attribute name=type,..})`, `set(type)`, `tuple([type])`. For more information, about the syntax to use the complex data type, see [Configuring variables](https://www.terraform.io/docs/configuration/variables.html#type-constraints).
	Type *string `json:"type,omitempty"`

	// If set to true, you are removing the overridden variable value from the .tfvars file. The next time plan or apply is executed, the default value for the variable in the Terraform template is used.
	UseDefault *bool `json:"use_default,omitempty"`

	// Enter the value as a string for the primitive types such as `bool`, `number`, `string`, and `HCL` format for the complex variables, as you provide in a `.tfvars` file. **You need to enter escaped string of `HCL` format for the complex variable value**. For more information, about how to declare variables in a terraform configuration file and provide value to schematics, see [Providing values for the declared variables](/docs/schematics?topic=schematics-create-tf-config#declare-variable).
	Value *string `json:"value,omitempty"`
}

WorkspaceVariableUpdateRequest defines model for WorkspaceVariableUpdateRequest.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.