v1

package
v0.0.0-...-fd19b33 Latest Latest
Warning

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

 Go to latest Published: Dec 19, 2024 License: Apache-2.0 Imports: 40 Imported by: 0

Documentation

Overview

Package v1 provides primitives to interact with the openapi HTTP API.

Code generated by github.com/oapi-codegen/oapi-codegen/v2 version v2.4.1 DO NOT EDIT.

Index

Constants

View Source 
const (
	ComposeRunningOrFailedError = "IMAGE-BUILDER-COMPOSER-31"

	// 64 GiB
	FSMaxSize = 68719476736
)

Variables

This section is empty.

Functions

func GetSwagger 

func GetSwagger() (swagger *openapi3.T, err error)

GetSwagger returns the Swagger specification corresponding to the generated code in this file. The external references of Swagger specification are resolved. The logic of resolving external references is tightly connected to "import-mapping" feature. Externally referenced files must be embedded in the corresponding golang packages. Urls can be supported but this task was out of the scope.

func RegisterHandlers 

func RegisterHandlers(router EchoRouter, si ServerInterface)

RegisterHandlers adds each server route to the EchoRouter.

func RegisterHandlersWithBaseURL 

func RegisterHandlersWithBaseURL(router EchoRouter, si ServerInterface, baseURL string)

Registers handlers, and prepends BaseURL to the paths, so that the paths can be served under a prefix.

func RoutePrefix 

func RoutePrefix() string

Types

type AWSConfig 

type AWSConfig struct {
	Region string
}

type AWSEC2Clone 

type AWSEC2Clone struct {
	// Region A region as described in
	// https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html#concepts-regions
	Region string `json:"region"`

	// ShareWithAccounts An array of AWS account IDs as described in
	// https://docs.aws.amazon.com/IAM/latest/UserGuide/console_account-alias.html
	ShareWithAccounts *[]string `json:"share_with_accounts,omitempty"`
	ShareWithSources  *[]string `json:"share_with_sources,omitempty"`
}

AWSEC2Clone defines model for AWSEC2Clone.

type AWSS3UploadRequestOptions 

type AWSS3UploadRequestOptions = map[string]interface{}

AWSS3UploadRequestOptions defines model for AWSS3UploadRequestOptions.

type AWSS3UploadStatus 

type AWSS3UploadStatus struct {
	Url string `json:"url"`
}

AWSS3UploadStatus defines model for AWSS3UploadStatus.

type AWSUploadRequestOptions 

type AWSUploadRequestOptions struct {
	ShareWithAccounts *[]string `json:"share_with_accounts,omitempty"`
	ShareWithSources  *[]string `json:"share_with_sources,omitempty"`
}

AWSUploadRequestOptions defines model for AWSUploadRequestOptions.

type AWSUploadStatus 

type AWSUploadStatus struct {
	Ami    string `json:"ami"`
	Region string `json:"region"`
}

AWSUploadStatus defines model for AWSUploadStatus.

type ArchitectureItem 

type ArchitectureItem struct {
	Arch       string   `json:"arch"`
	ImageTypes []string `json:"image_types"`

	// Repositories Base repositories for the given distribution and architecture.
	Repositories []Repository `json:"repositories"`
}

ArchitectureItem defines model for ArchitectureItem.

type Architectures 

type Architectures = []ArchitectureItem

Architectures defines model for Architectures.

type AzureUploadRequestOptions 

type AzureUploadRequestOptions struct {
	// HyperVGeneration Choose the VM Image HyperV generation, different features on Azure are available
	// depending on the HyperV generation.
	HyperVGeneration *AzureUploadRequestOptionsHyperVGeneration `json:"hyper_v_generation,omitempty"`

	// ImageName Name of the created image.
	// Must begin with a letter or number, end with a letter, number or underscore, and may contain only letters, numbers, underscores, periods, or hyphens.
	// The total length is limited to 60 characters.
	ImageName *string `json:"image_name,omitempty"`

	// ResourceGroup Name of the resource group where the image should be uploaded.
	ResourceGroup string `json:"resource_group"`

	// SourceId ID of the source that will be used to resolve the tenant and subscription IDs.
	// Do not provide a tenant_id or subscription_id when providing a source_id.
	SourceId *string `json:"source_id,omitempty"`

	// SubscriptionId ID of subscription where the image should be uploaded.
	// When providing a subscription_id, also be sure to provide a tenant_id and do not include a source_id.
	SubscriptionId *string `json:"subscription_id,omitempty"`

	// TenantId ID of the tenant where the image should be uploaded. This link explains how
	// to find it in the Azure Portal:
	// https://docs.microsoft.com/en-us/azure/active-directory/fundamentals/active-directory-how-to-find-tenant
	// When providing a tenant_id, also be sure to provide a subscription_id and do not include a source_id.
	TenantId *string `json:"tenant_id,omitempty"`
}

AzureUploadRequestOptions defines model for AzureUploadRequestOptions.

type AzureUploadRequestOptionsHyperVGeneration 

type AzureUploadRequestOptionsHyperVGeneration string

AzureUploadRequestOptionsHyperVGeneration Choose the VM Image HyperV generation, different features on Azure are available depending on the HyperV generation. 

const (
	V1 AzureUploadRequestOptionsHyperVGeneration = "V1"
	V2 AzureUploadRequestOptionsHyperVGeneration = "V2"
)

Defines values for AzureUploadRequestOptionsHyperVGeneration.

type AzureUploadStatus 

type AzureUploadStatus struct {
	ImageName string `json:"image_name"`
}

AzureUploadStatus defines model for AzureUploadStatus.

type BlueprintBody 

type BlueprintBody struct {
	Customizations Customizations `json:"customizations"`
	Distribution   Distributions  `json:"distribution"`
	ImageRequests  []ImageRequest `json:"image_requests"`
}

func BlueprintFromAPI 

func BlueprintFromAPI(cbr CreateBlueprintRequest) (BlueprintBody, error)

Util function used to create and update Blueprint from API request (WRITE)

func BlueprintFromEntry 

func BlueprintFromEntry(be *db.BlueprintEntry) (BlueprintBody, error)

Util function used to create Blueprint sctruct from DB entry (READ)

func BlueprintFromEntryWithRedactedPasswords 

func BlueprintFromEntryWithRedactedPasswords(be *db.BlueprintEntry) (BlueprintBody, error)

func (*BlueprintBody) CryptPasswords 

func (bb *BlueprintBody) CryptPasswords() error

func (*BlueprintBody) RedactPasswords 

func (bb *BlueprintBody) RedactPasswords()

type BlueprintExportResponse 

type BlueprintExportResponse struct {
	// ContentSources List of custom repositories including all the repository details needed in order
	// to recreate the repositories.
	ContentSources *[]map[string]interface{} `json:"content_sources,omitempty"`
	Customizations Customizations            `json:"customizations"`
	Description    string                    `json:"description"`

	// Distribution List of all distributions that image builder supports. A user might not have access to
	// restricted distributions.
	//
	// Restricted distributions include the RHEL nightlies and the Fedora distributions.
	Distribution Distributions     `json:"distribution"`
	Metadata     BlueprintMetadata `json:"metadata"`
	Name         string            `json:"name"`

	// SnapshotDate Importing the snapshot date will not yet be supported. It is exported for informative reasons.
	// The format is YYYY-MM-DD.
	SnapshotDate *string `json:"snapshot_date,omitempty"`
}

BlueprintExportResponse defines model for BlueprintExportResponse.

type BlueprintItem 

type BlueprintItem struct {
	Description    string             `json:"description"`
	Id             openapi_types.UUID `json:"id"`
	LastModifiedAt string             `json:"last_modified_at"`
	Name           string             `json:"name"`
	Version        int                `json:"version"`
}

BlueprintItem defines model for BlueprintItem.

type BlueprintMetadata 

type BlueprintMetadata struct {
	ExportedAt string              `json:"exported_at"`
	IsOnPrem   bool                `json:"is_on_prem"`
	ParentId   *openapi_types.UUID `json:"parent_id"`
}

BlueprintMetadata defines model for BlueprintMetadata.

type BlueprintResponse 

type BlueprintResponse struct {
	Customizations Customizations `json:"customizations"`
	Description    string         `json:"description"`

	// Distribution List of all distributions that image builder supports. A user might not have access to
	// restricted distributions.
	//
	// Restricted distributions include the RHEL nightlies and the Fedora distributions.
	Distribution Distributions      `json:"distribution"`
	Id           openapi_types.UUID `json:"id"`

	// ImageRequests Array of image requests. Having more image requests in a single blueprint is currently not supported.
	ImageRequests []ImageRequest `json:"image_requests"`
	Name          string         `json:"name"`
}

BlueprintResponse defines model for BlueprintResponse.

type BlueprintsResponse 

type BlueprintsResponse struct {
	Data  []BlueprintItem   `json:"data"`
	Links ListResponseLinks `json:"links"`
	Meta  ListResponseMeta  `json:"meta"`
}

BlueprintsResponse defines model for BlueprintsResponse.

type ClientId 

type ClientId string

ClientId defines model for ClientId. 

const (
	Api ClientId = "api"
	Ui  ClientId = "ui"
)

Defines values for ClientId.

type CloneComposeJSONRequestBody 

type CloneComposeJSONRequestBody = CloneRequest

CloneComposeJSONRequestBody defines body for CloneCompose for application/json ContentType.

type CloneRequest 

type CloneRequest struct {
	// contains filtered or unexported fields
}

CloneRequest defines model for CloneRequest.

func (CloneRequest) AsAWSEC2Clone 

func (t CloneRequest) AsAWSEC2Clone() (AWSEC2Clone, error)

AsAWSEC2Clone returns the union data inside the CloneRequest as a AWSEC2Clone

func (*CloneRequest) FromAWSEC2Clone 

func (t *CloneRequest) FromAWSEC2Clone(v AWSEC2Clone) error

FromAWSEC2Clone overwrites any union data inside the CloneRequest as the provided AWSEC2Clone

func (CloneRequest) MarshalJSON 

func (t CloneRequest) MarshalJSON() ([]byte, error)

func (*CloneRequest) MergeAWSEC2Clone 

func (t *CloneRequest) MergeAWSEC2Clone(v AWSEC2Clone) error

MergeAWSEC2Clone performs a merge with any union data inside the CloneRequest, using the provided AWSEC2Clone

func (*CloneRequest) UnmarshalJSON 

func (t *CloneRequest) UnmarshalJSON(b []byte) error

type CloneResponse 

type CloneResponse struct {
	Id openapi_types.UUID `json:"id"`
}

CloneResponse defines model for CloneResponse.

type CloneStatusResponse 

type CloneStatusResponse struct {
	ComposeId *openapi_types.UUID         `json:"compose_id,omitempty"`
	Options   CloneStatusResponse_Options `json:"options"`
	Status    CloneStatusResponseStatus   `json:"status"`
	Type      UploadTypes                 `json:"type"`
}

CloneStatusResponse defines model for CloneStatusResponse.

type CloneStatusResponseStatus 

type CloneStatusResponseStatus string

CloneStatusResponseStatus defines model for CloneStatusResponse.Status. 

const (
	CloneStatusResponseStatusFailure CloneStatusResponseStatus = "failure"
	CloneStatusResponseStatusPending CloneStatusResponseStatus = "pending"
	CloneStatusResponseStatusRunning CloneStatusResponseStatus = "running"
	CloneStatusResponseStatusSuccess CloneStatusResponseStatus = "success"
)

Defines values for CloneStatusResponseStatus.

type CloneStatusResponse_Options 

type CloneStatusResponse_Options struct {
	// contains filtered or unexported fields
}

CloneStatusResponse_Options defines model for CloneStatusResponse.Options.

func (CloneStatusResponse_Options) AsAWSS3UploadStatus 

func (t CloneStatusResponse_Options) AsAWSS3UploadStatus() (AWSS3UploadStatus, error)

AsAWSS3UploadStatus returns the union data inside the CloneStatusResponse_Options as a AWSS3UploadStatus

func (CloneStatusResponse_Options) AsAWSUploadStatus 

func (t CloneStatusResponse_Options) AsAWSUploadStatus() (AWSUploadStatus, error)

AsAWSUploadStatus returns the union data inside the CloneStatusResponse_Options as a AWSUploadStatus

func (CloneStatusResponse_Options) AsAzureUploadStatus 

func (t CloneStatusResponse_Options) AsAzureUploadStatus() (AzureUploadStatus, error)

AsAzureUploadStatus returns the union data inside the CloneStatusResponse_Options as a AzureUploadStatus

func (CloneStatusResponse_Options) AsGCPUploadStatus 

func (t CloneStatusResponse_Options) AsGCPUploadStatus() (GCPUploadStatus, error)

AsGCPUploadStatus returns the union data inside the CloneStatusResponse_Options as a GCPUploadStatus

func (CloneStatusResponse_Options) AsOCIUploadStatus 

func (t CloneStatusResponse_Options) AsOCIUploadStatus() (OCIUploadStatus, error)

AsOCIUploadStatus returns the union data inside the CloneStatusResponse_Options as a OCIUploadStatus

func (*CloneStatusResponse_Options) FromAWSS3UploadStatus 

func (t *CloneStatusResponse_Options) FromAWSS3UploadStatus(v AWSS3UploadStatus) error

FromAWSS3UploadStatus overwrites any union data inside the CloneStatusResponse_Options as the provided AWSS3UploadStatus

func (*CloneStatusResponse_Options) FromAWSUploadStatus 

func (t *CloneStatusResponse_Options) FromAWSUploadStatus(v AWSUploadStatus) error

FromAWSUploadStatus overwrites any union data inside the CloneStatusResponse_Options as the provided AWSUploadStatus

func (*CloneStatusResponse_Options) FromAzureUploadStatus 

func (t *CloneStatusResponse_Options) FromAzureUploadStatus(v AzureUploadStatus) error

FromAzureUploadStatus overwrites any union data inside the CloneStatusResponse_Options as the provided AzureUploadStatus

func (*CloneStatusResponse_Options) FromGCPUploadStatus 

func (t *CloneStatusResponse_Options) FromGCPUploadStatus(v GCPUploadStatus) error

FromGCPUploadStatus overwrites any union data inside the CloneStatusResponse_Options as the provided GCPUploadStatus

func (*CloneStatusResponse_Options) FromOCIUploadStatus 

func (t *CloneStatusResponse_Options) FromOCIUploadStatus(v OCIUploadStatus) error

FromOCIUploadStatus overwrites any union data inside the CloneStatusResponse_Options as the provided OCIUploadStatus

func (CloneStatusResponse_Options) MarshalJSON 

func (t CloneStatusResponse_Options) MarshalJSON() ([]byte, error)

func (*CloneStatusResponse_Options) MergeAWSS3UploadStatus 

func (t *CloneStatusResponse_Options) MergeAWSS3UploadStatus(v AWSS3UploadStatus) error

MergeAWSS3UploadStatus performs a merge with any union data inside the CloneStatusResponse_Options, using the provided AWSS3UploadStatus

func (*CloneStatusResponse_Options) MergeAWSUploadStatus 

func (t *CloneStatusResponse_Options) MergeAWSUploadStatus(v AWSUploadStatus) error

MergeAWSUploadStatus performs a merge with any union data inside the CloneStatusResponse_Options, using the provided AWSUploadStatus

func (*CloneStatusResponse_Options) MergeAzureUploadStatus 

func (t *CloneStatusResponse_Options) MergeAzureUploadStatus(v AzureUploadStatus) error

MergeAzureUploadStatus performs a merge with any union data inside the CloneStatusResponse_Options, using the provided AzureUploadStatus

func (*CloneStatusResponse_Options) MergeGCPUploadStatus 

func (t *CloneStatusResponse_Options) MergeGCPUploadStatus(v GCPUploadStatus) error

MergeGCPUploadStatus performs a merge with any union data inside the CloneStatusResponse_Options, using the provided GCPUploadStatus

func (*CloneStatusResponse_Options) MergeOCIUploadStatus 

func (t *CloneStatusResponse_Options) MergeOCIUploadStatus(v OCIUploadStatus) error

MergeOCIUploadStatus performs a merge with any union data inside the CloneStatusResponse_Options, using the provided OCIUploadStatus

func (*CloneStatusResponse_Options) UnmarshalJSON 

func (t *CloneStatusResponse_Options) UnmarshalJSON(b []byte) error

type ClonesResponse 

type ClonesResponse struct {
	Data  []ClonesResponseItem `json:"data"`
	Links ListResponseLinks    `json:"links"`
	Meta  ListResponseMeta     `json:"meta"`
}

ClonesResponse defines model for ClonesResponse.

type ClonesResponseItem 

type ClonesResponseItem struct {
	// ComposeId UUID of the parent compose of the clone
	ComposeId openapi_types.UUID `json:"compose_id"`
	CreatedAt string             `json:"created_at"`
	Id        openapi_types.UUID `json:"id"`
	Request   CloneRequest       `json:"request"`
}

ClonesResponseItem defines model for ClonesResponseItem.

type ComposeBlueprintJSONBody 

type ComposeBlueprintJSONBody struct {
	ImageTypes *[]ImageTypes `json:"image_types,omitempty"`
}

ComposeBlueprintJSONBody defines parameters for ComposeBlueprint.

type ComposeBlueprintJSONRequestBody 

type ComposeBlueprintJSONRequestBody ComposeBlueprintJSONBody

ComposeBlueprintJSONRequestBody defines body for ComposeBlueprint for application/json ContentType.

type ComposeImageJSONRequestBody 

type ComposeImageJSONRequestBody = ComposeRequest

ComposeImageJSONRequestBody defines body for ComposeImage for application/json ContentType.

type ComposeMetadata 

type ComposeMetadata struct {
	// OstreeCommit ID (hash) of the built commit
	OstreeCommit *string `json:"ostree_commit,omitempty"`

	// Packages Package list including NEVRA
	Packages *[]PackageMetadata `json:"packages,omitempty"`
}

ComposeMetadata defines model for ComposeMetadata.

type ComposeRequest 

type ComposeRequest struct {
	ClientId       *ClientId       `json:"client_id,omitempty"`
	Customizations *Customizations `json:"customizations,omitempty"`

	// Distribution List of all distributions that image builder supports. A user might not have access to
	// restricted distributions.
	//
	// Restricted distributions include the RHEL nightlies and the Fedora distributions.
	Distribution     Distributions `json:"distribution"`
	ImageDescription *string       `json:"image_description,omitempty"`
	ImageName        *string       `json:"image_name,omitempty"`

	// ImageRequests Array of exactly one image request. Having more image requests in one compose is currently not supported.
	ImageRequests []ImageRequest `json:"image_requests"`
}

ComposeRequest defines model for ComposeRequest.

type ComposeResponse 

type ComposeResponse struct {
	Id openapi_types.UUID `json:"id"`
}

ComposeResponse defines model for ComposeResponse.

type ComposeStatus 

type ComposeStatus struct {
	ImageStatus ImageStatus    `json:"image_status"`
	Request     ComposeRequest `json:"request"`
}

ComposeStatus defines model for ComposeStatus.

type ComposeStatusError 

type ComposeStatusError struct {
	Details *interface{} `json:"details,omitempty"`
	Id      int          `json:"id"`
	Reason  string       `json:"reason"`
}

ComposeStatusError defines model for ComposeStatusError.

type ComposesResponse 

type ComposesResponse struct {
	Data  []ComposesResponseItem `json:"data"`
	Links ListResponseLinks      `json:"links"`
	Meta  ListResponseMeta       `json:"meta"`
}

ComposesResponse defines model for ComposesResponse.

type ComposesResponseItem 

type ComposesResponseItem struct {
	BlueprintId      *openapi_types.UUID `json:"blueprint_id"`
	BlueprintVersion *int                `json:"blueprint_version"`
	ClientId         *ClientId           `json:"client_id,omitempty"`
	CreatedAt        string              `json:"created_at"`
	Id               openapi_types.UUID  `json:"id"`
	ImageName        *string             `json:"image_name,omitempty"`
	Request          ComposeRequest      `json:"request"`
}

ComposesResponseItem defines model for ComposesResponseItem.

type Container 

type Container struct {
	// Name Name to use for the container from the image
	Name *string `json:"name,omitempty"`

	// Source Reference to the container to embed
	Source string `json:"source"`

	// TlsVerify Control TLS verifification
	TlsVerify *bool `json:"tls_verify,omitempty"`
}

Container defines model for Container.

type CreateBlueprintJSONRequestBody 

type CreateBlueprintJSONRequestBody = CreateBlueprintRequest

CreateBlueprintJSONRequestBody defines body for CreateBlueprint for application/json ContentType.

type CreateBlueprintRequest 

type CreateBlueprintRequest struct {
	Customizations Customizations `json:"customizations"`
	Description    *string        `json:"description,omitempty"`

	// Distribution List of all distributions that image builder supports. A user might not have access to
	// restricted distributions.
	//
	// Restricted distributions include the RHEL nightlies and the Fedora distributions.
	Distribution Distributions `json:"distribution"`

	// ImageRequests Array of image requests. Having more image requests in a single blueprint is currently not supported.
	ImageRequests []ImageRequest     `json:"image_requests"`
	Metadata      *BlueprintMetadata `json:"metadata,omitempty"`
	Name          string             `json:"name"`
}

CreateBlueprintRequest defines model for CreateBlueprintRequest.

type CreateBlueprintResponse 

type CreateBlueprintResponse struct {
	Id openapi_types.UUID `json:"id"`
}

CreateBlueprintResponse defines model for CreateBlueprintResponse.

type CustomRepository 

type CustomRepository struct {
	Baseurl      *[]string `json:"baseurl,omitempty"`
	CheckGpg     *bool     `json:"check_gpg,omitempty"`
	CheckRepoGpg *bool     `json:"check_repo_gpg,omitempty"`
	Enabled      *bool     `json:"enabled,omitempty"`
	Filename     *string   `json:"filename,omitempty"`

	// Gpgkey GPG key used to sign packages in this repository. Can be a gpg key or a URL
	Gpgkey         *[]string `json:"gpgkey,omitempty"`
	Id             string    `json:"id"`
	Metalink       *string   `json:"metalink,omitempty"`
	Mirrorlist     *string   `json:"mirrorlist,omitempty"`
	ModuleHotfixes *bool     `json:"module_hotfixes,omitempty"`
	Name           *string   `json:"name,omitempty"`
	Priority       *int      `json:"priority,omitempty"`
	SslVerify      *bool     `json:"ssl_verify,omitempty"`
}

CustomRepository Repository configuration for custom repositories. At least one of the 'baseurl', 'mirrorlist', 'metalink' properties must be specified. If more of them are specified, the order of precedence is the same as listed above. Id is required.

type Customizations 

type Customizations struct {
	Containers *[]Container `json:"containers,omitempty"`

	// CustomRepositories List of custom repositories.
	CustomRepositories *[]CustomRepository `json:"custom_repositories,omitempty"`
	Directories        *[]Directory        `json:"directories,omitempty"`

	// Fdo FIDO device onboard configuration
	Fdo        *FDO          `json:"fdo,omitempty"`
	Files      *[]File       `json:"files,omitempty"`
	Filesystem *[]Filesystem `json:"filesystem,omitempty"`

	// Fips System FIPS mode setup
	Fips *FIPS `json:"fips,omitempty"`

	// Firewall Firewalld configuration
	Firewall *FirewallCustomization `json:"firewall,omitempty"`

	// Groups List of groups to create
	Groups *[]Group `json:"groups,omitempty"`

	// Hostname Configures the hostname
	Hostname *string `json:"hostname,omitempty"`

	// Ignition Ignition configuration
	Ignition *Ignition `json:"ignition,omitempty"`

	// InstallationDevice Name of the installation device, currently only useful for the edge-simplified-installer type
	InstallationDevice *string `json:"installation_device,omitempty"`

	// Installer Anaconda installer configuration
	Installer *Installer `json:"installer,omitempty"`
	Kernel    *Kernel    `json:"kernel,omitempty"`

	// Locale Locale configuration
	Locale   *Locale   `json:"locale,omitempty"`
	Openscap *OpenSCAP `json:"openscap,omitempty"`
	Packages *[]string `json:"packages,omitempty"`

	// PartitioningMode Select how the disk image will be partitioned. 'auto-lvm' will use raw unless
	// there are one or more mountpoints in which case it will use LVM. 'lvm' always
	// uses LVM, even when there are no extra mountpoints. 'raw' uses raw partitions
	// even when there are one or more mountpoints.
	PartitioningMode    *CustomizationsPartitioningMode `json:"partitioning_mode,omitempty"`
	PayloadRepositories *[]Repository                   `json:"payload_repositories,omitempty"`
	Services            *Services                       `json:"services,omitempty"`
	Subscription        *Subscription                   `json:"subscription,omitempty"`

	// Timezone Timezone configuration
	Timezone *Timezone `json:"timezone,omitempty"`

	// Users List of users that a customer can add,
	// also specifying their respective groups and SSH keys and/or password
	Users *[]User `json:"users,omitempty"`
}

Customizations defines model for Customizations.

type CustomizationsPartitioningMode 

type CustomizationsPartitioningMode string

CustomizationsPartitioningMode Select how the disk image will be partitioned. 'auto-lvm' will use raw unless there are one or more mountpoints in which case it will use LVM. 'lvm' always uses LVM, even when there are no extra mountpoints. 'raw' uses raw partitions even when there are one or more mountpoints. 

const (
	AutoLvm CustomizationsPartitioningMode = "auto-lvm"
	Lvm     CustomizationsPartitioningMode = "lvm"
	Raw     CustomizationsPartitioningMode = "raw"
)

Defines values for CustomizationsPartitioningMode.

type Directory 

type Directory struct {
	// EnsureParents Ensure that the parent directories exist
	EnsureParents *bool `json:"ensure_parents,omitempty"`

	// Group Group of the directory as a group name or a gid
	Group *Directory_Group `json:"group,omitempty"`

	// Mode Permissions string for the directory in octal format
	Mode *string `json:"mode,omitempty"`

	// Path Path to the directory
	Path string `json:"path"`

	// User Owner of the directory as a user name or a uid
	User *Directory_User `json:"user,omitempty"`
}

Directory A custom directory to create in the final artifact.

type DirectoryGroup0 

type DirectoryGroup0 = string

DirectoryGroup0 defines model for .

type DirectoryGroup1 

type DirectoryGroup1 = int

DirectoryGroup1 defines model for .

type DirectoryUser0 

type DirectoryUser0 = string

DirectoryUser0 defines model for .

type DirectoryUser1 

type DirectoryUser1 = int

DirectoryUser1 defines model for .

type Directory_Group 

type Directory_Group struct {
	// contains filtered or unexported fields
}

Directory_Group Group of the directory as a group name or a gid

func (Directory_Group) AsDirectoryGroup0 

func (t Directory_Group) AsDirectoryGroup0() (DirectoryGroup0, error)

AsDirectoryGroup0 returns the union data inside the Directory_Group as a DirectoryGroup0

func (Directory_Group) AsDirectoryGroup1 

func (t Directory_Group) AsDirectoryGroup1() (DirectoryGroup1, error)

AsDirectoryGroup1 returns the union data inside the Directory_Group as a DirectoryGroup1

func (*Directory_Group) FromDirectoryGroup0 

func (t *Directory_Group) FromDirectoryGroup0(v DirectoryGroup0) error

FromDirectoryGroup0 overwrites any union data inside the Directory_Group as the provided DirectoryGroup0

func (*Directory_Group) FromDirectoryGroup1 

func (t *Directory_Group) FromDirectoryGroup1(v DirectoryGroup1) error

FromDirectoryGroup1 overwrites any union data inside the Directory_Group as the provided DirectoryGroup1

func (Directory_Group) MarshalJSON 

func (t Directory_Group) MarshalJSON() ([]byte, error)

func (*Directory_Group) MergeDirectoryGroup0 

func (t *Directory_Group) MergeDirectoryGroup0(v DirectoryGroup0) error

MergeDirectoryGroup0 performs a merge with any union data inside the Directory_Group, using the provided DirectoryGroup0

func (*Directory_Group) MergeDirectoryGroup1 

func (t *Directory_Group) MergeDirectoryGroup1(v DirectoryGroup1) error

MergeDirectoryGroup1 performs a merge with any union data inside the Directory_Group, using the provided DirectoryGroup1

func (*Directory_Group) UnmarshalJSON 

func (t *Directory_Group) UnmarshalJSON(b []byte) error

type Directory_User 

type Directory_User struct {
	// contains filtered or unexported fields
}

Directory_User Owner of the directory as a user name or a uid

func (Directory_User) AsDirectoryUser0 

func (t Directory_User) AsDirectoryUser0() (DirectoryUser0, error)

AsDirectoryUser0 returns the union data inside the Directory_User as a DirectoryUser0

func (Directory_User) AsDirectoryUser1 

func (t Directory_User) AsDirectoryUser1() (DirectoryUser1, error)

AsDirectoryUser1 returns the union data inside the Directory_User as a DirectoryUser1

func (*Directory_User) FromDirectoryUser0 

func (t *Directory_User) FromDirectoryUser0(v DirectoryUser0) error

FromDirectoryUser0 overwrites any union data inside the Directory_User as the provided DirectoryUser0

func (*Directory_User) FromDirectoryUser1 

func (t *Directory_User) FromDirectoryUser1(v DirectoryUser1) error

FromDirectoryUser1 overwrites any union data inside the Directory_User as the provided DirectoryUser1

func (Directory_User) MarshalJSON 

func (t Directory_User) MarshalJSON() ([]byte, error)

func (*Directory_User) MergeDirectoryUser0 

func (t *Directory_User) MergeDirectoryUser0(v DirectoryUser0) error

MergeDirectoryUser0 performs a merge with any union data inside the Directory_User, using the provided DirectoryUser0

func (*Directory_User) MergeDirectoryUser1 

func (t *Directory_User) MergeDirectoryUser1(v DirectoryUser1) error

MergeDirectoryUser1 performs a merge with any union data inside the Directory_User, using the provided DirectoryUser1

func (*Directory_User) UnmarshalJSON 

func (t *Directory_User) UnmarshalJSON(b []byte) error

type DistributionItem 

type DistributionItem struct {
	Description string `json:"description"`
	Name        string `json:"name"`
}

DistributionItem defines model for DistributionItem.

type DistributionProfileItem 

type DistributionProfileItem string

DistributionProfileItem defines model for DistributionProfileItem. 

const (
	XccdfOrgSsgprojectContentProfileAnssiBp28Enhanced     DistributionProfileItem = "xccdf_org.ssgproject.content_profile_anssi_bp28_enhanced"
	XccdfOrgSsgprojectContentProfileAnssiBp28High         DistributionProfileItem = "xccdf_org.ssgproject.content_profile_anssi_bp28_high"
	XccdfOrgSsgprojectContentProfileAnssiBp28Intermediary DistributionProfileItem = "xccdf_org.ssgproject.content_profile_anssi_bp28_intermediary"
	XccdfOrgSsgprojectContentProfileAnssiBp28Minimal      DistributionProfileItem = "xccdf_org.ssgproject.content_profile_anssi_bp28_minimal"
	XccdfOrgSsgprojectContentProfileCcnAdvanced           DistributionProfileItem = "xccdf_org.ssgproject.content_profile_ccn_advanced"
	XccdfOrgSsgprojectContentProfileCcnBasic              DistributionProfileItem = "xccdf_org.ssgproject.content_profile_ccn_basic"
	XccdfOrgSsgprojectContentProfileCcnIntermediate       DistributionProfileItem = "xccdf_org.ssgproject.content_profile_ccn_intermediate"
	XccdfOrgSsgprojectContentProfileCis                   DistributionProfileItem = "xccdf_org.ssgproject.content_profile_cis"
	XccdfOrgSsgprojectContentProfileCisServerL1           DistributionProfileItem = "xccdf_org.ssgproject.content_profile_cis_server_l1"
	XccdfOrgSsgprojectContentProfileCisWorkstationL1      DistributionProfileItem = "xccdf_org.ssgproject.content_profile_cis_workstation_l1"
	XccdfOrgSsgprojectContentProfileCisWorkstationL2      DistributionProfileItem = "xccdf_org.ssgproject.content_profile_cis_workstation_l2"
	XccdfOrgSsgprojectContentProfileCui                   DistributionProfileItem = "xccdf_org.ssgproject.content_profile_cui"
	XccdfOrgSsgprojectContentProfileE8                    DistributionProfileItem = "xccdf_org.ssgproject.content_profile_e8"
	XccdfOrgSsgprojectContentProfileHipaa                 DistributionProfileItem = "xccdf_org.ssgproject.content_profile_hipaa"
	XccdfOrgSsgprojectContentProfileIsmO                  DistributionProfileItem = "xccdf_org.ssgproject.content_profile_ism_o"
	XccdfOrgSsgprojectContentProfileOspp                  DistributionProfileItem = "xccdf_org.ssgproject.content_profile_ospp"
	XccdfOrgSsgprojectContentProfilePciDss                DistributionProfileItem = "xccdf_org.ssgproject.content_profile_pci-dss"
	XccdfOrgSsgprojectContentProfileStandard              DistributionProfileItem = "xccdf_org.ssgproject.content_profile_standard"
	XccdfOrgSsgprojectContentProfileStig                  DistributionProfileItem = "xccdf_org.ssgproject.content_profile_stig"
	XccdfOrgSsgprojectContentProfileStigGui               DistributionProfileItem = "xccdf_org.ssgproject.content_profile_stig_gui"
)

Defines values for DistributionProfileItem.

type DistributionProfileResponse 

type DistributionProfileResponse = []DistributionProfileItem

DistributionProfileResponse List of profiles for a given distribution

func OscapProfiles 

func OscapProfiles(distribution Distributions) (DistributionProfileResponse, error)

type Distributions 

type Distributions string

Distributions List of all distributions that image builder supports. A user might not have access to restricted distributions.

Restricted distributions include the RHEL nightlies and the Fedora distributions. 

const (
	Centos10      Distributions = "centos-10"
	Centos9       Distributions = "centos-9"
	Fedora37      Distributions = "fedora-37"
	Fedora38      Distributions = "fedora-38"
	Fedora39      Distributions = "fedora-39"
	Fedora40      Distributions = "fedora-40"
	Fedora41      Distributions = "fedora-41"
	Rhel10Beta    Distributions = "rhel-10-beta"
	Rhel10Nightly Distributions = "rhel-10-nightly"
	Rhel8         Distributions = "rhel-8"
	Rhel810       Distributions = "rhel-8.10"
	Rhel84        Distributions = "rhel-84"
	Rhel85        Distributions = "rhel-85"
	Rhel86        Distributions = "rhel-86"
	Rhel87        Distributions = "rhel-87"
	Rhel88        Distributions = "rhel-88"
	Rhel89        Distributions = "rhel-89"
	Rhel8Nightly  Distributions = "rhel-8-nightly"
	Rhel9         Distributions = "rhel-9"
	Rhel90        Distributions = "rhel-90"
	Rhel91        Distributions = "rhel-91"
	Rhel92        Distributions = "rhel-92"
	Rhel93        Distributions = "rhel-93"
	Rhel94        Distributions = "rhel-94"
	Rhel95        Distributions = "rhel-95"
	Rhel9Beta     Distributions = "rhel-9-beta"
	Rhel9Nightly  Distributions = "rhel-9-nightly"
)

Defines values for Distributions.

type DistributionsResponse 

type DistributionsResponse = []DistributionItem

DistributionsResponse List of distributions this user is allowed to build.

type EchoRouter 

type EchoRouter interface {
	CONNECT(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
	DELETE(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
	GET(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
	HEAD(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
	OPTIONS(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
	PATCH(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
	POST(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
	PUT(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
	TRACE(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
}

This is a simple interface which specifies echo.Route addition functions which are present on both echo.Echo and echo.Group, since we want to allow using either of them for path registration

type FDO 

type FDO struct {
	DiunPubKeyHash         *string `json:"diun_pub_key_hash,omitempty"`
	DiunPubKeyInsecure     *string `json:"diun_pub_key_insecure,omitempty"`
	DiunPubKeyRootCerts    *string `json:"diun_pub_key_root_certs,omitempty"`
	ManufacturingServerUrl *string `json:"manufacturing_server_url,omitempty"`
}

FDO FIDO device onboard configuration

type FIPS 

type FIPS struct {
	// Enabled Enables the system FIPS mode
	Enabled *bool `json:"enabled,omitempty"`
}

FIPS System FIPS mode setup

type File 

type File struct {
	// Data Contents of the file as plain text
	Data *string `json:"data,omitempty"`

	// DataEncoding When data is base64-encoded to prevent Akamai content filter false positives
	DataEncoding *FileDataEncoding `json:"data_encoding,omitempty"`

	// EnsureParents Ensure that the parent directories exist
	EnsureParents *bool `json:"ensure_parents,omitempty"`

	// Group Group of the file as a gid or a group name
	Group *File_Group `json:"group,omitempty"`

	// Mode Permissions string for the file in octal format
	Mode *string `json:"mode,omitempty"`

	// Path Path to the file
	Path string `json:"path"`

	// User Owner of the file as a uid or a user name
	User *File_User `json:"user,omitempty"`
}

File A custom file to create in the final artifact.

type FileDataEncoding 

type FileDataEncoding string

FileDataEncoding When data is base64-encoded to prevent Akamai content filter false positives 

const (
	Base64 FileDataEncoding = "base64"
	Plain  FileDataEncoding = "plain"
)

Defines values for FileDataEncoding.

type FileGroup0 

type FileGroup0 = string

FileGroup0 defines model for .

type FileGroup1 

type FileGroup1 = int

FileGroup1 defines model for .

type FileUser0 

type FileUser0 = string

FileUser0 defines model for .

type FileUser1 

type FileUser1 = int

FileUser1 defines model for .

type File_Group 

type File_Group struct {
	// contains filtered or unexported fields
}

File_Group Group of the file as a gid or a group name

func (File_Group) AsFileGroup0 

func (t File_Group) AsFileGroup0() (FileGroup0, error)

AsFileGroup0 returns the union data inside the File_Group as a FileGroup0

func (File_Group) AsFileGroup1 

func (t File_Group) AsFileGroup1() (FileGroup1, error)

AsFileGroup1 returns the union data inside the File_Group as a FileGroup1

func (*File_Group) FromFileGroup0 

func (t *File_Group) FromFileGroup0(v FileGroup0) error

FromFileGroup0 overwrites any union data inside the File_Group as the provided FileGroup0

func (*File_Group) FromFileGroup1 

func (t *File_Group) FromFileGroup1(v FileGroup1) error

FromFileGroup1 overwrites any union data inside the File_Group as the provided FileGroup1

func (File_Group) MarshalJSON 

func (t File_Group) MarshalJSON() ([]byte, error)

func (*File_Group) MergeFileGroup0 

func (t *File_Group) MergeFileGroup0(v FileGroup0) error

MergeFileGroup0 performs a merge with any union data inside the File_Group, using the provided FileGroup0

func (*File_Group) MergeFileGroup1 

func (t *File_Group) MergeFileGroup1(v FileGroup1) error

MergeFileGroup1 performs a merge with any union data inside the File_Group, using the provided FileGroup1

func (*File_Group) UnmarshalJSON 

func (t *File_Group) UnmarshalJSON(b []byte) error

type File_User 

type File_User struct {
	// contains filtered or unexported fields
}

File_User Owner of the file as a uid or a user name

func (File_User) AsFileUser0 

func (t File_User) AsFileUser0() (FileUser0, error)

AsFileUser0 returns the union data inside the File_User as a FileUser0

func (File_User) AsFileUser1 

func (t File_User) AsFileUser1() (FileUser1, error)

AsFileUser1 returns the union data inside the File_User as a FileUser1

func (*File_User) FromFileUser0 

func (t *File_User) FromFileUser0(v FileUser0) error

FromFileUser0 overwrites any union data inside the File_User as the provided FileUser0

func (*File_User) FromFileUser1 

func (t *File_User) FromFileUser1(v FileUser1) error

FromFileUser1 overwrites any union data inside the File_User as the provided FileUser1

func (File_User) MarshalJSON 

func (t File_User) MarshalJSON() ([]byte, error)

func (*File_User) MergeFileUser0 

func (t *File_User) MergeFileUser0(v FileUser0) error

MergeFileUser0 performs a merge with any union data inside the File_User, using the provided FileUser0

func (*File_User) MergeFileUser1 

func (t *File_User) MergeFileUser1(v FileUser1) error

MergeFileUser1 performs a merge with any union data inside the File_User, using the provided FileUser1

func (*File_User) UnmarshalJSON 

func (t *File_User) UnmarshalJSON(b []byte) error

type Filesystem 

type Filesystem struct {
	// MinSize size of the filesystem in bytes
	MinSize    uint64 `json:"min_size"`
	Mountpoint string `json:"mountpoint"`
}

Filesystem defines model for Filesystem.

type FirewallCustomization 

type FirewallCustomization struct {
	// Ports List of ports (or port ranges) and protocols to open
	Ports *[]string `json:"ports,omitempty"`

	// Services Firewalld services to enable or disable
	Services *struct {
		// Disabled List of services to disable
		Disabled *[]string `json:"disabled,omitempty"`

		// Enabled List of services to enable
		Enabled *[]string `json:"enabled,omitempty"`
	} `json:"services,omitempty"`
}

FirewallCustomization Firewalld configuration

type GCPConfig 

type GCPConfig struct {
	Region string
	Bucket string
}

type GCPUploadRequestOptions 

type GCPUploadRequestOptions struct {
	// ShareWithAccounts List of valid Google accounts to share the imported Compute Node image with.
	// Each string must contain a specifier of the account type. Valid formats are:
	//   - 'user:{emailid}': An email address that represents a specific
	//     Google account. For example, 'alice@example.com'.
	//   - 'serviceAccount:{emailid}': An email address that represents a
	//     service account. For example, 'my-other-app@appspot.gserviceaccount.com'.
	//   - 'group:{emailid}': An email address that represents a Google group.
	//     For example, 'admins@example.com'.
	//   - 'domain:{domain}': The G Suite domain (primary) that represents all
	//     the users of that domain. For example, 'google.com' or 'example.com'.
	//     If not specified, the imported Compute Node image is not shared with any
	//     account.
	ShareWithAccounts *[]string `json:"share_with_accounts,omitempty"`
}

GCPUploadRequestOptions defines model for GCPUploadRequestOptions.

type GCPUploadStatus 

type GCPUploadStatus struct {
	ImageName string `json:"image_name"`
	ProjectId string `json:"project_id"`
}

GCPUploadStatus defines model for GCPUploadStatus.

type GetBlueprintComposesParams 

type GetBlueprintComposesParams struct {
	// BlueprintVersion Filter by a specific version of the Blueprint we want to fetch composes for.
	// Pass special value -1 to fetch composes for latest version of the Blueprint.
	BlueprintVersion *int `form:"blueprint_version,omitempty" json:"blueprint_version,omitempty"`

	// Limit max amount of composes, default 100
	Limit *int `form:"limit,omitempty" json:"limit,omitempty"`

	// Offset composes page offset, default 0
	Offset *int `form:"offset,omitempty" json:"offset,omitempty"`

	// IgnoreImageTypes Filter the composes on image type. The filter is optional and can be specified multiple times.
	IgnoreImageTypes *[]ImageTypes `form:"ignoreImageTypes,omitempty" json:"ignoreImageTypes,omitempty"`
}

GetBlueprintComposesParams defines parameters for GetBlueprintComposes.

type GetBlueprintParams 

type GetBlueprintParams struct {
	// Version Filter by a specific version of the Blueprint we want to fetch.
	// Omit or pass -1 to fetch latest version.
	Version *int `form:"version,omitempty" json:"version,omitempty"`
}

GetBlueprintParams defines parameters for GetBlueprint.

type GetBlueprintsParams 

type GetBlueprintsParams struct {
	// Name fetch blueprint with specific name
	Name *string `form:"name,omitempty" json:"name,omitempty"`

	// Search search for blueprints by name or description
	Search *string `form:"search,omitempty" json:"search,omitempty"`

	// Limit max amount of blueprints, default 100
	Limit *int `form:"limit,omitempty" json:"limit,omitempty"`

	// Offset blueprint page offset, default 0
	Offset *int `form:"offset,omitempty" json:"offset,omitempty"`
}

GetBlueprintsParams defines parameters for GetBlueprints.

type GetComposeClonesParams 

type GetComposeClonesParams struct {
	// Limit max amount of clones, default 100
	Limit *int `form:"limit,omitempty" json:"limit,omitempty"`

	// Offset clones page offset, default 0
	Offset *int `form:"offset,omitempty" json:"offset,omitempty"`
}

GetComposeClonesParams defines parameters for GetComposeClones.

type GetComposesParams 

type GetComposesParams struct {
	// Limit max amount of composes, default 100
	Limit *int `form:"limit,omitempty" json:"limit,omitempty"`

	// Offset composes page offset, default 0
	Offset *int `form:"offset,omitempty" json:"offset,omitempty"`

	// IgnoreImageTypes Filter the composes on image type. The filter is optional and can be specified multiple times.
	IgnoreImageTypes *[]ImageTypes `form:"ignoreImageTypes,omitempty" json:"ignoreImageTypes,omitempty"`
}

GetComposesParams defines parameters for GetComposes.

type GetPackagesParams 

type GetPackagesParams struct {
	// Distribution distribution to look up packages for
	Distribution Distributions `form:"distribution" json:"distribution"`

	// Architecture architecture to look up packages for
	Architecture GetPackagesParamsArchitecture `form:"architecture" json:"architecture"`

	// Search packages to look for
	Search string `form:"search" json:"search"`

	// Limit max amount of packages, default 100
	Limit *int `form:"limit,omitempty" json:"limit,omitempty"`

	// Offset packages page offset, default 0
	Offset *int `form:"offset,omitempty" json:"offset,omitempty"`
}

GetPackagesParams defines parameters for GetPackages.

type GetPackagesParamsArchitecture 

type GetPackagesParamsArchitecture string

GetPackagesParamsArchitecture defines parameters for GetPackages. 

const (
	GetPackagesParamsArchitectureAarch64 GetPackagesParamsArchitecture = "aarch64"
	GetPackagesParamsArchitectureX8664   GetPackagesParamsArchitecture = "x86_64"
)

Defines values for GetPackagesParamsArchitecture.

type Group 

type Group struct {
	// Gid Group id of the group to create (optional)
	Gid *int `json:"gid,omitempty"`

	// Name Name of the group to create
	Name string `json:"name"`
}

Group defines model for Group.

type HTTPError 

type HTTPError struct {
	Detail string `json:"detail"`
	Title  string `json:"title"`
}

HTTPError defines model for HTTPError.

type HTTPErrorList 

type HTTPErrorList struct {
	Errors []HTTPError `json:"errors"`
}

HTTPErrorList defines model for HTTPErrorList.

type Handlers 

type Handlers struct {
	// contains filtered or unexported fields
}

func (*Handlers) CloneCompose 

func (h *Handlers) CloneCompose(ctx echo.Context, composeId uuid.UUID) error

func (*Handlers) ComposeBlueprint 

func (h *Handlers) ComposeBlueprint(ctx echo.Context, id openapi_types.UUID) error

func (*Handlers) ComposeImage 

func (h *Handlers) ComposeImage(ctx echo.Context) error

func (*Handlers) CreateBlueprint 

func (h *Handlers) CreateBlueprint(ctx echo.Context) error

func (*Handlers) DeleteBlueprint 

func (h *Handlers) DeleteBlueprint(ctx echo.Context, blueprintId openapi_types.UUID) error

func (*Handlers) DeleteCompose 

func (h *Handlers) DeleteCompose(ctx echo.Context, composeId uuid.UUID) error

func (*Handlers) ExportBlueprint 

func (h *Handlers) ExportBlueprint(ctx echo.Context, id openapi_types.UUID) error

func (*Handlers) GetArchitectures 

func (h *Handlers) GetArchitectures(ctx echo.Context, distro Distributions) error

func (*Handlers) GetBlueprint 

func (h *Handlers) GetBlueprint(ctx echo.Context, id openapi_types.UUID, params GetBlueprintParams) error

func (*Handlers) GetBlueprintComposes 

func (h *Handlers) GetBlueprintComposes(ctx echo.Context, blueprintId openapi_types.UUID, params GetBlueprintComposesParams) error

func (*Handlers) GetBlueprints 

func (h *Handlers) GetBlueprints(ctx echo.Context, params GetBlueprintsParams) error

func (*Handlers) GetCloneStatus 

func (h *Handlers) GetCloneStatus(ctx echo.Context, id uuid.UUID) error

func (*Handlers) GetComposeClones 

func (h *Handlers) GetComposeClones(ctx echo.Context, composeId uuid.UUID, params GetComposeClonesParams) error

func (*Handlers) GetComposeMetadata 

func (h *Handlers) GetComposeMetadata(ctx echo.Context, composeId uuid.UUID) error

func (*Handlers) GetComposeStatus 

func (h *Handlers) GetComposeStatus(ctx echo.Context, composeId uuid.UUID) error

func (*Handlers) GetComposes 

func (h *Handlers) GetComposes(ctx echo.Context, params GetComposesParams) error

func (*Handlers) GetDistributions 

func (h *Handlers) GetDistributions(ctx echo.Context) error

func (*Handlers) GetOpenapiJson 

func (h *Handlers) GetOpenapiJson(ctx echo.Context) error

func (*Handlers) GetOscapCustomizations 

func (h *Handlers) GetOscapCustomizations(ctx echo.Context, distribution Distributions, profile DistributionProfileItem) error

func (*Handlers) GetOscapProfiles 

func (h *Handlers) GetOscapProfiles(ctx echo.Context, distribution Distributions) error

func (*Handlers) GetPackages 

func (h *Handlers) GetPackages(ctx echo.Context, params GetPackagesParams) error

func (*Handlers) GetReadiness 

func (h *Handlers) GetReadiness(ctx echo.Context) error

func (*Handlers) GetVersion 

func (h *Handlers) GetVersion(ctx echo.Context) error

func (*Handlers) RecommendPackage 

func (h *Handlers) RecommendPackage(ctx echo.Context) error

func (*Handlers) UpdateBlueprint 

func (h *Handlers) UpdateBlueprint(ctx echo.Context, blueprintId uuid.UUID) error

type Identity 

type Identity struct {
	// contains filtered or unexported fields
}

func (*Identity) AccountNumber 

func (i *Identity) AccountNumber() string

func (*Identity) Email 

func (i *Identity) Email() string

func (*Identity) IsEntitled 

func (i *Identity) IsEntitled(ctx echo.Context, ask string) bool

func (*Identity) OrgID 

func (i *Identity) OrgID() string

func (*Identity) Type 

func (i *Identity) Type() string

type Ignition 

type Ignition struct {
	Embedded  *IgnitionEmbedded  `json:"embedded,omitempty"`
	Firstboot *IgnitionFirstboot `json:"firstboot,omitempty"`
}

Ignition Ignition configuration

type IgnitionEmbedded 

type IgnitionEmbedded struct {
	Config string `json:"config"`
}

IgnitionEmbedded defines model for IgnitionEmbedded.

type IgnitionFirstboot 

type IgnitionFirstboot struct {
	// Url Provisioning URL
	Url string `json:"url"`
}

IgnitionFirstboot defines model for IgnitionFirstboot.

type ImageRequest 

type ImageRequest struct {
	// Architecture CPU architecture of the image, x86_64 and aarch64 are currently supported.
	Architecture ImageRequestArchitecture `json:"architecture"`
	ImageType    ImageTypes               `json:"image_type"`
	Ostree       *OSTree                  `json:"ostree,omitempty"`

	// Size Size of image, in bytes. When set to 0 the image size is a minimum
	// defined by the image type.
	Size *uint64 `json:"size,omitempty"`

	// SnapshotDate Snapshotted content will be used instead of the official repositories of the
	// distribution. The snapshot that was made closest to, but before the specified date will
	// be used. If no snapshots made before the specified date can be found, the snapshot
	// closest to, but after the specified date will be used. If no snapshots can be found at
	// all, the request will fail. The format must be YYYY-MM-DD (ISO 8601 extended).
	SnapshotDate  *string       `json:"snapshot_date,omitempty"`
	UploadRequest UploadRequest `json:"upload_request"`
}

ImageRequest defines model for ImageRequest.

type ImageRequestArchitecture 

type ImageRequestArchitecture string

ImageRequestArchitecture CPU architecture of the image, x86_64 and aarch64 are currently supported. 

const (
	ImageRequestArchitectureAarch64 ImageRequestArchitecture = "aarch64"
	ImageRequestArchitectureX8664   ImageRequestArchitecture = "x86_64"
)

Defines values for ImageRequestArchitecture.

type ImageStatus 

type ImageStatus struct {
	Error        *ComposeStatusError `json:"error,omitempty"`
	Status       ImageStatusStatus   `json:"status"`
	UploadStatus *UploadStatus       `json:"upload_status,omitempty"`
}

ImageStatus defines model for ImageStatus.

type ImageStatusStatus 

type ImageStatusStatus string

ImageStatusStatus defines model for ImageStatus.Status. 

const (
	ImageStatusStatusBuilding    ImageStatusStatus = "building"
	ImageStatusStatusFailure     ImageStatusStatus = "failure"
	ImageStatusStatusPending     ImageStatusStatus = "pending"
	ImageStatusStatusRegistering ImageStatusStatus = "registering"
	ImageStatusStatusSuccess     ImageStatusStatus = "success"
	ImageStatusStatusUploading   ImageStatusStatus = "uploading"
)

Defines values for ImageStatusStatus.

type ImageTypes 

type ImageTypes string

ImageTypes defines model for ImageTypes. 

const (
	ImageTypesAmi               ImageTypes = "ami"
	ImageTypesAws               ImageTypes = "aws"
	ImageTypesAzure             ImageTypes = "azure"
	ImageTypesEdgeCommit        ImageTypes = "edge-commit"
	ImageTypesEdgeInstaller     ImageTypes = "edge-installer"
	ImageTypesGcp               ImageTypes = "gcp"
	ImageTypesGuestImage        ImageTypes = "guest-image"
	ImageTypesImageInstaller    ImageTypes = "image-installer"
	ImageTypesOci               ImageTypes = "oci"
	ImageTypesRhelEdgeCommit    ImageTypes = "rhel-edge-commit"
	ImageTypesRhelEdgeInstaller ImageTypes = "rhel-edge-installer"
	ImageTypesVhd               ImageTypes = "vhd"
	ImageTypesVsphere           ImageTypes = "vsphere"
	ImageTypesVsphereOva        ImageTypes = "vsphere-ova"
	ImageTypesWsl               ImageTypes = "wsl"
)

Defines values for ImageTypes.

type Installer 

type Installer struct {
	SudoNopasswd *[]string `json:"sudo-nopasswd,omitempty"`

	// Unattended Create a kickstart file for a fully automated installation
	Unattended *bool `json:"unattended,omitempty"`
}

Installer Anaconda installer configuration

type Kernel 

type Kernel struct {
	// Append Appends arguments to the bootloader kernel command line
	Append *string `json:"append,omitempty"`

	// Name Name of the kernel to use
	Name *string `json:"name,omitempty"`
}

Kernel defines model for Kernel. 

type ListResponseLinks struct {
	First string `json:"first"`
	Last  string `json:"last"`
}

ListResponseLinks defines model for ListResponseLinks.

type ListResponseMeta 

type ListResponseMeta struct {
	Count int `json:"count"`
}

ListResponseMeta defines model for ListResponseMeta.

type Locale 

type Locale struct {
	// Keyboard Sets the keyboard layout
	Keyboard *string `json:"keyboard,omitempty"`

	// Languages List of locales to be installed, the first one becomes primary, subsequent ones are secondary
	Languages *[]string `json:"languages,omitempty"`
}

Locale Locale configuration

type OCIUploadRequestOptions 

type OCIUploadRequestOptions = map[string]interface{}

OCIUploadRequestOptions defines model for OCIUploadRequestOptions.

type OCIUploadStatus 

type OCIUploadStatus struct {
	Url string `json:"url"`
}

OCIUploadStatus defines model for OCIUploadStatus.

type OSTree 

type OSTree struct {
	// Contenturl A URL which, if set, is used for fetching content. Implies that `url` is set as well,
	// which will be used for metadata only.
	Contenturl *string `json:"contenturl,omitempty"`

	// Parent Can be either a commit (example: 02604b2da6e954bd34b8b82a835e5a77d2b60ffa), or a branch-like reference (example: rhel/8/x86_64/edge)
	Parent *string `json:"parent,omitempty"`
	Ref    *string `json:"ref,omitempty"`

	// Rhsm Determines whether a valid subscription manager (candlepin) identity is required to
	// access this repository. Consumer certificates will be used as client certificates when
	// fetching metadata and content.
	Rhsm *bool   `json:"rhsm,omitempty"`
	Url  *string `json:"url,omitempty"`
}

OSTree defines model for OSTree.

type OpenSCAP 

type OpenSCAP struct {
	// contains filtered or unexported fields
}

OpenSCAP defines model for OpenSCAP.

func (OpenSCAP) AsOpenSCAPCompliance 

func (t OpenSCAP) AsOpenSCAPCompliance() (OpenSCAPCompliance, error)

AsOpenSCAPCompliance returns the union data inside the OpenSCAP as a OpenSCAPCompliance

func (OpenSCAP) AsOpenSCAPProfile 

func (t OpenSCAP) AsOpenSCAPProfile() (OpenSCAPProfile, error)

AsOpenSCAPProfile returns the union data inside the OpenSCAP as a OpenSCAPProfile

func (*OpenSCAP) FromOpenSCAPCompliance 

func (t *OpenSCAP) FromOpenSCAPCompliance(v OpenSCAPCompliance) error

FromOpenSCAPCompliance overwrites any union data inside the OpenSCAP as the provided OpenSCAPCompliance

func (*OpenSCAP) FromOpenSCAPProfile 

func (t *OpenSCAP) FromOpenSCAPProfile(v OpenSCAPProfile) error

FromOpenSCAPProfile overwrites any union data inside the OpenSCAP as the provided OpenSCAPProfile

func (OpenSCAP) MarshalJSON 

func (t OpenSCAP) MarshalJSON() ([]byte, error)

func (*OpenSCAP) MergeOpenSCAPCompliance 

func (t *OpenSCAP) MergeOpenSCAPCompliance(v OpenSCAPCompliance) error

MergeOpenSCAPCompliance performs a merge with any union data inside the OpenSCAP, using the provided OpenSCAPCompliance

func (*OpenSCAP) MergeOpenSCAPProfile 

func (t *OpenSCAP) MergeOpenSCAPProfile(v OpenSCAPProfile) error

MergeOpenSCAPProfile performs a merge with any union data inside the OpenSCAP, using the provided OpenSCAPProfile

func (*OpenSCAP) UnmarshalJSON 

func (t *OpenSCAP) UnmarshalJSON(b []byte) error

type OpenSCAPCompliance 

type OpenSCAPCompliance struct {
	// PolicyId Apply a compliance policy which is defined in the Red Hat Insights Compliance
	// service. This policy can include tailorings. This only works for RHEL images, and the
	// policy needs to be available for the specific RHEL version.
	PolicyId openapi_types.UUID `json:"policy_id"`
}

OpenSCAPCompliance defines model for OpenSCAPCompliance.

type OpenSCAPProfile 

type OpenSCAPProfile struct {
	// ProfileDescription The longform profile description
	ProfileDescription *string `json:"profile_description,omitempty"`

	// ProfileId Uses the OpenSCAP tooling directly to apply a pre-defined profile without tailorings.
	ProfileId string `json:"profile_id"`

	// ProfileName The profile type
	ProfileName *string `json:"profile_name,omitempty"`
}

OpenSCAPProfile defines model for OpenSCAPProfile.

type Package 

type Package struct {
	Name    string `json:"name"`
	Summary string `json:"summary"`
}

Package defines model for Package.

type PackageMetadata 

type PackageMetadata struct {
	Arch      string  `json:"arch"`
	Epoch     *string `json:"epoch,omitempty"`
	Name      string  `json:"name"`
	Release   string  `json:"release"`
	Sigmd5    string  `json:"sigmd5"`
	Signature *string `json:"signature,omitempty"`
	Type      string  `json:"type"`
	Version   string  `json:"version"`
}

PackageMetadata defines model for PackageMetadata.

type PackagesResponse 

type PackagesResponse struct {
	Data  []Package         `json:"data"`
	Links ListResponseLinks `json:"links"`
	Meta  ListResponseMeta  `json:"meta"`
}

PackagesResponse defines model for PackagesResponse.

type Readiness 

type Readiness struct {
	Readiness string `json:"readiness"`
}

Readiness defines model for Readiness.

type RecommendPackageJSONRequestBody 

type RecommendPackageJSONRequestBody = RecommendPackageRequest

RecommendPackageJSONRequestBody defines body for RecommendPackage for application/json ContentType.

type RecommendPackageRequest 

type RecommendPackageRequest struct {
	Packages            []string `json:"packages"`
	RecommendedPackages int32    `json:"recommendedPackages"`
}

RecommendPackageRequest defines model for RecommendPackageRequest.

type RecommendationsResponse 

type RecommendationsResponse struct {
	Packages []string `json:"packages"`
}

RecommendationsResponse defines model for RecommendationsResponse.

type Repository 

type Repository struct {
	Baseurl  *string `json:"baseurl,omitempty"`
	CheckGpg *bool   `json:"check_gpg,omitempty"`

	// CheckRepoGpg Enables gpg verification of the repository metadata
	CheckRepoGpg   *bool   `json:"check_repo_gpg,omitempty"`
	Gpgkey         *string `json:"gpgkey,omitempty"`
	IgnoreSsl      *bool   `json:"ignore_ssl,omitempty"`
	Metalink       *string `json:"metalink,omitempty"`
	Mirrorlist     *string `json:"mirrorlist,omitempty"`
	ModuleHotfixes *bool   `json:"module_hotfixes,omitempty"`
	Rhsm           bool    `json:"rhsm"`
}

Repository defines model for Repository.

type Server 

type Server struct {
	// contains filtered or unexported fields
}

func Attach 

func Attach(conf *ServerConfig) (*Server, error)

func (*Server) HTTPErrorHandler 

func (s *Server) HTTPErrorHandler(err error, c echo.Context)

func (*Server) ValidateRequest 

func (s *Server) ValidateRequest(nextHandler echo.HandlerFunc) echo.HandlerFunc

type ServerConfig 

type ServerConfig struct {
	EchoServer       *echo.Echo
	CompClient       *composer.ComposerClient
	ProvClient       *provisioning.ProvisioningClient
	CSClient         *content_sources.ContentSourcesClient
	CSReposURL       string
	RecommendClient  *recommendations.RecommendationsClient
	ComplianceClient *compliance.ComplianceClient
	DBase            db.DB
	AwsConfig        AWSConfig
	GcpConfig        GCPConfig
	QuotaFile        string
	AllowFile        string
	AllDistros       *distribution.AllDistroRegistry
	DistributionsDir string
	FedoraAuth       bool
}

type ServerInterface 

type ServerInterface interface {
	// get the architectures and their image types available for a given distribution
	// (GET /architectures/{distribution})
	GetArchitectures(ctx echo.Context, distribution Distributions) error
	// get a collection of blueprints
	// (GET /blueprints)
	GetBlueprints(ctx echo.Context, params GetBlueprintsParams) error
	// create blueprint
	// (POST /blueprints)
	CreateBlueprint(ctx echo.Context) error
	// delete a blueprint
	// (DELETE /blueprints/{id})
	DeleteBlueprint(ctx echo.Context, id openapi_types.UUID) error
	// get detail of a blueprint
	// (GET /blueprints/{id})
	GetBlueprint(ctx echo.Context, id openapi_types.UUID, params GetBlueprintParams) error
	// update blueprint
	// (PUT /blueprints/{id})
	UpdateBlueprint(ctx echo.Context, id openapi_types.UUID) error
	// create new compose from blueprint
	// (POST /blueprints/{id}/compose)
	ComposeBlueprint(ctx echo.Context, id openapi_types.UUID) error
	// get composes associated with a blueprint
	// (GET /blueprints/{id}/composes)
	GetBlueprintComposes(ctx echo.Context, id openapi_types.UUID, params GetBlueprintComposesParams) error
	// export a blueprint
	// (GET /blueprints/{id}/export)
	ExportBlueprint(ctx echo.Context, id openapi_types.UUID) error
	// get status of a compose clone
	// (GET /clones/{id})
	GetCloneStatus(ctx echo.Context, id openapi_types.UUID) error
	// compose image
	// (POST /compose)
	ComposeImage(ctx echo.Context) error
	// get a collection of previous compose requests for the logged in user
	// (GET /composes)
	GetComposes(ctx echo.Context, params GetComposesParams) error
	// delete a compose
	// (DELETE /composes/{composeId})
	DeleteCompose(ctx echo.Context, composeId openapi_types.UUID) error
	// get status of an image compose
	// (GET /composes/{composeId})
	GetComposeStatus(ctx echo.Context, composeId openapi_types.UUID) error
	// clone a compose
	// (POST /composes/{composeId}/clone)
	CloneCompose(ctx echo.Context, composeId openapi_types.UUID) error
	// get clones of a compose
	// (GET /composes/{composeId}/clones)
	GetComposeClones(ctx echo.Context, composeId openapi_types.UUID, params GetComposeClonesParams) error
	// get metadata of an image compose
	// (GET /composes/{composeId}/metadata)
	GetComposeMetadata(ctx echo.Context, composeId openapi_types.UUID) error
	// get the distributions available to this user
	// (GET /distributions)
	GetDistributions(ctx echo.Context) error
	// List recommended packages.
	// (POST /experimental/recommendations)
	RecommendPackage(ctx echo.Context) error
	// get the available profiles for a given distribution. This is a temporary endpoint meant to be removed soon.
	// (GET /oscap/{distribution}/profiles)
	GetOscapProfiles(ctx echo.Context, distribution Distributions) error
	// get the customizations for a given distribution and profile. This is a temporary endpoint meant to be removed soon.
	// (GET /oscap/{distribution}/{profile}/customizations)
	GetOscapCustomizations(ctx echo.Context, distribution Distributions, profile DistributionProfileItem) error

	// (GET /packages)
	GetPackages(ctx echo.Context, params GetPackagesParams) error
	// return the readiness
	// (GET /ready)
	GetReadiness(ctx echo.Context) error
	// get the service version
	// (GET /version)
	GetVersion(ctx echo.Context) error
}

ServerInterface represents all server handlers.

type ServerInterfaceWrapper 

type ServerInterfaceWrapper struct {
	Handler ServerInterface
}

ServerInterfaceWrapper converts echo contexts to parameters.

func (*ServerInterfaceWrapper) CloneCompose 

func (w *ServerInterfaceWrapper) CloneCompose(ctx echo.Context) error

CloneCompose converts echo context to params.

func (*ServerInterfaceWrapper) ComposeBlueprint 

func (w *ServerInterfaceWrapper) ComposeBlueprint(ctx echo.Context) error

ComposeBlueprint converts echo context to params.

func (*ServerInterfaceWrapper) ComposeImage 

func (w *ServerInterfaceWrapper) ComposeImage(ctx echo.Context) error

ComposeImage converts echo context to params.

func (*ServerInterfaceWrapper) CreateBlueprint 

func (w *ServerInterfaceWrapper) CreateBlueprint(ctx echo.Context) error

CreateBlueprint converts echo context to params.

func (*ServerInterfaceWrapper) DeleteBlueprint 

func (w *ServerInterfaceWrapper) DeleteBlueprint(ctx echo.Context) error

DeleteBlueprint converts echo context to params.

func (*ServerInterfaceWrapper) DeleteCompose 

func (w *ServerInterfaceWrapper) DeleteCompose(ctx echo.Context) error

DeleteCompose converts echo context to params.

func (*ServerInterfaceWrapper) ExportBlueprint 

func (w *ServerInterfaceWrapper) ExportBlueprint(ctx echo.Context) error

ExportBlueprint converts echo context to params.

func (*ServerInterfaceWrapper) GetArchitectures 

func (w *ServerInterfaceWrapper) GetArchitectures(ctx echo.Context) error

GetArchitectures converts echo context to params.

func (*ServerInterfaceWrapper) GetBlueprint 

func (w *ServerInterfaceWrapper) GetBlueprint(ctx echo.Context) error

GetBlueprint converts echo context to params.

func (*ServerInterfaceWrapper) GetBlueprintComposes 

func (w *ServerInterfaceWrapper) GetBlueprintComposes(ctx echo.Context) error

GetBlueprintComposes converts echo context to params.

func (*ServerInterfaceWrapper) GetBlueprints 

func (w *ServerInterfaceWrapper) GetBlueprints(ctx echo.Context) error

GetBlueprints converts echo context to params.

func (*ServerInterfaceWrapper) GetCloneStatus 

func (w *ServerInterfaceWrapper) GetCloneStatus(ctx echo.Context) error

GetCloneStatus converts echo context to params.

func (*ServerInterfaceWrapper) GetComposeClones 

func (w *ServerInterfaceWrapper) GetComposeClones(ctx echo.Context) error

GetComposeClones converts echo context to params.

func (*ServerInterfaceWrapper) GetComposeMetadata 

func (w *ServerInterfaceWrapper) GetComposeMetadata(ctx echo.Context) error

GetComposeMetadata converts echo context to params.

func (*ServerInterfaceWrapper) GetComposeStatus 

func (w *ServerInterfaceWrapper) GetComposeStatus(ctx echo.Context) error

GetComposeStatus converts echo context to params.

func (*ServerInterfaceWrapper) GetComposes 

func (w *ServerInterfaceWrapper) GetComposes(ctx echo.Context) error

GetComposes converts echo context to params.

func (*ServerInterfaceWrapper) GetDistributions 

func (w *ServerInterfaceWrapper) GetDistributions(ctx echo.Context) error

GetDistributions converts echo context to params.

func (*ServerInterfaceWrapper) GetOscapCustomizations 

func (w *ServerInterfaceWrapper) GetOscapCustomizations(ctx echo.Context) error

GetOscapCustomizations converts echo context to params.

func (*ServerInterfaceWrapper) GetOscapProfiles 

func (w *ServerInterfaceWrapper) GetOscapProfiles(ctx echo.Context) error

GetOscapProfiles converts echo context to params.

func (*ServerInterfaceWrapper) GetPackages 

func (w *ServerInterfaceWrapper) GetPackages(ctx echo.Context) error

GetPackages converts echo context to params.

func (*ServerInterfaceWrapper) GetReadiness 

func (w *ServerInterfaceWrapper) GetReadiness(ctx echo.Context) error

GetReadiness converts echo context to params.

func (*ServerInterfaceWrapper) GetVersion 

func (w *ServerInterfaceWrapper) GetVersion(ctx echo.Context) error

GetVersion converts echo context to params.

func (*ServerInterfaceWrapper) RecommendPackage 

func (w *ServerInterfaceWrapper) RecommendPackage(ctx echo.Context) error

RecommendPackage converts echo context to params.

func (*ServerInterfaceWrapper) UpdateBlueprint 

func (w *ServerInterfaceWrapper) UpdateBlueprint(ctx echo.Context) error

UpdateBlueprint converts echo context to params.

type Services 

type Services struct {
	// Disabled List of services to disable by default
	Disabled *[]string `json:"disabled,omitempty"`

	// Enabled List of services to enable by default
	Enabled *[]string `json:"enabled,omitempty"`

	// Masked List of services to mask by default
	Masked *[]string `json:"masked,omitempty"`
}

Services defines model for Services.

type Subscription 

type Subscription struct {
	ActivationKey string `json:"activation-key"`
	BaseUrl       string `json:"base-url"`
	Insights      bool   `json:"insights"`
	Organization  int    `json:"organization"`

	// Rhc Optional flag to use rhc to register the system, which also always enables Insights.
	Rhc       *bool  `json:"rhc,omitempty"`
	ServerUrl string `json:"server-url"`
}

Subscription defines model for Subscription.

type Timezone 

type Timezone struct {
	// Ntpservers List of ntp servers
	Ntpservers *[]string `json:"ntpservers,omitempty"`

	// Timezone Name of the timezone, defaults to UTC
	Timezone *string `json:"timezone,omitempty"`
}

Timezone Timezone configuration

type UpdateBlueprintJSONRequestBody 

type UpdateBlueprintJSONRequestBody = CreateBlueprintRequest

UpdateBlueprintJSONRequestBody defines body for UpdateBlueprint for application/json ContentType.

type UploadRequest 

type UploadRequest struct {
	Options UploadRequest_Options `json:"options"`
	Type    UploadTypes           `json:"type"`
}

UploadRequest defines model for UploadRequest.

type UploadRequest_Options 

type UploadRequest_Options struct {
	// contains filtered or unexported fields
}

UploadRequest_Options defines model for UploadRequest.Options.

func (UploadRequest_Options) AsAWSS3UploadRequestOptions 

func (t UploadRequest_Options) AsAWSS3UploadRequestOptions() (AWSS3UploadRequestOptions, error)

AsAWSS3UploadRequestOptions returns the union data inside the UploadRequest_Options as a AWSS3UploadRequestOptions

func (UploadRequest_Options) AsAWSUploadRequestOptions 

func (t UploadRequest_Options) AsAWSUploadRequestOptions() (AWSUploadRequestOptions, error)

AsAWSUploadRequestOptions returns the union data inside the UploadRequest_Options as a AWSUploadRequestOptions

func (UploadRequest_Options) AsAzureUploadRequestOptions 

func (t UploadRequest_Options) AsAzureUploadRequestOptions() (AzureUploadRequestOptions, error)

AsAzureUploadRequestOptions returns the union data inside the UploadRequest_Options as a AzureUploadRequestOptions

func (UploadRequest_Options) AsGCPUploadRequestOptions 

func (t UploadRequest_Options) AsGCPUploadRequestOptions() (GCPUploadRequestOptions, error)

AsGCPUploadRequestOptions returns the union data inside the UploadRequest_Options as a GCPUploadRequestOptions

func (UploadRequest_Options) AsOCIUploadRequestOptions 

func (t UploadRequest_Options) AsOCIUploadRequestOptions() (OCIUploadRequestOptions, error)

AsOCIUploadRequestOptions returns the union data inside the UploadRequest_Options as a OCIUploadRequestOptions

func (*UploadRequest_Options) FromAWSS3UploadRequestOptions 

func (t *UploadRequest_Options) FromAWSS3UploadRequestOptions(v AWSS3UploadRequestOptions) error

FromAWSS3UploadRequestOptions overwrites any union data inside the UploadRequest_Options as the provided AWSS3UploadRequestOptions

func (*UploadRequest_Options) FromAWSUploadRequestOptions 

func (t *UploadRequest_Options) FromAWSUploadRequestOptions(v AWSUploadRequestOptions) error

FromAWSUploadRequestOptions overwrites any union data inside the UploadRequest_Options as the provided AWSUploadRequestOptions

func (*UploadRequest_Options) FromAzureUploadRequestOptions 

func (t *UploadRequest_Options) FromAzureUploadRequestOptions(v AzureUploadRequestOptions) error

FromAzureUploadRequestOptions overwrites any union data inside the UploadRequest_Options as the provided AzureUploadRequestOptions

func (*UploadRequest_Options) FromGCPUploadRequestOptions 

func (t *UploadRequest_Options) FromGCPUploadRequestOptions(v GCPUploadRequestOptions) error

FromGCPUploadRequestOptions overwrites any union data inside the UploadRequest_Options as the provided GCPUploadRequestOptions

func (*UploadRequest_Options) FromOCIUploadRequestOptions 

func (t *UploadRequest_Options) FromOCIUploadRequestOptions(v OCIUploadRequestOptions) error

FromOCIUploadRequestOptions overwrites any union data inside the UploadRequest_Options as the provided OCIUploadRequestOptions

func (UploadRequest_Options) MarshalJSON 

func (t UploadRequest_Options) MarshalJSON() ([]byte, error)

func (*UploadRequest_Options) MergeAWSS3UploadRequestOptions 

func (t *UploadRequest_Options) MergeAWSS3UploadRequestOptions(v AWSS3UploadRequestOptions) error

MergeAWSS3UploadRequestOptions performs a merge with any union data inside the UploadRequest_Options, using the provided AWSS3UploadRequestOptions

func (*UploadRequest_Options) MergeAWSUploadRequestOptions 

func (t *UploadRequest_Options) MergeAWSUploadRequestOptions(v AWSUploadRequestOptions) error

MergeAWSUploadRequestOptions performs a merge with any union data inside the UploadRequest_Options, using the provided AWSUploadRequestOptions

func (*UploadRequest_Options) MergeAzureUploadRequestOptions 

func (t *UploadRequest_Options) MergeAzureUploadRequestOptions(v AzureUploadRequestOptions) error

MergeAzureUploadRequestOptions performs a merge with any union data inside the UploadRequest_Options, using the provided AzureUploadRequestOptions

func (*UploadRequest_Options) MergeGCPUploadRequestOptions 

func (t *UploadRequest_Options) MergeGCPUploadRequestOptions(v GCPUploadRequestOptions) error

MergeGCPUploadRequestOptions performs a merge with any union data inside the UploadRequest_Options, using the provided GCPUploadRequestOptions

func (*UploadRequest_Options) MergeOCIUploadRequestOptions 

func (t *UploadRequest_Options) MergeOCIUploadRequestOptions(v OCIUploadRequestOptions) error

MergeOCIUploadRequestOptions performs a merge with any union data inside the UploadRequest_Options, using the provided OCIUploadRequestOptions

func (*UploadRequest_Options) UnmarshalJSON 

func (t *UploadRequest_Options) UnmarshalJSON(b []byte) error

type UploadStatus 

type UploadStatus struct {
	Options UploadStatus_Options `json:"options"`
	Status  UploadStatusStatus   `json:"status"`
	Type    UploadTypes          `json:"type"`
}

UploadStatus defines model for UploadStatus.

type UploadStatusStatus 

type UploadStatusStatus string

UploadStatusStatus defines model for UploadStatus.Status. 

const (
	Failure UploadStatusStatus = "failure"
	Pending UploadStatusStatus = "pending"
	Running UploadStatusStatus = "running"
	Success UploadStatusStatus = "success"
)

Defines values for UploadStatusStatus.

type UploadStatus_Options 

type UploadStatus_Options struct {
	// contains filtered or unexported fields
}

UploadStatus_Options defines model for UploadStatus.Options.

func (UploadStatus_Options) AsAWSS3UploadStatus 

func (t UploadStatus_Options) AsAWSS3UploadStatus() (AWSS3UploadStatus, error)

AsAWSS3UploadStatus returns the union data inside the UploadStatus_Options as a AWSS3UploadStatus

func (UploadStatus_Options) AsAWSUploadStatus 

func (t UploadStatus_Options) AsAWSUploadStatus() (AWSUploadStatus, error)

AsAWSUploadStatus returns the union data inside the UploadStatus_Options as a AWSUploadStatus

func (UploadStatus_Options) AsAzureUploadStatus 

func (t UploadStatus_Options) AsAzureUploadStatus() (AzureUploadStatus, error)

AsAzureUploadStatus returns the union data inside the UploadStatus_Options as a AzureUploadStatus

func (UploadStatus_Options) AsGCPUploadStatus 

func (t UploadStatus_Options) AsGCPUploadStatus() (GCPUploadStatus, error)

AsGCPUploadStatus returns the union data inside the UploadStatus_Options as a GCPUploadStatus

func (UploadStatus_Options) AsOCIUploadStatus 

func (t UploadStatus_Options) AsOCIUploadStatus() (OCIUploadStatus, error)

AsOCIUploadStatus returns the union data inside the UploadStatus_Options as a OCIUploadStatus

func (*UploadStatus_Options) FromAWSS3UploadStatus 

func (t *UploadStatus_Options) FromAWSS3UploadStatus(v AWSS3UploadStatus) error

FromAWSS3UploadStatus overwrites any union data inside the UploadStatus_Options as the provided AWSS3UploadStatus

func (*UploadStatus_Options) FromAWSUploadStatus 

func (t *UploadStatus_Options) FromAWSUploadStatus(v AWSUploadStatus) error

FromAWSUploadStatus overwrites any union data inside the UploadStatus_Options as the provided AWSUploadStatus

func (*UploadStatus_Options) FromAzureUploadStatus 

func (t *UploadStatus_Options) FromAzureUploadStatus(v AzureUploadStatus) error

FromAzureUploadStatus overwrites any union data inside the UploadStatus_Options as the provided AzureUploadStatus

func (*UploadStatus_Options) FromGCPUploadStatus 

func (t *UploadStatus_Options) FromGCPUploadStatus(v GCPUploadStatus) error

FromGCPUploadStatus overwrites any union data inside the UploadStatus_Options as the provided GCPUploadStatus

func (*UploadStatus_Options) FromOCIUploadStatus 

func (t *UploadStatus_Options) FromOCIUploadStatus(v OCIUploadStatus) error

FromOCIUploadStatus overwrites any union data inside the UploadStatus_Options as the provided OCIUploadStatus

func (UploadStatus_Options) MarshalJSON 

func (t UploadStatus_Options) MarshalJSON() ([]byte, error)

func (*UploadStatus_Options) MergeAWSS3UploadStatus 

func (t *UploadStatus_Options) MergeAWSS3UploadStatus(v AWSS3UploadStatus) error

MergeAWSS3UploadStatus performs a merge with any union data inside the UploadStatus_Options, using the provided AWSS3UploadStatus

func (*UploadStatus_Options) MergeAWSUploadStatus 

func (t *UploadStatus_Options) MergeAWSUploadStatus(v AWSUploadStatus) error

MergeAWSUploadStatus performs a merge with any union data inside the UploadStatus_Options, using the provided AWSUploadStatus

func (*UploadStatus_Options) MergeAzureUploadStatus 

func (t *UploadStatus_Options) MergeAzureUploadStatus(v AzureUploadStatus) error

MergeAzureUploadStatus performs a merge with any union data inside the UploadStatus_Options, using the provided AzureUploadStatus

func (*UploadStatus_Options) MergeGCPUploadStatus 

func (t *UploadStatus_Options) MergeGCPUploadStatus(v GCPUploadStatus) error

MergeGCPUploadStatus performs a merge with any union data inside the UploadStatus_Options, using the provided GCPUploadStatus

func (*UploadStatus_Options) MergeOCIUploadStatus 

func (t *UploadStatus_Options) MergeOCIUploadStatus(v OCIUploadStatus) error

MergeOCIUploadStatus performs a merge with any union data inside the UploadStatus_Options, using the provided OCIUploadStatus

func (*UploadStatus_Options) UnmarshalJSON 

func (t *UploadStatus_Options) UnmarshalJSON(b []byte) error

type UploadTypes 

type UploadTypes string

UploadTypes defines model for UploadTypes. 

const (
	UploadTypesAws              UploadTypes = "aws"
	UploadTypesAwsS3            UploadTypes = "aws.s3"
	UploadTypesAzure            UploadTypes = "azure"
	UploadTypesGcp              UploadTypes = "gcp"
	UploadTypesOciObjectstorage UploadTypes = "oci.objectstorage"
)

Defines values for UploadTypes.

type User 

type User struct {
	// Groups List of groups to add the user to. The 'wheel' group should be added explicitly, as the
	// default value is empty.
	Groups *[]string `json:"groups,omitempty"`
	Name   string    `json:"name"`

	// Password Plaintext passwords are also supported, they will be hashed and stored using the SHA-512 algorithm.
	// The password is never returned in the response.
	// Empty string can be used to remove the password during update but only with ssh_key set.
	Password *string `json:"password,omitempty"`
	SshKey   *string `json:"ssh_key,omitempty"`
}

User At least one of password, ssh_key must be set, validator takes care of it. On update empty string can be used to remove password or ssh_key, but at least one of them still must be present.

func (*User) CryptPassword 

func (u *User) CryptPassword() error

func (*User) MergeExisting 

func (u *User) MergeExisting(other User)

Merges Password or SshKey from other User struct to this User struct if it is not set

func (*User) MergeForUpdate 

func (u *User) MergeForUpdate(userData []User) error

func (*User) RedactPassword 

func (u *User) RedactPassword()

Set password to nil if it is not nil

func (*User) Valid 

func (u *User) Valid() error

User must have name and non-empty password or ssh key

type Version 

type Version struct {
	BuildCommit *string `json:"build_commit,omitempty"`
	BuildTime   *string `json:"build_time,omitempty"`
	Version     string  `json:"version"`
}

Version defines model for Version.

Source Files

View all Source files

Directories

Path Synopsis

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.