Help us shape the future of Go! Take the 2026 Go Developer Survey

operations

package
v6.0.1 Latest Latest
Warning

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

Go to latest
Published: Jan 26, 2022 License: MIT Imports: 5 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var OperationStatusValues = operationStatusValuesType{

	NotSet: "notSet",

	Queued: "queued",

	InProgress: "inProgress",

	Cancelled: "cancelled",

	Succeeded: "succeeded",

	Failed: "failed",
}

Functions

This section is empty.

Types

type Client

type Client interface {
	// Gets an operation from the the operationId using the given pluginId.
	GetOperation(context.Context, GetOperationArgs) (*Operation, error)
}

func NewClient

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

type ClientImpl

type ClientImpl struct {
	Client azuredevops.Client
}

func (*ClientImpl) GetOperation

func (client *ClientImpl) GetOperation(ctx context.Context, args GetOperationArgs) (*Operation, error)

Gets an operation from the the operationId using the given pluginId.

type GetOperationArgs

type GetOperationArgs struct {
	// (required) The ID for the operation.
	OperationId *uuid.UUID
	// (optional) The ID for the plugin.
	PluginId *uuid.UUID
}

Arguments for the GetOperation function

type Operation

type Operation struct {
	// Unique identifier for the operation.
	Id *uuid.UUID `json:"id,omitempty"`
	// Unique identifier for the plugin.
	PluginId *uuid.UUID `json:"pluginId,omitempty"`
	// The current status of the operation.
	Status *OperationStatus `json:"status,omitempty"`
	// URL to get the full operation object.
	Url *string `json:"url,omitempty"`
	// Links to other related objects.
	Links interface{} `json:"_links,omitempty"`
	// Detailed messaged about the status of an operation.
	DetailedMessage *string `json:"detailedMessage,omitempty"`
	// Result message for an operation.
	ResultMessage *string `json:"resultMessage,omitempty"`
	// URL to the operation result.
	ResultUrl *OperationResultReference `json:"resultUrl,omitempty"`
}

Contains information about the progress or result of an async operation.

type OperationReference

type OperationReference struct {
	// Unique identifier for the operation.
	Id *uuid.UUID `json:"id,omitempty"`
	// Unique identifier for the plugin.
	PluginId *uuid.UUID `json:"pluginId,omitempty"`
	// The current status of the operation.
	Status *OperationStatus `json:"status,omitempty"`
	// URL to get the full operation object.
	Url *string `json:"url,omitempty"`
}

Reference for an async operation.

type OperationResultReference

type OperationResultReference struct {
	// URL to the operation result.
	ResultUrl *string `json:"resultUrl,omitempty"`
}

type OperationStatus

type OperationStatus string

The status of an operation.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL