api

Documentation

Index

• Constants
• type ChunkFileStatusType
• type ChunkId
• type ChunkStatus
• type FileRepresentation
• type FileUploadStatusResponse
• type NodeIdResponse
• type ProcessStatusType
• type TargetAuth
• type UploadChunk
  • func (uc *UploadChunk) AppendUploadCandidateIfNeeded(file FileRepresentation, buildInfoRepo bool)
  • func (uc *UploadChunk) IsChunkFull() bool
• type UploadChunkResponse
• type UploadChunksStatusBody
• type UploadChunksStatusResponse
• type UuidTokenResponse

Constants

const (
	Done       ProcessStatusType = "DONE"
	InProgress ProcessStatusType = "IN_PROGRESS"

	Success             ChunkFileStatusType = "SUCCESS"
	Fail                ChunkFileStatusType = "FAIL"
	SkippedLargeProps   ChunkFileStatusType = "SKIPPED_LARGE_PROPS"
	SkippedMetadataFile ChunkFileStatusType = "SKIPPED_METADATA_FILE"
	SkippedNonEmptyDir  ChunkFileStatusType = "SKIPPED_NON_EMPTY_DIR"

	Phase1 int = 0
	Phase2 int = 1
	Phase3 int = 2
)

Types

type ChunkFileStatusType

type ChunkFileStatusType string

type ChunkId

type ChunkId string

type ChunkStatus

type ChunkStatus struct {
	UuidTokenResponse
	Status ProcessStatusType          `json:"status,omitempty"`
	Files  []FileUploadStatusResponse `json:"files,omitempty"`
}

type FileRepresentation

type FileRepresentation struct {
	Repo        string `json:"repo,omitempty"`
	Path        string `json:"path,omitempty"`
	Name        string `json:"name,omitempty"`
	Size        int64  `json:"size,omitempty"`
	NonEmptyDir bool   `json:"non_empty_dir,omitempty"`
}

type FileUploadStatusResponse

type FileUploadStatusResponse struct {
	FileRepresentation
	SizeBytes        int64               `json:"size_bytes,omitempty"`
	ChecksumDeployed bool                `json:"checksum_deployed,omitempty"`
	Status           ChunkFileStatusType `json:"status,omitempty"`
	StatusCode       int                 `json:"status_code,omitempty"`
	Reason           string              `json:"reason,omitempty"`
}

type NodeIdResponse

type NodeIdResponse struct {
	NodeId string `json:"node_id,omitempty"`
}

type ProcessStatusType

type ProcessStatusType string

type TargetAuth

type TargetAuth struct {
	TargetArtifactoryUrl string `json:"target_artifactory_url,omitempty"`
	TargetUsername       string `json:"target_username,omitempty"`
	TargetPassword       string `json:"target_password,omitempty"`
	TargetToken          string `json:"target_token,omitempty"`
	TargetProxyKey       string `json:"target_proxy_key,omitempty"`
}

type UploadChunk

type UploadChunk struct {
	// Authentication details of the target server
	TargetAuth
	// Files and folders to transfer
	UploadCandidates []FileRepresentation `json:"upload_candidates,omitempty"`
	// True if should check for the existence of artifacts on the target filestore
	CheckExistenceInFilestore bool `json:"check_existence_in_filestore,omitempty"`
	// True if should skip file filtering in the Data Transfer plugin
	SkipFileFiltering bool `json:"skip_file_filtering,omitempty"`
}

func (*UploadChunk) AppendUploadCandidateIfNeeded

func (uc *UploadChunk) AppendUploadCandidateIfNeeded(file FileRepresentation, buildInfoRepo bool)

Append upload candidate to the list of upload candidates. Skip empty directories in build-info repositories. file - The upload candidate buildInfoRepo - True if this is a build-info repository

func (*UploadChunk) IsChunkFull

func (uc *UploadChunk) IsChunkFull() bool

Return true if the chunk contains at least 16 files or at least 1GiB in total

type UploadChunkResponse

type UploadChunkResponse struct {
	NodeIdResponse
	UuidTokenResponse
}

type UploadChunksStatusBody

type UploadChunksStatusBody struct {
	AwaitingStatusChunks []ChunkId `json:"awaiting_status_chunks,omitempty"`
	ChunksToDelete       []ChunkId `json:"chunks_to_delete,omitempty"`
}

type UploadChunksStatusResponse

type UploadChunksStatusResponse struct {
	NodeIdResponse
	ChunksStatus  []ChunkStatus `json:"chunks_status,omitempty"`
	DeletedChunks []string      `json:"deleted_chunks,omitempty"`
}

type UuidTokenResponse

type UuidTokenResponse struct {
	UuidToken string `json:"uuid_token,omitempty"`
}