analytics

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: 8 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var AnalyticsStateValues = analyticsStateValuesType{

	Disabled: "disabled",

	Enabled: "enabled",

	Paused: "paused",

	Deleting: "deleting",

	Preparing: "preparing",
}
View Source 
var FieldOperationValues = fieldOperationValuesType{
	Eq:          "eq",
	Ne:          "ne",
	Ge:          "ge",
	Le:          "le",
	Gt:          "gt",
	Lt:          "lt",
	Contains:    "contains",
	Notcontains: "notcontains",
	Under:       "under",
	Notunder:    "notunder",
}
View Source 
var FieldTypeValues = fieldTypeValuesType{

	Common: "common",

	Custom: "custom",
}
View Source 
var FieldValuesOperatorValues = fieldValuesOperatorValuesType{
	And: "and",
	Or:  "or",
}
View Source 
var HistoryTypeValues = historyTypeValuesType{

	None: "none",

	Rolling: "rolling",

	Range: "range",

	All: "all",
}
View Source 
var TrendGranularityTypeValues = trendGranularityTypeValuesType{

	Daily: "daily",

	Weekly: "weekly",

	Monthly: "monthly",
}
View Source 
var ValueModeValues = valueModeValuesType{

	Filter: "filter",

	All: "all",
}

Functions

This section is empty.

Types

type AnalyticsState 

type AnalyticsState string

type AnalyticsStateDetails 

type AnalyticsStateDetails struct {
	// The Analytics feature state.
	AnalyticsState *AnalyticsState `json:"analyticsState,omitempty"`
	// When this state was set.
	ChangedDate *azuredevops.Time `json:"changedDate,omitempty"`
}

type AnalyticsViewWorkItemsDefinition 

type AnalyticsViewWorkItemsDefinition struct {
	// List of area paths to filter by.
	AreaPathFilters *[]AreaPathFilter `json:"areaPathFilters,omitempty"`
	// List of backlog names to filter by.
	Backlogs *[]string `json:"backlogs,omitempty"`
	// List of field criteria to filter by.
	FieldFilters *[]FieldFilter `json:"fieldFilters,omitempty"`
	// Selection of fields for an analytics view. Field set may include common fields, or custom fields selected by the user.
	FieldSet *FieldSet `json:"fieldSet,omitempty"`
	// History/time-period constraints to filter an analytics view by.
	HistoryConfiguration *HistoryConfiguration `json:"historyConfiguration,omitempty"`
	// Defines the user-selected parameter by which an analytics view is filtered. True - filter by team. False -filter by area path.
	IsTeamFilterBySelectionMode *bool `json:"isTeamFilterBySelectionMode,omitempty"`
	// List of projects and teams to filter by.
	ProjectTeamFilters *[]ProjectTeamFilter `json:"projectTeamFilters,omitempty"`
	// List of work item types to filter by.
	WorkItemTypes interface{} `json:"workItemTypes,omitempty"`
}

Definition Contract for Analytics Views.

type AreaPathFilter 

type AreaPathFilter struct {
	// Area Id to filter by.
	AreaId *string `json:"areaId,omitempty"`
	// Enumeration representing operations while filtering an analytics view by area path.
	Operation *FieldOperation `json:"operation,omitempty"`
	// Unique identifier (Guid) for a project.
	ProjectId *uuid.UUID `json:"projectId,omitempty"`
}

Project and Area path filter metadata for analytics view definitions.

type Client 

type Client interface {
	// [Preview API]
	CreateShard(context.Context, CreateShardArgs) (*StageProviderShardInfo, error)
	// [Preview API]
	DeleteShard(context.Context, DeleteShardArgs) error
	// [Preview API]
	GetShard(context.Context, GetShardArgs) (*StageProviderShardInfo, error)
	// [Preview API] Gets the current state of the Analytics feature.
	GetState(context.Context, GetStateArgs) (*AnalyticsStateDetails, error)
	// [Preview API]
	GetTable(context.Context, GetTableArgs) (*StageTableInfo, error)
	// [Preview API]
	InvalidateShard(context.Context, InvalidateShardArgs) error
	// [Preview API]
	StageRecords(context.Context, StageRecordsArgs) (*IngestResult, error)
}

func NewClient 

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

type ClientImpl 

type ClientImpl struct {
	Client azuredevops.Client
}

func (*ClientImpl) CreateShard 

func (client *ClientImpl) CreateShard(ctx context.Context, args CreateShardArgs) (*StageProviderShardInfo, error)

[Preview API]

func (*ClientImpl) DeleteShard 

func (client *ClientImpl) DeleteShard(ctx context.Context, args DeleteShardArgs) error

[Preview API]

func (*ClientImpl) GetShard 

func (client *ClientImpl) GetShard(ctx context.Context, args GetShardArgs) (*StageProviderShardInfo, error)

[Preview API]

func (*ClientImpl) GetState 

func (client *ClientImpl) GetState(ctx context.Context, args GetStateArgs) (*AnalyticsStateDetails, error)

[Preview API] Gets the current state of the Analytics feature.

func (*ClientImpl) GetTable 

func (client *ClientImpl) GetTable(ctx context.Context, args GetTableArgs) (*StageTableInfo, error)

[Preview API]

func (*ClientImpl) InvalidateShard 

func (client *ClientImpl) InvalidateShard(ctx context.Context, args InvalidateShardArgs) error

[Preview API]

func (*ClientImpl) StageRecords 

func (client *ClientImpl) StageRecords(ctx context.Context, args StageRecordsArgs) (*IngestResult, error)

[Preview API]

type CreateShardArgs 

type CreateShardArgs struct {
	// (required)
	Table *string
	// (required)
	ProviderShard *int
}

Arguments for the CreateShard function

type DateRange 

type DateRange struct {
	// End date for date range interval. If null, data spans until current date.
	EndDate *azuredevops.Time `json:"endDate,omitempty"`
	// Start date for date range interval.
	StartDate *azuredevops.Time `json:"startDate,omitempty"`
}

Date range to filter analytics view rows.

type DeleteShardArgs 

type DeleteShardArgs struct {
	// (required)
	Table *string
	// (required)
	ProviderShard *int
}

Arguments for the DeleteShard function

type FieldFilter 

type FieldFilter struct {
	// Name of work item field.
	FieldName *string `json:"fieldName,omitempty"`
	// Query comparison operator for selected field.
	FieldOperation *FieldOperation `json:"fieldOperation,omitempty"`
	// Deprecated: Use Values instead
	FieldValue *[]string `json:"fieldValue,omitempty"`
	// Deprecated: Use Values instead
	FieldValuesOperator *FieldValuesOperator `json:"fieldValuesOperator,omitempty"`
	// Value(s) of selected field.
	Value interface{} `json:"value,omitempty"`
}

Field filter criteria metadata for analytics view definitions.

type FieldOperation 

type FieldOperation string

Enumeration representing operations while filtering field values an analytics view

type FieldSet 

type FieldSet struct {
	// List of fields in the analytics view field set.
	Fields *[]string `json:"fields,omitempty"`
	// Enumeration representing type of work item field set.
	FieldType *FieldType `json:"fieldType,omitempty"`
}

Fields metadata for analytics view definitions.

type FieldType 

type FieldType string

Enumeration representing type of work item field set.

type FieldValuesOperator 

type FieldValuesOperator string

Enumeration represanting multi-value operation for a single filter i.e. what is the condition that should be applied _between_ values

type FilterValues 

type FilterValues struct {
	// Enumeration to specify whether filtering is applied on an entity.
	Mode *ValueMode `json:"mode,omitempty"`
	// Value(s) of selected field.
	Operator *FieldValuesOperator `json:"operator,omitempty"`
	// List of entity values of a generic type.
	Values *[]interface{} `json:"values,omitempty"`
}

Values of a generic type used for filtering information in an analytics view. Part of metadata for an analytics view definition.

type GetShardArgs 

type GetShardArgs struct {
	// (required)
	Table *string
	// (required)
	ProviderShard *int
}

Arguments for the GetShard function

type GetStateArgs 

type GetStateArgs struct {
}

Arguments for the GetState function

type GetTableArgs 

type GetTableArgs struct {
	// (required)
	Table *string
}

Arguments for the GetTable function

type HistoryConfiguration 

type HistoryConfiguration struct {
	// Date range to filter analytics view rows.
	DateRange *DateRange `json:"dateRange,omitempty"`
	// If true, then a clause will be added to filter out work items with a CompletedDateSK before OldCompletedItemsCutoffDate or the start of the rolling period when HistoryType is Rolling.  When not present, the value is assumed to be false. This also achieves backwards compatibility.
	ExcludeOldCompletedWorkItems *bool `json:"excludeOldCompletedWorkItems,omitempty"`
	// Enumeration representing interval type for Analytics View History.
	HistoryType *HistoryType `json:"historyType,omitempty"`
	// When HistoryType is anything EXCEPT Rolling, and ExcludeOldCompletedWorkItems is true, this is the date to use to cutoff old completed work items. Work items closed on the cutoff date will not be filtered out.  For HistoryType Rolling, it is always calculated to be the beginning of the rolling period instead of using this.
	OldCompletedItemsCutoffDate *azuredevops.Time `json:"oldCompletedItemsCutoffDate,omitempty"`
	// Rolling period interval by number of days. Null when history type is not set to rolling period.
	RollingDays *int `json:"rollingDays,omitempty"`
	// Trend Granularity for filtering an analytics view by history.
	TrendGranularity *TrendGranularity `json:"trendGranularity,omitempty"`
}

History metadata for analytics view definitions.

type HistoryType 

type HistoryType string

Enumeration representing history interval type for Analytics View History.

type IngestResult 

type IngestResult struct {
	Count     *int  `json:"count,omitempty"`
	Terminate *bool `json:"terminate,omitempty"`
}

type InvalidateShardArgs 

type InvalidateShardArgs struct {
	// (required)
	Shard *StageShardInvalid
	// (required)
	Table *string
	// (required)
	ProviderShard *int
}

Arguments for the InvalidateShard function

type ProjectTeamFilter 

type ProjectTeamFilter struct {
	// Unique identifier (Guid) for a project.
	ProjectId *uuid.UUID `json:"projectId,omitempty"`
	// List of some or all teams under a project.
	Teams interface{} `json:"teams,omitempty"`
}

Teams filter metadata for analytics view definitions.

type StageProviderShardInfo 

type StageProviderShardInfo struct {
	ProviderShardId *int               `json:"providerShardId,omitempty"`
	Streams         *[]StageStreamInfo `json:"streams,omitempty"`
}

type StageRecordsArgs 

type StageRecordsArgs struct {
	// (required) Stream to upload
	UploadStream io.Reader
	// (required)
	Table *string
	// (required)
	ProviderShard *int
	// (required)
	Stream *int
}

Arguments for the StageRecords function

type StageShardInvalid 

type StageShardInvalid struct {
	DisableCurrentStream *bool     `json:"disableCurrentStream,omitempty"`
	InvalidFields        *[]string `json:"invalidFields,omitempty"`
	KeysOnly             *bool     `json:"keysOnly,omitempty"`
}

type StageStreamInfo 

type StageStreamInfo struct {
	CreatedTime           *azuredevops.Time `json:"createdTime,omitempty"`
	Current               *bool             `json:"current,omitempty"`
	InitialContentVersion *int              `json:"initialContentVersion,omitempty"`
	KeysOnly              *bool             `json:"keysOnly,omitempty"`
	LatestContentVersion  *int              `json:"latestContentVersion,omitempty"`
	Priority              *int              `json:"priority,omitempty"`
	StreamId              *int              `json:"streamId,omitempty"`
	Watermark             *string           `json:"watermark,omitempty"`
}

type StageTableInfo 

type StageTableInfo struct {
	Shards       *[]StageProviderShardInfo `json:"shards,omitempty"`
	StageVersion *int                      `json:"stageVersion,omitempty"`
	TableName    *string                   `json:"tableName,omitempty"`
}

type TrendGranularity 

type TrendGranularity struct {
	// Enumeration representing granularity of data being represented in an analytics view. Value is null when history type is 'None'.
	GranularityType *TrendGranularityType `json:"granularityType,omitempty"`
	// End day of week for weekly trend granularity. Value is null when trend granularity is daily or monthly.
	WeeklyEndDay *string `json:"weeklyEndDay,omitempty"`
}

Trend Granularity for filtering an analytics view by history.

type TrendGranularityType 

type TrendGranularityType string

Enumeration representing granularity of data being represented in an analytics view.

type ValueMode 

type ValueMode string

Enumeration to specify whether filtering is applied on an entity.

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.