Documentation
¶
Index ¶
- Constants
- type BuildMetadata
- type BuildMetadataResponse
- type BuildOutput
- type BuildRequest
- type BuildStatsResponse
- type BuildStatsResponseData
- func (m *BuildStatsResponseData) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *BuildStatsResponseData) MarshalBinary() ([]byte, error)
- func (m *BuildStatsResponseData) UnmarshalBinary(b []byte) error
- func (m *BuildStatsResponseData) Validate(formats strfmt.Registry) error
- type DefFile
- type Definition
- type DefinitionBuildData
- type DefinitionBuildDataBuildScripts
- func (m *DefinitionBuildDataBuildScripts) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *DefinitionBuildDataBuildScripts) MarshalBinary() ([]byte, error)
- func (m *DefinitionBuildDataBuildScripts) UnmarshalBinary(b []byte) error
- func (m *DefinitionBuildDataBuildScripts) Validate(formats strfmt.Registry) error
- type DefinitionHeader
- type DefinitionImageData
- type DefinitionImageDataImageScripts
- func (m *DefinitionImageDataImageScripts) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *DefinitionImageDataImageScripts) MarshalBinary() ([]byte, error)
- func (m *DefinitionImageDataImageScripts) UnmarshalBinary(b []byte) error
- func (m *DefinitionImageDataImageScripts) Validate(formats strfmt.Registry) error
- type DefinitionResponse
- type JSONError
- type JSONErrorError
- type ListBuildsResponse
- type VersionResponse
- type VersionResponseData
Constants ¶
const ( // BuildMetadataStatusPending captures enum value "Pending" BuildMetadataStatusPending string = "Pending" // BuildMetadataStatusInProgress captures enum value "InProgress" BuildMetadataStatusInProgress string = "InProgress" // BuildMetadataStatusComplete captures enum value "Complete" BuildMetadataStatusComplete string = "Complete" // BuildMetadataStatusCancelled captures enum value "Cancelled" BuildMetadataStatusCancelled string = "Cancelled" // BuildMetadataStatusDeleted captures enum value "Deleted" BuildMetadataStatusDeleted string = "Deleted" )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type BuildMetadata ¶
type BuildMetadata struct {
// Raw build recipe
// Example: Bootstrap: arch
BuildRecipe string `json:"buildRecipe,omitempty"`
// Callback URL to be called on build completion
// Example: http://your.domain/build-completion-hook
CallbackURL string `json:"callbackURL,omitempty"`
// Time at which the build was completed
// Example: 2018-05-07T14:06:22.5742348Z
CompleteTime string `json:"completeTime,omitempty"`
// The user that created the build
// Example: user
CreatedBy string `json:"createdBy,omitempty"`
// definition
Definition *Definition `json:"definition,omitempty"`
// whether build is deleted or not
// Example: true
Deleted bool `json:"deleted,omitempty"`
// Unique BSON identifier for this object
// Example: 5af05d5e9293620001b41d2c
ID string `json:"id,omitempty"`
// Checksum of the image file
// Example: sha256.d86de0781ebd9e4d95c1c79b3387b563c90b0db3d3f6d77440c31127582f52bc
ImageChecksum string `json:"imageChecksum,omitempty"`
// Size of the image file, in bytes
// Example: 350411
ImageSize int64 `json:"imageSize,omitempty"`
// If TRUE, indicates the build is complete
// Example: true
IsComplete bool `json:"isComplete,omitempty"`
// The Container Library reference of the built image.
// Example: user/collection/name:tag
LibraryRef string `json:"libraryRef,omitempty"`
// URL of the Container Library that the Builder will push the built image to.
// Example: https://library.sylabs.io
LibraryURL string `json:"libraryURL,omitempty"`
// Time at which the build was started
// Example: 2018-05-07T14:06:22.5742348Z
StartTime string `json:"startTime,omitempty"`
// Indicates build status
// Example: InProgress
// Enum: [Pending InProgress Complete Cancelled Deleted]
Status string `json:"status,omitempty"`
// Time at which the build was submitted
// Example: 2018-05-07T14:06:22.5742348Z
SubmitTime string `json:"submitTime,omitempty"`
// URL of websocket to monitor console output as build progresses
// Example: http://localhost:5051/build-ws/5af05d5e9293620001b41d2c
WsURL string `json:"wsURL,omitempty"`
}
BuildMetadata Metadata that describes a build.
swagger:model BuildMetadata
func (*BuildMetadata) ContextValidate ¶
ContextValidate validate this build metadata based on the context it is used
func (*BuildMetadata) MarshalBinary ¶
func (m *BuildMetadata) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*BuildMetadata) UnmarshalBinary ¶
func (m *BuildMetadata) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type BuildMetadataResponse ¶
type BuildMetadataResponse struct {
// data
Data *BuildMetadata `json:"data,omitempty"`
}
BuildMetadataResponse build metadata response
swagger:model BuildMetadataResponse
func (*BuildMetadataResponse) ContextValidate ¶
ContextValidate validate this build metadata response based on the context it is used
func (*BuildMetadataResponse) MarshalBinary ¶
func (m *BuildMetadataResponse) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*BuildMetadataResponse) UnmarshalBinary ¶
func (m *BuildMetadataResponse) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type BuildOutput ¶
type BuildOutput string
BuildOutput Console output from a build. Example: Building Singularity image...\nSingularity container built: /tmp/5b3e30ac559f70000157df8a.simg\nCleaning up...\n
swagger:model BuildOutput
func (BuildOutput) ContextValidate ¶
ContextValidate validates this build output based on context it is used
type BuildRequest ¶
type BuildRequest struct {
// Raw build recipe
// Example: Bootstrap: arch
BuildRecipe string `json:"buildRecipe,omitempty"`
// Callback URL to be called on build completion
// Example: http://your.domain/build-completion-hook
CallbackURL string `json:"callbackURL,omitempty"`
// definition
Definition *Definition `json:"definition,omitempty"`
// The Container Library reference that the Builder will push the built image to. If not provided, the Builder will use an auto-generated reference.
// Example: user/collection/name:tag
LibraryRef string `json:"libraryRef,omitempty"`
// URL of the Container Library that the Builder will push the built image to. If not provided, the Sylabs Container Library will be used.
// Example: https://library.sylabs.io
LibraryURL string `json:"libraryURL,omitempty"`
}
BuildRequest Metadata that describes a build request.
swagger:model BuildRequest
func (*BuildRequest) ContextValidate ¶
ContextValidate validate this build request based on the context it is used
func (*BuildRequest) MarshalBinary ¶
func (m *BuildRequest) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*BuildRequest) UnmarshalBinary ¶
func (m *BuildRequest) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type BuildStatsResponse ¶
type BuildStatsResponse struct {
// data
Data *BuildStatsResponseData `json:"data,omitempty"`
}
BuildStatsResponse Build statistics response.
swagger:model BuildStatsResponse
func (*BuildStatsResponse) ContextValidate ¶
ContextValidate validate this build stats response based on the context it is used
func (*BuildStatsResponse) MarshalBinary ¶
func (m *BuildStatsResponse) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*BuildStatsResponse) UnmarshalBinary ¶
func (m *BuildStatsResponse) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type BuildStatsResponseData ¶
type BuildStatsResponseData struct {
// build count
// Example: 12345
BuildCount int64 `json:"buildCount,omitempty"`
// builds processing
// Example: 4
BuildsProcessing int64 `json:"buildsProcessing,omitempty"`
// builds queued
// Example: 6
BuildsQueued int64 `json:"buildsQueued,omitempty"`
// users with builds
// Example: 9876
UsersWithBuilds int64 `json:"usersWithBuilds,omitempty"`
}
BuildStatsResponseData build stats response data
swagger:model BuildStatsResponseData
func (*BuildStatsResponseData) ContextValidate ¶
func (m *BuildStatsResponseData) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this build stats response data based on context it is used
func (*BuildStatsResponseData) MarshalBinary ¶
func (m *BuildStatsResponseData) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*BuildStatsResponseData) UnmarshalBinary ¶
func (m *BuildStatsResponseData) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type DefFile ¶
type DefFile string
DefFile Raw DefFile Example: Bootstrap: arch
swagger:model DefFile
func (DefFile) ContextValidate ¶
ContextValidate validates this def file based on context it is used
type Definition ¶
type Definition struct {
// build data
BuildData *DefinitionBuildData `json:"buildData,omitempty"`
// header
Header *DefinitionHeader `json:"header,omitempty"`
// image data
ImageData *DefinitionImageData `json:"imageData,omitempty"`
}
Definition Description of a build request.
swagger:model Definition
func (*Definition) ContextValidate ¶
ContextValidate validate this definition based on the context it is used
func (*Definition) MarshalBinary ¶
func (m *Definition) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*Definition) UnmarshalBinary ¶
func (m *Definition) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type DefinitionBuildData ¶
type DefinitionBuildData struct {
// build scripts
BuildScripts *DefinitionBuildDataBuildScripts `json:"buildScripts,omitempty"`
// files
Files map[string]string `json:"files,omitempty"`
}
DefinitionBuildData definition build data
swagger:model DefinitionBuildData
func (*DefinitionBuildData) ContextValidate ¶
ContextValidate validate this definition build data based on the context it is used
func (*DefinitionBuildData) MarshalBinary ¶
func (m *DefinitionBuildData) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*DefinitionBuildData) UnmarshalBinary ¶
func (m *DefinitionBuildData) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type DefinitionBuildDataBuildScripts ¶
type DefinitionBuildDataBuildScripts struct {
// Commands that are executed within the container after the base OS has been installed at build time.
// Example: echo 'Post command!'
Post string `json:"post,omitempty"`
// Commands that are executed on the host system outside of the container after the base OS has been installed.
// Example: echo 'Setup command!'
Setup string `json:"setup,omitempty"`
}
DefinitionBuildDataBuildScripts definition build data build scripts
swagger:model DefinitionBuildDataBuildScripts
func (*DefinitionBuildDataBuildScripts) ContextValidate ¶
func (m *DefinitionBuildDataBuildScripts) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this definition build data build scripts based on context it is used
func (*DefinitionBuildDataBuildScripts) MarshalBinary ¶
func (m *DefinitionBuildDataBuildScripts) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*DefinitionBuildDataBuildScripts) UnmarshalBinary ¶
func (m *DefinitionBuildDataBuildScripts) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type DefinitionHeader ¶
type DefinitionHeader struct {
// The kind of base to use.
// Example: docker
Bootstrap string `json:"bootstrap,omitempty"`
// The named container reference.
// Example: ubuntu
From string `json:"from,omitempty"`
}
DefinitionHeader definition header
swagger:model DefinitionHeader
func (*DefinitionHeader) ContextValidate ¶
ContextValidate validates this definition header based on context it is used
func (*DefinitionHeader) MarshalBinary ¶
func (m *DefinitionHeader) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*DefinitionHeader) UnmarshalBinary ¶
func (m *DefinitionHeader) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type DefinitionImageData ¶
type DefinitionImageData struct {
// image scripts
ImageScripts *DefinitionImageDataImageScripts `json:"imageScripts,omitempty"`
}
DefinitionImageData definition image data
swagger:model DefinitionImageData
func (*DefinitionImageData) ContextValidate ¶
ContextValidate validate this definition image data based on the context it is used
func (*DefinitionImageData) MarshalBinary ¶
func (m *DefinitionImageData) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*DefinitionImageData) UnmarshalBinary ¶
func (m *DefinitionImageData) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type DefinitionImageDataImageScripts ¶
type DefinitionImageDataImageScripts struct {
// Environment variables that are exposed when the container image is run.
// Example: FOO=bar
Environment string `json:"environment,omitempty"`
// Some helpful message!
// Example: Help message for the container image.
Help string `json:"help,omitempty"`
// Script that is executed when the container image is run.
// Example: echo 'Hello, Singularity world!'
RunScript string `json:"runScript,omitempty"`
// Test script that is run on build completion.
// Example: echo 'Test command!'
Test string `json:"test,omitempty"`
}
DefinitionImageDataImageScripts definition image data image scripts
swagger:model DefinitionImageDataImageScripts
func (*DefinitionImageDataImageScripts) ContextValidate ¶
func (m *DefinitionImageDataImageScripts) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this definition image data image scripts based on context it is used
func (*DefinitionImageDataImageScripts) MarshalBinary ¶
func (m *DefinitionImageDataImageScripts) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*DefinitionImageDataImageScripts) UnmarshalBinary ¶
func (m *DefinitionImageDataImageScripts) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type DefinitionResponse ¶
type DefinitionResponse struct {
// data
Data *Definition `json:"data,omitempty"`
}
DefinitionResponse definition response
swagger:model DefinitionResponse
func (*DefinitionResponse) ContextValidate ¶
ContextValidate validate this definition response based on the context it is used
func (*DefinitionResponse) MarshalBinary ¶
func (m *DefinitionResponse) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*DefinitionResponse) UnmarshalBinary ¶
func (m *DefinitionResponse) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type JSONError ¶
type JSONError struct {
// error
Error *JSONErrorError `json:"error,omitempty"`
}
JSONError JSON error
swagger:model JSONError
func (*JSONError) ContextValidate ¶
ContextValidate validate this JSON error based on the context it is used
func (*JSONError) MarshalBinary ¶
MarshalBinary interface implementation
func (*JSONError) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type JSONErrorError ¶
type JSONErrorError struct {
// code
Code int64 `json:"code,omitempty"`
// message
Message string `json:"message,omitempty"`
}
JSONErrorError JSON error error
swagger:model JSONErrorError
func (*JSONErrorError) ContextValidate ¶
ContextValidate validates this JSON error error based on context it is used
func (*JSONErrorError) MarshalBinary ¶
func (m *JSONErrorError) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*JSONErrorError) UnmarshalBinary ¶
func (m *JSONErrorError) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ListBuildsResponse ¶
type ListBuildsResponse struct {
// data
Data []*BuildMetadata `json:"data"`
}
ListBuildsResponse list builds response
swagger:model ListBuildsResponse
func (*ListBuildsResponse) ContextValidate ¶
ContextValidate validate this list builds response based on the context it is used
func (*ListBuildsResponse) MarshalBinary ¶
func (m *ListBuildsResponse) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ListBuildsResponse) UnmarshalBinary ¶
func (m *ListBuildsResponse) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type VersionResponse ¶
type VersionResponse struct {
// data
Data *VersionResponseData `json:"data,omitempty"`
}
VersionResponse Version check response.
swagger:model VersionResponse
func (*VersionResponse) ContextValidate ¶
ContextValidate validate this version response based on the context it is used
func (*VersionResponse) MarshalBinary ¶
func (m *VersionResponse) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*VersionResponse) UnmarshalBinary ¶
func (m *VersionResponse) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type VersionResponseData ¶
type VersionResponseData struct {
// Version of the service.
// Example: v1.2.0-0-gdeadbee
Version string `json:"version,omitempty"`
}
VersionResponseData version response data
swagger:model VersionResponseData
func (*VersionResponseData) ContextValidate ¶
ContextValidate validates this version response data based on context it is used
func (*VersionResponseData) MarshalBinary ¶
func (m *VersionResponseData) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*VersionResponseData) UnmarshalBinary ¶
func (m *VersionResponseData) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation