apiclient

package

v0.108.0 Latest Latest Go to latest Published: Mar 24, 2024 License: GPL-2.0 Imports: 7 Imported by: 5

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

codeberg.org/haulproject/haul

Links

Open Source Insights

Documentation ¶

Index ¶

type APIClient
- func New(client *http.Client, host, key string, port int, protocol string) *APIClient
- func NewFromViper(client *http.Client) (*APIClient, error)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type APIClient ¶

type APIClient struct {
	Voki *voki.Voki
}

func New ¶

func New(client *http.Client, host, key string, port int, protocol string) *APIClient

func NewFromViper ¶

func NewFromViper(client *http.Client) (*APIClient, error)

func (*APIClient) DeleteAsset ¶

func (a *APIClient) DeleteAsset(assetID int64) (response apiresponse.AssetDELETE, err error)

func (*APIClient) DeleteAssetStatus ¶ added in v0.77.0

func (a *APIClient) DeleteAssetStatus(assetID int64) (response apiresponse.AssetStatusDELETE, err error)

func (*APIClient) DeleteAssetTarget ¶

func (a *APIClient) DeleteAssetTarget(assetID int64) (response apiresponse.AssetTargetDELETE, err error)

func (*APIClient) DeleteAssets ¶

func (a *APIClient) DeleteAssets(assetIDs []int64) (response apiresponse.AssetsDELETE, err error)

func (*APIClient) DeleteAttribute ¶

func (a *APIClient) DeleteAttribute(attributeID int64) (response apiresponse.AttributeDELETE, err error)

func (*APIClient) DeleteAttributes ¶ added in v0.77.0

func (a *APIClient) DeleteAttributes(attributeIDs []int64) (response apiresponse.AttributesDELETE, err error)

func (*APIClient) DeleteTag ¶ added in v0.78.0

func (a *APIClient) DeleteTag(tagID int64) (response apiresponse.TagDELETE, err error)

func (*APIClient) DeleteTags ¶ added in v0.78.0

func (a *APIClient) DeleteTags(tagIDs []int64) (response apiresponse.TagsDELETE, err error)

func (*APIClient) GetAllAssets ¶

func (a *APIClient) GetAllAssets(page, pageSize int) (response apiresponse.AssetsAllGET, err error)

func (*APIClient) GetAsset ¶

func (a *APIClient) GetAsset(assetID int64) (response apiresponse.AssetGET, err error)

func (*APIClient) GetAssetAttributes ¶

func (a *APIClient) GetAssetAttributes(assetID int64) (response apiresponse.AssetAttributesGET, err error)

Get attributes for an asset

func (*APIClient) GetAssetDescription ¶

func (a *APIClient) GetAssetDescription(assetID int64) (response apiresponse.AssetDescriptionGET, err error)

func (*APIClient) GetAssetStatus ¶

func (a *APIClient) GetAssetStatus(assetID int64) (response apiresponse.AssetStatusGET, err error)

func (*APIClient) GetAssetTarget ¶

func (a *APIClient) GetAssetTarget(assetID int64) (response apiresponse.AssetTargetGET, err error)

func (*APIClient) GetAssetWithAttributes ¶

func (a *APIClient) GetAssetWithAttributes(assetID int64) (apiresponse.AssetAttributesGET, error)

func (*APIClient) GetAssets ¶

func (a *APIClient) GetAssets(deleted bool, page, pageSize int) (response apiresponse.AssetsGET, err error)

func (*APIClient) GetAssetsDetailed ¶ added in v0.74.0

func (a *APIClient) GetAssetsDetailed(deleted bool, pageSize, page int) (r apiresponse.AssetsDetailedGET, err error)

func (*APIClient) GetAssetsWithAttributes deprecated

func (a *APIClient) GetAssetsWithAttributes(deleted bool, pageSize, page int) (apiresponse.AttributeAssetsGET, error)

Deprecated: Use GetAssetsDetailed instead

func (*APIClient) GetAttribute ¶

func (a *APIClient) GetAttribute(attributeID int64) (response apiresponse.AttributeGET, err error)

func (*APIClient) GetAttributeAllowEmptyValue ¶ added in v0.96.0

func (a *APIClient) GetAttributeAllowEmptyValue(attributeID int64) (response apiresponse.AttributeAllowEmptyValueGET, err error)

func (*APIClient) GetAttributeAssets ¶

func (a *APIClient) GetAttributeAssets(attributeID int64) (response apiresponse.AttributeAssetsGET, err error)

func (*APIClient) GetAttributeKey ¶ added in v0.95.0

func (a *APIClient) GetAttributeKey(attributeID int64) (response apiresponse.AttributeKeyGET, err error)

func (*APIClient) GetAttributes ¶

func (a *APIClient) GetAttributes() (response apiresponse.AttributesGET, err error)

func (*APIClient) GetEvents ¶

func (a *APIClient) GetEvents(descending bool) (response apiresponse.EventsGET, err error)

func (*APIClient) GetHealth ¶

func (a *APIClient) GetHealth() (response apiresponse.HealthGET, err error)

GetHealth allows checking for API server health

func (*APIClient) GetSpec ¶ added in v0.87.0

func (a *APIClient) GetSpec() (response apiresponse.SpecGET, err error)

GetSpec returns the API server spec (pave, not openapi)

func (*APIClient) GetTag ¶ added in v0.78.0

func (a *APIClient) GetTag(tagID int64) (response apiresponse.TagGET, err error)

func (*APIClient) GetTagDetailed ¶ added in v0.78.0

func (a *APIClient) GetTagDetailed(tagID int64) (r apiresponse.TagDetailedGET, err error)

func (*APIClient) GetTagValue ¶ added in v0.78.0

func (a *APIClient) GetTagValue(tagID int64) (response apiresponse.TagValueGET, err error)

func (*APIClient) GetTags ¶ added in v0.78.0

func (a *APIClient) GetTags() (response apiresponse.TagsGET, err error)

func (*APIClient) InsertAssets ¶

func (a *APIClient) InsertAssets(assets []models.Asset) (response apiresponse.AssetsPOST, err error)

func (*APIClient) InsertAttributes ¶

func (a *APIClient) InsertAttributes(attributes []models.Attribute) (response apiresponse.AttributesPOST, err error)

func (*APIClient) InsertTags ¶ added in v0.78.0

func (a *APIClient) InsertTags(tags []models.Tag) (response apiresponse.TagsPOST, err error)

func (*APIClient) RestoreAsset ¶

func (a *APIClient) RestoreAsset(assetID int64) (response apiresponse.AssetRestorePOST, err error)

func (*APIClient) RestoreAssets ¶ added in v0.67.0

func (a *APIClient) RestoreAssets(assetIDs []int64) (response apiresponse.AssetsRestorePOST, err error)

func (*APIClient) RestoreAttribute ¶

func (a *APIClient) RestoreAttribute(attributeID int64) (response apiresponse.AttributeRestorePOST, err error)

func (*APIClient) SearchAssets ¶ added in v0.108.0

func (a *APIClient) SearchAssets(filter string) (response apiresponse.AssetsSearchGET, err error)

func (*APIClient) Seed ¶

func (a *APIClient) Seed() (response apiresponse.SeedPOST, err error)

Seed allows creating the required tables in the database

func (*APIClient) UpdateAssetDescription ¶

func (a *APIClient) UpdateAssetDescription(assetID int64, description string) (response apiresponse.AssetDescriptionPUT, err error)

func (*APIClient) UpdateAssetStatus ¶

func (a *APIClient) UpdateAssetStatus(assetID int64, status string) (response apiresponse.AssetStatusPUT, err error)

func (*APIClient) UpdateAssetTarget ¶

func (a *APIClient) UpdateAssetTarget(assetID, target int64) (response apiresponse.AssetTargetPUT, err error)

func (*APIClient) UpdateAttributeAllowEmptyValue ¶ added in v0.75.0

func (a *APIClient) UpdateAttributeAllowEmptyValue(attributeID int64, allowEmptyValue bool) (response apiresponse.AttributeAllowEmptyValuePUT, err error)

func (*APIClient) UpdateAttributeKey ¶ added in v0.75.0

func (a *APIClient) UpdateAttributeKey(attributeID int64, key string) (response apiresponse.AttributeKeyPUT, err error)

func (*APIClient) UpdateTagValue ¶ added in v0.78.0

func (a *APIClient) UpdateTagValue(tagID int64, value string) (r apiresponse.TagValuePUT, err error)

Source Files ¶

View all Source files

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