task

package
v7.2.2 Latest Latest
Warning

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

 Go to latest Published: Mar 14, 2024 License: MIT Imports: 9 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var IssueTypeValues = issueTypeValuesType{
	Error:   "error",
	Warning: "warning",
}
View Source 
var MaskTypeValues = maskTypeValuesType{
	Variable: "variable",
	Regex:    "regex",
}
View Source 
var PlanGroupStatusValues = planGroupStatusValuesType{
	Running: "running",
	Queued:  "queued",
	All:     "all",
}
View Source 
var TaskAgentJobStepTypeValues = taskAgentJobStepTypeValuesType{
	Task:   "task",
	Action: "action",
}
View Source 
var TaskOrchestrationItemTypeValues = taskOrchestrationItemTypeValuesType{
	Container: "container",
	Job:       "job",
}
View Source 
var TaskOrchestrationPlanStateValues = taskOrchestrationPlanStateValuesType{
	InProgress: "inProgress",
	Queued:     "queued",
	Completed:  "completed",
	Throttled:  "throttled",
}
View Source 
var TaskResultValues = taskResultValuesType{
	Succeeded:           "succeeded",
	SucceededWithIssues: "succeededWithIssues",
	Failed:              "failed",
	Canceled:            "canceled",
	Skipped:             "skipped",
	Abandoned:           "abandoned",
}
View Source 
var TimelineRecordStateValues = timelineRecordStateValuesType{
	Pending:    "pending",
	InProgress: "inProgress",
	Completed:  "completed",
}

Functions

This section is empty.

Types

type AppendLogContentArgs 

type AppendLogContentArgs struct {
	// (required) Stream to upload
	UploadStream io.Reader
	// (required) The project GUID to scope the request
	ScopeIdentifier *uuid.UUID
	// (required) The name of the server hub. Common examples: "build", "rm", "checks"
	HubName *string
	// (required) The ID of the plan.
	PlanId *uuid.UUID
	// (required) The ID of the log.
	LogId *int
}

Arguments for the AppendLogContent function

type AssociateLogArgs 

type AssociateLogArgs struct {
	// (required) The project GUID to scope the request
	ScopeIdentifier *uuid.UUID
	// (required) The name of the server hub. Common examples: "build", "rm", "checks"
	HubName *string
	// (required)
	PlanId *uuid.UUID
	// (required)
	LogId *int
	// (required)
	SerializedBlobId *string
	// (required)
	LineCount *int
}

Arguments for the AssociateLog function

type Client 

type Client interface {
	// [Preview API] Append a log to a task's log. The log should be sent in the body of the request as a TaskLog object stream.
	AppendLogContent(context.Context, AppendLogContentArgs) (*TaskLog, error)
	// [Preview API]
	AssociateLog(context.Context, AssociateLogArgs) (*TaskLog, error)
	// [Preview API]
	CreateAttachment(context.Context, CreateAttachmentArgs) (*TaskAttachment, error)
	// [Preview API]
	CreateAttachmentFromArtifact(context.Context, CreateAttachmentFromArtifactArgs) (*TaskAttachment, error)
	// [Preview API] Create a log and connect it to a pipeline run's execution plan.
	CreateLog(context.Context, CreateLogArgs) (*TaskLog, error)
	// [Preview API]
	CreateOidcToken(context.Context, CreateOidcTokenArgs) (*TaskHubOidcToken, error)
	// [Preview API]
	CreateTimeline(context.Context, CreateTimelineArgs) (*Timeline, error)
	// [Preview API]
	DeleteTimeline(context.Context, DeleteTimelineArgs) error
	// [Preview API]
	GetAttachment(context.Context, GetAttachmentArgs) (*TaskAttachment, error)
	// [Preview API]
	GetAttachmentContent(context.Context, GetAttachmentContentArgs) (io.ReadCloser, error)
	// [Preview API]
	GetAttachments(context.Context, GetAttachmentsArgs) (*[]TaskAttachment, error)
	// [Preview API]
	GetLog(context.Context, GetLogArgs) (*[]string, error)
	// [Preview API]
	GetLogs(context.Context, GetLogsArgs) (*[]TaskLog, error)
	// [Preview API]
	GetPlanAttachments(context.Context, GetPlanAttachmentsArgs) (*[]TaskAttachment, error)
	// [Preview API]
	GetRecords(context.Context, GetRecordsArgs) (*[]TimelineRecord, error)
	// [Preview API]
	GetTimeline(context.Context, GetTimelineArgs) (*Timeline, error)
	// [Preview API]
	GetTimelines(context.Context, GetTimelinesArgs) (*[]Timeline, error)
	// [Preview API] Update timeline records if they already exist, otherwise create new ones for the same timeline.
	UpdateRecords(context.Context, UpdateRecordsArgs) (*[]TimelineRecord, error)
}

func NewClient 

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

type ClientImpl 

type ClientImpl struct {
	Client azuredevops.Client
}

func (*ClientImpl) AppendLogContent 

func (client *ClientImpl) AppendLogContent(ctx context.Context, args AppendLogContentArgs) (*TaskLog, error)

[Preview API] Append a log to a task's log. The log should be sent in the body of the request as a TaskLog object stream.

func (*ClientImpl) AssociateLog 

func (client *ClientImpl) AssociateLog(ctx context.Context, args AssociateLogArgs) (*TaskLog, error)

[Preview API]

func (*ClientImpl) CreateAttachment 

func (client *ClientImpl) CreateAttachment(ctx context.Context, args CreateAttachmentArgs) (*TaskAttachment, error)

[Preview API]

func (*ClientImpl) CreateAttachmentFromArtifact 

func (client *ClientImpl) CreateAttachmentFromArtifact(ctx context.Context, args CreateAttachmentFromArtifactArgs) (*TaskAttachment, error)

[Preview API]

func (*ClientImpl) CreateLog 

func (client *ClientImpl) CreateLog(ctx context.Context, args CreateLogArgs) (*TaskLog, error)

[Preview API] Create a log and connect it to a pipeline run's execution plan.

func (*ClientImpl) CreateOidcToken 

func (client *ClientImpl) CreateOidcToken(ctx context.Context, args CreateOidcTokenArgs) (*TaskHubOidcToken, error)

[Preview API]

func (*ClientImpl) CreateTimeline 

func (client *ClientImpl) CreateTimeline(ctx context.Context, args CreateTimelineArgs) (*Timeline, error)

[Preview API]

func (*ClientImpl) DeleteTimeline 

func (client *ClientImpl) DeleteTimeline(ctx context.Context, args DeleteTimelineArgs) error

[Preview API]

func (*ClientImpl) GetAttachment 

func (client *ClientImpl) GetAttachment(ctx context.Context, args GetAttachmentArgs) (*TaskAttachment, error)

[Preview API]

func (*ClientImpl) GetAttachmentContent 

func (client *ClientImpl) GetAttachmentContent(ctx context.Context, args GetAttachmentContentArgs) (io.ReadCloser, error)

[Preview API]

func (*ClientImpl) GetAttachments 

func (client *ClientImpl) GetAttachments(ctx context.Context, args GetAttachmentsArgs) (*[]TaskAttachment, error)

[Preview API]

func (*ClientImpl) GetLog 

func (client *ClientImpl) GetLog(ctx context.Context, args GetLogArgs) (*[]string, error)

[Preview API]

func (*ClientImpl) GetLogs 

func (client *ClientImpl) GetLogs(ctx context.Context, args GetLogsArgs) (*[]TaskLog, error)

[Preview API]

func (*ClientImpl) GetPlanAttachments 

func (client *ClientImpl) GetPlanAttachments(ctx context.Context, args GetPlanAttachmentsArgs) (*[]TaskAttachment, error)

[Preview API]

func (*ClientImpl) GetRecords 

func (client *ClientImpl) GetRecords(ctx context.Context, args GetRecordsArgs) (*[]TimelineRecord, error)

[Preview API]

func (*ClientImpl) GetTimeline 

func (client *ClientImpl) GetTimeline(ctx context.Context, args GetTimelineArgs) (*Timeline, error)

[Preview API]

func (*ClientImpl) GetTimelines 

func (client *ClientImpl) GetTimelines(ctx context.Context, args GetTimelinesArgs) (*[]Timeline, error)

[Preview API]

func (*ClientImpl) UpdateRecords 

func (client *ClientImpl) UpdateRecords(ctx context.Context, args UpdateRecordsArgs) (*[]TimelineRecord, error)

[Preview API] Update timeline records if they already exist, otherwise create new ones for the same timeline.

type CreateAttachmentArgs 

type CreateAttachmentArgs struct {
	// (required) Stream to upload
	UploadStream io.Reader
	// (required) The project GUID to scope the request
	ScopeIdentifier *uuid.UUID
	// (required) The name of the server hub. Common examples: "build", "rm", "checks"
	HubName *string
	// (required)
	PlanId *uuid.UUID
	// (required)
	TimelineId *uuid.UUID
	// (required)
	RecordId *uuid.UUID
	// (required)
	Type *string
	// (required)
	Name *string
}

Arguments for the CreateAttachment function

type CreateAttachmentFromArtifactArgs 

type CreateAttachmentFromArtifactArgs struct {
	// (required) The project GUID to scope the request
	ScopeIdentifier *uuid.UUID
	// (required) The name of the server hub. Common examples: "build", "rm", "checks"
	HubName *string
	// (required)
	PlanId *uuid.UUID
	// (required)
	TimelineId *uuid.UUID
	// (required)
	RecordId *uuid.UUID
	// (required)
	Type *string
	// (required)
	Name *string
	// (required)
	ArtifactHash *string
	// (required)
	Length *uint64
}

Arguments for the CreateAttachmentFromArtifact function

type CreateLogArgs 

type CreateLogArgs struct {
	// (required) An object that contains information about log's path.
	Log *TaskLog
	// (required) The project GUID to scope the request
	ScopeIdentifier *uuid.UUID
	// (required) The name of the server hub. Common examples: "build", "rm", "checks"
	HubName *string
	// (required) The ID of the plan.
	PlanId *uuid.UUID
}

Arguments for the CreateLog function

type CreateOidcTokenArgs 

type CreateOidcTokenArgs struct {
	// (required)
	Claims *map[string]string
	// (required) The project GUID to scope the request
	ScopeIdentifier *uuid.UUID
	// (required) The name of the server hub. Common examples: "build", "rm", "checks"
	HubName *string
	// (required)
	PlanId *uuid.UUID
	// (required)
	JobId *uuid.UUID
	// (required)
	ServiceConnectionId *uuid.UUID
}

Arguments for the CreateOidcToken function

type CreateTimelineArgs 

type CreateTimelineArgs struct {
	// (required)
	Timeline *Timeline
	// (required) The project GUID to scope the request
	ScopeIdentifier *uuid.UUID
	// (required) The name of the server hub. Common examples: "build", "rm", "checks"
	HubName *string
	// (required)
	PlanId *uuid.UUID
}

Arguments for the CreateTimeline function

type DeleteTimelineArgs 

type DeleteTimelineArgs struct {
	// (required) The project GUID to scope the request
	ScopeIdentifier *uuid.UUID
	// (required) The name of the server hub. Common examples: "build", "rm", "checks"
	HubName *string
	// (required)
	PlanId *uuid.UUID
	// (required)
	TimelineId *uuid.UUID
}

Arguments for the DeleteTimeline function

type GetAttachmentArgs 

type GetAttachmentArgs struct {
	// (required) The project GUID to scope the request
	ScopeIdentifier *uuid.UUID
	// (required) The name of the server hub. Common examples: "build", "rm", "checks"
	HubName *string
	// (required)
	PlanId *uuid.UUID
	// (required)
	TimelineId *uuid.UUID
	// (required)
	RecordId *uuid.UUID
	// (required)
	Type *string
	// (required)
	Name *string
}

Arguments for the GetAttachment function

type GetAttachmentContentArgs 

type GetAttachmentContentArgs struct {
	// (required) The project GUID to scope the request
	ScopeIdentifier *uuid.UUID
	// (required) The name of the server hub. Common examples: "build", "rm", "checks"
	HubName *string
	// (required)
	PlanId *uuid.UUID
	// (required)
	TimelineId *uuid.UUID
	// (required)
	RecordId *uuid.UUID
	// (required)
	Type *string
	// (required)
	Name *string
}

Arguments for the GetAttachmentContent function

type GetAttachmentsArgs 

type GetAttachmentsArgs struct {
	// (required) The project GUID to scope the request
	ScopeIdentifier *uuid.UUID
	// (required) The name of the server hub. Common examples: "build", "rm", "checks"
	HubName *string
	// (required)
	PlanId *uuid.UUID
	// (required)
	TimelineId *uuid.UUID
	// (required)
	RecordId *uuid.UUID
	// (required)
	Type *string
}

Arguments for the GetAttachments function

type GetLogArgs 

type GetLogArgs struct {
	// (required) The project GUID to scope the request
	ScopeIdentifier *uuid.UUID
	// (required) The name of the server hub. Common examples: "build", "rm", "checks"
	HubName *string
	// (required)
	PlanId *uuid.UUID
	// (required)
	LogId *int
	// (optional)
	StartLine *uint64
	// (optional)
	EndLine *uint64
}

Arguments for the GetLog function

type GetLogsArgs 

type GetLogsArgs struct {
	// (required) The project GUID to scope the request
	ScopeIdentifier *uuid.UUID
	// (required) The name of the server hub. Common examples: "build", "rm", "checks"
	HubName *string
	// (required)
	PlanId *uuid.UUID
}

Arguments for the GetLogs function

type GetPlanAttachmentsArgs 

type GetPlanAttachmentsArgs struct {
	// (required) The project GUID to scope the request
	ScopeIdentifier *uuid.UUID
	// (required) The name of the server hub. Common examples: "build", "rm", "checks"
	HubName *string
	// (required)
	PlanId *uuid.UUID
	// (required)
	Type *string
}

Arguments for the GetPlanAttachments function

type GetRecordsArgs 

type GetRecordsArgs struct {
	// (required) The project GUID to scope the request
	ScopeIdentifier *uuid.UUID
	// (required) The name of the server hub. Common examples: "build", "rm", "checks"
	HubName *string
	// (required)
	PlanId *uuid.UUID
	// (required)
	TimelineId *uuid.UUID
	// (optional)
	ChangeId *int
}

Arguments for the GetRecords function

type GetTimelineArgs 

type GetTimelineArgs struct {
	// (required) The project GUID to scope the request
	ScopeIdentifier *uuid.UUID
	// (required) The name of the server hub. Common examples: "build", "rm", "checks"
	HubName *string
	// (required)
	PlanId *uuid.UUID
	// (required)
	TimelineId *uuid.UUID
	// (optional)
	ChangeId *int
	// (optional)
	IncludeRecords *bool
}

Arguments for the GetTimeline function

type GetTimelinesArgs 

type GetTimelinesArgs struct {
	// (required) The project GUID to scope the request
	ScopeIdentifier *uuid.UUID
	// (required) The name of the server hub. Common examples: "build", "rm", "checks"
	HubName *string
	// (required)
	PlanId *uuid.UUID
}

Arguments for the GetTimelines function

type Issue 

type Issue struct {
	// The category of the issue. <br />Example: Code - refers to compilation errors <br />Example: General - refers to generic errors
	Category *string `json:"category,omitempty"`
	// A dictionary containing details about the issue.
	Data *map[string]string `json:"data,omitempty"`
	// A description of issue.
	Message *string `json:"message,omitempty"`
	// The type (error, warning) of the issue.
	Type *IssueType `json:"type,omitempty"`
}

An issue (error, warning) associated with a pipeline run.

type IssueType 

type IssueType string

The type of issue based on severity.

type JobEvent 

type JobEvent struct {
	// The ID of the pipeline job affected by the event.
	JobId *uuid.UUID `json:"jobId,omitempty"`
	// The name of the pipeline job event.
	Name *string `json:"name,omitempty"`
}

A pipeline job event to be processed by the execution plan.

type JobOption 

type JobOption struct {
	Data *map[string]string `json:"data,omitempty"`
	// Gets the id of the option.
	Id *uuid.UUID `json:"id,omitempty"`
}

Represents an option that may affect the way an agent runs the job.

type MaskHint 

type MaskHint struct {
	Type  *MaskType `json:"type,omitempty"`
	Value *string   `json:"value,omitempty"`
}

type MaskType 

type MaskType string

type PlanEnvironment 

type PlanEnvironment struct {
	Mask      *[]MaskHint              `json:"mask,omitempty"`
	Options   *map[uuid.UUID]JobOption `json:"options,omitempty"`
	Variables *map[string]string       `json:"variables,omitempty"`
}

type PlanGroupStatus 

type PlanGroupStatus string

[Flags]

type ProjectReference 

type ProjectReference struct {
	Id   *uuid.UUID `json:"id,omitempty"`
	Name *string    `json:"name,omitempty"`
}

type TaskAgentJob 

type TaskAgentJob struct {
	Container         *string                 `json:"container,omitempty"`
	Id                *uuid.UUID              `json:"id,omitempty"`
	Name              *string                 `json:"name,omitempty"`
	SidecarContainers *map[string]string      `json:"sidecarContainers,omitempty"`
	Steps             *[]TaskAgentJobStep     `json:"steps,omitempty"`
	Variables         *[]TaskAgentJobVariable `json:"variables,omitempty"`
}

type TaskAgentJobStep 

type TaskAgentJobStep struct {
	Condition               *string               `json:"condition,omitempty"`
	ContinueOnError         *bool                 `json:"continueOnError,omitempty"`
	Enabled                 *bool                 `json:"enabled,omitempty"`
	Env                     *map[string]string    `json:"env,omitempty"`
	Id                      *uuid.UUID            `json:"id,omitempty"`
	Inputs                  *map[string]string    `json:"inputs,omitempty"`
	Name                    *string               `json:"name,omitempty"`
	RetryCountOnTaskFailure *int                  `json:"retryCountOnTaskFailure,omitempty"`
	Task                    *TaskAgentJobTask     `json:"task,omitempty"`
	TimeoutInMinutes        *int                  `json:"timeoutInMinutes,omitempty"`
	Type                    *TaskAgentJobStepType `json:"type,omitempty"`
}

type TaskAgentJobStepType 

type TaskAgentJobStepType string

type TaskAgentJobTask 

type TaskAgentJobTask struct {
	Id      *uuid.UUID `json:"id,omitempty"`
	Name    *string    `json:"name,omitempty"`
	Version *string    `json:"version,omitempty"`
}

type TaskAgentJobVariable 

type TaskAgentJobVariable struct {
	Name   *string `json:"name,omitempty"`
	Secret *bool   `json:"secret,omitempty"`
	Value  *string `json:"value,omitempty"`
}

type TaskAttachment 

type TaskAttachment struct {
	Links         interface{}       `json:"_links,omitempty"`
	CreatedOn     *azuredevops.Time `json:"createdOn,omitempty"`
	LastChangedBy *uuid.UUID        `json:"lastChangedBy,omitempty"`
	LastChangedOn *azuredevops.Time `json:"lastChangedOn,omitempty"`
	Name          *string           `json:"name,omitempty"`
	RecordId      *uuid.UUID        `json:"recordId,omitempty"`
	TimelineId    *uuid.UUID        `json:"timelineId,omitempty"`
	Type          *string           `json:"type,omitempty"`
}

type TaskHubOidcToken 

type TaskHubOidcToken struct {
	OidcToken *string `json:"oidcToken,omitempty"`
}

type TaskLog 

type TaskLog struct {
	// The ID of the task log.
	Id *int `json:"id,omitempty"`
	// The REST URL of the task log.
	Location *string `json:"location,omitempty"`
	// The time of the task log creation.
	CreatedOn *azuredevops.Time `json:"createdOn,omitempty"`
	// The REST URL of the task log when indexed.
	IndexLocation *string `json:"indexLocation,omitempty"`
	// The time of the last modification of the task log.
	LastChangedOn *azuredevops.Time `json:"lastChangedOn,omitempty"`
	// The number of the task log lines.
	LineCount *uint64 `json:"lineCount,omitempty"`
	// The path of the task log.
	Path *string `json:"path,omitempty"`
}

A task log connected to a timeline record.

type TaskLogReference 

type TaskLogReference struct {
	// The ID of the task log.
	Id *int `json:"id,omitempty"`
	// The REST URL of the task log.
	Location *string `json:"location,omitempty"`
}

A reference to a task log. This class contains information about the output printed to the timeline record's logs console during pipeline run.

type TaskOrchestrationContainer 

type TaskOrchestrationContainer struct {
	ItemType        *TaskOrchestrationItemType  `json:"itemType,omitempty"`
	ContinueOnError *bool                       `json:"continueOnError,omitempty"`
	Data            *map[string]string          `json:"data,omitempty"`
	Children        *[]TaskOrchestrationItem    `json:"children,omitempty"`
	MaxConcurrency  *int                        `json:"maxConcurrency,omitempty"`
	Parallel        *bool                       `json:"parallel,omitempty"`
	Rollback        *TaskOrchestrationContainer `json:"rollback,omitempty"`
}

type TaskOrchestrationItem 

type TaskOrchestrationItem struct {
	ItemType *TaskOrchestrationItemType `json:"itemType,omitempty"`
}

type TaskOrchestrationItemType 

type TaskOrchestrationItemType string

type TaskOrchestrationOwner 

type TaskOrchestrationOwner struct {
	Links interface{} `json:"_links,omitempty"`
	Id    *int        `json:"id,omitempty"`
	Name  *string     `json:"name,omitempty"`
}

type TaskOrchestrationPlan 

type TaskOrchestrationPlan struct {
	ArtifactLocation  *string                     `json:"artifactLocation,omitempty"`
	ArtifactUri       *string                     `json:"artifactUri,omitempty"`
	Definition        *TaskOrchestrationOwner     `json:"definition,omitempty"`
	Owner             *TaskOrchestrationOwner     `json:"owner,omitempty"`
	PlanGroup         *string                     `json:"planGroup,omitempty"`
	PlanId            *uuid.UUID                  `json:"planId,omitempty"`
	PlanType          *string                     `json:"planType,omitempty"`
	ScopeIdentifier   *uuid.UUID                  `json:"scopeIdentifier,omitempty"`
	Version           *int                        `json:"version,omitempty"`
	Environment       *PlanEnvironment            `json:"environment,omitempty"`
	ExpandedYaml      *TaskLogReference           `json:"expandedYaml,omitempty"`
	FinishTime        *azuredevops.Time           `json:"finishTime,omitempty"`
	Implementation    *TaskOrchestrationContainer `json:"implementation,omitempty"`
	InitializationLog *TaskLogReference           `json:"initializationLog,omitempty"`
	RequestedById     *uuid.UUID                  `json:"requestedById,omitempty"`
	RequestedForId    *uuid.UUID                  `json:"requestedForId,omitempty"`
	Result            *TaskResult                 `json:"result,omitempty"`
	ResultCode        *string                     `json:"resultCode,omitempty"`
	StartTime         *azuredevops.Time           `json:"startTime,omitempty"`
	State             *TaskOrchestrationPlanState `json:"state,omitempty"`
	Timeline          *TimelineReference          `json:"timeline,omitempty"`
}

type TaskOrchestrationPlanGroupsQueueMetrics 

type TaskOrchestrationPlanGroupsQueueMetrics struct {
	Count  *int             `json:"count,omitempty"`
	Status *PlanGroupStatus `json:"status,omitempty"`
}

type TaskOrchestrationPlanReference 

type TaskOrchestrationPlanReference struct {
	ArtifactLocation *string                 `json:"artifactLocation,omitempty"`
	ArtifactUri      *string                 `json:"artifactUri,omitempty"`
	Definition       *TaskOrchestrationOwner `json:"definition,omitempty"`
	Owner            *TaskOrchestrationOwner `json:"owner,omitempty"`
	PlanGroup        *string                 `json:"planGroup,omitempty"`
	PlanId           *uuid.UUID              `json:"planId,omitempty"`
	PlanType         *string                 `json:"planType,omitempty"`
	ScopeIdentifier  *uuid.UUID              `json:"scopeIdentifier,omitempty"`
	Version          *int                    `json:"version,omitempty"`
}

type TaskOrchestrationPlanState 

type TaskOrchestrationPlanState string

type TaskOrchestrationQueuedPlan 

type TaskOrchestrationQueuedPlan struct {
	AssignTime      *azuredevops.Time       `json:"assignTime,omitempty"`
	Definition      *TaskOrchestrationOwner `json:"definition,omitempty"`
	Owner           *TaskOrchestrationOwner `json:"owner,omitempty"`
	PlanGroup       *string                 `json:"planGroup,omitempty"`
	PlanId          *uuid.UUID              `json:"planId,omitempty"`
	PoolId          *int                    `json:"poolId,omitempty"`
	QueuePosition   *int                    `json:"queuePosition,omitempty"`
	QueueTime       *azuredevops.Time       `json:"queueTime,omitempty"`
	ScopeIdentifier *uuid.UUID              `json:"scopeIdentifier,omitempty"`
}

type TaskOrchestrationQueuedPlanGroup 

type TaskOrchestrationQueuedPlanGroup struct {
	Definition    *TaskOrchestrationOwner        `json:"definition,omitempty"`
	Owner         *TaskOrchestrationOwner        `json:"owner,omitempty"`
	PlanGroup     *string                        `json:"planGroup,omitempty"`
	Plans         *[]TaskOrchestrationQueuedPlan `json:"plans,omitempty"`
	Project       *ProjectReference              `json:"project,omitempty"`
	QueuePosition *int                           `json:"queuePosition,omitempty"`
}

type TaskReference 

type TaskReference struct {
	// The ID of the task definition. Corresponds to the id value of task.json file. <br />Example: CmdLineV2 { "id": "D9BAFED4-0B18-4F58-968D-86655B4D2CE9" }
	Id *uuid.UUID `json:"id,omitempty"`
	// A dictionary of inputs specific to a task definition. Corresponds to inputs value of task.json file.
	Inputs *map[string]string `json:"inputs,omitempty"`
	// The name of the task definition. Corresponds to the name value of task.json file. <br />Example: CmdLineV2 { "name": "CmdLine" }
	Name *string `json:"name,omitempty"`
	// The version of the task definition. Corresponds to the version value of task.json file. <br />Example: CmdLineV2 { "version": { "Major": 2, "Minor": 212, "Patch": 0 } }
	Version *string `json:"version,omitempty"`
}

A reference to a task.

type TaskResult 

type TaskResult string

The result of an operation tracked by a timeline record.

type Timeline 

type Timeline struct {
	// The change ID.
	ChangeId *int `json:"changeId,omitempty"`
	// The ID of the timeline.
	Id *uuid.UUID `json:"id,omitempty"`
	// The REST URL of the timeline.
	Location      *string           `json:"location,omitempty"`
	LastChangedBy *uuid.UUID        `json:"lastChangedBy,omitempty"`
	LastChangedOn *azuredevops.Time `json:"lastChangedOn,omitempty"`
	Records       *[]TimelineRecord `json:"records,omitempty"`
}

type TimelineAttempt 

type TimelineAttempt struct {
	// The attempt of the record.
	Attempt *int `json:"attempt,omitempty"`
	// The unique identifier for the record.
	Identifier *string `json:"identifier,omitempty"`
	// The record identifier located within the specified timeline.
	RecordId *uuid.UUID `json:"recordId,omitempty"`
	// The timeline identifier which owns the record representing this attempt.
	TimelineId *uuid.UUID `json:"timelineId,omitempty"`
}

An attempt to update a TimelineRecord.

type TimelineRecord 

type TimelineRecord struct {
	// The specification of an agent running a pipeline job, in binary format. Applicable when record is of type Job. <br />Example: { "VMImage" : "windows-2019" }
	AgentSpecification interface{} `json:"agentSpecification,omitempty"`
	// The number of record attempts.
	Attempt *int `json:"attempt,omitempty"`
	// A string that indicates the current operation.
	CurrentOperation *string `json:"currentOperation,omitempty"`
	// A reference to a sub-timeline.
	Details *TimelineReference `json:"details,omitempty"`
	// The number of errors produced by this operation.
	ErrorCount *int `json:"errorCount,omitempty"`
	// The finish time of the record.
	FinishTime *azuredevops.Time `json:"finishTime,omitempty"`
	// The ID connecting all records updated at the same time. This value is taken from timeline's ChangeId.
	ChangeId *int `json:"changeId,omitempty"`
	// The ID of the record.
	Id *uuid.UUID `json:"id,omitempty"`
	// String identifier that is consistent across attempts.
	Identifier *string `json:"identifier,omitempty"`
	// The list of issues produced by this operation.
	Issues *[]Issue `json:"issues,omitempty"`
	// The time the record was last modified.
	LastModified *azuredevops.Time `json:"lastModified,omitempty"`
	// The REST URL of the record.
	Location *string `json:"location,omitempty"`
	// A reference to the log produced by this operation.
	Log *TaskLogReference `json:"log,omitempty"`
	// The name of the record.
	Name *string `json:"name,omitempty"`
	// An ordinal value relative to other records within the timeline.
	Order *int `json:"order,omitempty"`
	// The ID of the record's parent. <br />Example: Stage is a parent of a Phase, Phase is a parent of a Job, Job is a parent of a Task.
	ParentId *uuid.UUID `json:"parentId,omitempty"`
	// The percentage of record completion.
	PercentComplete *int `json:"percentComplete,omitempty"`
	// The previous record attempts.
	PreviousAttempts *[]TimelineAttempt `json:"previousAttempts,omitempty"`
	// The ID of the queue which connects projects to agent pools on which the operation ran on. Applicable when record is of type Job.
	QueueId *int `json:"queueId,omitempty"`
	// Name of the referenced record.
	RefName *string `json:"refName,omitempty"`
	// The result of the record.
	Result *TaskResult `json:"result,omitempty"`
	// Evaluation of predefined conditions upon completion of record's operation. <br />Example: Evaluating `succeeded()`, Result = True <br />Example: Evaluating `and(succeeded(), eq(variables['system.debug'], False))`, Result = False
	ResultCode *string `json:"resultCode,omitempty"`
	// The start time of the record.
	StartTime *azuredevops.Time `json:"startTime,omitempty"`
	// The state of the record.
	State *TimelineRecordState `json:"state,omitempty"`
	// A reference to the task. Applicable when record is of type Task.
	Task *TaskReference `json:"task,omitempty"`
	// The type of operation being tracked by the record. <br />Example: Stage, Phase, Job, Task...
	Type *string `json:"type,omitempty"`
	// The variables of the record.
	Variables *map[string]interface{} `json:"variables,omitempty"`
	// The number of warnings produced by this operation.
	WarningCount *int `json:"warningCount,omitempty"`
	// The name of the agent running the operation. Applicable when record is of type Job.
	WorkerName *string `json:"workerName,omitempty"`
}

Detailed information about the execution of different operations during pipeline run.

type TimelineRecordFeedLinesWrapper 

type TimelineRecordFeedLinesWrapper struct {
	Count     *int       `json:"count,omitempty"`
	EndLine   *uint64    `json:"endLine,omitempty"`
	StartLine *uint64    `json:"startLine,omitempty"`
	StepId    *uuid.UUID `json:"stepId,omitempty"`
	Value     *[]string  `json:"value,omitempty"`
}

type TimelineRecordState 

type TimelineRecordState string

The state of the timeline record.

type TimelineReference 

type TimelineReference struct {
	// The change ID.
	ChangeId *int `json:"changeId,omitempty"`
	// The ID of the timeline.
	Id *uuid.UUID `json:"id,omitempty"`
	// The REST URL of the timeline.
	Location *string `json:"location,omitempty"`
}

A reference to a timeline.

type UpdateRecordsArgs 

type UpdateRecordsArgs struct {
	// (required) The array of timeline records to be updated.
	Records *azuredevops.VssJsonCollectionWrapper
	// (required) The project GUID to scope the request
	ScopeIdentifier *uuid.UUID
	// (required) The name of the server hub. Common examples: "build", "rm", "checks"
	HubName *string
	// (required) The ID of the plan.
	PlanId *uuid.UUID
	// (required) The ID of the timeline.
	TimelineId *uuid.UUID
}

Arguments for the UpdateRecords function

type VariableValue 

type VariableValue struct {
	// Indicates whether the variable can be changed during script's execution runtime.
	IsReadOnly *bool `json:"isReadOnly,omitempty"`
	// Indicates whether the variable should be encrypted at rest.
	IsSecret *bool `json:"isSecret,omitempty"`
	// The value of the variable.
	Value *string `json:"value,omitempty"`
}

A wrapper class for a generic variable.

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.