filecontainer

Documentation

Index

• Variables
• type Client
  • func NewClient(ctx context.Context, connection *azuredevops.Connection) Client
• type ClientImpl
  • func (client *ClientImpl) CreateItems(ctx context.Context, args CreateItemsArgs) (*[]FileContainerItem, error)
  • func (client *ClientImpl) DeleteItem(ctx context.Context, args DeleteItemArgs) error
  • func (client *ClientImpl) GetContainers(ctx context.Context, args GetContainersArgs) (*[]FileContainer, error)
  • func (client *ClientImpl) GetItems(ctx context.Context, args GetItemsArgs) (*[]FileContainerItem, error)
• type ContainerItemStatus
• type ContainerItemType
• type ContainerOptions
• type CreateItemsArgs
• type DeleteItemArgs
• type FileContainer
• type FileContainerItem
• type GetContainersArgs
• type GetItemsArgs

Variables

var ContainerItemStatusValues = containerItemStatusValuesType{

	Created: "created",

	PendingUpload: "pendingUpload",
}

var ContainerItemTypeValues = containerItemTypeValuesType{

	Any: "any",

	Folder: "folder",

	File: "file",
}

var ContainerOptionsValues = containerOptionsValuesType{

	None: "none",
}

Types

type Client

type Client interface {
	// [Preview API] Creates the specified items in in the referenced container.
	CreateItems(context.Context, CreateItemsArgs) (*[]FileContainerItem, error)
	// [Preview API] Deletes the specified items in a container.
	DeleteItem(context.Context, DeleteItemArgs) error
	// [Preview API] Gets containers filtered by a comma separated list of artifact uris within the same scope, if not specified returns all containers
	GetContainers(context.Context, GetContainersArgs) (*[]FileContainer, error)
	// [Preview API]
	GetItems(context.Context, GetItemsArgs) (*[]FileContainerItem, error)
}

func NewClient

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

type ClientImpl

type ClientImpl struct {
	Client azuredevops.Client
}

func (*ClientImpl) CreateItems

func (client *ClientImpl) CreateItems(ctx context.Context, args CreateItemsArgs) (*[]FileContainerItem, error)

[Preview API] Creates the specified items in in the referenced container.

func (*ClientImpl) DeleteItem

func (client *ClientImpl) DeleteItem(ctx context.Context, args DeleteItemArgs) error

[Preview API] Deletes the specified items in a container.

func (*ClientImpl) GetContainers

func (client *ClientImpl) GetContainers(ctx context.Context, args GetContainersArgs) (*[]FileContainer, error)

[Preview API] Gets containers filtered by a comma separated list of artifact uris within the same scope, if not specified returns all containers

func (*ClientImpl) GetItems

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

[Preview API]

type ContainerItemStatus

type ContainerItemStatus string

Status of a container item.

type ContainerItemType

type ContainerItemType string

Type of a container item.

type ContainerOptions

type ContainerOptions string

[Flags] Options a container can have.

type CreateItemsArgs

type CreateItemsArgs struct {
	// (required)
	Items *azuredevops.VssJsonCollectionWrapper
	// (required)
	ContainerId *int
	// (optional) A guid representing the scope of the container. This is often the project id.
	Scope *uuid.UUID
}

Arguments for the CreateItems function

type DeleteItemArgs

type DeleteItemArgs struct {
	// (required) Container Id.
	ContainerId *uint64
	// (required) Path to delete.
	ItemPath *string
	// (optional) A guid representing the scope of the container. This is often the project id.
	Scope *uuid.UUID
}

Arguments for the DeleteItem function

type FileContainer

type FileContainer struct {
	// Uri of the artifact associated with the container.
	ArtifactUri *string `json:"artifactUri,omitempty"`
	// Download Url for the content of this item.
	ContentLocation *string `json:"contentLocation,omitempty"`
	// Owner.
	CreatedBy *uuid.UUID `json:"createdBy,omitempty"`
	// Creation date.
	DateCreated *azuredevops.Time `json:"dateCreated,omitempty"`
	// Description.
	Description *string `json:"description,omitempty"`
	// Id.
	Id *uint64 `json:"id,omitempty"`
	// Location of the item resource.
	ItemLocation *string `json:"itemLocation,omitempty"`
	// ItemStore Locator for this container.
	LocatorPath *string `json:"locatorPath,omitempty"`
	// Name.
	Name *string `json:"name,omitempty"`
	// Options the container can have.
	Options *ContainerOptions `json:"options,omitempty"`
	// Project Id.
	ScopeIdentifier *uuid.UUID `json:"scopeIdentifier,omitempty"`
	// Security token of the artifact associated with the container.
	SecurityToken *string `json:"securityToken,omitempty"`
	// Identifier of the optional encryption key.
	SigningKeyId *uuid.UUID `json:"signingKeyId,omitempty"`
	// Total size of the files in bytes.
	Size *uint64 `json:"size,omitempty"`
}

Represents a container that encapsulates a hierarchical file system.

type FileContainerItem

type FileContainerItem struct {
	// Container Id.
	ContainerId *uint64 `json:"containerId,omitempty"`
	ContentId   *[]byte `json:"contentId,omitempty"`
	// Download Url for the content of this item.
	ContentLocation *string `json:"contentLocation,omitempty"`
	// Creator.
	CreatedBy *uuid.UUID `json:"createdBy,omitempty"`
	// Creation date.
	DateCreated *azuredevops.Time `json:"dateCreated,omitempty"`
	// Last modified date.
	DateLastModified *azuredevops.Time `json:"dateLastModified,omitempty"`
	// Encoding of the file. Zero if not a file.
	FileEncoding *int `json:"fileEncoding,omitempty"`
	// Hash value of the file. Null if not a file.
	FileHash *[]byte `json:"fileHash,omitempty"`
	// Id of the file content.
	FileId *int `json:"fileId,omitempty"`
	// Length of the file. Zero if not of a file.
	FileLength *uint64 `json:"fileLength,omitempty"`
	// Type of the file. Zero if not a file.
	FileType *int `json:"fileType,omitempty"`
	// Location of the item resource.
	ItemLocation *string `json:"itemLocation,omitempty"`
	// Type of the item: Folder, File or String.
	ItemType *ContainerItemType `json:"itemType,omitempty"`
	// Modifier.
	LastModifiedBy *uuid.UUID `json:"lastModifiedBy,omitempty"`
	// Unique path that identifies the item.
	Path *string `json:"path,omitempty"`
	// Project Id.
	ScopeIdentifier *uuid.UUID `json:"scopeIdentifier,omitempty"`
	// Status of the item: Created or Pending Upload.
	Status *ContainerItemStatus `json:"status,omitempty"`
	Ticket *string              `json:"ticket,omitempty"`
}

Represents an item in a container.

type GetContainersArgs

type GetContainersArgs struct {
	// (optional) A guid representing the scope of the container. This is often the project id.
	Scope *uuid.UUID
	// (optional)
	ArtifactUris *string
}

Arguments for the GetContainers function

type GetItemsArgs

type GetItemsArgs struct {
	// (required)
	ContainerId *uint64
	// (optional)
	Scope *uuid.UUID
	// (optional)
	ItemPath *string
	// (optional)
	Metadata *bool
	// (optional)
	Format *string
	// (optional)
	DownloadFileName *string
	// (optional)
	IncludeDownloadTickets *bool
	// (optional)
	IsShallow *bool
}

Arguments for the GetItems function