core

package
v7.2.4 Latest Latest
Warning

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

 Go to latest Published: Mar 14, 2024 License: MIT Imports: 12 Imported by: 1

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var ConnectedServiceKindValues = connectedServiceKindValuesType{

	Custom: "custom",

	AzureSubscription: "azureSubscription",

	Chef: "chef",

	Generic: "generic",
}
View Source 
var ProcessCustomizationTypeValues = processCustomizationTypeValuesType{

	Unknown: "unknown",

	Xml: "xml",

	Inherited: "inherited",
}
View Source 
var ProcessTypeValues = processTypeValuesType{
	System:    "system",
	Custom:    "custom",
	Inherited: "inherited",
}
View Source 
var ProjectChangeTypeValues = projectChangeTypeValuesType{
	Modified: "modified",
	Deleted:  "deleted",
	Added:    "added",
}
View Source 
var ProjectStateValues = projectStateValuesType{

	Deleting: "deleting",

	New: "new",

	WellFormed: "wellFormed",

	CreatePending: "createPending",

	All: "all",

	Unchanged: "unchanged",

	Deleted: "deleted",
}
View Source 
var ProjectVisibilityValues = projectVisibilityValuesType{

	Private: "private",

	Public: "public",
}
View Source 
var ResourceAreaId, _ = uuid.Parse("79134c72-4a58-4b42-976c-04e7115f32bf")
View Source 
var SourceControlTypesValues = sourceControlTypesValuesType{
	Tfvc: "tfvc",
	Git:  "git",
}

Functions

This section is empty.

Types

type Client 

type Client interface {
	// [Preview API]
	CreateConnectedService(context.Context, CreateConnectedServiceArgs) (*WebApiConnectedService, error)
	// [Preview API]
	CreateOrUpdateProxy(context.Context, CreateOrUpdateProxyArgs) (*Proxy, error)
	// [Preview API] Create a team in a team project.
	CreateTeam(context.Context, CreateTeamArgs) (*WebApiTeam, error)
	// [Preview API]
	DeleteProxy(context.Context, DeleteProxyArgs) error
	// [Preview API] Delete a team.
	DeleteTeam(context.Context, DeleteTeamArgs) error
	// [Preview API] Get a list of all teams.
	GetAllTeams(context.Context, GetAllTeamsArgs) (*[]WebApiTeam, error)
	// [Preview API]
	GetConnectedServiceDetails(context.Context, GetConnectedServiceDetailsArgs) (*WebApiConnectedServiceDetails, error)
	// [Preview API]
	GetConnectedServices(context.Context, GetConnectedServicesArgs) (*[]WebApiConnectedService, error)
	// [Preview API] Get a process by ID.
	GetProcessById(context.Context, GetProcessByIdArgs) (*Process, error)
	// [Preview API] Get a list of processes.
	GetProcesses(context.Context, GetProcessesArgs) (*[]Process, error)
	// [Preview API] Get project with the specified id or name, optionally including capabilities.
	GetProject(context.Context, GetProjectArgs) (*TeamProject, error)
	// [Preview API] Get project collection with the specified id or name.
	GetProjectCollection(context.Context, GetProjectCollectionArgs) (*TeamProjectCollection, error)
	// [Preview API] Get project collection references for this application.
	GetProjectCollections(context.Context, GetProjectCollectionsArgs) (*[]TeamProjectCollectionReference, error)
	// [Preview API] Get a collection of team project properties.
	GetProjectProperties(context.Context, GetProjectPropertiesArgs) (*[]ProjectProperty, error)
	// [Preview API] Get all projects in the organization that the authenticated user has access to.
	GetProjects(context.Context, GetProjectsArgs) (*GetProjectsResponseValue, error)
	// [Preview API]
	GetProxies(context.Context, GetProxiesArgs) (*[]Proxy, error)
	// [Preview API] Get a specific team.
	GetTeam(context.Context, GetTeamArgs) (*WebApiTeam, error)
	// [Preview API] Get a list of members for a specific team.
	GetTeamMembersWithExtendedProperties(context.Context, GetTeamMembersWithExtendedPropertiesArgs) (*[]webapi.TeamMember, error)
	// [Preview API] Get a list of teams.
	GetTeams(context.Context, GetTeamsArgs) (*[]WebApiTeam, error)
	// [Preview API] Queues a project to be created. Use the [GetOperation](../../operations/operations/get) to periodically check for create project status.
	QueueCreateProject(context.Context, QueueCreateProjectArgs) (*operations.OperationReference, error)
	// [Preview API] Queues a project to be deleted. Use the [GetOperation](../../operations/operations/get) to periodically check for delete project status.
	QueueDeleteProject(context.Context, QueueDeleteProjectArgs) (*operations.OperationReference, error)
	// [Preview API] Removes the avatar for the project.
	RemoveProjectAvatar(context.Context, RemoveProjectAvatarArgs) error
	// [Preview API] Sets the avatar for the project.
	SetProjectAvatar(context.Context, SetProjectAvatarArgs) error
	// [Preview API] Create, update, and delete team project properties.
	SetProjectProperties(context.Context, SetProjectPropertiesArgs) error
	// [Preview API] Update an existing project's name, abbreviation, description, or restore a project.
	UpdateProject(context.Context, UpdateProjectArgs) (*operations.OperationReference, error)
	// [Preview API] Update a team's name and/or description.
	UpdateTeam(context.Context, UpdateTeamArgs) (*WebApiTeam, error)
}

func NewClient 

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

type ClientImpl 

type ClientImpl struct {
	Client azuredevops.Client
}

func (*ClientImpl) CreateConnectedService 

func (client *ClientImpl) CreateConnectedService(ctx context.Context, args CreateConnectedServiceArgs) (*WebApiConnectedService, error)

[Preview API]

func (*ClientImpl) CreateOrUpdateProxy 

func (client *ClientImpl) CreateOrUpdateProxy(ctx context.Context, args CreateOrUpdateProxyArgs) (*Proxy, error)

[Preview API]

func (*ClientImpl) CreateTeam 

func (client *ClientImpl) CreateTeam(ctx context.Context, args CreateTeamArgs) (*WebApiTeam, error)

[Preview API] Create a team in a team project.

func (*ClientImpl) DeleteProxy 

func (client *ClientImpl) DeleteProxy(ctx context.Context, args DeleteProxyArgs) error

[Preview API]

func (*ClientImpl) DeleteTeam 

func (client *ClientImpl) DeleteTeam(ctx context.Context, args DeleteTeamArgs) error

[Preview API] Delete a team.

func (*ClientImpl) GetAllTeams 

func (client *ClientImpl) GetAllTeams(ctx context.Context, args GetAllTeamsArgs) (*[]WebApiTeam, error)

[Preview API] Get a list of all teams.

func (*ClientImpl) GetConnectedServiceDetails 

func (client *ClientImpl) GetConnectedServiceDetails(ctx context.Context, args GetConnectedServiceDetailsArgs) (*WebApiConnectedServiceDetails, error)

[Preview API]

func (*ClientImpl) GetConnectedServices 

func (client *ClientImpl) GetConnectedServices(ctx context.Context, args GetConnectedServicesArgs) (*[]WebApiConnectedService, error)

[Preview API]

func (*ClientImpl) GetProcessById 

func (client *ClientImpl) GetProcessById(ctx context.Context, args GetProcessByIdArgs) (*Process, error)

[Preview API] Get a process by ID.

func (*ClientImpl) GetProcesses 

func (client *ClientImpl) GetProcesses(ctx context.Context, args GetProcessesArgs) (*[]Process, error)

[Preview API] Get a list of processes.

func (*ClientImpl) GetProject 

func (client *ClientImpl) GetProject(ctx context.Context, args GetProjectArgs) (*TeamProject, error)

[Preview API] Get project with the specified id or name, optionally including capabilities.

func (*ClientImpl) GetProjectCollection 

func (client *ClientImpl) GetProjectCollection(ctx context.Context, args GetProjectCollectionArgs) (*TeamProjectCollection, error)

[Preview API] Get project collection with the specified id or name.

func (*ClientImpl) GetProjectCollections 

func (client *ClientImpl) GetProjectCollections(ctx context.Context, args GetProjectCollectionsArgs) (*[]TeamProjectCollectionReference, error)

[Preview API] Get project collection references for this application.

func (*ClientImpl) GetProjectProperties 

func (client *ClientImpl) GetProjectProperties(ctx context.Context, args GetProjectPropertiesArgs) (*[]ProjectProperty, error)

[Preview API] Get a collection of team project properties.

func (*ClientImpl) GetProjects 

func (client *ClientImpl) GetProjects(ctx context.Context, args GetProjectsArgs) (*GetProjectsResponseValue, error)

[Preview API] Get all projects in the organization that the authenticated user has access to.

func (*ClientImpl) GetProxies 

func (client *ClientImpl) GetProxies(ctx context.Context, args GetProxiesArgs) (*[]Proxy, error)

[Preview API]

func (*ClientImpl) GetTeam 

func (client *ClientImpl) GetTeam(ctx context.Context, args GetTeamArgs) (*WebApiTeam, error)

[Preview API] Get a specific team.

func (*ClientImpl) GetTeamMembersWithExtendedProperties 

func (client *ClientImpl) GetTeamMembersWithExtendedProperties(ctx context.Context, args GetTeamMembersWithExtendedPropertiesArgs) (*[]webapi.TeamMember, error)

[Preview API] Get a list of members for a specific team.

func (*ClientImpl) GetTeams 

func (client *ClientImpl) GetTeams(ctx context.Context, args GetTeamsArgs) (*[]WebApiTeam, error)

[Preview API] Get a list of teams.

func (*ClientImpl) QueueCreateProject 

func (client *ClientImpl) QueueCreateProject(ctx context.Context, args QueueCreateProjectArgs) (*operations.OperationReference, error)

[Preview API] Queues a project to be created. Use the [GetOperation](../../operations/operations/get) to periodically check for create project status.

func (*ClientImpl) QueueDeleteProject 

func (client *ClientImpl) QueueDeleteProject(ctx context.Context, args QueueDeleteProjectArgs) (*operations.OperationReference, error)

[Preview API] Queues a project to be deleted. Use the [GetOperation](../../operations/operations/get) to periodically check for delete project status.

func (*ClientImpl) RemoveProjectAvatar 

func (client *ClientImpl) RemoveProjectAvatar(ctx context.Context, args RemoveProjectAvatarArgs) error

[Preview API] Removes the avatar for the project.

func (*ClientImpl) SetProjectAvatar 

func (client *ClientImpl) SetProjectAvatar(ctx context.Context, args SetProjectAvatarArgs) error

[Preview API] Sets the avatar for the project.

func (*ClientImpl) SetProjectProperties 

func (client *ClientImpl) SetProjectProperties(ctx context.Context, args SetProjectPropertiesArgs) error

[Preview API] Create, update, and delete team project properties.

func (*ClientImpl) UpdateProject 

func (client *ClientImpl) UpdateProject(ctx context.Context, args UpdateProjectArgs) (*operations.OperationReference, error)

[Preview API] Update an existing project's name, abbreviation, description, or restore a project.

func (*ClientImpl) UpdateTeam 

func (client *ClientImpl) UpdateTeam(ctx context.Context, args UpdateTeamArgs) (*WebApiTeam, error)

[Preview API] Update a team's name and/or description.

type ConnectedServiceKind 

type ConnectedServiceKind string

type CreateConnectedServiceArgs 

type CreateConnectedServiceArgs struct {
	// (required)
	ConnectedServiceCreationData *WebApiConnectedServiceDetails
	// (required)
	ProjectId *string
}

Arguments for the CreateConnectedService function

type CreateOrUpdateProxyArgs 

type CreateOrUpdateProxyArgs struct {
	// (required)
	Proxy *Proxy
}

Arguments for the CreateOrUpdateProxy function

type CreateTeamArgs 

type CreateTeamArgs struct {
	// (required) The team data used to create the team.
	Team *WebApiTeam
	// (required) The name or ID (GUID) of the team project in which to create the team.
	ProjectId *string
}

Arguments for the CreateTeam function

type DeleteProxyArgs 

type DeleteProxyArgs struct {
	// (required)
	ProxyUrl *string
	// (optional)
	Site *string
}

Arguments for the DeleteProxy function

type DeleteTeamArgs 

type DeleteTeamArgs struct {
	// (required) The name or ID (GUID) of the team project containing the team to delete.
	ProjectId *string
	// (required) The name or ID of the team to delete.
	TeamId *string
}

Arguments for the DeleteTeam function

type GetAllTeamsArgs 

type GetAllTeamsArgs struct {
	// (optional) If true, then return all teams requesting user is member. Otherwise return all teams user has read access.
	Mine *bool
	// (optional) Maximum number of teams to return.
	Top *int
	// (optional) Number of teams to skip.
	Skip *int
	// (optional) A value indicating whether or not to expand Identity information in the result WebApiTeam object.
	ExpandIdentity *bool
}

Arguments for the GetAllTeams function

type GetConnectedServiceDetailsArgs 

type GetConnectedServiceDetailsArgs struct {
	// (required)
	ProjectId *string
	// (required)
	Name *string
}

Arguments for the GetConnectedServiceDetails function

type GetConnectedServicesArgs 

type GetConnectedServicesArgs struct {
	// (required)
	ProjectId *string
	// (optional)
	Kind *ConnectedServiceKind
}

Arguments for the GetConnectedServices function

type GetProcessByIdArgs 

type GetProcessByIdArgs struct {
	// (required) ID for a process.
	ProcessId *uuid.UUID
}

Arguments for the GetProcessById function

type GetProcessesArgs 

type GetProcessesArgs struct {
}

Arguments for the GetProcesses function

type GetProjectArgs 

type GetProjectArgs struct {
	// (required)
	ProjectId *string
	// (optional) Include capabilities (such as source control) in the team project result (default: false).
	IncludeCapabilities *bool
	// (optional) Search within renamed projects (that had such name in the past).
	IncludeHistory *bool
}

Arguments for the GetProject function

type GetProjectCollectionArgs 

type GetProjectCollectionArgs struct {
	// (required)
	CollectionId *string
}

Arguments for the GetProjectCollection function

type GetProjectCollectionsArgs 

type GetProjectCollectionsArgs struct {
	// (optional)
	Top *int
	// (optional)
	Skip *int
}

Arguments for the GetProjectCollections function

type GetProjectPropertiesArgs 

type GetProjectPropertiesArgs struct {
	// (required) The team project ID.
	ProjectId *uuid.UUID
	// (optional) A comma-delimited string of team project property names. Wildcard characters ("?" and "*") are supported. If no key is specified, all properties will be returned.
	Keys *[]string
}

Arguments for the GetProjectProperties function

type GetProjectsArgs 

type GetProjectsArgs struct {
	// (optional) Filter on team projects in a specific team project state (default: WellFormed).
	StateFilter *ProjectState
	// (optional)
	Top *int
	// (optional)
	Skip *int
	// (optional) Pointer that shows how many projects already been fetched.
	ContinuationToken *int
	// (optional)
	GetDefaultTeamImageUrl *bool
}

Arguments for the GetProjects function

type GetProjectsResponseValue 

type GetProjectsResponseValue struct {
	Value             []TeamProjectReference
	ContinuationToken string
}

Return type for the GetProjects function

type GetProxiesArgs 

type GetProxiesArgs struct {
	// (optional)
	ProxyUrl *string
}

Arguments for the GetProxies function

type GetTeamArgs 

type GetTeamArgs struct {
	// (required) The name or ID (GUID) of the team project containing the team.
	ProjectId *string
	// (required) The name or ID (GUID) of the team.
	TeamId *string
	// (optional) A value indicating whether or not to expand Identity information in the result WebApiTeam object.
	ExpandIdentity *bool
}

Arguments for the GetTeam function

type GetTeamMembersWithExtendedPropertiesArgs 

type GetTeamMembersWithExtendedPropertiesArgs struct {
	// (required) The name or ID (GUID) of the team project the team belongs to.
	ProjectId *string
	// (required) The name or ID (GUID) of the team .
	TeamId *string
	// (optional)
	Top *int
	// (optional)
	Skip *int
}

Arguments for the GetTeamMembersWithExtendedProperties function

type GetTeamsArgs 

type GetTeamsArgs struct {
	// (required)
	ProjectId *string
	// (optional) If true return all the teams requesting user is member, otherwise return all the teams user has read access.
	Mine *bool
	// (optional) Maximum number of teams to return.
	Top *int
	// (optional) Number of teams to skip.
	Skip *int
	// (optional) A value indicating whether or not to expand Identity information in the result WebApiTeam object.
	ExpandIdentity *bool
}

Arguments for the GetTeams function

type IdentityData 

type IdentityData struct {
	IdentityIds *[]uuid.UUID `json:"identityIds,omitempty"`
}

type Process 

type Process struct {
	Name        *string      `json:"name,omitempty"`
	Url         *string      `json:"url,omitempty"`
	Links       interface{}  `json:"_links,omitempty"`
	Description *string      `json:"description,omitempty"`
	Id          *uuid.UUID   `json:"id,omitempty"`
	IsDefault   *bool        `json:"isDefault,omitempty"`
	Type        *ProcessType `json:"type,omitempty"`
}

type ProcessCustomizationType 

type ProcessCustomizationType string

Type of process customization on a collection.

type ProcessReference 

type ProcessReference struct {
	Name *string `json:"name,omitempty"`
	Url  *string `json:"url,omitempty"`
}

type ProcessType 

type ProcessType string

type ProjectAvatar 

type ProjectAvatar struct {
	// The avatar image represented as a byte array.
	Image *[]byte `json:"image,omitempty"`
}

Contains the image data for project avatar.

type ProjectChangeType 

type ProjectChangeType string

type ProjectInfo 

type ProjectInfo struct {
	// The abbreviated name of the project.
	Abbreviation *string `json:"abbreviation,omitempty"`
	// The description of the project.
	Description *string `json:"description,omitempty"`
	// The id of the project.
	Id *uuid.UUID `json:"id,omitempty"`
	// The time that this project was last updated.
	LastUpdateTime *azuredevops.Time `json:"lastUpdateTime,omitempty"`
	// The name of the project.
	Name *string `json:"name,omitempty"`
	// A set of name-value pairs storing additional property data related to the project.
	Properties *[]ProjectProperty `json:"properties,omitempty"`
	// The current revision of the project.
	Revision *uint64 `json:"revision,omitempty"`
	// The current state of the project.
	State *ProjectState `json:"state,omitempty"`
	// A Uri that can be used to refer to this project.
	Uri *string `json:"uri,omitempty"`
	// The version number of the project.
	Version *uint64 `json:"version,omitempty"`
	// Indicates whom the project is visible to.
	Visibility *ProjectVisibility `json:"visibility,omitempty"`
}

Contains information describing a project.

type ProjectMessage 

type ProjectMessage struct {
	Project                     *ProjectInfo       `json:"project,omitempty"`
	ProjectChangeType           *ProjectChangeType `json:"projectChangeType,omitempty"`
	ShouldInvalidateSystemStore *bool              `json:"shouldInvalidateSystemStore,omitempty"`
}

type ProjectProperties 

type ProjectProperties struct {
	// The team project Id
	ProjectId *uuid.UUID `json:"projectId,omitempty"`
	// The collection of team project properties
	Properties *[]ProjectProperty `json:"properties,omitempty"`
}

type ProjectProperty 

type ProjectProperty struct {
	// The name of the property.
	Name *string `json:"name,omitempty"`
	// The value of the property.
	Value interface{} `json:"value,omitempty"`
}

A named value associated with a project.

type ProjectState 

type ProjectState string

type ProjectVisibility 

type ProjectVisibility string

type Proxy 

type Proxy struct {
	Authorization *ProxyAuthorization `json:"authorization,omitempty"`
	// This is a description string
	Description *string `json:"description,omitempty"`
	// The friendly name of the server
	FriendlyName  *string `json:"friendlyName,omitempty"`
	GlobalDefault *bool   `json:"globalDefault,omitempty"`
	// This is a string representation of the site that the proxy server is located in (e.g. "NA-WA-RED")
	Site        *string `json:"site,omitempty"`
	SiteDefault *bool   `json:"siteDefault,omitempty"`
	// The URL of the proxy server
	Url *string `json:"url,omitempty"`
}

type ProxyAuthorization 

type ProxyAuthorization struct {
	// Gets or sets the endpoint used to obtain access tokens from the configured token service.
	AuthorizationUrl *string `json:"authorizationUrl,omitempty"`
	// Gets or sets the client identifier for this proxy.
	ClientId *uuid.UUID `json:"clientId,omitempty"`
	// Gets or sets the user identity to authorize for on-prem.
	Identity *string `json:"identity,omitempty"`
	// Gets or sets the public key used to verify the identity of this proxy. Only specify on hosted.
	PublicKey *webapi.PublicKey `json:"publicKey,omitempty"`
}

type QueueCreateProjectArgs 

type QueueCreateProjectArgs struct {
	// (required) The project to create.
	ProjectToCreate *TeamProject
}

Arguments for the QueueCreateProject function

type QueueDeleteProjectArgs 

type QueueDeleteProjectArgs struct {
	// (required) The project id of the project to delete.
	ProjectId *uuid.UUID
}

Arguments for the QueueDeleteProject function

type RemoveProjectAvatarArgs 

type RemoveProjectAvatarArgs struct {
	// (required) The ID or name of the project.
	ProjectId *string
}

Arguments for the RemoveProjectAvatar function

type SetProjectAvatarArgs 

type SetProjectAvatarArgs struct {
	// (required) The avatar blob data object to upload.
	AvatarBlob *ProjectAvatar
	// (required) The ID or name of the project.
	ProjectId *string
}

Arguments for the SetProjectAvatar function

type SetProjectPropertiesArgs 

type SetProjectPropertiesArgs struct {
	// (required) The team project ID.
	ProjectId *uuid.UUID
	// (required) A JSON Patch document that represents an array of property operations. See RFC 6902 for more details on JSON Patch. The accepted operation verbs are Add and Remove, where Add is used for both creating and updating properties. The path consists of a forward slash and a property name.
	PatchDocument *[]webapi.JsonPatchOperation
}

Arguments for the SetProjectProperties function

type SourceControlTypes 

type SourceControlTypes string

type TeamContext 

type TeamContext struct {
	// The team project Id or name.  Ignored if ProjectId is set.
	Project *string `json:"project,omitempty"`
	// The Team Project ID.  Required if Project is not set.
	ProjectId *uuid.UUID `json:"projectId,omitempty"`
	// The Team Id or name.  Ignored if TeamId is set.
	Team *string `json:"team,omitempty"`
	// The Team Id
	TeamId *uuid.UUID `json:"teamId,omitempty"`
}

The Team Context for an operation.

type TeamProject 

type TeamProject struct {
	// Project abbreviation.
	Abbreviation *string `json:"abbreviation,omitempty"`
	// Url to default team identity image.
	DefaultTeamImageUrl *string `json:"defaultTeamImageUrl,omitempty"`
	// The project's description (if any).
	Description *string `json:"description,omitempty"`
	// Project identifier.
	Id *uuid.UUID `json:"id,omitempty"`
	// Project last update time.
	LastUpdateTime *azuredevops.Time `json:"lastUpdateTime,omitempty"`
	// Project name.
	Name *string `json:"name,omitempty"`
	// Project revision.
	Revision *uint64 `json:"revision,omitempty"`
	// Project state.
	State *ProjectState `json:"state,omitempty"`
	// Url to the full version of the object.
	Url *string `json:"url,omitempty"`
	// Project visibility.
	Visibility *ProjectVisibility `json:"visibility,omitempty"`
	// The links to other objects related to this object.
	Links interface{} `json:"_links,omitempty"`
	// Set of capabilities this project has (such as process template & version control).
	Capabilities *map[string]map[string]string `json:"capabilities,omitempty"`
	// The shallow ref to the default team.
	DefaultTeam *WebApiTeamRef `json:"defaultTeam,omitempty"`
}

Represents a Team Project object.

type TeamProjectCollection 

type TeamProjectCollection struct {
	// Collection avatar Url.
	AvatarUrl *string `json:"avatarUrl,omitempty"`
	// Collection Id.
	Id *uuid.UUID `json:"id,omitempty"`
	// Collection Name.
	Name *string `json:"name,omitempty"`
	// Collection REST Url.
	Url *string `json:"url,omitempty"`
	// The links to other objects related to this object.
	Links interface{} `json:"_links,omitempty"`
	// Project collection description.
	Description *string `json:"description,omitempty"`
	// Process customization type on this collection. It can be Xml or Inherited.
	ProcessCustomizationType *ProcessCustomizationType `json:"processCustomizationType,omitempty"`
	// Project collection state.
	State *string `json:"state,omitempty"`
}

Data contract for a TeamProjectCollection.

type TeamProjectCollectionReference 

type TeamProjectCollectionReference struct {
	// Collection avatar Url.
	AvatarUrl *string `json:"avatarUrl,omitempty"`
	// Collection Id.
	Id *uuid.UUID `json:"id,omitempty"`
	// Collection Name.
	Name *string `json:"name,omitempty"`
	// Collection REST Url.
	Url *string `json:"url,omitempty"`
}

Reference object for a TeamProjectCollection.

type TeamProjectReference 

type TeamProjectReference struct {
	// Project abbreviation.
	Abbreviation *string `json:"abbreviation,omitempty"`
	// Url to default team identity image.
	DefaultTeamImageUrl *string `json:"defaultTeamImageUrl,omitempty"`
	// The project's description (if any).
	Description *string `json:"description,omitempty"`
	// Project identifier.
	Id *uuid.UUID `json:"id,omitempty"`
	// Project last update time.
	LastUpdateTime *azuredevops.Time `json:"lastUpdateTime,omitempty"`
	// Project name.
	Name *string `json:"name,omitempty"`
	// Project revision.
	Revision *uint64 `json:"revision,omitempty"`
	// Project state.
	State *ProjectState `json:"state,omitempty"`
	// Url to the full version of the object.
	Url *string `json:"url,omitempty"`
	// Project visibility.
	Visibility *ProjectVisibility `json:"visibility,omitempty"`
}

Represents a shallow reference to a TeamProject.

type TemporaryDataCreatedDTO 

type TemporaryDataCreatedDTO struct {
	ExpirationSeconds *int              `json:"expirationSeconds,omitempty"`
	Origin            *string           `json:"origin,omitempty"`
	Value             interface{}       `json:"value,omitempty"`
	ExpirationDate    *azuredevops.Time `json:"expirationDate,omitempty"`
	Id                *uuid.UUID        `json:"id,omitempty"`
	Url               *string           `json:"url,omitempty"`
}

A data transfer object that stores the metadata associated with the creation of temporary data.

type TemporaryDataDTO 

type TemporaryDataDTO struct {
	ExpirationSeconds *int        `json:"expirationSeconds,omitempty"`
	Origin            *string     `json:"origin,omitempty"`
	Value             interface{} `json:"value,omitempty"`
}

A data transfer object that stores the metadata associated with the temporary data.

type UpdateProjectArgs 

type UpdateProjectArgs struct {
	// (required) The updates for the project. The state must be set to wellFormed to restore the project.
	ProjectUpdate *TeamProject
	// (required) The project id of the project to update.
	ProjectId *uuid.UUID
}

Arguments for the UpdateProject function

type UpdateTeam 

type UpdateTeam struct {
	// New description for the team.
	Description *string `json:"description,omitempty"`
	// New name for the team.
	Name *string `json:"name,omitempty"`
}

Updateable properties for a WebApiTeam.

type UpdateTeamArgs 

type UpdateTeamArgs struct {
	// (required)
	TeamData *WebApiTeam
	// (required) The name or ID (GUID) of the team project containing the team to update.
	ProjectId *string
	// (required) The name of ID of the team to update.
	TeamId *string
}

Arguments for the UpdateTeam function

type WebApiConnectedService 

type WebApiConnectedService struct {
	Url *string `json:"url,omitempty"`
	// The user who did the OAuth authentication to created this service
	AuthenticatedBy *webapi.IdentityRef `json:"authenticatedBy,omitempty"`
	// Extra description on the service.
	Description *string `json:"description,omitempty"`
	// Friendly Name of service connection
	FriendlyName *string `json:"friendlyName,omitempty"`
	// Id/Name of the connection service. For Ex: Subscription Id for Azure Connection
	Id *string `json:"id,omitempty"`
	// The kind of service.
	Kind *string `json:"kind,omitempty"`
	// The project associated with this service
	Project *TeamProjectReference `json:"project,omitempty"`
	// Optional uri to connect directly to the service such as https://windows.azure.com
	ServiceUri *string `json:"serviceUri,omitempty"`
}

type WebApiConnectedServiceDetails 

type WebApiConnectedServiceDetails struct {
	Id  *string `json:"id,omitempty"`
	Url *string `json:"url,omitempty"`
	// Meta data for service connection
	ConnectedServiceMetaData *WebApiConnectedService `json:"connectedServiceMetaData,omitempty"`
	// Credential info
	CredentialsXml *string `json:"credentialsXml,omitempty"`
	// Optional uri to connect directly to the service such as https://windows.azure.com
	EndPoint *string `json:"endPoint,omitempty"`
}

type WebApiConnectedServiceRef 

type WebApiConnectedServiceRef struct {
	Id  *string `json:"id,omitempty"`
	Url *string `json:"url,omitempty"`
}

type WebApiCreateTagRequestData 

type WebApiCreateTagRequestData struct {
	// Name of the tag definition that will be created.
	Name *string `json:"name,omitempty"`
}

The representation of data needed to create a tag definition which is sent across the wire.

type WebApiProject 

type WebApiProject struct {
	// Project abbreviation.
	Abbreviation *string `json:"abbreviation,omitempty"`
	// Url to default team identity image.
	DefaultTeamImageUrl *string `json:"defaultTeamImageUrl,omitempty"`
	// The project's description (if any).
	Description *string `json:"description,omitempty"`
	// Project identifier.
	Id *uuid.UUID `json:"id,omitempty"`
	// Project last update time.
	LastUpdateTime *azuredevops.Time `json:"lastUpdateTime,omitempty"`
	// Project name.
	Name *string `json:"name,omitempty"`
	// Project revision.
	Revision *uint64 `json:"revision,omitempty"`
	// Project state.
	State *ProjectState `json:"state,omitempty"`
	// Url to the full version of the object.
	Url *string `json:"url,omitempty"`
	// Project visibility.
	Visibility *ProjectVisibility `json:"visibility,omitempty"`
	// Set of capabilities this project has
	Capabilities *map[string]map[string]string `json:"capabilities,omitempty"`
	// Reference to collection which contains this project
	Collection *WebApiProjectCollectionRef `json:"collection,omitempty"`
	// Default team for this project
	DefaultTeam *WebApiTeamRef `json:"defaultTeam,omitempty"`
}

type WebApiProjectCollection 

type WebApiProjectCollection struct {
	// Collection Tfs Url (Host Url)
	CollectionUrl *string `json:"collectionUrl,omitempty"`
	// Collection Guid
	Id *uuid.UUID `json:"id,omitempty"`
	// Collection Name
	Name *string `json:"name,omitempty"`
	// Collection REST Url
	Url *string `json:"url,omitempty"`
	// Project collection description
	Description *string `json:"description,omitempty"`
	// Project collection state
	State *string `json:"state,omitempty"`
}

type WebApiProjectCollectionRef 

type WebApiProjectCollectionRef struct {
	// Collection Tfs Url (Host Url)
	CollectionUrl *string `json:"collectionUrl,omitempty"`
	// Collection Guid
	Id *uuid.UUID `json:"id,omitempty"`
	// Collection Name
	Name *string `json:"name,omitempty"`
	// Collection REST Url
	Url *string `json:"url,omitempty"`
}

type WebApiTagDefinition 

type WebApiTagDefinition struct {
	// Whether or not the tag definition is active.
	Active *bool `json:"active,omitempty"`
	// ID of the tag definition.
	Id *uuid.UUID `json:"id,omitempty"`
	// The name of the tag definition.
	Name *string `json:"name,omitempty"`
	// Resource URL for the Tag Definition.
	Url *string `json:"url,omitempty"`
}

The representation of a tag definition which is sent across the wire.

type WebApiTeam 

type WebApiTeam struct {
	// Team (Identity) Guid. A Team Foundation ID.
	Id *uuid.UUID `json:"id,omitempty"`
	// Team name
	Name *string `json:"name,omitempty"`
	// Team REST API Url
	Url *string `json:"url,omitempty"`
	// Team description
	Description *string `json:"description,omitempty"`
	// Team identity.
	Identity *identity.Identity `json:"identity,omitempty"`
	// Identity REST API Url to this team
	IdentityUrl *string    `json:"identityUrl,omitempty"`
	ProjectId   *uuid.UUID `json:"projectId,omitempty"`
	ProjectName *string    `json:"projectName,omitempty"`
}

type WebApiTeamRef 

type WebApiTeamRef struct {
	// Team (Identity) Guid. A Team Foundation ID.
	Id *uuid.UUID `json:"id,omitempty"`
	// Team name
	Name *string `json:"name,omitempty"`
	// Team REST API Url
	Url *string `json:"url,omitempty"`
}

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.