workitemtrackingprocesstemplate

package
v1.0.0-b5 Latest Latest
Warning

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

 Go to latest Published: Aug 23, 2020 License: MIT Imports: 7 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var ResourceAreaId, _ = uuid.Parse("5264459e-e5e0-4bd8-b118-0985e68a4ec5")
View Source 
var ValidationIssueTypeValues = validationIssueTypeValuesType{
	Warning: "warning",
	Error:   "error",
}

Functions

This section is empty.

Types

type AdminBehavior 

type AdminBehavior struct {
	// Is the behavior abstract (i.e. can not be associated with any work item type).
	Abstract *bool `json:"abstract,omitempty"`
	// The color associated with the behavior.
	Color *string `json:"color,omitempty"`
	// Indicates if the behavior is custom.
	Custom *bool `json:"custom,omitempty"`
	// The description of the behavior.
	Description *string `json:"description,omitempty"`
	// List of behavior fields.
	Fields *[]AdminBehaviorField `json:"fields,omitempty"`
	// Behavior ID.
	Id *string `json:"id,omitempty"`
	// Parent behavior reference.
	Inherits *string `json:"inherits,omitempty"`
	// The behavior name.
	Name *string `json:"name,omitempty"`
	// Is the behavior overrides a behavior from system process.
	Overriden *bool `json:"overriden,omitempty"`
	// The rank.
	Rank *int `json:"rank,omitempty"`
}

Describes an admin behavior for a process.

type AdminBehaviorField 

type AdminBehaviorField struct {
	// The behavior field identifier.
	BehaviorFieldId *string `json:"behaviorFieldId,omitempty"`
	// The behavior ID.
	Id *string `json:"id,omitempty"`
	// The behavior name.
	Name *string `json:"name,omitempty"`
}

Describes an admin behavior field.

type CheckTemplateExistenceResult 

type CheckTemplateExistenceResult struct {
	// Indicates whether a template exists.
	DoesTemplateExist *bool `json:"doesTemplateExist,omitempty"`
	// The name of the existing template.
	ExistingTemplateName *string `json:"existingTemplateName,omitempty"`
	// The existing template type identifier.
	ExistingTemplateTypeId *uuid.UUID `json:"existingTemplateTypeId,omitempty"`
	// The name of the requested template.
	RequestedTemplateName *string `json:"requestedTemplateName,omitempty"`
}

Describes result of a check template existence request.

type Client 

type Client interface {
	// [Preview API] Returns requested process template.
	ExportProcessTemplate(context.Context, ExportProcessTemplateArgs) (io.ReadCloser, error)
	// [Preview API] Returns a behavior for the process.
	GetBehavior(context.Context, GetBehaviorArgs) (*AdminBehavior, error)
	// [Preview API] Returns a list of behaviors for the process.
	GetBehaviors(context.Context, GetBehaviorsArgs) (*[]AdminBehavior, error)
	// [Preview API] Imports a process from zip file.
	ImportProcessTemplate(context.Context, ImportProcessTemplateArgs) (*ProcessImportResult, error)
	// [Preview API] Tells whether promote has completed for the specified promote job ID.
	ImportProcessTemplateStatus(context.Context, ImportProcessTemplateStatusArgs) (*ProcessPromoteStatus, error)
}

func NewClient 

func NewClient(ctx context.Context, connection *azuredevops.Connection) (Client, error)

type ClientImpl 

type ClientImpl struct {
	Client azuredevops.Client
}

func (*ClientImpl) ExportProcessTemplate 

func (client *ClientImpl) ExportProcessTemplate(ctx context.Context, args ExportProcessTemplateArgs) (io.ReadCloser, error)

[Preview API] Returns requested process template.

func (*ClientImpl) GetBehavior 

func (client *ClientImpl) GetBehavior(ctx context.Context, args GetBehaviorArgs) (*AdminBehavior, error)

[Preview API] Returns a behavior for the process.

func (*ClientImpl) GetBehaviors 

func (client *ClientImpl) GetBehaviors(ctx context.Context, args GetBehaviorsArgs) (*[]AdminBehavior, error)

[Preview API] Returns a list of behaviors for the process.

func (*ClientImpl) ImportProcessTemplate 

func (client *ClientImpl) ImportProcessTemplate(ctx context.Context, args ImportProcessTemplateArgs) (*ProcessImportResult, error)

[Preview API] Imports a process from zip file.

func (*ClientImpl) ImportProcessTemplateStatus 

func (client *ClientImpl) ImportProcessTemplateStatus(ctx context.Context, args ImportProcessTemplateStatusArgs) (*ProcessPromoteStatus, error)

[Preview API] Tells whether promote has completed for the specified promote job ID.

type ExportProcessTemplateArgs 

type ExportProcessTemplateArgs struct {
	// (required) The ID of the process
	Id *uuid.UUID
}

Arguments for the ExportProcessTemplate function

type GetBehaviorArgs 

type GetBehaviorArgs struct {
	// (required) The ID of the process
	ProcessId *uuid.UUID
	// (required) The reference name of the behavior
	BehaviorRefName *string
}

Arguments for the GetBehavior function

type GetBehaviorsArgs 

type GetBehaviorsArgs struct {
	// (required) The ID of the process
	ProcessId *uuid.UUID
}

Arguments for the GetBehaviors function

type ImportProcessTemplateArgs 

type ImportProcessTemplateArgs struct {
	// (required) Stream to upload
	UploadStream io.Reader
	// (optional) Ignores validation warnings. Default value is false.
	IgnoreWarnings *bool
	// (optional) Replaces the existing template. Default value is true.
	ReplaceExistingTemplate *bool
}

Arguments for the ImportProcessTemplate function

type ImportProcessTemplateStatusArgs 

type ImportProcessTemplateStatusArgs struct {
	// (required) The ID of the promote job operation
	Id *uuid.UUID
}

Arguments for the ImportProcessTemplateStatus function

type ProcessImportResult 

type ProcessImportResult struct {
	// Check template existence result.
	CheckExistenceResult *CheckTemplateExistenceResult `json:"checkExistenceResult,omitempty"`
	// Help URL.
	HelpUrl *string `json:"helpUrl,omitempty"`
	// ID of the import operation.
	Id *uuid.UUID `json:"id,omitempty"`
	// Whether this imported process is new.
	IsNew *bool `json:"isNew,omitempty"`
	// The promote job identifier.
	PromoteJobId *uuid.UUID `json:"promoteJobId,omitempty"`
	// The list of validation results.
	ValidationResults *[]ValidationIssue `json:"validationResults,omitempty"`
}

Describes the result of a Process Import request.

type ProcessPromoteStatus 

type ProcessPromoteStatus struct {
	// Number of projects for which promote is complete.
	Complete *int `json:"complete,omitempty"`
	// ID of the promote operation.
	Id *uuid.UUID `json:"id,omitempty"`
	// The error message associated with the promote operation. The string will be empty if there are no errors.
	Message *string `json:"message,omitempty"`
	// Number of projects for which promote is pending.
	Pending *int `json:"pending,omitempty"`
	// The remaining retries.
	RemainingRetries *int `json:"remainingRetries,omitempty"`
	// True if promote finished all the projects successfully. False if still in progress or any project promote failed.
	Successful *bool `json:"successful,omitempty"`
}

Describes result of process operation promote.

type ValidationIssue 

type ValidationIssue struct {
	Description *string              `json:"description,omitempty"`
	File        *string              `json:"file,omitempty"`
	HelpLink    *string              `json:"helpLink,omitempty"`
	IssueType   *ValidationIssueType `json:"issueType,omitempty"`
	Line        *int                 `json:"line,omitempty"`
}

type ValidationIssueType 

type ValidationIssueType string

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.