Documentation ¶
Index ¶
- Variables
- type AppendLogContentArgs
- type Client
- type ClientImpl
- func (client *ClientImpl) AppendLogContent(ctx context.Context, args AppendLogContentArgs) (*TaskLog, error)
- func (client *ClientImpl) CreateAttachment(ctx context.Context, args CreateAttachmentArgs) (*TaskAttachment, error)
- func (client *ClientImpl) CreateLog(ctx context.Context, args CreateLogArgs) (*TaskLog, error)
- func (client *ClientImpl) CreateTimeline(ctx context.Context, args CreateTimelineArgs) (*Timeline, error)
- func (client *ClientImpl) DeleteTimeline(ctx context.Context, args DeleteTimelineArgs) error
- func (client *ClientImpl) GetAttachment(ctx context.Context, args GetAttachmentArgs) (*TaskAttachment, error)
- func (client *ClientImpl) GetAttachmentContent(ctx context.Context, args GetAttachmentContentArgs) (io.ReadCloser, error)
- func (client *ClientImpl) GetAttachments(ctx context.Context, args GetAttachmentsArgs) (*[]TaskAttachment, error)
- func (client *ClientImpl) GetLog(ctx context.Context, args GetLogArgs) (*[]string, error)
- func (client *ClientImpl) GetLogs(ctx context.Context, args GetLogsArgs) (*[]TaskLog, error)
- func (client *ClientImpl) GetPlanAttachments(ctx context.Context, args GetPlanAttachmentsArgs) (*[]TaskAttachment, error)
- func (client *ClientImpl) GetRecords(ctx context.Context, args GetRecordsArgs) (*[]TimelineRecord, error)
- func (client *ClientImpl) GetTimeline(ctx context.Context, args GetTimelineArgs) (*Timeline, error)
- func (client *ClientImpl) GetTimelines(ctx context.Context, args GetTimelinesArgs) (*[]Timeline, error)
- func (client *ClientImpl) UpdateRecords(ctx context.Context, args UpdateRecordsArgs) (*[]TimelineRecord, error)
- type CreateAttachmentArgs
- type CreateLogArgs
- type CreateTimelineArgs
- type DeleteTimelineArgs
- type GetAttachmentArgs
- type GetAttachmentContentArgs
- type GetAttachmentsArgs
- type GetLogArgs
- type GetLogsArgs
- type GetPlanAttachmentsArgs
- type GetRecordsArgs
- type GetTimelineArgs
- type GetTimelinesArgs
- type Issue
- type IssueType
- type JobOption
- type MaskHint
- type MaskType
- type PlanEnvironment
- type PlanGroupStatus
- type ProjectReference
- type TaskAgentJob
- type TaskAgentJobStep
- type TaskAgentJobStepType
- type TaskAgentJobTask
- type TaskAgentJobVariable
- type TaskAttachment
- type TaskLog
- type TaskLogReference
- type TaskOrchestrationContainer
- type TaskOrchestrationItem
- type TaskOrchestrationItemType
- type TaskOrchestrationOwner
- type TaskOrchestrationPlan
- type TaskOrchestrationPlanGroupsQueueMetrics
- type TaskOrchestrationPlanReference
- type TaskOrchestrationPlanState
- type TaskOrchestrationQueuedPlan
- type TaskOrchestrationQueuedPlanGroup
- type TaskReference
- type TaskResult
- type Timeline
- type TimelineAttempt
- type TimelineRecord
- type TimelineRecordFeedLinesWrapper
- type TimelineRecordState
- type TimelineReference
- type UpdateRecordsArgs
- type VariableValue
Constants ¶
This section is empty.
Variables ¶
var IssueTypeValues = issueTypeValuesType{
Error: "error",
Warning: "warning",
}
var MaskTypeValues = maskTypeValuesType{
Variable: "variable",
Regex: "regex",
}
var PlanGroupStatusValues = planGroupStatusValuesType{
Running: "running",
Queued: "queued",
All: "all",
}
var TaskAgentJobStepTypeValues = taskAgentJobStepTypeValuesType{
Task: "task",
Action: "action",
}
var TaskOrchestrationItemTypeValues = taskOrchestrationItemTypeValuesType{
Container: "container",
Job: "job",
}
var TaskOrchestrationPlanStateValues = taskOrchestrationPlanStateValuesType{
InProgress: "inProgress",
Queued: "queued",
Completed: "completed",
Throttled: "throttled",
}
var TaskResultValues = taskResultValuesType{
Succeeded: "succeeded",
SucceededWithIssues: "succeededWithIssues",
Failed: "failed",
Canceled: "canceled",
Skipped: "skipped",
Abandoned: "abandoned",
}
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: "build" for the Build server or "rm" for the Release Management server HubName *string // (required) PlanId *uuid.UUID // (required) LogId *int }
Arguments for the AppendLogContent function
type Client ¶
type Client interface { AppendLogContent(context.Context, AppendLogContentArgs) (*TaskLog, error) // [Preview API] CreateAttachment(context.Context, CreateAttachmentArgs) (*TaskAttachment, error) CreateLog(context.Context, CreateLogArgs) (*TaskLog, error) CreateTimeline(context.Context, CreateTimelineArgs) (*Timeline, error) 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) GetLog(context.Context, GetLogArgs) (*[]string, error) GetLogs(context.Context, GetLogsArgs) (*[]TaskLog, error) // [Preview API] GetPlanAttachments(context.Context, GetPlanAttachmentsArgs) (*[]TaskAttachment, error) GetRecords(context.Context, GetRecordsArgs) (*[]TimelineRecord, error) GetTimeline(context.Context, GetTimelineArgs) (*Timeline, error) GetTimelines(context.Context, GetTimelinesArgs) (*[]Timeline, error) 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)
func (*ClientImpl) CreateAttachment ¶
func (client *ClientImpl) CreateAttachment(ctx context.Context, args CreateAttachmentArgs) (*TaskAttachment, error)
[Preview API]
func (*ClientImpl) CreateLog ¶
func (client *ClientImpl) CreateLog(ctx context.Context, args CreateLogArgs) (*TaskLog, error)
func (*ClientImpl) CreateTimeline ¶
func (client *ClientImpl) CreateTimeline(ctx context.Context, args CreateTimelineArgs) (*Timeline, error)
func (*ClientImpl) DeleteTimeline ¶
func (client *ClientImpl) DeleteTimeline(ctx context.Context, args DeleteTimelineArgs) error
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)
func (*ClientImpl) GetLogs ¶
func (client *ClientImpl) GetLogs(ctx context.Context, args GetLogsArgs) (*[]TaskLog, error)
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)
func (*ClientImpl) GetTimeline ¶
func (client *ClientImpl) GetTimeline(ctx context.Context, args GetTimelineArgs) (*Timeline, error)
func (*ClientImpl) GetTimelines ¶
func (client *ClientImpl) GetTimelines(ctx context.Context, args GetTimelinesArgs) (*[]Timeline, error)
func (*ClientImpl) UpdateRecords ¶
func (client *ClientImpl) UpdateRecords(ctx context.Context, args UpdateRecordsArgs) (*[]TimelineRecord, error)
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: "build" for the Build server or "rm" for the Release Management server 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 CreateLogArgs ¶
type CreateLogArgs struct { // (required) Log *TaskLog // (required) The project GUID to scope the request ScopeIdentifier *uuid.UUID // (required) The name of the server hub: "build" for the Build server or "rm" for the Release Management server HubName *string // (required) PlanId *uuid.UUID }
Arguments for the CreateLog 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: "build" for the Build server or "rm" for the Release Management server 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: "build" for the Build server or "rm" for the Release Management server 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: "build" for the Build server or "rm" for the Release Management server 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: "build" for the Build server or "rm" for the Release Management server 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: "build" for the Build server or "rm" for the Release Management server 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: "build" for the Build server or "rm" for the Release Management server 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: "build" for the Build server or "rm" for the Release Management server 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: "build" for the Build server or "rm" for the Release Management server 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: "build" for the Build server or "rm" for the Release Management server 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: "build" for the Build server or "rm" for the Release Management server 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: "build" for the Build server or "rm" for the Release Management server HubName *string // (required) PlanId *uuid.UUID }
Arguments for the GetTimelines function
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 PlanEnvironment ¶
type ProjectReference ¶
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"` Task *TaskAgentJobTask `json:"task,omitempty"` TimeoutInMinutes *int `json:"timeoutInMinutes,omitempty"` Type *TaskAgentJobStepType `json:"type,omitempty"` }
type TaskAgentJobStepType ¶
type TaskAgentJobStepType string
type TaskAgentJobTask ¶
type TaskAgentJobVariable ¶
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 TaskLog ¶
type TaskLog struct { Id *int `json:"id,omitempty"` Location *string `json:"location,omitempty"` CreatedOn *azuredevops.Time `json:"createdOn,omitempty"` IndexLocation *string `json:"indexLocation,omitempty"` LastChangedOn *azuredevops.Time `json:"lastChangedOn,omitempty"` LineCount *uint64 `json:"lineCount,omitempty"` Path *string `json:"path,omitempty"` }
type TaskLogReference ¶
type TaskOrchestrationContainer ¶
type TaskOrchestrationContainer struct { ItemType *TaskOrchestrationItemType `json:"itemType,omitempty"` Children *[]TaskOrchestrationItem `json:"children,omitempty"` ContinueOnError *bool `json:"continueOnError,omitempty"` Data *map[string]string `json:"data,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 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"` 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 TaskResult ¶
type TaskResult string
type Timeline ¶
type Timeline struct { ChangeId *int `json:"changeId,omitempty"` Id *uuid.UUID `json:"id,omitempty"` 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 { // Gets or sets the attempt of the record. Attempt *int `json:"attempt,omitempty"` // Gets or sets the unique identifier for the record. Identifier *string `json:"identifier,omitempty"` // Gets or sets the record identifier located within the specified timeline. RecordId *uuid.UUID `json:"recordId,omitempty"` // Gets or sets the timeline identifier which owns the record representing this attempt. TimelineId *uuid.UUID `json:"timelineId,omitempty"` }
type TimelineRecord ¶
type TimelineRecord struct { Attempt *int `json:"attempt,omitempty"` ChangeId *int `json:"changeId,omitempty"` CurrentOperation *string `json:"currentOperation,omitempty"` Details *TimelineReference `json:"details,omitempty"` ErrorCount *int `json:"errorCount,omitempty"` FinishTime *azuredevops.Time `json:"finishTime,omitempty"` Id *uuid.UUID `json:"id,omitempty"` Identifier *string `json:"identifier,omitempty"` Issues *[]Issue `json:"issues,omitempty"` LastModified *azuredevops.Time `json:"lastModified,omitempty"` Location *string `json:"location,omitempty"` Log *TaskLogReference `json:"log,omitempty"` Name *string `json:"name,omitempty"` Order *int `json:"order,omitempty"` ParentId *uuid.UUID `json:"parentId,omitempty"` PercentComplete *int `json:"percentComplete,omitempty"` PreviousAttempts *[]TimelineAttempt `json:"previousAttempts,omitempty"` RefName *string `json:"refName,omitempty"` Result *TaskResult `json:"result,omitempty"` ResultCode *string `json:"resultCode,omitempty"` StartTime *azuredevops.Time `json:"startTime,omitempty"` State *TimelineRecordState `json:"state,omitempty"` Task *TaskReference `json:"task,omitempty"` Type *string `json:"type,omitempty"` Variables *map[string]interface{} `json:"variables,omitempty"` WarningCount *int `json:"warningCount,omitempty"` WorkerName *string `json:"workerName,omitempty"` }
type TimelineRecordState ¶
type TimelineRecordState string
type TimelineReference ¶
type UpdateRecordsArgs ¶
type UpdateRecordsArgs struct { // (required) Records *azuredevops.VssJsonCollectionWrapper // (required) The project GUID to scope the request ScopeIdentifier *uuid.UUID // (required) The name of the server hub: "build" for the Build server or "rm" for the Release Management server HubName *string // (required) PlanId *uuid.UUID // (required) TimelineId *uuid.UUID }
Arguments for the UpdateRecords function