client

package
v0.41.6 Latest Latest
Warning

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

 Go to latest Published: Jun 20, 2025 License: Apache-2.0 Imports: 36 Imported by: 0

Documentation

Overview

Copyright 2023 Commonwealth Scientific and Industrial Research Organisation (CSIRO) ABN 41 687 119 230

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at 

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func AddArtifactMeta 

func AddArtifactMeta(
	ctxt context.Context,
	artifactID string,
	schemaName string,
	meta io.Reader,
	size int64,
	adpt *adapter.Adapter,
	logger *log.Logger,
) (adapter.Payload, error)

func AddArtifactToCollection 

func AddArtifactToCollection(
	ctxt context.Context,
	artifactID string,
	collectionName string,
	adpt *adapter.Adapter,
	logger *log.Logger,
) (adapter.Payload, error)

func AddProgressBar 

func AddProgressBar(description string, size int64, reader io.Reader) io.Reader

func AddUpdateAspect 

func AddUpdateAspect(ctxt context.Context, isAdd bool, entity string, schema string, policy string, meta []byte, adpt *adapter.Adapter, logger *log.Logger) (adapter.Payload, error)

func BaseEncode 

func BaseEncode(value string) string

func CreateArtifact 

func CreateArtifact(
	ctxt context.Context,
	cmd *CreateArtifactRequest,
	contentType string,
	size int64,
	reader io.Reader,
	adpt *adapter.Adapter,
	logger *log.Logger,
) (*api.UploadResponseBody, error)

func CreateArtifactRaw 

func CreateArtifactRaw(
	ctxt context.Context,
	cmd *CreateArtifactRequest,
	contentType string,
	size int64,
	reader io.Reader,
	adpt *adapter.Adapter,
	logger *log.Logger,
) (adapter.Payload, error)

func CreateOrder 

func CreateOrder(ctxt context.Context, cmd *api.CreateRequestBody, adpt *adapter.Adapter, logger *log.Logger) (*api.CreateResponseBody, error)

func CreateOrderRaw 

func CreateOrderRaw(ctxt context.Context, cmd *api.CreateRequestBody, adpt *adapter.Adapter, logger *log.Logger) (adapter.Payload, error)

func CreateQueue added in v0.41.2 

func CreateQueue(
	ctxt context.Context,
	cmd *api.CreateRequestBody,
	adpt *adapter.Adapter,
	logger *log.Logger,
) (*api.CreateResponseBody, error)

*** CREATE ***

func CreateQueueRaw added in v0.41.2 

func CreateQueueRaw(
	ctxt context.Context,
	cmd *api.CreateRequestBody,
	adpt *adapter.Adapter,
	logger *log.Logger,
) (adapter.Payload, error)

func CreateService 

func CreateService(ctxt context.Context, cmd *api.CreateServiceRequestBody, adpt *adapter.Adapter, logger *log.Logger) (*api.CreateServiceResponseBody, error)

func CreateServiceRaw 

func CreateServiceRaw(ctxt context.Context, cmd *api.CreateServiceRequestBody, adpt *adapter.Adapter, logger *log.Logger) (adapter.Payload, error)
type CreateServiceRequest struct {
	Id   string `json:"id"`
	Name string `json:"name"`
}

func DeleteQueueRaw added in v0.41.2 

func DeleteQueueRaw(
	ctx context.Context,
	cmd *ReadQueueRequest,
	adpt *adapter.Adapter,
	logger *log.Logger,
) (adapter.Payload, error)

*** DELETE ***

func Dequeue added in v0.41.2 

func Dequeue(
	ctx context.Context,
	cmd *ReadQueueRequest,
	limit int,
	adpt *adapter.Adapter,
	logger *log.Logger,
) (*api.DequeueResponseBody, error)

*** DEQUEUE ***

func DequeueRaw added in v0.41.2 

func DequeueRaw(
	ctx context.Context,
	cmd *ReadQueueRequest,
	limit int,
	adpt *adapter.Adapter,
	logger *log.Logger,
) (adapter.Payload, error)

func DownloadOrderLog 

func DownloadOrderLog(ctxt context.Context, req *LogsRequestBody, adpt *adapter.Adapter, logger *log.Logger) error

func Enqueue added in v0.41.2 

func Enqueue(
	ctx context.Context,
	cmd *ReadQueueRequest,
	schema string,
	message string,
	adpt *adapter.Adapter,
	logger *log.Logger,
) (*api.EnqueueResponseBody, error)

*** ENQUEUE ***

func EnqueueRaw added in v0.41.2 

func EnqueueRaw(
	ctx context.Context,
	cmd *ReadQueueRequest,
	schema string,
	message string,
	adpt *adapter.Adapter,
	logger *log.Logger,
) (adapter.Payload, error)

func GetAspect 

func GetAspect(
	ctxt context.Context,
	recordID string,
	adpt *adapter.Adapter,
	logger *log.Logger,
) (*api.ReadResponseBody, error)

func GetAspectRaw added in v0.35.0 

func GetAspectRaw(ctxt context.Context, recordID string, adpt *adapter.Adapter, logger *log.Logger) (adapter.Payload, error)

func GetProgressBar 

func GetProgressBar(description string, size int64) io.Writer

func GetSecret added in v0.41.4 

func GetSecret(ctxt context.Context, host string, req *GetSecretRequest, adpt *adapter.Adapter, logger *log.Logger) (*api.GetResponseBody, error)

func GetSecretRaw added in v0.41.4 

func GetSecretRaw(ctxt context.Context, host string, req *GetSecretRequest, adpt *adapter.Adapter, logger *log.Logger) (adapter.Payload, error)

func ListArtifacts 

func ListArtifacts(ctxt context.Context, cmd *ListRequest, adpt *adapter.Adapter, logger *log.Logger) (*api.ListResponseBody, error)

func ListArtifactsRaw 

func ListArtifactsRaw(ctxt context.Context, cmd *ListRequest, adpt *adapter.Adapter, logger *log.Logger) (adapter.Payload, error)

func ListAspect 

func ListAspect(ctxt context.Context,
	selector AspectSelector,
	adpt *adapter.Adapter,
	logger *log.Logger,
) (*api.ListResponseBody, adapter.Payload, error)

func ListOrders 

func ListOrders(ctxt context.Context, cmd *ListRequest, adpt *adapter.Adapter, logger *log.Logger) (*api.ListResponseBody, error)

func ListOrdersRaw 

func ListOrdersRaw(ctxt context.Context, cmd *ListRequest, adpt *adapter.Adapter, logger *log.Logger) (adapter.Payload, error)

func ListPackages added in v0.40.5 

func ListPackages(ctxt context.Context, tag string, adpt *adapter.Adapter, logger *log.Logger) (*api.ListResponseBody, error)

func ListQueues added in v0.41.2 

func ListQueues(
	ctxt context.Context,
	cmd *ListRequest,
	adpt *adapter.Adapter,
	logger *log.Logger,
) (*api.ListResponseBody, error)

*** LIST ***

func ListQueuesRaw added in v0.41.2 

func ListQueuesRaw(
	ctxt context.Context,
	cmd *ListRequest,
	adpt *adapter.Adapter,
	logger *log.Logger,
) (adapter.Payload, error)

func ListSecrets added in v0.41.4 

func ListSecrets(ctxt context.Context, host string, req *ListSecretsRequest, adpt *adapter.Adapter, logger *log.Logger) (*api.ListResponseBody, error)

func ListSecretsRaw added in v0.41.4 

func ListSecretsRaw(ctxt context.Context, host string, req *ListSecretsRequest, adpt *adapter.Adapter, logger *log.Logger) (adapter.Payload, error)

func ListServices 

func ListServices(ctxt context.Context, cmd *ListRequest, adpt *adapter.Adapter, logger *log.Logger) (*api.ListResponseBody, error)

func ListServicesRaw 

func ListServicesRaw(ctxt context.Context, cmd *ListRequest, adpt *adapter.Adapter, logger *log.Logger) (adapter.Payload, error)

func PullPackage added in v0.40.5 

func PullPackage(ctxt context.Context, tag string, adpt *adapter.Adapter, logger *log.Logger) error

func PushServicePackage added in v0.40.5 

func PushServicePackage(srcTagName string, forcePush, localImage bool, adpt *adapter.Adapter, logger *log.Logger) (*api.PushResponseBody, error)

func ReadArtifact 

func ReadArtifact(ctxt context.Context, cmd *ReadArtifactRequest, adpt *adapter.Adapter, logger *log.Logger) (*api.ReadResponseBody, error)

func ReadArtifactRaw 

func ReadArtifactRaw(ctxt context.Context, cmd *ReadArtifactRequest, adpt *adapter.Adapter, logger *log.Logger) (adapter.Payload, error)

func ReadOrder 

func ReadOrder(ctxt context.Context, cmd *ReadOrderRequest, adpt *adapter.Adapter, logger *log.Logger) (*api.ReadResponseBody, error)

func ReadOrderRaw 

func ReadOrderRaw(ctxt context.Context, cmd *ReadOrderRequest, adpt *adapter.Adapter, logger *log.Logger) (adapter.Payload, error)

func ReadQueue added in v0.41.2 

func ReadQueue(
	ctxt context.Context,
	cmd *ReadQueueRequest,
	adpt *adapter.Adapter,
	logger *log.Logger,
) (*api.ReadResponseBody, error)

func ReadQueueRaw added in v0.41.2 

func ReadQueueRaw(
	ctxt context.Context,
	cmd *ReadQueueRequest,
	adpt *adapter.Adapter,
	logger *log.Logger,
) (adapter.Payload, error)

func ReadService 

func ReadService(ctxt context.Context, cmd *ReadServiceRequest, adpt *adapter.Adapter, logger *log.Logger) (*api.ReadResponseBody, error)

func ReadServiceRaw 

func ReadServiceRaw(ctxt context.Context, cmd *ReadServiceRequest, adpt *adapter.Adapter, logger *log.Logger) (adapter.Payload, error)

func RemoveArtifactToCollection 

func RemoveArtifactToCollection(
	ctxt context.Context,
	artifactID string,
	collectionName string,
	adpt *adapter.Adapter,
	logger *log.Logger,
) (adapter.Payload, error)

func RemovePackage added in v0.40.5 

func RemovePackage(ctxt context.Context, tag string, adpt *adapter.Adapter, logger *log.Logger) error

func RetractAspect 

func RetractAspect(ctxt context.Context, recordID string, adpt *adapter.Adapter, logger *log.Logger) (adapter.Payload, error)

func SetSecret added in v0.41.4 

func SetSecret(ctxt context.Context, host string, req *api.SetRequestBody, adpt *adapter.Adapter, logger *log.Logger) error

func TopOrder 

func TopOrder(ctxt context.Context, orderID string, adpt *adapter.Adapter, logger *log.Logger) (*api.TopResponseBody, error)

func TopOrderRaw 

func TopOrderRaw(ctxt context.Context, orderID string, adpt *adapter.Adapter, logger *log.Logger) (adapter.Payload, error)

func UpdateService 

func UpdateService(ctxt context.Context, id string, createAnyway bool, cmd *api.UpdateRequestBody, adpt *adapter.Adapter, logger *log.Logger) (*api.UpdateResponseBody, error)

func UpdateServiceRaw 

func UpdateServiceRaw(ctxt context.Context, id string, createAnyway bool, cmd *api.UpdateRequestBody, adpt *adapter.Adapter, logger *log.Logger) (adapter.Payload, error)

func UploadArtifact 

func UploadArtifact(
	ctxt context.Context,
	reader io.Reader,
	size int64,
	offset int64,
	chunkSize int64,
	path string,
	adpt *adapter.Adapter,
	silent bool,
	logger *log.Logger,
) (err error)

Types

type AspectSelector 

type AspectSelector struct {
	ListRequest
	Entity         string
	SchemaPrefix   string
	JsonFilter     *string
	IncludeContent bool
}

type CreateArtifactRequest 

type CreateArtifactRequest struct {
	Name       string            `json:"name"`
	Size       int64             `json:"size"`
	Collection string            `json:"collection"`
	Policy     string            `json:"policy"`
	Meta       map[string]string `json:"meta"`
}

type GetSecretRequest added in v0.41.4 

type GetSecretRequest struct {
	SecretName string
	SecretType string
}

type ListRequest added in v0.35.0 

type ListRequest struct {
	Limit     int
	Page      *string
	Filter    *string
	OrderBy   *string
	OrderDesc bool
	AtTime    *time.Time
}

type ListSecretsRequest added in v0.41.4 

type ListSecretsRequest struct {
	Page        string
	Limit       int
	OffsetToken string
	Filter      string
}

type ListServiceRequest 

type ListServiceRequest struct {
	Offset    int
	Limit     int
	OrderBy   string
	OrderDesc bool
}

type LogsRequestBody 

type LogsRequestBody struct {
	From    int64
	To      int64
	OrderID string
}

type PushStatus added in v0.40.5 

type PushStatus string
const (
	PushStatusUnstarted  PushStatus = "unstarted"
	PushStatusInprogress PushStatus = "inprogress"
	PushStatusErrored    PushStatus = "errored"
	PushStatusDone       PushStatus = "done"
)

type ReadArtifactRequest 

type ReadArtifactRequest struct {
	Id string
}

type ReadOrderRequest 

type ReadOrderRequest struct {
	Id string
}

type ReadQueueRequest added in v0.41.2 

type ReadQueueRequest struct {
	Id string
}

*** READ ***

type ReadServiceRequest 

type ReadServiceRequest struct {
	Id string
}

Source Files

View all Source files

Directories

Path Synopsis
Program to create, update & delete aspect schemas in cayp Adapted from https://github.com/maxott/cayp-cli/blob/main/pkg/adapter/adapter.go
 Program to create, update & delete aspect schemas in cayp Adapted from https://github.com/maxott/cayp-cli/blob/main/pkg/adapter/adapter.go

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.