package
1.4.11
Repository: https://github.com/sylabs/scs-library-client.git
Documentation: pkg.go.dev

# Functions

IDInSlice returns true if ID is present in the slice.
ImageHash returns the appropriate hash for a provided image file e.g.
IsImageHash returns true if the provided string is valid as a unique hash for an image.
IsLibraryPullRef returns true if the provided string is a valid library reference for a pull operation.
IsLibraryPushRef returns true if the provided string is a valid library reference for a push operation.
IsRefPart returns true if the provided string is valid as a component of a library URI (i.e.
NewClient sets up a new Cloud-Library Service client with the specified base URL and auth token.
Parse parses a raw Library reference.
ParseAmbiguous behaves like Parse, but takes into account ambiguity that exists within Singularity Library references that begin with the prefix "library://".
No description provided by the author
PrettyPrint - Debug helper, print nice json for any interface.
SliceWithoutID returns slice with specified ID removed.
StringInSlice returns true if string is present in the slice.

# Constants

APIVersionV2ArchTags supports extended arch tags functionality.
APIVersionV2Upload supports extended image upload functionality.
OptionS3Compliant indicates a 100% S3 compatible object store is being used by backend library server.
Scheme is the required scheme for Library URIs.

# Variables

DefaultConfig is a configuration that uses default values.
ErrNotFound is returned by when a resource is not found (http status 404).
ErrRefFragmentNotPermitted represents a ref with an invalid fragment.
ErrRefPathNotValid represents a ref with an invalid path.
ErrRefQueryNotPermitted represents a ref with an invalid query.
ErrRefSchemeNotValid represents a ref with an invalid scheme.
ErrRefTagsNotValid represents a ref with invalid tags.
ErrRefUserNotPermitted represents a ref with an invalid user.
ErrUnauthorized represents HTTP status "401 Unauthorized".
LibraryModels lists names of valid models in the database.

# Structs

AbortMultipartUploadRequest is sent to abort V2 multipart image upload.
ArchImageTag - A simple mapping from a architecture and tag string to bson ID.
ArchTagsResponse - Response from the API for a v2 tags request (with arch).
BaseModel - has an ID, soft deletion marker, and Audit struct.
Blob - Binary data object (e.g.
Client describes the client details.
Collection - Second level in the library, holds a collection of containers.
CollectionResponse - Response from the API for an Collection request.
CompletedPart represents a single part of a multipart image upload.
CompleteMultipartUploadRequest is sent to complete V2 multipart image upload.
CompleteMultipartUploadResponse - Response from the API for a multipart image upload complete request.
Config contains the client configuration.
Container - Third level of library.
ContainerResponse - Response from the API for an Container request.
Downloader defines concurrency (# of requests) and part size for download operation.
Entity - Top level entry in the library, contains collections of images for a user or group.
EntityResponse - Response from the API for an Entity request.
Image - Represents a Singularity image held by the library for a particular Container.
ImageResponse - Response from the API for an Image request.
ImageTag - A single mapping from a string to bson ID.
MultipartUpload - Contains data for multipart image upload start request.
MultipartUploadStartRequest is sent to initiate V2 multipart image upload.
MultipartUploadStartResponse - Response from the API for a multipart image upload start request.
NoopProgressBar implements ProgressBarInterface to allow disabling the progress bar.
QuotaResponse contains quota usage and total available storage.
A Ref represents a parsed Library URI.
SearchResponse - Response from the API for a search request.
SearchResults - Results structure for searches.
TagsResponse - Response from the API for a tags request.
UploadImage - Contains requisite data for direct S3 image upload support.
UploadImageComplete contains data from upload image completion.
UploadImageCompleteRequest is sent to complete V2 image upload; it is currently unused.
UploadImageCompleteResponse is the response to the upload image completion request.
UploadImagePart - Contains data for multipart image upload part request.
UploadImagePartRequest is sent prior to each part in a multipart upload.
UploadImagePartResponse - Response from the API for a multipart image upload part request.
UploadImageRequest is sent to initiate V2 image upload.
UploadImageResponse - Response from the API for an image upload request.
VersionInfo contains version information.

# Interfaces

ModelManager - Generic interface for models which must have a bson ObjectID.
ProgressBar provides a minimal interface for interacting with a progress bar.
UploadCallback defines an interface used to perform a call-out to set up the source file Reader.

# Type aliases

ArchTagMap is a mapping of a string architecture to a TagMap, and hence to Images.
TagMap is a mapping of a string tag, to an ObjectID that refers to an Image e.g.