symbol

package
v7.2.1 Latest Latest
Warning

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

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

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var DebugEntryCreateBehaviorValues = debugEntryCreateBehaviorValuesType{

	ThrowIfExists: "throwIfExists",

	SkipIfExists: "skipIfExists",

	OverwriteIfExists: "overwriteIfExists",
}
View Source 
var DebugEntryStatusValues = debugEntryStatusValuesType{

	None: "none",

	Created: "created",

	BlobMissing: "blobMissing",
}
View Source 
var RequestStatusValues = requestStatusValuesType{

	None: "none",

	Created: "created",

	Sealed: "sealed",

	Unavailable: "unavailable",
}
View Source 
var ResourceAreaId, _ = uuid.Parse("af607f94-69ba-4821-8159-f04e37b66350")

Functions

This section is empty.

Types

type CheckAvailabilityArgs 

type CheckAvailabilityArgs struct {
}

Arguments for the CheckAvailability function

type Client 

type Client interface {
	// [Preview API] Create a new symbol request.
	CreateRequests(context.Context, CreateRequestsArgs) (*Request, error)
	// [Preview API] Create debug entries for a symbol request as specified by its identifier.
	CreateRequestsRequestIdDebugEntries(context.Context, CreateRequestsRequestIdDebugEntriesArgs) (*[]DebugEntry, error)
	// [Preview API] Create debug entries for a symbol request as specified by its name.
	CreateRequestsRequestNameDebugEntries(context.Context, CreateRequestsRequestNameDebugEntriesArgs) (*[]DebugEntry, error)
	// [Preview API] Delete a symbol request by request identifier.
	DeleteRequestsRequestId(context.Context, DeleteRequestsRequestIdArgs) error
	// [Preview API] Delete a symbol request by request name.
	DeleteRequestsRequestName(context.Context, DeleteRequestsRequestNameArgs) error
	// [Preview API] Get the client package.
	GetClient(context.Context, GetClientArgs) (interface{}, error)
	// [Preview API] Get a stitched debug entry for a symbol request as specified by symbol request identifier and debug entry identifier.
	GetDebugEntryContent(context.Context, GetDebugEntryContentArgs) error
	// [Preview API] Get a symbol request by request identifier.
	GetRequestsRequestId(context.Context, GetRequestsRequestIdArgs) (*Request, error)
	// [Preview API] Get a symbol request by request name.
	GetRequestsRequestName(context.Context, GetRequestsRequestNameArgs) (*Request, error)
	// [Preview API] Given a client key, returns the best matched debug entry.
	GetSymSrvDebugEntryClientKey(context.Context, GetSymSrvDebugEntryClientKeyArgs) error
	// [Preview API] Get client version information.
	HeadClient(context.Context, HeadClientArgs) error
	// [Preview API] Check the availability of symbol service. This includes checking for feature flag, and possibly license in future. Note this is NOT an anonymous endpoint, and the caller will be redirected to authentication before hitting it.
	CheckAvailability(context.Context, CheckAvailabilityArgs) error
	// [Preview API] Update a symbol request by request identifier.
	UpdateRequestsRequestId(context.Context, UpdateRequestsRequestIdArgs) (*Request, error)
	// [Preview API] Update a symbol request by request name.
	UpdateRequestsRequestName(context.Context, UpdateRequestsRequestNameArgs) (*Request, error)
}

func NewClient 

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

type ClientImpl 

type ClientImpl struct {
	Client azuredevops.Client
}

func (*ClientImpl) CheckAvailability 

func (client *ClientImpl) CheckAvailability(ctx context.Context, args CheckAvailabilityArgs) error

[Preview API] Check the availability of symbol service. This includes checking for feature flag, and possibly license in future. Note this is NOT an anonymous endpoint, and the caller will be redirected to authentication before hitting it.

func (*ClientImpl) CreateRequests 

func (client *ClientImpl) CreateRequests(ctx context.Context, args CreateRequestsArgs) (*Request, error)

[Preview API] Create a new symbol request.

func (*ClientImpl) CreateRequestsRequestIdDebugEntries 

func (client *ClientImpl) CreateRequestsRequestIdDebugEntries(ctx context.Context, args CreateRequestsRequestIdDebugEntriesArgs) (*[]DebugEntry, error)

[Preview API] Create debug entries for a symbol request as specified by its identifier.

func (*ClientImpl) CreateRequestsRequestNameDebugEntries 

func (client *ClientImpl) CreateRequestsRequestNameDebugEntries(ctx context.Context, args CreateRequestsRequestNameDebugEntriesArgs) (*[]DebugEntry, error)

[Preview API] Create debug entries for a symbol request as specified by its name.

func (*ClientImpl) DeleteRequestsRequestId 

func (client *ClientImpl) DeleteRequestsRequestId(ctx context.Context, args DeleteRequestsRequestIdArgs) error

[Preview API] Delete a symbol request by request identifier.

func (*ClientImpl) DeleteRequestsRequestName 

func (client *ClientImpl) DeleteRequestsRequestName(ctx context.Context, args DeleteRequestsRequestNameArgs) error

[Preview API] Delete a symbol request by request name.

func (*ClientImpl) GetClient 

func (client *ClientImpl) GetClient(ctx context.Context, args GetClientArgs) (interface{}, error)

[Preview API] Get the client package.

func (*ClientImpl) GetDebugEntryContent 

func (client *ClientImpl) GetDebugEntryContent(ctx context.Context, args GetDebugEntryContentArgs) error

[Preview API] Get a stitched debug entry for a symbol request as specified by symbol request identifier and debug entry identifier.

func (*ClientImpl) GetRequestsRequestId 

func (client *ClientImpl) GetRequestsRequestId(ctx context.Context, args GetRequestsRequestIdArgs) (*Request, error)

[Preview API] Get a symbol request by request identifier.

func (*ClientImpl) GetRequestsRequestName 

func (client *ClientImpl) GetRequestsRequestName(ctx context.Context, args GetRequestsRequestNameArgs) (*Request, error)

[Preview API] Get a symbol request by request name.

func (*ClientImpl) GetSymSrvDebugEntryClientKey 

func (client *ClientImpl) GetSymSrvDebugEntryClientKey(ctx context.Context, args GetSymSrvDebugEntryClientKeyArgs) error

[Preview API] Given a client key, returns the best matched debug entry.

func (*ClientImpl) HeadClient 

func (client *ClientImpl) HeadClient(ctx context.Context, args HeadClientArgs) error

[Preview API] Get client version information.

func (*ClientImpl) UpdateRequestsRequestId 

func (client *ClientImpl) UpdateRequestsRequestId(ctx context.Context, args UpdateRequestsRequestIdArgs) (*Request, error)

[Preview API] Update a symbol request by request identifier.

func (*ClientImpl) UpdateRequestsRequestName 

func (client *ClientImpl) UpdateRequestsRequestName(ctx context.Context, args UpdateRequestsRequestNameArgs) (*Request, error)

[Preview API] Update a symbol request by request name.

type CreateRequestsArgs 

type CreateRequestsArgs struct {
	// (required) The symbol request to create.
	RequestToCreate *Request
}

Arguments for the CreateRequests function

type CreateRequestsRequestIdDebugEntriesArgs 

type CreateRequestsRequestIdDebugEntriesArgs struct {
	// (required) A batch that contains debug entries to create.
	Batch *DebugEntryCreateBatch
	// (required) The symbol request identifier.
	RequestId *string
	// (required) A valid debug entry collection name. Must be "debugentries".
	Collection *string
}

Arguments for the CreateRequestsRequestIdDebugEntries function

type CreateRequestsRequestNameDebugEntriesArgs 

type CreateRequestsRequestNameDebugEntriesArgs struct {
	// (required) A batch that contains debug entries to create.
	Batch *DebugEntryCreateBatch
	// (required) The symbol request name.
	RequestName *string
	// (required) A valid debug entry collection name. Must be "debugentries".
	Collection *string
}

Arguments for the CreateRequestsRequestNameDebugEntries function

type DebugEntry 

type DebugEntry struct {
	// The ID of user who created this item. Optional.
	CreatedBy *uuid.UUID `json:"createdBy,omitempty"`
	// The date time when this item is created. Optional.
	CreatedDate *azuredevops.Time `json:"createdDate,omitempty"`
	// An identifier for this item. Optional.
	Id *string `json:"id,omitempty"`
	// An opaque ETag used to synchronize with the version stored at server end. Optional.
	StorageETag *string `json:"storageETag,omitempty"`
	// A URI which can be used to retrieve this item in its raw format. Optional. Note this is distinguished from other URIs that are present in a derived resource.
	Url *string `json:"url,omitempty"`
	// Details of the blob formatted to be deserialized for symbol service.
	BlobDetails *JsonBlobIdentifierWithBlocks `json:"blobDetails,omitempty"`
	// A blob identifier of the symbol file to upload to this debug entry. This property is mostly used during creation of debug entry (a.k.a. symbol publishing) to allow the server to query the existence of the blob.
	BlobIdentifier *JsonBlobIdentifier `json:"blobIdentifier,omitempty"`
	// The URI to get the symbol file. Provided by the server, the URI contains authentication information and is readily accessible by plain HTTP GET request. The client is recommended to retrieve the file as soon as it can since the URI will expire in a short period.
	BlobUri *string `json:"blobUri,omitempty"`
	// A key the client (debugger, for example) uses to find the debug entry. Note it is not unique for each different symbol file as it does not distinguish between those which only differ by information level.
	ClientKey *string `json:"clientKey,omitempty"`
	// The Domain Id where this debugEntry lives. This property should not be null.
	DomainId *string `json:"domainId,omitempty"`
	// The information level this debug entry contains.
	InformationLevel *symbolcommon.DebugInformationLevel `json:"informationLevel,omitempty"`
	// The identifier of symbol request to which this debug entry belongs.
	RequestId *string `json:"requestId,omitempty"`
	// The size for the debug entry.
	Size *uint64 `json:"size,omitempty"`
	// The status of debug entry.
	Status *DebugEntryStatus `json:"status,omitempty"`
}

A dual-purpose data object, the debug entry is used by the client to publish the symbol file (with file's blob identifier, which can be calculated from VSTS hashing algorithm) or query the file (with a client key). Since the symbol server tries to return a matched symbol file with the richest information level, it may not always point to the same symbol file for different queries with same client key.

type DebugEntryCreateBatch 

type DebugEntryCreateBatch struct {
	// Defines what to do when a debug entry in the batch already exists.
	CreateBehavior *DebugEntryCreateBehavior `json:"createBehavior,omitempty"`
	// The debug entries.
	DebugEntries *[]DebugEntry `json:"debugEntries,omitempty"`
	// Serialized Proof nodes, used to verify uploads on server side for Chunk Dedup DebugEntry
	ProofNodes *[]string `json:"proofNodes,omitempty"`
}

A batch of debug entry to create.

type DebugEntryCreateBehavior 

type DebugEntryCreateBehavior string

The expected behavior when a debug entry to add already exists.

type DebugEntryStatus 

type DebugEntryStatus string

The status of debug entry.

type DeleteRequestsRequestIdArgs 

type DeleteRequestsRequestIdArgs struct {
	// (required) The symbol request identifier.
	RequestId *string
	// (optional) If true, delete all the debug entries under this request synchronously in the current session. If false, the deletion will be postponed to a later point and be executed automatically by the system.
	Synchronous *bool
}

Arguments for the DeleteRequestsRequestId function

type DeleteRequestsRequestNameArgs 

type DeleteRequestsRequestNameArgs struct {
	// (required) The symbol request name.
	RequestName *string
	// (optional) If true, delete all the debug entries under this request synchronously in the current session. If false, the deletion will be postponed to a later point and be executed automatically by the system.
	Synchronous *bool
}

Arguments for the DeleteRequestsRequestName function

type GetClientArgs 

type GetClientArgs struct {
	// (required) Either "EXE" for a zip file containing a Windows symbol client (a.k.a. symbol.exe) along with dependencies, or "TASK" for a VSTS task that can be run on a VSTS build agent. All the other values are invalid. The parameter is case-insensitive.
	ClientType *string
}

Arguments for the GetClient function

type GetDebugEntryContentArgs 

type GetDebugEntryContentArgs struct {
	// (required) The symbol request identifier.
	RequestId *string
	// (required) The debug entry identifier.
	DebugEntryId *string
}

Arguments for the GetDebugEntryContent function

type GetRequestsRequestIdArgs 

type GetRequestsRequestIdArgs struct {
	// (required) The symbol request identifier.
	RequestId *string
}

Arguments for the GetRequestsRequestId function

type GetRequestsRequestNameArgs 

type GetRequestsRequestNameArgs struct {
	// (required) The symbol request name.
	RequestName *string
}

Arguments for the GetRequestsRequestName function

type GetSymSrvDebugEntryClientKeyArgs 

type GetSymSrvDebugEntryClientKeyArgs struct {
	// (required) A "client key" used by both ends of Microsoft's symbol protocol to identify a debug entry. The semantics of client key is governed by symsrv and is beyond the scope of this documentation.
	DebugEntryClientKey *string
}

Arguments for the GetSymSrvDebugEntryClientKey function

type HeadClientArgs 

type HeadClientArgs struct {
}

Arguments for the HeadClient function

type JsonBlobBlockHash 

type JsonBlobBlockHash struct {
	// Array of hash bytes.
	HashBytes *[]byte `json:"hashBytes,omitempty"`
}

BlobBlock hash formatted to be deserialized for symbol service.

type JsonBlobIdentifier 

type JsonBlobIdentifier struct {
	IdentifierValue *[]byte `json:"identifierValue,omitempty"`
}

type JsonBlobIdentifierWithBlocks 

type JsonBlobIdentifierWithBlocks struct {
	// List of blob block hashes.
	BlockHashes *[]JsonBlobBlockHash `json:"blockHashes,omitempty"`
	// Array of blobId bytes.
	IdentifierValue *[]byte `json:"identifierValue,omitempty"`
}

BlobIdentifier with block hashes formatted to be deserialzied for symbol service.

type Request 

type Request struct {
	// The ID of user who created this item. Optional.
	CreatedBy *uuid.UUID `json:"createdBy,omitempty"`
	// The date time when this item is created. Optional.
	CreatedDate *azuredevops.Time `json:"createdDate,omitempty"`
	// An identifier for this item. Optional.
	Id *string `json:"id,omitempty"`
	// An opaque ETag used to synchronize with the version stored at server end. Optional.
	StorageETag *string `json:"storageETag,omitempty"`
	// A URI which can be used to retrieve this item in its raw format. Optional. Note this is distinguished from other URIs that are present in a derived resource.
	Url *string `json:"url,omitempty"`
	// An optional human-facing description.
	Description *string `json:"description,omitempty"`
	// The Domain Id where this request lives. This property should not be null.
	DomainId *string `json:"domainId,omitempty"`
	// An optional expiration date for the request. The request will become inaccessible and get deleted after the date, regardless of its status.  On an HTTP POST, if expiration date is null/missing, the server will assign a default expiration data (30 days unless overwridden in the registry at the account level). On PATCH, if expiration date is null/missing, the behavior is to not change whatever the request's current expiration date is.
	ExpirationDate *azuredevops.Time `json:"expirationDate,omitempty"`
	// Indicates if request should be chunk dedup
	IsChunked *bool `json:"isChunked,omitempty"`
	// A human-facing name for the request. Required on POST, ignored on PATCH.
	Name *string `json:"name,omitempty"`
	// The total Size for this request.
	Size *uint64 `json:"size,omitempty"`
	// The status for this request.
	Status *RequestStatus `json:"status,omitempty"`
}

Symbol request.

type RequestStatus 

type RequestStatus string

The status of request.

type ResourceBase 

type ResourceBase struct {
	// The ID of user who created this item. Optional.
	CreatedBy *uuid.UUID `json:"createdBy,omitempty"`
	// The date time when this item is created. Optional.
	CreatedDate *azuredevops.Time `json:"createdDate,omitempty"`
	// An identifier for this item. Optional.
	Id *string `json:"id,omitempty"`
	// An opaque ETag used to synchronize with the version stored at server end. Optional.
	StorageETag *string `json:"storageETag,omitempty"`
	// A URI which can be used to retrieve this item in its raw format. Optional. Note this is distinguished from other URIs that are present in a derived resource.
	Url *string `json:"url,omitempty"`
}

type UpdateRequestsRequestIdArgs 

type UpdateRequestsRequestIdArgs struct {
	// (required) The symbol request.
	UpdateRequest *Request
	// (required) The symbol request identifier.
	RequestId *string
}

Arguments for the UpdateRequestsRequestId function

type UpdateRequestsRequestNameArgs 

type UpdateRequestsRequestNameArgs struct {
	// (required) The symbol request.
	UpdateRequest *Request
	// (required) The symbol request name.
	RequestName *string
}

Arguments for the UpdateRequestsRequestName 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.