hub

package
v1.14.1 Latest Latest
Warning

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

Go to latest
Published: Oct 18, 2023 License: Apache-2.0 Imports: 13 Imported by: 0

Documentation

Index

Constants

View Source
const (
	ArtifactHubType = "artifact"
	TektonHubType   = "tekton"
)

Variables

This section is empty.

Functions

func NewArtifactHubClient added in v1.11.0

func NewArtifactHubClient() *artifactHubClient

func NewTektonHubClient added in v1.11.0

func NewTektonHubClient() *tektonHubClient

func URL

func URL() string

URL returns the Hub API Server URL

Types

type ArtifactHubPkgData added in v1.12.0

type ArtifactHubPkgData struct {
	PipelineMinVer string   `json:"pipelines.minVersion"`
	ManifestRaw    string   `json:"manifestRaw"`
	Platforms      []string `json:"platforms"`
}

type ArtifactHubPkgResponse added in v1.12.0

type ArtifactHubPkgResponse struct {
	Name              string               `json:"name,omitempty"`
	Data              ArtifactHubPkgData   `json:"data,omitempty"`
	AvailableVersions []ArtifactHubVersion `json:"available_versions,omitempty"`
	Repository        ArtifactHubRepo      `json:"repository,omitempty"`
}

type ArtifactHubRepo added in v1.12.0

type ArtifactHubRepo struct {
	Org string `json:"organization_name,omitempty"`
}

type ArtifactHubResourceResult added in v1.12.0

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

ArtifactHubResourceResult defines Artifact Hub API response

func (*ArtifactHubResourceResult) Manifest added in v1.12.0

func (rr *ArtifactHubResourceResult) Manifest() ([]byte, error)

Manifest gets the raw resource of the catalog from ArtifactHubResourceResult

func (*ArtifactHubResourceResult) MinPipelinesVersion added in v1.12.0

func (rr *ArtifactHubResourceResult) MinPipelinesVersion() (string, error)

MinPipelinesVersion returns the minimum pipeline version the resource is compatible from ArtifactHubResourceResult

func (*ArtifactHubResourceResult) Org added in v1.12.0

func (rr *ArtifactHubResourceResult) Org() (string, error)

Org returns the organization of the catalog from Artifact Hub

func (*ArtifactHubResourceResult) RawURL added in v1.12.0

func (rr *ArtifactHubResourceResult) RawURL() (string, error)

RawURL returns the raw url of the resource yaml file from ArtifactHubResourceResult

func (*ArtifactHubResourceResult) Resource added in v1.12.0

func (rr *ArtifactHubResourceResult) Resource() (interface{}, error)

Resource returns the resource found from ArtifactHubResourceResult

func (*ArtifactHubResourceResult) ResourceVersion added in v1.12.0

func (rr *ArtifactHubResourceResult) ResourceVersion() (string, error)

ResourceVersion returns the resource version found from ArtifactHubResourceResult

func (*ArtifactHubResourceResult) ResourceYaml added in v1.12.0

func (rr *ArtifactHubResourceResult) ResourceYaml() (string, error)

ResourceYaml returns the resource yaml file found from ArtifactHubResourceResult

func (*ArtifactHubResourceResult) UnmarshalData added in v1.12.0

func (rr *ArtifactHubResourceResult) UnmarshalData() error

UnmarshalData unmarshals the data embedded in ArtifactHubResourceResult

type ArtifactHubVersion added in v1.12.0

type ArtifactHubVersion struct {
	Version string `json:"version"`
}

type CatalogData

type CatalogData = cclient.ListResponseBody

type CatalogResult

type CatalogResult struct {
	Catalog CatalogData
	// contains filtered or unexported fields
}

func (*CatalogResult) Type

func (cr *CatalogResult) Type() (CatalogData, error)

Typed returns unmarshalled API response as CatalogResponse

type Client

type Client interface {
	GetType() string
	SetURL(u string) error
	Get(endpoint string) ([]byte, int, error)
	GetCatalogsList() ([]string, error)
	Search(opt SearchOption) SearchResult
	GetResource(opt ResourceOption) ResourceResult
	GetResourceYaml(opt ResourceOption) ResourceResult
	GetResourcesList(opt SearchOption) ([]string, error)
	GetResourceVersions(opt ResourceOption) ResourceVersionResult
	GetResourceVersionslist(opt ResourceOption) ([]string, error)
}

type ResVersions

type ResVersions = rclient.VersionsResponseBody

ResVersions is the data in API response consisting of list of versions

type ResourceData

type ResourceData = rclient.ResourceDataResponseBody

ResourceData is the response of API when finding a resource

type ResourceOption

type ResourceOption struct {
	Name            string
	Catalog         string
	Version         string
	Kind            string
	PipelineVersion string
}

ResourceOption defines option associated with API to fetch a particular resource

func (ResourceOption) Endpoint

func (opt ResourceOption) Endpoint() string

Endpoint computes the endpoint url using input provided

type ResourceResult

type ResourceResult interface {
	RawURL() (string, error)
	Manifest() ([]byte, error)
	Resource() (interface{}, error)
	ResourceYaml() (string, error)
	ResourceVersion() (string, error)
	MinPipelinesVersion() (string, error)
	Org() (string, error)
	UnmarshalData() error
}

ResourceResult defines API response

type ResourceVersionOptions

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

type ResourceVersionResult

type ResourceVersionResult interface {
	ResourceVersions() (*ResVersions, error)
	UnmarshalData() error
}

type ResourceWithVersionData

type ResourceWithVersionData = rclient.ResourceVersionDataResponseBody

ResourceWithVersionData is the response of API when finding a resource with a specific version

type SearchOption

type SearchOption struct {
	Name       string
	Kinds      []string
	Tags       []string
	Categories []string
	Platforms  []string
	Match      string
	Limit      uint
	Catalog    string
}

SearchOption defines option associated with query API

func (SearchOption) Endpoint

func (so SearchOption) Endpoint() string

Endpoint computes the endpoint url using input provided

type SearchResponse

SearchResponse is the data object which is the search result

type SearchResult

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

SearchResult defines API raw response, unmarshalled reponse, and error

func (*SearchResult) Raw

func (sr *SearchResult) Raw() ([]byte, error)

Raw returns API response as byte array

func (*SearchResult) Typed

func (sr *SearchResult) Typed() (SearchResponse, error)

Typed returns unmarshalled API response as SearchResponse

type TektonHubResourceResult added in v1.12.0

type TektonHubResourceResult struct {
	ResourceContent *ResourceContent
	// contains filtered or unexported fields
}

TektonHubResourceResult defines Tekton Hub API response

func (*TektonHubResourceResult) Manifest added in v1.12.0

func (rr *TektonHubResourceResult) Manifest() ([]byte, error)

Manifest gets the raw resource of the catalog from TektonHubResourceResult

func (*TektonHubResourceResult) MinPipelinesVersion added in v1.12.0

func (rr *TektonHubResourceResult) MinPipelinesVersion() (string, error)

MinPipelinesVersion returns the minimum pipeline version the resource is compatible from TektonHubResourceResult

func (*TektonHubResourceResult) Org added in v1.12.0

func (rr *TektonHubResourceResult) Org() (string, error)

Org returns the organization of the catalog from Tekton Hub

func (*TektonHubResourceResult) RawURL added in v1.12.0

func (rr *TektonHubResourceResult) RawURL() (string, error)

RawURL returns the raw url of the resource yaml file from TektonHubResourceResult

func (*TektonHubResourceResult) Resource added in v1.12.0

func (rr *TektonHubResourceResult) Resource() (interface{}, error)

Resource returns the resource found from TektonHubResourceResult

func (*TektonHubResourceResult) ResourceVersion added in v1.12.0

func (rr *TektonHubResourceResult) ResourceVersion() (string, error)

ResourceVersion returns the resource version found from TektonHubResourceResult

func (*TektonHubResourceResult) ResourceYaml added in v1.12.0

func (rr *TektonHubResourceResult) ResourceYaml() (string, error)

ResourceYaml returns the resource yaml file found from TektonHubResourceResult

func (*TektonHubResourceResult) UnmarshalData added in v1.12.0

func (rr *TektonHubResourceResult) UnmarshalData() error

UnmarshalData unmarshals the data embedded in TektonHubResourceResult

type TektonHubResourceVersionResult added in v1.12.0

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

ResourceVersionResult defines API response

func (*TektonHubResourceVersionResult) ResourceVersions added in v1.12.0

func (rvr *TektonHubResourceVersionResult) ResourceVersions() (*ResVersions, error)

ResourceVersions returns list of all versions of the resource

func (*TektonHubResourceVersionResult) UnmarshalData added in v1.12.0

func (rvr *TektonHubResourceVersionResult) UnmarshalData() error

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL