cdtoolchainv2

package
v1.0.0 Latest Latest
Warning

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

 Go to latest Published: Sep 5, 2022 License: Apache-2.0 Imports: 10 Imported by: 2

Documentation

Overview

Package cdtoolchainv2 : Operations and models for the CdToolchainV2 service

Index

Constants

View Source 
const (
	GetToolByIDResponseStateConfiguredConst    = "configured"
	GetToolByIDResponseStateConfiguringConst   = "configuring"
	GetToolByIDResponseStateMisconfiguredConst = "misconfigured"
	GetToolByIDResponseStateUnconfiguredConst  = "unconfigured"
)

Constants associated with the GetToolByIDResponse.State property. Current configuration state of the tool.

View Source 
const (
	PostToolResponseStateConfiguredConst    = "configured"
	PostToolResponseStateConfiguringConst   = "configuring"
	PostToolResponseStateMisconfiguredConst = "misconfigured"
	PostToolResponseStateUnconfiguredConst  = "unconfigured"
)

Constants associated with the PostToolResponse.State property. Current configuration state of the tool.

View Source 
const (
	ToolStateConfiguredConst    = "configured"
	ToolStateConfiguringConst   = "configuring"
	ToolStateMisconfiguredConst = "misconfigured"
	ToolStateUnconfiguredConst  = "unconfigured"
)

Constants associated with the Tool.State property. Current configuration state of the tool.

View Source 
const DefaultServiceName = "cd_toolchain"

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

View Source 
const DefaultServiceURL = "https://api.us-south.devops.cloud.ibm.com"

DefaultServiceURL is the default URL to make service requests to.

Variables

This section is empty.

Functions

func GetServiceURLForRegion 

func GetServiceURLForRegion(region string) (string, error)

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

func UnmarshalGetToolByIDResponse added in v0.0.3 

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

UnmarshalGetToolByIDResponse unmarshals an instance of GetToolByIDResponse from the specified map of raw messages.

func UnmarshalGetToolchainByIDResponse 

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

UnmarshalGetToolchainByIDResponse unmarshals an instance of GetToolchainByIDResponse from the specified map of raw messages.

func UnmarshalGetToolchainsResponse 

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

UnmarshalGetToolchainsResponse unmarshals an instance of GetToolchainsResponse from the specified map of raw messages.

func UnmarshalGetToolchainsResponseFirst 

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

UnmarshalGetToolchainsResponseFirst unmarshals an instance of GetToolchainsResponseFirst from the specified map of raw messages.

func UnmarshalGetToolchainsResponseLast 

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

UnmarshalGetToolchainsResponseLast unmarshals an instance of GetToolchainsResponseLast from the specified map of raw messages.

func UnmarshalGetToolchainsResponseNext 

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

UnmarshalGetToolchainsResponseNext unmarshals an instance of GetToolchainsResponseNext from the specified map of raw messages.

func UnmarshalGetToolchainsResponsePrevious 

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

UnmarshalGetToolchainsResponsePrevious unmarshals an instance of GetToolchainsResponsePrevious from the specified map of raw messages.

func UnmarshalGetToolsResponse added in v0.0.3 

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

UnmarshalGetToolsResponse unmarshals an instance of GetToolsResponse from the specified map of raw messages.

func UnmarshalGetToolsResponseFirst added in v0.0.3 

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

UnmarshalGetToolsResponseFirst unmarshals an instance of GetToolsResponseFirst from the specified map of raw messages.

func UnmarshalGetToolsResponseLast added in v0.0.3 

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

UnmarshalGetToolsResponseLast unmarshals an instance of GetToolsResponseLast from the specified map of raw messages.

func UnmarshalGetToolsResponseNext added in v0.0.3 

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

UnmarshalGetToolsResponseNext unmarshals an instance of GetToolsResponseNext from the specified map of raw messages.

func UnmarshalGetToolsResponsePrevious added in v0.0.3 

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

UnmarshalGetToolsResponsePrevious unmarshals an instance of GetToolsResponsePrevious from the specified map of raw messages.

func UnmarshalPostToolResponse added in v0.0.3 

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

UnmarshalPostToolResponse unmarshals an instance of PostToolResponse from the specified map of raw messages.

func UnmarshalPostToolchainResponse 

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

UnmarshalPostToolchainResponse unmarshals an instance of PostToolchainResponse from the specified map of raw messages.

func UnmarshalReferent 

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

UnmarshalReferent unmarshals an instance of Referent from the specified map of raw messages.

func UnmarshalTool added in v0.0.3 

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

UnmarshalTool unmarshals an instance of Tool from the specified map of raw messages.

func UnmarshalToolReferent added in v0.0.3 

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

UnmarshalToolReferent unmarshals an instance of ToolReferent from the specified map of raw messages.

func UnmarshalToolchain 

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

UnmarshalToolchain unmarshals an instance of Toolchain from the specified map of raw messages.

Types

type CdToolchainV2 

type CdToolchainV2 struct {
	Service *core.BaseService
}

CdToolchainV2 : This swagger document describes the options and endpoints of the Toolchain API.<br><br> All calls require an <strong>Authorization</strong> HTTP header to be set with a bearer token, which can be generated using the <a href="https://cloud.ibm.com/apidocs/iam-identity-token-api">Identity and Access Management (IAM) API</a>.<br><br>Note that all resources must have a corresponding <b>resource_group_id</b> to use the API, resources within a Cloud Foundry organization cannot be accessed or modified using the API.

API Version: 2.0.0

func NewCdToolchainV2 

func NewCdToolchainV2(options *CdToolchainV2Options) (service *CdToolchainV2, err error)

NewCdToolchainV2 : constructs an instance of CdToolchainV2 with passed in options.

func NewCdToolchainV2UsingExternalConfig 

func NewCdToolchainV2UsingExternalConfig(options *CdToolchainV2Options) (cdToolchain *CdToolchainV2, err error)

NewCdToolchainV2UsingExternalConfig : constructs an instance of CdToolchainV2 with passed in options and external configuration.

func (*CdToolchainV2) Clone 

func (cdToolchain *CdToolchainV2) Clone() *CdToolchainV2

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

func (*CdToolchainV2) CreateTool added in v0.0.3 

func (cdToolchain *CdToolchainV2) CreateTool(createToolOptions *CreateToolOptions) (result *PostToolResponse, response *core.DetailedResponse, err error)

CreateTool : Create a tool Provisions a new tool based off of provided parameters in the POST body and binds it to the specified toolchain.

func (*CdToolchainV2) CreateToolWithContext added in v0.0.3 

func (cdToolchain *CdToolchainV2) CreateToolWithContext(ctx context.Context, createToolOptions *CreateToolOptions) (result *PostToolResponse, response *core.DetailedResponse, err error)

CreateToolWithContext is an alternate form of the CreateTool method which supports a Context parameter

func (*CdToolchainV2) CreateToolchain 

func (cdToolchain *CdToolchainV2) CreateToolchain(createToolchainOptions *CreateToolchainOptions) (result *PostToolchainResponse, response *core.DetailedResponse, err error)

CreateToolchain : Create a toolchain Creates a new toolchain based off of provided parameters in the POST body.

func (*CdToolchainV2) CreateToolchainWithContext 

func (cdToolchain *CdToolchainV2) CreateToolchainWithContext(ctx context.Context, createToolchainOptions *CreateToolchainOptions) (result *PostToolchainResponse, response *core.DetailedResponse, err error)

CreateToolchainWithContext is an alternate form of the CreateToolchain method which supports a Context parameter

func (*CdToolchainV2) DeleteTool added in v0.0.3 

func (cdToolchain *CdToolchainV2) DeleteTool(deleteToolOptions *DeleteToolOptions) (response *core.DetailedResponse, err error)

DeleteTool : Delete a tool Delete the tool with the specified ID.

func (*CdToolchainV2) DeleteToolWithContext added in v0.0.3 

func (cdToolchain *CdToolchainV2) DeleteToolWithContext(ctx context.Context, deleteToolOptions *DeleteToolOptions) (response *core.DetailedResponse, err error)

DeleteToolWithContext is an alternate form of the DeleteTool method which supports a Context parameter

func (*CdToolchainV2) DeleteToolchain 

func (cdToolchain *CdToolchainV2) DeleteToolchain(deleteToolchainOptions *DeleteToolchainOptions) (response *core.DetailedResponse, err error)

DeleteToolchain : Delete a toolchain Delete the toolchain with the specified ID.

func (*CdToolchainV2) DeleteToolchainWithContext 

func (cdToolchain *CdToolchainV2) DeleteToolchainWithContext(ctx context.Context, deleteToolchainOptions *DeleteToolchainOptions) (response *core.DetailedResponse, err error)

DeleteToolchainWithContext is an alternate form of the DeleteToolchain method which supports a Context parameter

func (*CdToolchainV2) DisableRetries 

func (cdToolchain *CdToolchainV2) DisableRetries()

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

func (*CdToolchainV2) EnableRetries 

func (cdToolchain *CdToolchainV2) EnableRetries(maxRetries int, maxRetryInterval time.Duration)

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

func (*CdToolchainV2) GetEnableGzipCompression 

func (cdToolchain *CdToolchainV2) GetEnableGzipCompression() bool

GetEnableGzipCompression returns the service's EnableGzipCompression field

func (*CdToolchainV2) GetServiceURL 

func (cdToolchain *CdToolchainV2) GetServiceURL() string

GetServiceURL returns the service URL

func (*CdToolchainV2) GetToolByID added in v0.0.3 

func (cdToolchain *CdToolchainV2) GetToolByID(getToolByIDOptions *GetToolByIDOptions) (result *GetToolByIDResponse, response *core.DetailedResponse, err error)

GetToolByID : Fetch a tool Returns a tool that is bound to the provided toolchain.

func (*CdToolchainV2) GetToolByIDWithContext added in v0.0.3 

func (cdToolchain *CdToolchainV2) GetToolByIDWithContext(ctx context.Context, getToolByIDOptions *GetToolByIDOptions) (result *GetToolByIDResponse, response *core.DetailedResponse, err error)

GetToolByIDWithContext is an alternate form of the GetToolByID method which supports a Context parameter

func (*CdToolchainV2) GetToolchainByID 

func (cdToolchain *CdToolchainV2) GetToolchainByID(getToolchainByIDOptions *GetToolchainByIDOptions) (result *GetToolchainByIDResponse, response *core.DetailedResponse, err error)

GetToolchainByID : Fetch a toolchain Returns data for a single toolchain identified by id.

func (*CdToolchainV2) GetToolchainByIDWithContext 

func (cdToolchain *CdToolchainV2) GetToolchainByIDWithContext(ctx context.Context, getToolchainByIDOptions *GetToolchainByIDOptions) (result *GetToolchainByIDResponse, response *core.DetailedResponse, err error)

GetToolchainByIDWithContext is an alternate form of the GetToolchainByID method which supports a Context parameter

func (*CdToolchainV2) ListToolchains 

func (cdToolchain *CdToolchainV2) ListToolchains(listToolchainsOptions *ListToolchainsOptions) (result *GetToolchainsResponse, response *core.DetailedResponse, err error)

ListToolchains : Returns a list of toolchains Returns a list of toolchains that the caller is authorized to access and that meet the provided query parameters.

func (*CdToolchainV2) ListToolchainsWithContext 

func (cdToolchain *CdToolchainV2) ListToolchainsWithContext(ctx context.Context, listToolchainsOptions *ListToolchainsOptions) (result *GetToolchainsResponse, response *core.DetailedResponse, err error)

ListToolchainsWithContext is an alternate form of the ListToolchains method which supports a Context parameter

func (*CdToolchainV2) ListTools added in v0.0.3 

func (cdToolchain *CdToolchainV2) ListTools(listToolsOptions *ListToolsOptions) (result *GetToolsResponse, response *core.DetailedResponse, err error)

ListTools : Returns a list of tools bound to toolchain Returns a list of tools bound to toolchain that the caller is authorized to access and that meet the provided query parameters.

func (*CdToolchainV2) ListToolsWithContext added in v0.0.3 

func (cdToolchain *CdToolchainV2) ListToolsWithContext(ctx context.Context, listToolsOptions *ListToolsOptions) (result *GetToolsResponse, response *core.DetailedResponse, err error)

ListToolsWithContext is an alternate form of the ListTools method which supports a Context parameter

func (*CdToolchainV2) NewCreateToolOptions added in v0.0.3 

func (*CdToolchainV2) NewCreateToolOptions(toolchainID string, toolTypeID string) *CreateToolOptions

NewCreateToolOptions : Instantiate CreateToolOptions

func (*CdToolchainV2) NewCreateToolchainOptions 

func (*CdToolchainV2) NewCreateToolchainOptions(name string, resourceGroupID string) *CreateToolchainOptions

NewCreateToolchainOptions : Instantiate CreateToolchainOptions

func (*CdToolchainV2) NewDeleteToolOptions added in v0.0.3 

func (*CdToolchainV2) NewDeleteToolOptions(toolchainID string, toolID string) *DeleteToolOptions

NewDeleteToolOptions : Instantiate DeleteToolOptions

func (*CdToolchainV2) NewDeleteToolchainOptions 

func (*CdToolchainV2) NewDeleteToolchainOptions(toolchainID string) *DeleteToolchainOptions

NewDeleteToolchainOptions : Instantiate DeleteToolchainOptions

func (*CdToolchainV2) NewGetToolByIDOptions added in v0.0.3 

func (*CdToolchainV2) NewGetToolByIDOptions(toolchainID string, toolID string) *GetToolByIDOptions

NewGetToolByIDOptions : Instantiate GetToolByIDOptions

func (*CdToolchainV2) NewGetToolchainByIDOptions 

func (*CdToolchainV2) NewGetToolchainByIDOptions(toolchainID string) *GetToolchainByIDOptions

NewGetToolchainByIDOptions : Instantiate GetToolchainByIDOptions

func (*CdToolchainV2) NewListToolchainsOptions 

func (*CdToolchainV2) NewListToolchainsOptions(resourceGroupID string) *ListToolchainsOptions

NewListToolchainsOptions : Instantiate ListToolchainsOptions

func (*CdToolchainV2) NewListToolsOptions added in v0.0.3 

func (*CdToolchainV2) NewListToolsOptions(toolchainID string) *ListToolsOptions

NewListToolsOptions : Instantiate ListToolsOptions

func (*CdToolchainV2) NewUpdateToolOptions added in v0.0.3 

func (*CdToolchainV2) NewUpdateToolOptions(toolchainID string, toolID string) *UpdateToolOptions

NewUpdateToolOptions : Instantiate UpdateToolOptions

func (*CdToolchainV2) NewUpdateToolchainOptions 

func (*CdToolchainV2) NewUpdateToolchainOptions(toolchainID string) *UpdateToolchainOptions

NewUpdateToolchainOptions : Instantiate UpdateToolchainOptions

func (*CdToolchainV2) SetDefaultHeaders 

func (cdToolchain *CdToolchainV2) SetDefaultHeaders(headers http.Header)

SetDefaultHeaders sets HTTP headers to be sent in every request

func (*CdToolchainV2) SetEnableGzipCompression 

func (cdToolchain *CdToolchainV2) SetEnableGzipCompression(enableGzip bool)

SetEnableGzipCompression sets the service's EnableGzipCompression field

func (*CdToolchainV2) SetServiceURL 

func (cdToolchain *CdToolchainV2) SetServiceURL(url string) error

SetServiceURL sets the service URL

func (*CdToolchainV2) UpdateTool added in v0.0.3 

func (cdToolchain *CdToolchainV2) UpdateTool(updateToolOptions *UpdateToolOptions) (response *core.DetailedResponse, err error)

UpdateTool : Update a tool Update the tool with the specified ID.

func (*CdToolchainV2) UpdateToolWithContext added in v0.0.3 

func (cdToolchain *CdToolchainV2) UpdateToolWithContext(ctx context.Context, updateToolOptions *UpdateToolOptions) (response *core.DetailedResponse, err error)

UpdateToolWithContext is an alternate form of the UpdateTool method which supports a Context parameter

func (*CdToolchainV2) UpdateToolchain 

func (cdToolchain *CdToolchainV2) UpdateToolchain(updateToolchainOptions *UpdateToolchainOptions) (response *core.DetailedResponse, err error)

UpdateToolchain : Update a toolchain Update the toolchain with the specified ID.

func (*CdToolchainV2) UpdateToolchainWithContext 

func (cdToolchain *CdToolchainV2) UpdateToolchainWithContext(ctx context.Context, updateToolchainOptions *UpdateToolchainOptions) (response *core.DetailedResponse, err error)

UpdateToolchainWithContext is an alternate form of the UpdateToolchain method which supports a Context parameter

type CdToolchainV2Options 

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

CdToolchainV2Options : Service options

type CreateToolOptions added in v0.0.3 

type CreateToolOptions struct {
	// ID of the toolchain to bind tool to.
	ToolchainID *string `json:"toolchain_id" validate:"required,ne="`

	// The unique short name of the tool that should be provisioned.
	ToolTypeID *string `json:"tool_type_id" validate:"required"`

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

	// Parameters to be used to create the tool.
	Parameters map[string]interface{} `json:"parameters,omitempty"`

	// Decoded values used on provision in the broker that reference fields in the parameters.
	ParametersReferences map[string]interface{} `json:"parameters_references,omitempty"`

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

CreateToolOptions : The CreateTool options.

func (*CreateToolOptions) SetHeaders added in v0.0.3 

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

SetHeaders : Allow user to set Headers

func (*CreateToolOptions) SetName added in v0.0.3 

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

SetName : Allow user to set Name

func (*CreateToolOptions) SetParameters added in v0.0.3 

func (_options *CreateToolOptions) SetParameters(parameters map[string]interface{}) *CreateToolOptions

SetParameters : Allow user to set Parameters

func (*CreateToolOptions) SetParametersReferences added in v0.0.3 

func (_options *CreateToolOptions) SetParametersReferences(parametersReferences map[string]interface{}) *CreateToolOptions

SetParametersReferences : Allow user to set ParametersReferences

func (*CreateToolOptions) SetToolTypeID added in v0.0.3 

func (_options *CreateToolOptions) SetToolTypeID(toolTypeID string) *CreateToolOptions

SetToolTypeID : Allow user to set ToolTypeID

func (*CreateToolOptions) SetToolchainID added in v0.0.3 

func (_options *CreateToolOptions) SetToolchainID(toolchainID string) *CreateToolOptions

SetToolchainID : Allow user to set ToolchainID

type CreateToolchainOptions 

type CreateToolchainOptions struct {
	// Toolchain name.
	Name *string `json:"name" validate:"required"`

	// Resource group where toolchain will be created.
	ResourceGroupID *string `json:"resource_group_id" validate:"required"`

	// Describes the toolchain.
	Description *string `json:"description,omitempty"`

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

CreateToolchainOptions : The CreateToolchain options.

func (*CreateToolchainOptions) SetDescription 

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

SetDescription : Allow user to set Description

func (*CreateToolchainOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*CreateToolchainOptions) SetName 

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

SetName : Allow user to set Name

func (*CreateToolchainOptions) SetResourceGroupID 

func (_options *CreateToolchainOptions) SetResourceGroupID(resourceGroupID string) *CreateToolchainOptions

SetResourceGroupID : Allow user to set ResourceGroupID

type DeleteToolOptions added in v0.0.3 

type DeleteToolOptions struct {
	// ID of the toolchain.
	ToolchainID *string `json:"toolchain_id" validate:"required,ne="`

	// ID of the tool bound to the toolchain.
	ToolID *string `json:"tool_id" validate:"required,ne="`

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

DeleteToolOptions : The DeleteTool options.

func (*DeleteToolOptions) SetHeaders added in v0.0.3 

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

SetHeaders : Allow user to set Headers

func (*DeleteToolOptions) SetToolID added in v0.0.3 

func (_options *DeleteToolOptions) SetToolID(toolID string) *DeleteToolOptions

SetToolID : Allow user to set ToolID

func (*DeleteToolOptions) SetToolchainID added in v0.0.3 

func (_options *DeleteToolOptions) SetToolchainID(toolchainID string) *DeleteToolOptions

SetToolchainID : Allow user to set ToolchainID

type DeleteToolchainOptions 

type DeleteToolchainOptions struct {
	// ID of the toolchain.
	ToolchainID *string `json:"toolchain_id" validate:"required,ne="`

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

DeleteToolchainOptions : The DeleteToolchain options.

func (*DeleteToolchainOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*DeleteToolchainOptions) SetToolchainID 

func (_options *DeleteToolchainOptions) SetToolchainID(toolchainID string) *DeleteToolchainOptions

SetToolchainID : Allow user to set ToolchainID

type GetToolByIDOptions added in v0.0.3 

type GetToolByIDOptions struct {
	// ID of the toolchain.
	ToolchainID *string `json:"toolchain_id" validate:"required,ne="`

	// ID of the tool bound to the toolchain.
	ToolID *string `json:"tool_id" validate:"required,ne="`

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

GetToolByIDOptions : The GetToolByID options.

func (*GetToolByIDOptions) SetHeaders added in v0.0.3 

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

SetHeaders : Allow user to set Headers

func (*GetToolByIDOptions) SetToolID added in v0.0.3 

func (_options *GetToolByIDOptions) SetToolID(toolID string) *GetToolByIDOptions

SetToolID : Allow user to set ToolID

func (*GetToolByIDOptions) SetToolchainID added in v0.0.3 

func (_options *GetToolByIDOptions) SetToolchainID(toolchainID string) *GetToolByIDOptions

SetToolchainID : Allow user to set ToolchainID

type GetToolByIDResponse added in v0.0.3 

type GetToolByIDResponse struct {
	// Tool ID.
	ID *string `json:"id" validate:"required"`

	// Resource group where tool can be found.
	ResourceGroupID *string `json:"resource_group_id" validate:"required"`

	// Tool CRN.
	CRN *string `json:"crn" validate:"required"`

	// The unique name of the provisioned tool.
	ToolTypeID *string `json:"tool_type_id" validate:"required"`

	// ID of toolchain which the tool is bound to.
	ToolchainID *string `json:"toolchain_id" validate:"required"`

	// CRN of toolchain which the tool is bound to.
	ToolchainCRN *string `json:"toolchain_crn" validate:"required"`

	// URI representing the tool.
	Href *string `json:"href" validate:"required"`

	// Information on URIs to access this resource through the UI or API.
	Referent *ToolReferent `json:"referent" validate:"required"`

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

	// Latest tool update timestamp.
	UpdatedAt *strfmt.DateTime `json:"updated_at" validate:"required"`

	// Parameters to be used to create the tool.
	Parameters map[string]interface{} `json:"parameters" validate:"required"`

	// Current configuration state of the tool.
	State *string `json:"state" validate:"required"`
}

GetToolByIDResponse : Response structure for GET tool.

type GetToolchainByIDOptions 

type GetToolchainByIDOptions struct {
	// ID of the toolchain.
	ToolchainID *string `json:"toolchain_id" validate:"required,ne="`

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

GetToolchainByIDOptions : The GetToolchainByID options.

func (*GetToolchainByIDOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*GetToolchainByIDOptions) SetToolchainID 

func (_options *GetToolchainByIDOptions) SetToolchainID(toolchainID string) *GetToolchainByIDOptions

SetToolchainID : Allow user to set ToolchainID

type GetToolchainByIDResponse 

type GetToolchainByIDResponse struct {
	// Toolchain ID.
	ID *string `json:"id" validate:"required"`

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

	// Toolchain description.
	Description *string `json:"description" validate:"required"`

	// Account ID where toolchain can be found.
	AccountID *string `json:"account_id" validate:"required"`

	// Toolchain region.
	Location *string `json:"location" validate:"required"`

	// Resource group where toolchain can be found.
	ResourceGroupID *string `json:"resource_group_id" validate:"required"`

	// Toolchain CRN.
	CRN *string `json:"crn" validate:"required"`

	// URI that can be used to retrieve toolchain.
	Href *string `json:"href" validate:"required"`

	// Toolchain creation timestamp.
	CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"`

	// Latest toolchain update timestamp.
	UpdatedAt *strfmt.DateTime `json:"updated_at" validate:"required"`

	// Identity that created the toolchain.
	CreatedBy *string `json:"created_by" validate:"required"`

	// Tags associated with the toolchain.
	Tags []string `json:"tags" validate:"required"`
}

GetToolchainByIDResponse : Response structure for GET toolchains.

type GetToolchainsResponse 

type GetToolchainsResponse struct {
	// Maximum number of toolchains returned from collection.
	Limit *int64 `json:"limit" validate:"required"`

	// Offset applied to toolchains collection.
	Offset *int64 `json:"offset" validate:"required"`

	// Total number of toolchains found in collection.
	TotalCount *int64 `json:"total_count" validate:"required"`

	// Information about retrieving first toolchain results from the collection.
	First *GetToolchainsResponseFirst `json:"first" validate:"required"`

	// Information about retrieving previous toolchain results from the collection.
	Previous *GetToolchainsResponsePrevious `json:"previous,omitempty"`

	// Information about retrieving next toolchain results from the collection.
	Next *GetToolchainsResponseNext `json:"next,omitempty"`

	// Information about retrieving last toolchain results from the collection.
	Last *GetToolchainsResponseLast `json:"last" validate:"required"`

	// Toolchain results returned from the collection.
	Toolchains []Toolchain `json:"toolchains" validate:"required"`
}

GetToolchainsResponse : Response structure for GET toolchains.

func (*GetToolchainsResponse) GetNextOffset 

func (resp *GetToolchainsResponse) GetNextOffset() (*int64, error)

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

type GetToolchainsResponseFirst 

type GetToolchainsResponseFirst struct {
	// URI that can be used to get first results from the collection.
	Href *string `json:"href,omitempty"`
}

GetToolchainsResponseFirst : Information about retrieving first toolchain results from the collection.

type GetToolchainsResponseLast 

type GetToolchainsResponseLast struct {
	// URI that can be used to get last results from the collection.
	Href *string `json:"href,omitempty"`
}

GetToolchainsResponseLast : Information about retrieving last toolchain results from the collection.

type GetToolchainsResponseNext 

type GetToolchainsResponseNext struct {
	// URI that can be used to get next results from the collection.
	Href *string `json:"href,omitempty"`
}

GetToolchainsResponseNext : Information about retrieving next toolchain results from the collection.

type GetToolchainsResponsePrevious 

type GetToolchainsResponsePrevious struct {
	// URI that can be used to get previous results from the collection.
	Href *string `json:"href,omitempty"`
}

GetToolchainsResponsePrevious : Information about retrieving previous toolchain results from the collection.

type GetToolsResponse added in v0.0.3 

type GetToolsResponse struct {
	// Maximum number of tools returned from collection.
	Limit *int64 `json:"limit" validate:"required"`

	// Offset applied to tools collection.
	Offset *int64 `json:"offset" validate:"required"`

	// Total number of tools found in collection.
	TotalCount *int64 `json:"total_count" validate:"required"`

	// Information about retrieving first tool results from the collection.
	First *GetToolsResponseFirst `json:"first" validate:"required"`

	// Information about retrieving previous tool results from the collection.
	Previous *GetToolsResponsePrevious `json:"previous,omitempty"`

	// Information about retrieving next tool results from the collection.
	Next *GetToolsResponseNext `json:"next,omitempty"`

	// Information about retrieving last tool results from the collection.
	Last *GetToolsResponseLast `json:"last" validate:"required"`

	// Tool results returned from the collection.
	Tools []Tool `json:"tools" validate:"required"`
}

GetToolsResponse : Response structure for GET tools.

func (*GetToolsResponse) GetNextOffset added in v0.0.3 

func (resp *GetToolsResponse) GetNextOffset() (*int64, error)

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

type GetToolsResponseFirst added in v0.0.3 

type GetToolsResponseFirst struct {
	// URI that can be used to get first results from the collection.
	Href *string `json:"href,omitempty"`
}

GetToolsResponseFirst : Information about retrieving first tool results from the collection.

type GetToolsResponseLast added in v0.0.3 

type GetToolsResponseLast struct {
	// URI that can be used to get last results from the collection.
	Href *string `json:"href,omitempty"`
}

GetToolsResponseLast : Information about retrieving last tool results from the collection.

type GetToolsResponseNext added in v0.0.3 

type GetToolsResponseNext struct {
	// URI that can be used to get next results from the collection.
	Href *string `json:"href,omitempty"`
}

GetToolsResponseNext : Information about retrieving next tool results from the collection.

type GetToolsResponsePrevious added in v0.0.3 

type GetToolsResponsePrevious struct {
	// URI that can be used to get previous results from the collection.
	Href *string `json:"href,omitempty"`
}

GetToolsResponsePrevious : Information about retrieving previous tool results from the collection.

type ListToolchainsOptions 

type ListToolchainsOptions struct {
	// The resource group ID where the toolchains exist.
	ResourceGroupID *string `json:"resource_group_id" validate:"required"`

	// Limit the number of results. Valid value 0 < limit <= 200.
	Limit *int64 `json:"limit,omitempty"`

	// Offset the number of results from the beginning of the list. Valid value 0 <= offset < 200.
	Offset *int64 `json:"offset,omitempty"`

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

ListToolchainsOptions : The ListToolchains options.

func (*ListToolchainsOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*ListToolchainsOptions) SetLimit 

func (_options *ListToolchainsOptions) SetLimit(limit int64) *ListToolchainsOptions

SetLimit : Allow user to set Limit

func (*ListToolchainsOptions) SetOffset 

func (_options *ListToolchainsOptions) SetOffset(offset int64) *ListToolchainsOptions

SetOffset : Allow user to set Offset

func (*ListToolchainsOptions) SetResourceGroupID 

func (_options *ListToolchainsOptions) SetResourceGroupID(resourceGroupID string) *ListToolchainsOptions

SetResourceGroupID : Allow user to set ResourceGroupID

type ListToolsOptions added in v0.0.3 

type ListToolsOptions struct {
	// ID of the toolchain that tools are bound to.
	ToolchainID *string `json:"toolchain_id" validate:"required,ne="`

	// Limit the number of results. Valid value 0 < limit <= 200.
	Limit *int64 `json:"limit,omitempty"`

	// Offset the number of results from the beginning of the list. Valid value 0 <= offset < 200.
	Offset *int64 `json:"offset,omitempty"`

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

ListToolsOptions : The ListTools options.

func (*ListToolsOptions) SetHeaders added in v0.0.3 

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

SetHeaders : Allow user to set Headers

func (*ListToolsOptions) SetLimit added in v0.0.3 

func (_options *ListToolsOptions) SetLimit(limit int64) *ListToolsOptions

SetLimit : Allow user to set Limit

func (*ListToolsOptions) SetOffset added in v0.0.3 

func (_options *ListToolsOptions) SetOffset(offset int64) *ListToolsOptions

SetOffset : Allow user to set Offset

func (*ListToolsOptions) SetToolchainID added in v0.0.3 

func (_options *ListToolsOptions) SetToolchainID(toolchainID string) *ListToolsOptions

SetToolchainID : Allow user to set ToolchainID

type PostToolResponse added in v0.0.3 

type PostToolResponse struct {
	// ID of created tool.
	ID *string `json:"id" validate:"required"`

	// Resource group where tool was created.
	ResourceGroupID *string `json:"resource_group_id" validate:"required"`

	// CRN of created tool.
	CRN *string `json:"crn" validate:"required"`

	// The unique name of the provisioned tool.
	ToolTypeID *string `json:"tool_type_id" validate:"required"`

	// ID of toolchain which the created tool was bound to.
	ToolchainID *string `json:"toolchain_id" validate:"required"`

	// CRN of toolchain which the created tool was bound to.
	ToolchainCRN *string `json:"toolchain_crn" validate:"required"`

	// URI representing the created tool.
	Href *string `json:"href" validate:"required"`

	// Information on URIs to access this resource through the UI or API.
	Referent *Referent `json:"referent" validate:"required"`

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

	// Parameters to be used to create the tool.
	Parameters map[string]interface{} `json:"parameters" validate:"required"`

	// Current configuration state of the tool.
	State *string `json:"state" validate:"required"`
}

PostToolResponse : Response structure for POST tool.

type PostToolchainResponse 

type PostToolchainResponse struct {
	// ID of created toolchain.
	ID *string `json:"id" validate:"required"`

	// Name of created toolchain.
	Name *string `json:"name" validate:"required"`

	// Description of created toolchain.
	Description *string `json:"description" validate:"required"`

	// Account ID where toolchain was created.
	AccountID *string `json:"account_id" validate:"required"`

	// Region where toolchain is created.
	Location *string `json:"location" validate:"required"`

	// Resource group where toolchain is created.
	ResourceGroupID *string `json:"resource_group_id" validate:"required"`

	// CRN of created toolchain.
	CRN *string `json:"crn" validate:"required"`

	// URI representing the created toolchain.
	Href *string `json:"href" validate:"required"`

	// Identity that created the toolchain.
	CreatedBy *string `json:"created_by" validate:"required"`

	// Tags associated with the created toolchain.
	Tags []string `json:"tags" validate:"required"`
}

PostToolchainResponse : POST toolchains response body.

type Referent 

type Referent struct {
	// URI representing the this resource through the UI.
	UIHref *string `json:"ui_href,omitempty"`

	// URI representing the this resource through an API.
	APIHref *string `json:"api_href,omitempty"`
}

Referent : Information on URIs to access this resource through the UI or API.

type Tool added in v0.0.3 

type Tool struct {
	// Tool ID.
	ID *string `json:"id" validate:"required"`

	// Resource group where tool can be found.
	ResourceGroupID *string `json:"resource_group_id" validate:"required"`

	// Tool CRN.
	CRN *string `json:"crn" validate:"required"`

	// The unique name of the provisioned tool.
	ToolTypeID *string `json:"tool_type_id" validate:"required"`

	// ID of toolchain which the tool is bound to.
	ToolchainID *string `json:"toolchain_id" validate:"required"`

	// CRN of toolchain which the tool is bound to.
	ToolchainCRN *string `json:"toolchain_crn" validate:"required"`

	// URI representing the tool.
	Href *string `json:"href" validate:"required"`

	// Information on URIs to access this resource through the UI or API.
	Referent *ToolReferent `json:"referent" validate:"required"`

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

	// Latest tool update timestamp.
	UpdatedAt *strfmt.DateTime `json:"updated_at" validate:"required"`

	// Parameters to be used to create the tool.
	Parameters map[string]interface{} `json:"parameters" validate:"required"`

	// Current configuration state of the tool.
	State *string `json:"state" validate:"required"`
}

Tool : Model describing tool resource.

type ToolReferent added in v0.0.3 

type ToolReferent struct {
	// URI representing the this resource through the UI.
	UIHref *string `json:"ui_href,omitempty"`

	// URI representing the this resource through an API.
	APIHref *string `json:"api_href,omitempty"`
}

ToolReferent : Information on URIs to access this resource through the UI or API.

type Toolchain 

type Toolchain struct {
	// Toolchain ID.
	ID *string `json:"id" validate:"required"`

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

	// Toolchain description.
	Description *string `json:"description" validate:"required"`

	// Account ID where toolchain can be found.
	AccountID *string `json:"account_id" validate:"required"`

	// Toolchain region.
	Location *string `json:"location" validate:"required"`

	// Resource group where toolchain can be found.
	ResourceGroupID *string `json:"resource_group_id" validate:"required"`

	// Toolchain CRN.
	CRN *string `json:"crn" validate:"required"`

	// URI that can be used to retrieve toolchain.
	Href *string `json:"href" validate:"required"`

	// Toolchain creation timestamp.
	CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"`

	// Latest toolchain update timestamp.
	UpdatedAt *strfmt.DateTime `json:"updated_at" validate:"required"`

	// Identity that created the toolchain.
	CreatedBy *string `json:"created_by" validate:"required"`

	// Tags associated with the toolchain.
	Tags []string `json:"tags" validate:"required"`
}

Toolchain : Model describing toolchain resource.

type UpdateToolOptions added in v0.0.3 

type UpdateToolOptions struct {
	// ID of the toolchain.
	ToolchainID *string `json:"toolchain_id" validate:"required,ne="`

	// ID of the tool bound to the toolchain.
	ToolID *string `json:"tool_id" validate:"required,ne="`

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

	// The unique short name of the tool that should be provisioned or updated.
	ToolTypeID *string `json:"tool_type_id,omitempty"`

	// Parameters to be used to create the tool.
	Parameters map[string]interface{} `json:"parameters,omitempty"`

	// Decoded values used on provision in the broker that reference fields in the parameters.
	ParametersReferences map[string]interface{} `json:"parameters_references,omitempty"`

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

UpdateToolOptions : The UpdateTool options.

func (*UpdateToolOptions) SetHeaders added in v0.0.3 

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

SetHeaders : Allow user to set Headers

func (*UpdateToolOptions) SetName added in v0.0.3 

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

SetName : Allow user to set Name

func (*UpdateToolOptions) SetParameters added in v0.0.3 

func (_options *UpdateToolOptions) SetParameters(parameters map[string]interface{}) *UpdateToolOptions

SetParameters : Allow user to set Parameters

func (*UpdateToolOptions) SetParametersReferences added in v0.0.3 

func (_options *UpdateToolOptions) SetParametersReferences(parametersReferences map[string]interface{}) *UpdateToolOptions

SetParametersReferences : Allow user to set ParametersReferences

func (*UpdateToolOptions) SetToolID added in v0.0.3 

func (_options *UpdateToolOptions) SetToolID(toolID string) *UpdateToolOptions

SetToolID : Allow user to set ToolID

func (*UpdateToolOptions) SetToolTypeID added in v0.0.3 

func (_options *UpdateToolOptions) SetToolTypeID(toolTypeID string) *UpdateToolOptions

SetToolTypeID : Allow user to set ToolTypeID

func (*UpdateToolOptions) SetToolchainID added in v0.0.3 

func (_options *UpdateToolOptions) SetToolchainID(toolchainID string) *UpdateToolOptions

SetToolchainID : Allow user to set ToolchainID

type UpdateToolchainOptions 

type UpdateToolchainOptions struct {
	// ID of the toolchain.
	ToolchainID *string `json:"toolchain_id" validate:"required,ne="`

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

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

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

UpdateToolchainOptions : The UpdateToolchain options.

func (*UpdateToolchainOptions) SetDescription 

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

SetDescription : Allow user to set Description

func (*UpdateToolchainOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*UpdateToolchainOptions) SetName 

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

SetName : Allow user to set Name

func (*UpdateToolchainOptions) SetToolchainID 

func (_options *UpdateToolchainOptions) SetToolchainID(toolchainID string) *UpdateToolchainOptions

SetToolchainID : Allow user to set ToolchainID

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.