projectanalysis

Documentation

Index

• Variables
• type AggregationType
• type AnalyzerDescriptor
• type Client
  • func NewClient(ctx context.Context, connection *azuredevops.Connection) (Client, error)
• type ClientImpl
  • func (client *ClientImpl) GetGitRepositoriesActivityMetrics(ctx context.Context, args GetGitRepositoriesActivityMetricsArgs) (*[]RepositoryActivityMetrics, error)
  • func (client *ClientImpl) GetProjectActivityMetrics(ctx context.Context, args GetProjectActivityMetricsArgs) (*ProjectActivityMetrics, error)
  • func (client *ClientImpl) GetProjectLanguageAnalytics(ctx context.Context, args GetProjectLanguageAnalyticsArgs) (*ProjectLanguageAnalytics, error)
  • func (client *ClientImpl) GetRepositoryActivityMetrics(ctx context.Context, args GetRepositoryActivityMetricsArgs) (*RepositoryActivityMetrics, error)
• type CodeChangeTrendItem
• type GetGitRepositoriesActivityMetricsArgs
• type GetProjectActivityMetricsArgs
• type GetProjectLanguageAnalyticsArgs
• type GetRepositoryActivityMetricsArgs
• type LanguageMetricsSecuredObject
• type LanguageStatistics
• type ProjectActivityMetrics
• type ProjectLanguageAnalytics
• type RepositoryActivityMetrics
• type RepositoryLanguageAnalytics
• type ResultPhase

Variables

var AggregationTypeValues = aggregationTypeValuesType{
	Hourly: "hourly",
	Daily:  "daily",
}

var ResourceAreaId, _ = uuid.Parse("7658fa33-b1bf-4580-990f-fac5896773d3")

var ResultPhaseValues = resultPhaseValuesType{
	Preliminary: "preliminary",
	Full:        "full",
}

Types

type AggregationType

type AggregationType string

type AnalyzerDescriptor

type AnalyzerDescriptor struct {
	Description  *string    `json:"description,omitempty"`
	Id           *uuid.UUID `json:"id,omitempty"`
	MajorVersion *int       `json:"majorVersion,omitempty"`
	MinorVersion *int       `json:"minorVersion,omitempty"`
	Name         *string    `json:"name,omitempty"`
	PatchVersion *int       `json:"patchVersion,omitempty"`
}

type Client

type Client interface {
	// [Preview API] Retrieves git activity metrics for repositories matching a specified criteria.
	GetGitRepositoriesActivityMetrics(context.Context, GetGitRepositoriesActivityMetricsArgs) (*[]RepositoryActivityMetrics, error)
	// [Preview API]
	GetProjectActivityMetrics(context.Context, GetProjectActivityMetricsArgs) (*ProjectActivityMetrics, error)
	// [Preview API]
	GetProjectLanguageAnalytics(context.Context, GetProjectLanguageAnalyticsArgs) (*ProjectLanguageAnalytics, error)
	// [Preview API]
	GetRepositoryActivityMetrics(context.Context, GetRepositoryActivityMetricsArgs) (*RepositoryActivityMetrics, error)
}

func NewClient

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

type ClientImpl

type ClientImpl struct {
	Client azuredevops.Client
}

func (*ClientImpl) GetGitRepositoriesActivityMetrics

func (client *ClientImpl) GetGitRepositoriesActivityMetrics(ctx context.Context, args GetGitRepositoriesActivityMetricsArgs) (*[]RepositoryActivityMetrics, error)

[Preview API] Retrieves git activity metrics for repositories matching a specified criteria.

func (*ClientImpl) GetProjectActivityMetrics

func (client *ClientImpl) GetProjectActivityMetrics(ctx context.Context, args GetProjectActivityMetricsArgs) (*ProjectActivityMetrics, error)

[Preview API]

func (*ClientImpl) GetProjectLanguageAnalytics

func (client *ClientImpl) GetProjectLanguageAnalytics(ctx context.Context, args GetProjectLanguageAnalyticsArgs) (*ProjectLanguageAnalytics, error)

[Preview API]

func (*ClientImpl) GetRepositoryActivityMetrics

func (client *ClientImpl) GetRepositoryActivityMetrics(ctx context.Context, args GetRepositoryActivityMetricsArgs) (*RepositoryActivityMetrics, error)

[Preview API]

type CodeChangeTrendItem

type CodeChangeTrendItem struct {
	Time  *azuredevops.Time `json:"time,omitempty"`
	Value *int              `json:"value,omitempty"`
}

type GetGitRepositoriesActivityMetricsArgs

type GetGitRepositoriesActivityMetricsArgs struct {
	// (required) Project ID or project name
	Project *string
	// (required) Date from which, the trends are to be fetched.
	FromDate *azuredevops.Time
	// (required) Bucket size on which, trends are to be aggregated.
	AggregationType *AggregationType
	// (required) The number of repositories to ignore.
	Skip *int
	// (required) The number of repositories for which activity metrics are to be retrieved.
	Top *int
}

Arguments for the GetGitRepositoriesActivityMetrics function

type GetProjectActivityMetricsArgs

type GetProjectActivityMetricsArgs struct {
	// (required) Project ID or project name
	Project *string
	// (required)
	FromDate *azuredevops.Time
	// (required)
	AggregationType *AggregationType
}

Arguments for the GetProjectActivityMetrics function

type GetProjectLanguageAnalyticsArgs

type GetProjectLanguageAnalyticsArgs struct {
	// (required) Project ID or project name
	Project *string
}

Arguments for the GetProjectLanguageAnalytics function

type GetRepositoryActivityMetricsArgs

type GetRepositoryActivityMetricsArgs struct {
	// (required) Project ID or project name
	Project *string
	// (required)
	RepositoryId *uuid.UUID
	// (required)
	FromDate *azuredevops.Time
	// (required)
	AggregationType *AggregationType
}

Arguments for the GetRepositoryActivityMetrics function

type LanguageMetricsSecuredObject

type LanguageMetricsSecuredObject struct {
	NamespaceId         *uuid.UUID `json:"namespaceId,omitempty"`
	ProjectId           *uuid.UUID `json:"projectId,omitempty"`
	RequiredPermissions *int       `json:"requiredPermissions,omitempty"`
}

type LanguageStatistics

type LanguageStatistics struct {
	NamespaceId         *uuid.UUID `json:"namespaceId,omitempty"`
	ProjectId           *uuid.UUID `json:"projectId,omitempty"`
	RequiredPermissions *int       `json:"requiredPermissions,omitempty"`
	Bytes               *uint64    `json:"bytes,omitempty"`
	Files               *int       `json:"files,omitempty"`
	FilesPercentage     *float64   `json:"filesPercentage,omitempty"`
	LanguagePercentage  *float64   `json:"languagePercentage,omitempty"`
	Name                *string    `json:"name,omitempty"`
}

type ProjectActivityMetrics

type ProjectActivityMetrics struct {
	AuthorsCount               *int                   `json:"authorsCount,omitempty"`
	CodeChangesCount           *int                   `json:"codeChangesCount,omitempty"`
	CodeChangesTrend           *[]CodeChangeTrendItem `json:"codeChangesTrend,omitempty"`
	ProjectId                  *uuid.UUID             `json:"projectId,omitempty"`
	PullRequestsCompletedCount *int                   `json:"pullRequestsCompletedCount,omitempty"`
	PullRequestsCreatedCount   *int                   `json:"pullRequestsCreatedCount,omitempty"`
}

type ProjectLanguageAnalytics

type ProjectLanguageAnalytics struct {
	NamespaceId                 *uuid.UUID                     `json:"namespaceId,omitempty"`
	ProjectId                   *uuid.UUID                     `json:"projectId,omitempty"`
	RequiredPermissions         *int                           `json:"requiredPermissions,omitempty"`
	Id                          *uuid.UUID                     `json:"id,omitempty"`
	LanguageBreakdown           *[]LanguageStatistics          `json:"languageBreakdown,omitempty"`
	RepositoryLanguageAnalytics *[]RepositoryLanguageAnalytics `json:"repositoryLanguageAnalytics,omitempty"`
	ResultPhase                 *ResultPhase                   `json:"resultPhase,omitempty"`
	Url                         *string                        `json:"url,omitempty"`
}

type RepositoryActivityMetrics

type RepositoryActivityMetrics struct {
	CodeChangesCount *int                   `json:"codeChangesCount,omitempty"`
	CodeChangesTrend *[]CodeChangeTrendItem `json:"codeChangesTrend,omitempty"`
	RepositoryId     *uuid.UUID             `json:"repositoryId,omitempty"`
}

type RepositoryLanguageAnalytics

type RepositoryLanguageAnalytics struct {
	NamespaceId         *uuid.UUID            `json:"namespaceId,omitempty"`
	ProjectId           *uuid.UUID            `json:"projectId,omitempty"`
	RequiredPermissions *int                  `json:"requiredPermissions,omitempty"`
	Id                  *uuid.UUID            `json:"id,omitempty"`
	LanguageBreakdown   *[]LanguageStatistics `json:"languageBreakdown,omitempty"`
	Name                *string               `json:"name,omitempty"`
	ResultPhase         *ResultPhase          `json:"resultPhase,omitempty"`
	UpdatedTime         *azuredevops.Time     `json:"updatedTime,omitempty"`
}

type ResultPhase

type ResultPhase string