tfvc

package
v7.1.1 Latest Latest
Warning

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

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

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var ResourceAreaId, _ = uuid.Parse("8aa40520-446d-40e6-89f6-9c9f9ce44c48")

Functions

This section is empty.

Types

type Client 

type Client interface {
	// [Preview API] Create a new changeset.
	CreateChangeset(context.Context, CreateChangesetArgs) (*git.TfvcChangesetRef, error)
	// [Preview API] Returns changesets for a given list of changeset Ids.
	GetBatchedChangesets(context.Context, GetBatchedChangesetsArgs) (*[]git.TfvcChangesetRef, error)
	// [Preview API] Get a single branch hierarchy at the given path with parents or children as specified.
	GetBranch(context.Context, GetBranchArgs) (*git.TfvcBranch, error)
	// [Preview API] Get a collection of branch roots -- first-level children, branches with no parents.
	GetBranches(context.Context, GetBranchesArgs) (*[]git.TfvcBranch, error)
	// [Preview API] Get branch hierarchies below the specified scopePath
	GetBranchRefs(context.Context, GetBranchRefsArgs) (*[]git.TfvcBranchRef, error)
	// [Preview API] Retrieve a Tfvc Changeset
	GetChangeset(context.Context, GetChangesetArgs) (*git.TfvcChangeset, error)
	// [Preview API] Retrieve Tfvc changes for a given changeset.
	GetChangesetChanges(context.Context, GetChangesetChangesArgs) (*GetChangesetChangesResponseValue, error)
	// [Preview API] Retrieve Tfvc Changesets
	GetChangesets(context.Context, GetChangesetsArgs) (*[]git.TfvcChangesetRef, error)
	// [Preview API] Retrieves the work items associated with a particular changeset.
	GetChangesetWorkItems(context.Context, GetChangesetWorkItemsArgs) (*[]git.AssociatedWorkItem, error)
	// [Preview API] Get Item Metadata and/or Content for a single item. The download parameter is to indicate whether the content should be available as a download or just sent as a stream in the response. Doesn't apply to zipped content which is always returned as a download.
	GetItem(context.Context, GetItemArgs) (*git.TfvcItem, error)
	// [Preview API] Get Item Metadata and/or Content for a single item. The download parameter is to indicate whether the content should be available as a download or just sent as a stream in the response. Doesn't apply to zipped content which is always returned as a download.
	GetItemContent(context.Context, GetItemContentArgs) (io.ReadCloser, error)
	// [Preview API] Get a list of Tfvc items
	GetItems(context.Context, GetItemsArgs) (*[]git.TfvcItem, error)
	// [Preview API] Post for retrieving a set of items given a list of paths or a long path. Allows for specifying the recursionLevel and version descriptors for each path.
	GetItemsBatch(context.Context, GetItemsBatchArgs) (*[][]git.TfvcItem, error)
	// [Preview API] Post for retrieving a set of items given a list of paths or a long path. Allows for specifying the recursionLevel and version descriptors for each path.
	GetItemsBatchZip(context.Context, GetItemsBatchZipArgs) (io.ReadCloser, error)
	// [Preview API] Get Item Metadata and/or Content for a single item. The download parameter is to indicate whether the content should be available as a download or just sent as a stream in the response. Doesn't apply to zipped content which is always returned as a download.
	GetItemText(context.Context, GetItemTextArgs) (io.ReadCloser, error)
	// [Preview API] Get Item Metadata and/or Content for a single item. The download parameter is to indicate whether the content should be available as a download or just sent as a stream in the response. Doesn't apply to zipped content which is always returned as a download.
	GetItemZip(context.Context, GetItemZipArgs) (io.ReadCloser, error)
	// [Preview API] Get a single deep label.
	GetLabel(context.Context, GetLabelArgs) (*git.TfvcLabel, error)
	// [Preview API] Get items under a label.
	GetLabelItems(context.Context, GetLabelItemsArgs) (*[]git.TfvcItem, error)
	// [Preview API] Get a collection of shallow label references.
	GetLabels(context.Context, GetLabelsArgs) (*[]git.TfvcLabelRef, error)
	// [Preview API] Get a single deep shelveset.
	GetShelveset(context.Context, GetShelvesetArgs) (*git.TfvcShelveset, error)
	// [Preview API] Get changes included in a shelveset.
	GetShelvesetChanges(context.Context, GetShelvesetChangesArgs) (*[]git.TfvcChange, error)
	// [Preview API] Return a collection of shallow shelveset references.
	GetShelvesets(context.Context, GetShelvesetsArgs) (*[]git.TfvcShelvesetRef, error)
	// [Preview API] Get work items associated with a shelveset.
	GetShelvesetWorkItems(context.Context, GetShelvesetWorkItemsArgs) (*[]git.AssociatedWorkItem, error)
}

func NewClient 

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

type ClientImpl 

type ClientImpl struct {
	Client azuredevops.Client
}

func (*ClientImpl) CreateChangeset 

func (client *ClientImpl) CreateChangeset(ctx context.Context, args CreateChangesetArgs) (*git.TfvcChangesetRef, error)

[Preview API] Create a new changeset.

func (*ClientImpl) GetBatchedChangesets 

func (client *ClientImpl) GetBatchedChangesets(ctx context.Context, args GetBatchedChangesetsArgs) (*[]git.TfvcChangesetRef, error)

[Preview API] Returns changesets for a given list of changeset Ids.

func (*ClientImpl) GetBranch 

func (client *ClientImpl) GetBranch(ctx context.Context, args GetBranchArgs) (*git.TfvcBranch, error)

[Preview API] Get a single branch hierarchy at the given path with parents or children as specified.

func (*ClientImpl) GetBranchRefs 

func (client *ClientImpl) GetBranchRefs(ctx context.Context, args GetBranchRefsArgs) (*[]git.TfvcBranchRef, error)

[Preview API] Get branch hierarchies below the specified scopePath

func (*ClientImpl) GetBranches 

func (client *ClientImpl) GetBranches(ctx context.Context, args GetBranchesArgs) (*[]git.TfvcBranch, error)

[Preview API] Get a collection of branch roots -- first-level children, branches with no parents.

func (*ClientImpl) GetChangeset 

func (client *ClientImpl) GetChangeset(ctx context.Context, args GetChangesetArgs) (*git.TfvcChangeset, error)

[Preview API] Retrieve a Tfvc Changeset

func (*ClientImpl) GetChangesetChanges 

func (client *ClientImpl) GetChangesetChanges(ctx context.Context, args GetChangesetChangesArgs) (*GetChangesetChangesResponseValue, error)

[Preview API] Retrieve Tfvc changes for a given changeset.

func (*ClientImpl) GetChangesetWorkItems 

func (client *ClientImpl) GetChangesetWorkItems(ctx context.Context, args GetChangesetWorkItemsArgs) (*[]git.AssociatedWorkItem, error)

[Preview API] Retrieves the work items associated with a particular changeset.

func (*ClientImpl) GetChangesets 

func (client *ClientImpl) GetChangesets(ctx context.Context, args GetChangesetsArgs) (*[]git.TfvcChangesetRef, error)

[Preview API] Retrieve Tfvc Changesets

func (*ClientImpl) GetItem 

func (client *ClientImpl) GetItem(ctx context.Context, args GetItemArgs) (*git.TfvcItem, error)

[Preview API] Get Item Metadata and/or Content for a single item. The download parameter is to indicate whether the content should be available as a download or just sent as a stream in the response. Doesn't apply to zipped content which is always returned as a download.

func (*ClientImpl) GetItemContent 

func (client *ClientImpl) GetItemContent(ctx context.Context, args GetItemContentArgs) (io.ReadCloser, error)

[Preview API] Get Item Metadata and/or Content for a single item. The download parameter is to indicate whether the content should be available as a download or just sent as a stream in the response. Doesn't apply to zipped content which is always returned as a download.

func (*ClientImpl) GetItemText 

func (client *ClientImpl) GetItemText(ctx context.Context, args GetItemTextArgs) (io.ReadCloser, error)

[Preview API] Get Item Metadata and/or Content for a single item. The download parameter is to indicate whether the content should be available as a download or just sent as a stream in the response. Doesn't apply to zipped content which is always returned as a download.

func (*ClientImpl) GetItemZip 

func (client *ClientImpl) GetItemZip(ctx context.Context, args GetItemZipArgs) (io.ReadCloser, error)

[Preview API] Get Item Metadata and/or Content for a single item. The download parameter is to indicate whether the content should be available as a download or just sent as a stream in the response. Doesn't apply to zipped content which is always returned as a download.

func (*ClientImpl) GetItems 

func (client *ClientImpl) GetItems(ctx context.Context, args GetItemsArgs) (*[]git.TfvcItem, error)

[Preview API] Get a list of Tfvc items

func (*ClientImpl) GetItemsBatch 

func (client *ClientImpl) GetItemsBatch(ctx context.Context, args GetItemsBatchArgs) (*[][]git.TfvcItem, error)

[Preview API] Post for retrieving a set of items given a list of paths or a long path. Allows for specifying the recursionLevel and version descriptors for each path.

func (*ClientImpl) GetItemsBatchZip 

func (client *ClientImpl) GetItemsBatchZip(ctx context.Context, args GetItemsBatchZipArgs) (io.ReadCloser, error)

[Preview API] Post for retrieving a set of items given a list of paths or a long path. Allows for specifying the recursionLevel and version descriptors for each path.

func (*ClientImpl) GetLabel 

func (client *ClientImpl) GetLabel(ctx context.Context, args GetLabelArgs) (*git.TfvcLabel, error)

[Preview API] Get a single deep label.

func (*ClientImpl) GetLabelItems 

func (client *ClientImpl) GetLabelItems(ctx context.Context, args GetLabelItemsArgs) (*[]git.TfvcItem, error)

[Preview API] Get items under a label.

func (*ClientImpl) GetLabels 

func (client *ClientImpl) GetLabels(ctx context.Context, args GetLabelsArgs) (*[]git.TfvcLabelRef, error)

[Preview API] Get a collection of shallow label references.

func (*ClientImpl) GetShelveset 

func (client *ClientImpl) GetShelveset(ctx context.Context, args GetShelvesetArgs) (*git.TfvcShelveset, error)

[Preview API] Get a single deep shelveset.

func (*ClientImpl) GetShelvesetChanges 

func (client *ClientImpl) GetShelvesetChanges(ctx context.Context, args GetShelvesetChangesArgs) (*[]git.TfvcChange, error)

[Preview API] Get changes included in a shelveset.

func (*ClientImpl) GetShelvesetWorkItems 

func (client *ClientImpl) GetShelvesetWorkItems(ctx context.Context, args GetShelvesetWorkItemsArgs) (*[]git.AssociatedWorkItem, error)

[Preview API] Get work items associated with a shelveset.

func (*ClientImpl) GetShelvesets 

func (client *ClientImpl) GetShelvesets(ctx context.Context, args GetShelvesetsArgs) (*[]git.TfvcShelvesetRef, error)

[Preview API] Return a collection of shallow shelveset references.

type CreateChangesetArgs 

type CreateChangesetArgs struct {
	// (required)
	Changeset *git.TfvcChangeset
	// (optional) Project ID or project name
	Project *string
}

Arguments for the CreateChangeset function

type GetBatchedChangesetsArgs 

type GetBatchedChangesetsArgs struct {
	// (required) List of changeset IDs.
	ChangesetsRequestData *git.TfvcChangesetsRequestData
}

Arguments for the GetBatchedChangesets function

type GetBranchArgs 

type GetBranchArgs struct {
	// (required) Full path to the branch.  Default: $/ Examples: $/, $/MyProject, $/MyProject/SomeFolder.
	Path *string
	// (optional) Project ID or project name
	Project *string
	// (optional) Return the parent branch, if there is one. Default: False
	IncludeParent *bool
	// (optional) Return child branches, if there are any. Default: False
	IncludeChildren *bool
}

Arguments for the GetBranch function

type GetBranchRefsArgs 

type GetBranchRefsArgs struct {
	// (required) Full path to the branch.  Default: $/ Examples: $/, $/MyProject, $/MyProject/SomeFolder.
	ScopePath *string
	// (optional) Project ID or project name
	Project *string
	// (optional) Return deleted branches. Default: False
	IncludeDeleted *bool
	// (optional) Return links. Default: False
	IncludeLinks *bool
}

Arguments for the GetBranchRefs function

type GetBranchesArgs 

type GetBranchesArgs struct {
	// (optional) Project ID or project name
	Project *string
	// (optional) Return the parent branch, if there is one. Default: False
	IncludeParent *bool
	// (optional) Return the child branches for each root branch. Default: False
	IncludeChildren *bool
	// (optional) Return deleted branches. Default: False
	IncludeDeleted *bool
	// (optional) Return links. Default: False
	IncludeLinks *bool
}

Arguments for the GetBranches function

type GetChangesetArgs 

type GetChangesetArgs struct {
	// (required) Changeset Id to retrieve.
	Id *int
	// (optional) Project ID or project name
	Project *string
	// (optional) Number of changes to return (maximum 100 changes) Default: 0
	MaxChangeCount *int
	// (optional) Include policy details and check-in notes in the response. Default: false
	IncludeDetails *bool
	// (optional) Include workitems. Default: false
	IncludeWorkItems *bool
	// (optional) Include details about associated work items in the response. Default: null
	MaxCommentLength *int
	// (optional) Include renames.  Default: false
	IncludeSourceRename *bool
	// (optional) Number of results to skip. Default: null
	Skip *int
	// (optional) The maximum number of results to return. Default: null
	Top *int
	// (optional) Results are sorted by ID in descending order by default. Use id asc to sort by ID in ascending order.
	Orderby *string
	// (optional) Following criteria available (.itemPath, .version, .versionType, .versionOption, .author, .fromId, .toId, .fromDate, .toDate) Default: null
	SearchCriteria *git.TfvcChangesetSearchCriteria
}

Arguments for the GetChangeset function

type GetChangesetChangesArgs 

type GetChangesetChangesArgs struct {
	// (optional) ID of the changeset. Default: null
	Id *int
	// (optional) Number of results to skip. Default: null
	Skip *int
	// (optional) The maximum number of results to return. Default: null
	Top *int
}

Arguments for the GetChangesetChanges function

type GetChangesetChangesResponseValue 

type GetChangesetChangesResponseValue struct {
	Value             []git.TfvcChange
	ContinuationToken string
}

Return type for the GetChangesetChanges function

type GetChangesetWorkItemsArgs 

type GetChangesetWorkItemsArgs struct {
	// (optional) ID of the changeset.
	Id *int
}

Arguments for the GetChangesetWorkItems function

type GetChangesetsArgs 

type GetChangesetsArgs struct {
	// (optional) Project ID or project name
	Project *string
	// (optional) Include details about associated work items in the response. Default: null
	MaxCommentLength *int
	// (optional) Number of results to skip. Default: null
	Skip *int
	// (optional) The maximum number of results to return. Default: null
	Top *int
	// (optional) Results are sorted by ID in descending order by default. Use id asc to sort by ID in ascending order.
	Orderby *string
	// (optional) Following criteria available (.itemPath, .version, .versionType, .versionOption, .author, .fromId, .toId, .fromDate, .toDate) Default: null
	SearchCriteria *git.TfvcChangesetSearchCriteria
}

Arguments for the GetChangesets function

type GetItemArgs 

type GetItemArgs struct {
	// (required) Version control path of an individual item to return.
	Path *string
	// (optional) Project ID or project name
	Project *string
	// (optional) file name of item returned.
	FileName *string
	// (optional) If true, create a downloadable attachment.
	Download *bool
	// (optional) Version control path of a folder to return multiple items.
	ScopePath *string
	// (optional) None (just the item), or OneLevel (contents of a folder).
	RecursionLevel *git.VersionControlRecursionType
	// (optional) Version descriptor.  Default is null.
	VersionDescriptor *git.TfvcVersionDescriptor
	// (optional) Set to true to include item content when requesting json.  Default is false.
	IncludeContent *bool
}

Arguments for the GetItem function

type GetItemContentArgs 

type GetItemContentArgs struct {
	// (required) Version control path of an individual item to return.
	Path *string
	// (optional) Project ID or project name
	Project *string
	// (optional) file name of item returned.
	FileName *string
	// (optional) If true, create a downloadable attachment.
	Download *bool
	// (optional) Version control path of a folder to return multiple items.
	ScopePath *string
	// (optional) None (just the item), or OneLevel (contents of a folder).
	RecursionLevel *git.VersionControlRecursionType
	// (optional) Version descriptor.  Default is null.
	VersionDescriptor *git.TfvcVersionDescriptor
	// (optional) Set to true to include item content when requesting json.  Default is false.
	IncludeContent *bool
}

Arguments for the GetItemContent function

type GetItemTextArgs 

type GetItemTextArgs struct {
	// (required) Version control path of an individual item to return.
	Path *string
	// (optional) Project ID or project name
	Project *string
	// (optional) file name of item returned.
	FileName *string
	// (optional) If true, create a downloadable attachment.
	Download *bool
	// (optional) Version control path of a folder to return multiple items.
	ScopePath *string
	// (optional) None (just the item), or OneLevel (contents of a folder).
	RecursionLevel *git.VersionControlRecursionType
	// (optional) Version descriptor.  Default is null.
	VersionDescriptor *git.TfvcVersionDescriptor
	// (optional) Set to true to include item content when requesting json.  Default is false.
	IncludeContent *bool
}

Arguments for the GetItemText function

type GetItemZipArgs 

type GetItemZipArgs struct {
	// (required) Version control path of an individual item to return.
	Path *string
	// (optional) Project ID or project name
	Project *string
	// (optional) file name of item returned.
	FileName *string
	// (optional) If true, create a downloadable attachment.
	Download *bool
	// (optional) Version control path of a folder to return multiple items.
	ScopePath *string
	// (optional) None (just the item), or OneLevel (contents of a folder).
	RecursionLevel *git.VersionControlRecursionType
	// (optional) Version descriptor.  Default is null.
	VersionDescriptor *git.TfvcVersionDescriptor
	// (optional) Set to true to include item content when requesting json.  Default is false.
	IncludeContent *bool
}

Arguments for the GetItemZip function

type GetItemsArgs 

type GetItemsArgs struct {
	// (optional) Project ID or project name
	Project *string
	// (optional) Version control path of a folder to return multiple items.
	ScopePath *string
	// (optional) None (just the item), or OneLevel (contents of a folder).
	RecursionLevel *git.VersionControlRecursionType
	// (optional) True to include links.
	IncludeLinks *bool
	// (optional)
	VersionDescriptor *git.TfvcVersionDescriptor
}

Arguments for the GetItems function

type GetItemsBatchArgs 

type GetItemsBatchArgs struct {
	// (required)
	ItemRequestData *git.TfvcItemRequestData
	// (optional) Project ID or project name
	Project *string
}

Arguments for the GetItemsBatch function

type GetItemsBatchZipArgs 

type GetItemsBatchZipArgs struct {
	// (required)
	ItemRequestData *git.TfvcItemRequestData
	// (optional) Project ID or project name
	Project *string
}

Arguments for the GetItemsBatchZip function

type GetLabelArgs 

type GetLabelArgs struct {
	// (required) Unique identifier of label
	LabelId *string
	// (required) maxItemCount
	RequestData *git.TfvcLabelRequestData
	// (optional) Project ID or project name
	Project *string
}

Arguments for the GetLabel function

type GetLabelItemsArgs 

type GetLabelItemsArgs struct {
	// (required) Unique identifier of label
	LabelId *string
	// (optional) Max number of items to return
	Top *int
	// (optional) Number of items to skip
	Skip *int
}

Arguments for the GetLabelItems function

type GetLabelsArgs 

type GetLabelsArgs struct {
	// (required) labelScope, name, owner, and itemLabelFilter
	RequestData *git.TfvcLabelRequestData
	// (optional) Project ID or project name
	Project *string
	// (optional) Max number of labels to return, defaults to 100 when undefined
	Top *int
	// (optional) Number of labels to skip
	Skip *int
}

Arguments for the GetLabels function

type GetShelvesetArgs 

type GetShelvesetArgs struct {
	// (required) Shelveset's unique ID
	ShelvesetId *string
	// (optional) includeDetails, includeWorkItems, maxChangeCount, and maxCommentLength
	RequestData *git.TfvcShelvesetRequestData
}

Arguments for the GetShelveset function

type GetShelvesetChangesArgs 

type GetShelvesetChangesArgs struct {
	// (required) Shelveset's unique ID
	ShelvesetId *string
	// (optional) Max number of changes to return
	Top *int
	// (optional) Number of changes to skip
	Skip *int
}

Arguments for the GetShelvesetChanges function

type GetShelvesetWorkItemsArgs 

type GetShelvesetWorkItemsArgs struct {
	// (required) Shelveset's unique ID
	ShelvesetId *string
}

Arguments for the GetShelvesetWorkItems function

type GetShelvesetsArgs 

type GetShelvesetsArgs struct {
	// (optional) name, owner, and maxCommentLength
	RequestData *git.TfvcShelvesetRequestData
	// (optional) Max number of shelvesets to return
	Top *int
	// (optional) Number of shelvesets to skip
	Skip *int
}

Arguments for the GetShelvesets function

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.