client

package
v0.50.1 Latest Latest
Warning

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

 Go to latest Published: Nov 2, 2026 License: Apache-2.0 Imports: 31 Imported by: 0

Documentation

Overview

SDK wrappers for the ivcap-accounts service (accounts / projects / invitations). Data models come from the generated pkg/accountsapi package (source of truth: the ivcap-accounts OpenAPI3 spec). Requests carry the caller's opaque token via the Authorization header and the selected project via the Ivcap-Project header; the CLI never mints project-scoped JWTs, so request bodies omit any token field.

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

View Source 
const (
	DatasetGranteeProject = "project"
	DatasetGranteeService = "service"
	DatasetGranteePublic  = "public"

	DatasetAccessRead  = "read"
	DatasetAccessWrite = "write"
)

Dataset grantee kinds and access levels, as the ivcap-accounts API spells them.

View Source 
const CreateFromAspectTemplate = `{
  "$schema": "urn:ivcap:schema:job.input.1",
  "request-aspect": "%s",
  "service": "%s"
}`

CreateFromAspectTemplate is a JSON job input body used to create a job from a request aspect (instead of inline job parameters).

The placeholders are:

  1. request-aspect URN
  2. service URN

This template is used by multiple CLI entry points and by the MCP server.

Variables

This section is empty.

Functions

func AcceptInvitationRaw added in v0.50.0 

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

func AddAspectContent added in v0.50.1 

func AddAspectContent(
	ctxt context.Context,
	entity, schema, policy string,
	content []byte,
	adpt *adapter.Adapter,
	logger *log.Logger,
) (string, error)

AddAspectContent adds an aspect with the given content to the entity and returns the ID of the new aspect.

func AddDatasetGrantRaw added in v0.50.0 

func AddDatasetGrantRaw(ctxt context.Context, id string, req *accountsapi.DatasetGrantPayload, 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 CapabilitiesForKind added in v0.50.0 

func CapabilitiesForKind(c *accountsapi.CapabilitiesResult, kind string) []accountsapi.Capability

CapabilitiesForKind returns the capabilities for "project" or "account" from a CapabilitiesResult (nil otherwise).

func CreateAccountInvitationRaw added in v0.50.0 

func CreateAccountInvitationRaw(ctxt context.Context, accountID string, req *accountsapi.CreateAccountInvitationPayload, adpt *adapter.Adapter, logger *log.Logger) (adapter.Payload, error)

func CreateAccountRaw added in v0.50.0 

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

func CreateDatasetRaw added in v0.50.0 

func CreateDatasetRaw(ctxt context.Context, projectID string, req *accountsapi.CreateDatasetPayload, adpt *adapter.Adapter, logger *log.Logger) (adapter.Payload, error)

func CreateListPath added in v0.50.1 

func CreateListPath(cmd *ListRequest, path string) (*url.URL, 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 CreateProjectInvitationRaw added in v0.50.0 

func CreateProjectInvitationRaw(ctxt context.Context, projectID string, req *accountsapi.CreateInvitationPayload, adpt *adapter.Adapter, logger *log.Logger) (adapter.Payload, error)

func CreateProjectRaw added in v0.50.0 

func CreateProjectRaw(ctxt context.Context, req *accountsapi.CreateProjectPayload, 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 CreateServiceRaw 

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

func DeclineInvitationRaw added in v0.50.0 

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

func DeleteProjectRaw added in v0.50.0 

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

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 FindAspectID added in v0.50.1 

func FindAspectID(ctxt context.Context, entity, schema string, adpt *adapter.Adapter, logger *log.Logger) (string, error)

FindAspectID returns the ID of an existing aspect with exactly this schema on the entity, or "" when there is none. The schema filter of the API matches by prefix, so the result is compared exactly.

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 GetCapabilities added in v0.50.0 

func GetCapabilities(ctxt context.Context, adpt *adapter.Adapter, logger *log.Logger) (*accountsapi.CapabilitiesResult, error)

GetCapabilities fetches the grantable capability vocabulary from ivcap-accounts. The endpoint is public reference data; no project scope is required.

func GetJobEvents added in v0.41.8 

func GetJobEvents(ctxt context.Context, serviceId string, jobId string, lastEventID *string, onEvent func(*sse.Event), adpt *adapter.Adapter, logger *log.Logger) 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 GrantAccountRaw added in v0.50.0 

func GrantAccountRaw(ctxt context.Context, accountID string, req *accountsapi.AddAccountGrantPayload, adpt *adapter.Adapter, logger *log.Logger) (adapter.Payload, error)

GrantAccountRaw grants account-admin capabilities to a user (batch add).

func GrantProjectRaw added in v0.50.0 

func GrantProjectRaw(ctxt context.Context, id string, req *accountsapi.AddProjectGrantPayload, adpt *adapter.Adapter, logger *log.Logger) (adapter.Payload, error)

func IsServiceURN added in v0.47.6 

func IsServiceURN(id string) bool

IsServiceURN checks if a string is a valid IVCAP service URN. Valid format: urn:ivcap:service:<something-non-empty>

func LeaveProjectRaw added in v0.50.0 

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

func ListAccountInvitationsRaw added in v0.50.0 

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

ListAccountInvitationsRaw lists the pending invitations on an account (admin view).

func ListAccountMembersRaw added in v0.50.0 

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

func ListAccounts added in v0.50.0 

func ListAccounts(ctxt context.Context, cmd *ListRequest, adpt *adapter.Adapter, logger *log.Logger) (*accountsapi.ListAccountsResult, error)

func ListAccountsRaw added in v0.50.0 

func ListAccountsRaw(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 ListDatasetEventsRaw added in v0.50.0 

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

func ListDatasetGrantsRaw added in v0.50.0 

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

func ListMyInvitations added in v0.50.0 

func ListMyInvitations(ctxt context.Context, adpt *adapter.Adapter, logger *log.Logger) (*accountsapi.ListInvitationsResult, error)

func ListMyInvitationsRaw added in v0.50.0 

func ListMyInvitationsRaw(ctxt context.Context, adpt *adapter.Adapter, logger *log.Logger) (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 ListProjectDatasetsRaw added in v0.50.0 

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

func ListProjectInvitationsRaw added in v0.50.0 

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

ListProjectInvitationsRaw lists the pending invitations on a project (admin view).

func ListProjectMembersRaw added in v0.50.0 

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

func ListProjects added in v0.50.0 

func ListProjects(ctxt context.Context, cmd *ListRequest, adpt *adapter.Adapter, logger *log.Logger) (*accountsapi.ListProjectsResult, error)

func ListProjectsRaw added in v0.50.0 

func ListProjectsRaw(ctxt context.Context, cmd *ListRequest, adpt *adapter.Adapter, logger *log.Logger) (adapter.Payload, 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 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 PushPackage added in v0.47.0 

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

func ReadAccountRaw added in v0.50.0 

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

func ReadDataset added in v0.50.0 

func ReadDataset(ctxt context.Context, id string, adpt *adapter.Adapter, logger *log.Logger) (*accountsapi.Dataset, error)

func ReadDatasetRaw added in v0.50.0 

func ReadDatasetRaw(ctxt context.Context, id string, 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 ReadProject added in v0.50.0 

func ReadProject(ctxt context.Context, id string, adpt *adapter.Adapter, logger *log.Logger) (*accountsapi.Project, error)

func ReadProjectRaw added in v0.50.0 

func ReadProjectRaw(ctxt context.Context, id string, 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 ReadServiceJobRaw added in v0.41.8 

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

func ReadServiceRaw 

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

func RemoveAccountGrantRaw added in v0.50.0 

func RemoveAccountGrantRaw(ctxt context.Context, accountID, userID, capability string, adpt *adapter.Adapter, logger *log.Logger) (adapter.Payload, error)

RemoveAccountGrantRaw revokes a single account capability from a user.

func RemoveAccountMemberRaw added in v0.50.0 

func RemoveAccountMemberRaw(ctxt context.Context, accountID, userID string, adpt *adapter.Adapter, logger *log.Logger) (adapter.Payload, error)

RemoveAccountMemberRaw removes a user from an account entirely (revoking all their grants).

func RemoveDatasetGrantRaw added in v0.50.0 

func RemoveDatasetGrantRaw(ctxt context.Context, id string, req *accountsapi.DatasetGrantPayload, adpt *adapter.Adapter, logger *log.Logger) (adapter.Payload, error)

RemoveDatasetGrantRaw revokes one grant. Like AddDatasetGrantRaw it refuses a malformed grant before making a request.

func RemovePackage added in v0.40.5 

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

func RemoveProjectGrantRaw added in v0.50.0 

func RemoveProjectGrantRaw(ctxt context.Context, projectID, principalID, principalKind, capability string, adpt *adapter.Adapter, logger *log.Logger) (adapter.Payload, error)

RemoveProjectGrantRaw revokes a single project capability from a principal (user or service). Removal is per-capability; call once per capability.

func RemoveProjectMemberRaw added in v0.50.0 

func RemoveProjectMemberRaw(ctxt context.Context, projectID, principalID, principalKind string, adpt *adapter.Adapter, logger *log.Logger) (adapter.Payload, error)

RemoveProjectMemberRaw removes a principal from a project entirely, atomically revoking all of their project capabilities in one server-side transaction.

func RetractAspect 

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

func RevokeInvitationRaw added in v0.50.0 

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

RevokeInvitationRaw cancels a pending invitation the caller issued.

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 UpdateDatasetRaw added in v0.50.0 

func UpdateDatasetRaw(ctxt context.Context, id string, req *accountsapi.UpdateDatasetPayload, adpt *adapter.Adapter, logger *log.Logger) (adapter.Payload, error)

func UpdateProjectRaw added in v0.50.0 

func UpdateProjectRaw(ctxt context.Context, id string, req *accountsapi.UpdateProjectPayload, adpt *adapter.Adapter, logger *log.Logger) (adapter.Payload, error)

func UpdateServiceRaw 

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

func ValidateDatasetGrant added in v0.50.0 

func ValidateDatasetGrant(granteeKind, granteeID, access string) error

ValidateDatasetGrant checks a grant's shape before any request is made: the grantee kind, that a project or service grantee names an id and a public one does not, and that public access is read-only.

func ValidateDatasetURN added in v0.50.0 

func ValidateDatasetURN(id string) error

ValidateDatasetURN checks that id is a dataset URN. Datasets are addressed by URN only; a project's default dataset has the project's UUID under the dataset prefix.

func ValidateEntityURN added in v0.47.5 

func ValidateEntityURN(entity string) error

ValidateEntityURN validates that entities starting with specific IVCAP system entity prefixes end with a valid UUID. Any entity not matching these prefixes is allowed without validation. Returns an error if validation fails.

Types

type AspectSelector 

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

type GetSecretRequest added in v0.41.4 

type GetSecretRequest struct {
	SecretName string
	SecretType string
}

type JobCreateBadRequestResponseBody added in v0.41.8 

type JobCreateBadRequestResponseBody struct {
	// Information message
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
}

JobCreateBadRequestResponseBody is the type of the "service" service "job-create" endpoint HTTP response body for the "bad-request" error.

type JobCreateInvalidParameterResponseBody added in v0.41.8 

type JobCreateInvalidParameterResponseBody struct {
	// message describing expected type or pattern.
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
	// name of parameter.
	Name *string `form:"name,omitempty" json:"name,omitempty" xml:"name,omitempty"`
	// provided parameter value.
	Value *string `form:"value,omitempty" json:"value,omitempty" xml:"value,omitempty"`
}

JobCreateInvalidParameterResponseBody is the type of the "service" service "job-create" endpoint HTTP response body for the "invalid-parameter" error.

type JobCreateInvalidScopesResponseBody added in v0.41.8 

type JobCreateInvalidScopesResponseBody struct {
	// ID of involved resource
	ID *string `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
	// Message of error
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
}

JobCreateInvalidScopesResponseBody is the type of the "service" service "job-create" endpoint HTTP response body for the "invalid-scopes" error.

type JobCreateNotFoundResponseBody added in v0.41.8 

type JobCreateNotFoundResponseBody struct {
	// ID of missing resource
	ID *string `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
	// Message of error
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
}

JobCreateNotFoundResponseBody is the type of the "service" service "job-create" endpoint HTTP response body for the "not-found" error.

type JobCreateNotImplementedResponseBody added in v0.41.8 

type JobCreateNotImplementedResponseBody struct {
	// Information message
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
}

JobCreateNotImplementedResponseBody is the type of the "service" service "job-create" endpoint HTTP response body for the "not-implemented" error.

type JobCreateNotReadyYetResponseBody added in v0.41.8 

type JobCreateNotReadyYetResponseBody struct {
	// the ID of the job
	JobID *string `form:"job-id,omitempty" json:"job-id,omitempty" xml:"job-id,omitempty"`
	// the URL for the job
	Location *string `form:"location,omitempty" json:"location,omitempty" xml:"location,omitempty"`
	// The time in seconds after which an update may be available
	RetryLater *int `form:"retry-later,omitempty" json:"retry-later,omitempty" xml:"retry-later,omitempty"`
}

JobCreateNotReadyYetResponseBody is the type of the "service" service "job-create" endpoint HTTP response body for the "not-ready-yet" error.

type JobCreateT added in v0.41.8 

type JobCreateT struct {
	JobID      string  `json:"job-id"`
	ServiceID  string  `json:"service-id,omitempty"`
	RetryLater float64 `json:"retry-later"`
}

func CreateServiceJobRaw added in v0.41.8 

func CreateServiceJobRaw(ctxt context.Context, serviceId string, pyld adapter.Payload, timeout int, adpt *adapter.Adapter, logger *log.Logger) (adapter.Payload, *JobCreateT, error)

type JobEventsBadRequestResponseBody added in v0.41.8 

type JobEventsBadRequestResponseBody struct {
	// Information message
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
}

JobEventsBadRequestResponseBody is the type of the "service" service "job-events" endpoint HTTP response body for the "bad-request" error.

type JobEventsEventTimeoutResponseBody added in v0.41.8 

type JobEventsEventTimeoutResponseBody struct {
	// Name is the name of this class of errors.
	Name *string `form:"name,omitempty" json:"name,omitempty" xml:"name,omitempty"`
	// ID is a unique identifier for this particular occurrence of the problem.
	ID *string `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
	// Message is a human-readable explanation specific to this occurrence of the
	// problem.
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
	// Is the error temporary?
	Temporary *bool `form:"temporary,omitempty" json:"temporary,omitempty" xml:"temporary,omitempty"`
	// Is the error a timeout?
	Timeout *bool `form:"timeout,omitempty" json:"timeout,omitempty" xml:"timeout,omitempty"`
	// Is the error a server-side fault?
	Fault *bool `form:"fault,omitempty" json:"fault,omitempty" xml:"fault,omitempty"`
}

JobEventsEventTimeoutResponseBody is the type of the "service" service "job-events" endpoint HTTP response body for the "event-timeout" error.

type JobEventsInvalidParameterResponseBody added in v0.41.8 

type JobEventsInvalidParameterResponseBody struct {
	// message describing expected type or pattern.
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
	// name of parameter.
	Name *string `form:"name,omitempty" json:"name,omitempty" xml:"name,omitempty"`
	// provided parameter value.
	Value *string `form:"value,omitempty" json:"value,omitempty" xml:"value,omitempty"`
}

JobEventsInvalidParameterResponseBody is the type of the "service" service "job-events" endpoint HTTP response body for the "invalid-parameter" error.

type JobEventsInvalidScopesResponseBody added in v0.41.8 

type JobEventsInvalidScopesResponseBody struct {
	// ID of involved resource
	ID *string `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
	// Message of error
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
}

JobEventsInvalidScopesResponseBody is the type of the "service" service "job-events" endpoint HTTP response body for the "invalid-scopes" error.

type JobEventsJobInternalErrorResponseBody added in v0.41.8 

type JobEventsJobInternalErrorResponseBody struct {
	// more infomration about the error
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
}

JobEventsJobInternalErrorResponseBody is the type of the "service" service "job-events" endpoint HTTP response body for the "job-internal-error" error.

type JobEventsJobRequestErrorResponseBody added in v0.41.8 

type JobEventsJobRequestErrorResponseBody struct {
	// more infomration about the error
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
}

JobEventsJobRequestErrorResponseBody is the type of the "service" service "job-events" endpoint HTTP response body for the "job-request-error" error.

type JobEventsNotFoundResponseBody added in v0.41.8 

type JobEventsNotFoundResponseBody struct {
	// ID of missing resource
	ID *string `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
	// Message of error
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
}

JobEventsNotFoundResponseBody is the type of the "service" service "job-events" endpoint HTTP response body for the "not-found" error.

type JobEventsNotImplementedResponseBody added in v0.41.8 

type JobEventsNotImplementedResponseBody struct {
	// Information message
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
}

JobEventsNotImplementedResponseBody is the type of the "service" service "job-events" endpoint HTTP response body for the "not-implemented" error.

type JobEventsResponseBody added in v0.41.8 

type JobEventsResponseBody struct {
	// Stream sequence ID. Used in Last-Event-Id
	SeqID *string `form:"SeqID,omitempty" json:"SeqID,omitempty" xml:"SeqID,omitempty"`
	// Event ID
	EventID *string `form:"eventID,omitempty" json:"eventID,omitempty" xml:"eventID,omitempty"`
	// Event type, usually a simpler verions of 'schema'
	Type *string `form:"type,omitempty" json:"type,omitempty" xml:"type,omitempty"`
	// Schema of 'data'
	Schema *string `form:"schema,omitempty" json:"schema,omitempty" xml:"schema,omitempty"`
	// Event source
	Source *string `form:"source,omitempty" json:"source,omitempty" xml:"source,omitempty"`
	// timestamp in ISO802
	Timestamp *string `form:"timestamp,omitempty" json:"timestamp,omitempty" xml:"timestamp,omitempty"`
	// Content of event
	Data any `form:"data,omitempty" json:"data,omitempty" xml:"data,omitempty"`
}

JobEventsResponseBody is the type of the "service" service "job-events" endpoint HTTP response body.

type JobListBadRequestResponseBody added in v0.41.8 

type JobListBadRequestResponseBody struct {
	// Information message
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
}

JobListBadRequestResponseBody is the type of the "service" service "job-list" endpoint HTTP response body for the "bad-request" error.

type JobListInvalidParameterResponseBody added in v0.41.8 

type JobListInvalidParameterResponseBody struct {
	// message describing expected type or pattern.
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
	// name of parameter.
	Name *string `form:"name,omitempty" json:"name,omitempty" xml:"name,omitempty"`
	// provided parameter value.
	Value *string `form:"value,omitempty" json:"value,omitempty" xml:"value,omitempty"`
}

JobListInvalidParameterResponseBody is the type of the "service" service "job-list" endpoint HTTP response body for the "invalid-parameter" error.

type JobListInvalidScopesResponseBody added in v0.41.8 

type JobListInvalidScopesResponseBody struct {
	// ID of involved resource
	ID *string `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
	// Message of error
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
}

JobListInvalidScopesResponseBody is the type of the "service" service "job-list" endpoint HTTP response body for the "invalid-scopes" error.

type JobListItemResponseBody added in v0.41.8 

type JobListItemResponseBody struct {
	// ID
	ID *string `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
	// Optional customer provided name
	Name *string `form:"name,omitempty" json:"name,omitempty" xml:"name,omitempty"`
	// Job status
	Status *string `form:"status,omitempty" json:"status,omitempty" xml:"status,omitempty"`
	// DateTime job processing started
	StartedAt *string `form:"started-at,omitempty" json:"started-at,omitempty" xml:"started-at,omitempty"`
	// DateTime job processing finished
	FinishedAt *string `form:"finished-at,omitempty" json:"finished-at,omitempty" xml:"finished-at,omitempty"`
	// Reference to service requested
	Service *string `form:"service,omitempty" json:"service,omitempty" xml:"service,omitempty"`
	// Reference to order
	Order *string `form:"order,omitempty" json:"order,omitempty" xml:"order,omitempty"`
	Href  *string `json:"href,omitempty"`
}

JobListItemResponseBody is used to define fields on response body types.

type JobListNotImplementedResponseBody added in v0.41.8 

type JobListNotImplementedResponseBody struct {
	// Information message
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
}

JobListNotImplementedResponseBody is the type of the "service" service "job-list" endpoint HTTP response body for the "not-implemented" error.

type JobListResponseBody added in v0.41.8 

type JobListResponseBody struct {
	// Jobs
	Items []*JobListItemResponseBody `form:"items,omitempty" json:"items,omitempty" xml:"items,omitempty"`
	// Time at which this list was valid
	AtTime *string              `form:"at-time,omitempty" json:"at-time,omitempty" xml:"at-time,omitempty"`
	Links  []*LinkTResponseBody `form:"links,omitempty" json:"links,omitempty" xml:"links,omitempty"`
}

JobListResponseBody is the type of the "service" service "job-list" endpoint HTTP response body.

type JobOutputBadRequestResponseBody added in v0.41.8 

type JobOutputBadRequestResponseBody struct {
	// Information message
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
}

JobOutputBadRequestResponseBody is the type of the "service" service "job-output" endpoint HTTP response body for the "bad-request" error.

type JobOutputInvalidParameterResponseBody added in v0.41.8 

type JobOutputInvalidParameterResponseBody struct {
	// message describing expected type or pattern.
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
	// name of parameter.
	Name *string `form:"name,omitempty" json:"name,omitempty" xml:"name,omitempty"`
	// provided parameter value.
	Value *string `form:"value,omitempty" json:"value,omitempty" xml:"value,omitempty"`
}

JobOutputInvalidParameterResponseBody is the type of the "service" service "job-output" endpoint HTTP response body for the "invalid-parameter" error.

type JobOutputInvalidScopesResponseBody added in v0.41.8 

type JobOutputInvalidScopesResponseBody struct {
	// ID of involved resource
	ID *string `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
	// Message of error
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
}

JobOutputInvalidScopesResponseBody is the type of the "service" service "job-output" endpoint HTTP response body for the "invalid-scopes" error.

type JobOutputJobInternalErrorResponseBody added in v0.41.8 

type JobOutputJobInternalErrorResponseBody struct {
	// more infomration about the error
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
}

JobOutputJobInternalErrorResponseBody is the type of the "service" service "job-output" endpoint HTTP response body for the "job-internal-error" error.

type JobOutputJobRequestErrorResponseBody added in v0.41.8 

type JobOutputJobRequestErrorResponseBody struct {
	// more infomration about the error
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
}

JobOutputJobRequestErrorResponseBody is the type of the "service" service "job-output" endpoint HTTP response body for the "job-request-error" error.

type JobOutputNotFoundResponseBody added in v0.41.8 

type JobOutputNotFoundResponseBody struct {
	// ID of missing resource
	ID *string `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
	// Message of error
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
}

JobOutputNotFoundResponseBody is the type of the "service" service "job-output" endpoint HTTP response body for the "not-found" error.

type JobOutputNotImplementedResponseBody added in v0.41.8 

type JobOutputNotImplementedResponseBody struct {
	// Information message
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
}

JobOutputNotImplementedResponseBody is the type of the "service" service "job-output" endpoint HTTP response body for the "not-implemented" error.

type JobOutputNotReadyYetResponseBody added in v0.41.8 

type JobOutputNotReadyYetResponseBody struct {
	// the ID of the job
	JobID *string `form:"job-id,omitempty" json:"job-id,omitempty" xml:"job-id,omitempty"`
	// The time in seconds after which an update may be available
	RetryLater *int `form:"retry-later,omitempty" json:"retry-later,omitempty" xml:"retry-later,omitempty"`
}

JobOutputNotReadyYetResponseBody is the type of the "service" service "job-output" endpoint HTTP response body for the "not-ready-yet" error.

type JobReadBadRequestResponseBody added in v0.41.8 

type JobReadBadRequestResponseBody struct {
	// Information message
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
}

JobReadBadRequestResponseBody is the type of the "service" service "job-read" endpoint HTTP response body for the "bad-request" error.

type JobReadInvalidScopesResponseBody added in v0.41.8 

type JobReadInvalidScopesResponseBody struct {
	// ID of involved resource
	ID *string `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
	// Message of error
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
}

JobReadInvalidScopesResponseBody is the type of the "service" service "job-read" endpoint HTTP response body for the "invalid-scopes" error.

type JobReadNotFoundResponseBody added in v0.41.8 

type JobReadNotFoundResponseBody struct {
	// ID of missing resource
	ID *string `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
	// Message of error
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
}

JobReadNotFoundResponseBody is the type of the "service" service "job-read" endpoint HTTP response body for the "not-found" error.

type JobReadNotImplementedResponseBody added in v0.41.8 

type JobReadNotImplementedResponseBody struct {
	// Information message
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
}

JobReadNotImplementedResponseBody is the type of the "service" service "job-read" endpoint HTTP response body for the "not-implemented" error.

type JobReadResponseBody added in v0.41.8 

type JobReadResponseBody struct {
	// ID
	ID *string `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
	// Job status
	Status *string `form:"status,omitempty" json:"status,omitempty" xml:"status,omitempty"`
	// Optional customer provided name
	Name *string `form:"name,omitempty" json:"name,omitempty" xml:"name,omitempty"`
	// Optional customer provided tags
	Tags []string `form:"tags,omitempty" json:"tags,omitempty" xml:"tags,omitempty"`
	// Reference to order
	Order *string `form:"order,omitempty" json:"order,omitempty" xml:"order,omitempty"`
	// Reference to service requested
	Service *string `form:"service,omitempty" json:"service,omitempty" xml:"service,omitempty"`
	// Mime type of request
	RequestContentType *string `form:"request-content-type,omitempty" json:"request-content-type,omitempty" xml:"request-content-type,omitempty"`
	// Request content
	RequestContent any `form:"request-content,omitempty" json:"request-content,omitempty" xml:"request-content,omitempty"`
	// Mime type of result
	ResultContentType *string `form:"result-content-type,omitempty" json:"result-content-type,omitempty" xml:"result-content-type,omitempty"`
	// Result content
	ResultContent any `form:"result-content,omitempty" json:"result-content,omitempty" xml:"result-content,omitempty"`
	// Result content URN
	ResultContentUrn *string                           `form:"result-content-urn,omitempty" json:"result-content-urn,omitempty" xml:"result-content-urn,omitempty"`
	Products         *PartialProductList2TResponseBody `form:"products,omitempty" json:"products,omitempty" xml:"products,omitempty"`
	// Additional error message id status is 'Error' or 'Failed'
	ErrorMessage *string `form:"error-message,omitempty" json:"error-message,omitempty" xml:"error-message,omitempty"`
	// Reference to billable account
	Account *string `form:"account,omitempty" json:"account,omitempty" xml:"account,omitempty"`
	// Reference to policy used
	Policy *string `form:"policy,omitempty" json:"policy,omitempty" xml:"policy,omitempty"`
	// DateTime job was submitted
	RequestedAt *string `form:"requested-at,omitempty" json:"requested-at,omitempty" xml:"requested-at,omitempty"`
	// DateTime job processing started
	StartedAt *string `form:"started-at,omitempty" json:"started-at,omitempty" xml:"started-at,omitempty"`
	// DateTime job processing finished
	FinishedAt *string              `form:"finished-at,omitempty" json:"finished-at,omitempty" xml:"finished-at,omitempty"`
	Links      []*LinkTResponseBody `form:"links,omitempty" json:"links,omitempty" xml:"links,omitempty"`
}

JobReadResponseBody is the type of the "service" service "job-read" endpoint HTTP response body.

func ReadServiceJob added in v0.41.8 

func ReadServiceJob(ctxt context.Context, cmd *ReadServiceJobRequest, adpt *adapter.Adapter, logger *log.Logger) (*JobReadResponseBody, adapter.Payload, error)

type LinkTResponseBody added in v0.41.8 

type LinkTResponseBody struct {
	// relation type
	Rel *string `form:"rel,omitempty" json:"rel,omitempty" xml:"rel,omitempty"`
	// mime type
	Type *string `form:"type,omitempty" json:"type,omitempty" xml:"type,omitempty"`
	// web link
	Href *string `form:"href,omitempty" json:"href,omitempty" xml:"href,omitempty"`
}

LinkTResponseBody is used to define fields on response body types.

type ListRequest added in v0.35.0 

type ListRequest struct {
	Limit     int
	Page      *string
	Search    *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 ParameterDefT added in v0.41.8 

type ParameterDefT struct {
	Name        string           `form:"name" json:"name" xml:"name"`
	Label       *string          `form:"label,omitempty" json:"label,omitempty" xml:"label,omitempty"`
	Type        string           `form:"type" json:"type" xml:"type"`
	Description string           `form:"description" json:"description" xml:"description"`
	Unit        *string          `form:"unit,omitempty" json:"unit,omitempty" xml:"unit,omitempty"`
	Constant    *bool            `form:"constant,omitempty" json:"constant,omitempty" xml:"constant,omitempty"`
	Optional    *bool            `form:"optional,omitempty" json:"optional,omitempty" xml:"optional,omitempty"`
	Default     *string          `form:"default,omitempty" json:"default,omitempty" xml:"default,omitempty"`
	Options     []*ParameterOptT `form:"options,omitempty" json:"options,omitempty" xml:"options,omitempty"`
	Unary       *bool            `form:"unary,omitempty" json:"unary,omitempty" xml:"unary,omitempty"`
}

ParameterDefT is used to define fields on request body types.

type ParameterDefTResponseBody added in v0.41.8 

type ParameterDefTResponseBody struct {
	Name        *string                      `form:"name,omitempty" json:"name,omitempty" xml:"name,omitempty"`
	Label       *string                      `form:"label,omitempty" json:"label,omitempty" xml:"label,omitempty"`
	Type        *string                      `form:"type,omitempty" json:"type,omitempty" xml:"type,omitempty"`
	Description *string                      `form:"description,omitempty" json:"description,omitempty" xml:"description,omitempty"`
	Unit        *string                      `form:"unit,omitempty" json:"unit,omitempty" xml:"unit,omitempty"`
	Constant    *bool                        `form:"constant,omitempty" json:"constant,omitempty" xml:"constant,omitempty"`
	Optional    *bool                        `form:"optional,omitempty" json:"optional,omitempty" xml:"optional,omitempty"`
	Default     *string                      `form:"default,omitempty" json:"default,omitempty" xml:"default,omitempty"`
	Options     []*ParameterOptTResponseBody `form:"options,omitempty" json:"options,omitempty" xml:"options,omitempty"`
	Unary       *bool                        `form:"unary,omitempty" json:"unary,omitempty" xml:"unary,omitempty"`
}

ParameterDefTResponseBody is used to define fields on response body types.

type ParameterOptT added in v0.41.8 

type ParameterOptT struct {
	Value       *string `form:"value,omitempty" json:"value,omitempty" xml:"value,omitempty"`
	Description *string `form:"description,omitempty" json:"description,omitempty" xml:"description,omitempty"`
}

ParameterOptT is used to define fields on request body types.

type ParameterOptTResponseBody added in v0.41.8 

type ParameterOptTResponseBody struct {
	Value       *string `form:"value,omitempty" json:"value,omitempty" xml:"value,omitempty"`
	Description *string `form:"description,omitempty" json:"description,omitempty" xml:"description,omitempty"`
}

ParameterOptTResponseBody is used to define fields on response body types.

type PartialProductList2TResponseBody added in v0.41.8 

type PartialProductList2TResponseBody struct {
	// (Partial) list of products delivered by this order
	Items []*ProductListItem2TResponseBody `form:"items,omitempty" json:"items,omitempty" xml:"items,omitempty"`
	// Links to more products, if there are any
	Links []*LinkTResponseBody `form:"links,omitempty" json:"links,omitempty" xml:"links,omitempty"`
}

PartialProductList2TResponseBody is used to define fields on response body types.

type ProductListItem2TResponseBody added in v0.41.8 

type ProductListItem2TResponseBody struct {
	ID       *string `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
	Name     *string `form:"name,omitempty" json:"name,omitempty" xml:"name,omitempty"`
	Status   *string `form:"status,omitempty" json:"status,omitempty" xml:"status,omitempty"`
	MimeType *string `json:"mime-type,omitempty"`
	Size     *int64  `form:"size,omitempty" json:"size,omitempty" xml:"size,omitempty"`
	Href     *string `json:"href,omitempty"`
	DataHref *string `json:"dataRef,omitempty"`
}

ProductListItem2TResponseBody is used to define fields on response body types.

type ReadOrderRequest 

type ReadOrderRequest struct {
	Id string
}

type ReadQueueRequest added in v0.41.2 

type ReadQueueRequest struct {
	Id string
}

*** READ ***

type ReadServiceJobRequest added in v0.41.8 

type ReadServiceJobRequest struct {
	ServiceId string
	JobId     string
}

type ReadServiceRequest 

type ReadServiceRequest struct {
	Id string
}

type ServiceCreateAlreadyCreatedResponseBody added in v0.41.8 

type ServiceCreateAlreadyCreatedResponseBody struct {
	// ID of already existing resource
	ID *string `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
	// Message of error
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
}

ServiceCreateAlreadyCreatedResponseBody is the type of the "service" service "service-create" endpoint HTTP response body for the "already-created" error.

type ServiceCreateBadRequestResponseBody added in v0.41.8 

type ServiceCreateBadRequestResponseBody struct {
	// Information message
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
}

ServiceCreateBadRequestResponseBody is the type of the "service" service "service-create" endpoint HTTP response body for the "bad-request" error.

type ServiceCreateInvalidParameterResponseBody added in v0.41.8 

type ServiceCreateInvalidParameterResponseBody struct {
	// message describing expected type or pattern.
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
	// name of parameter.
	Name *string `form:"name,omitempty" json:"name,omitempty" xml:"name,omitempty"`
	// provided parameter value.
	Value *string `form:"value,omitempty" json:"value,omitempty" xml:"value,omitempty"`
}

ServiceCreateInvalidParameterResponseBody is the type of the "service" service "service-create" endpoint HTTP response body for the "invalid-parameter" error.

type ServiceCreateInvalidScopesResponseBody added in v0.41.8 

type ServiceCreateInvalidScopesResponseBody struct {
	// ID of involved resource
	ID *string `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
	// Message of error
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
}

ServiceCreateInvalidScopesResponseBody is the type of the "service" service "service-create" endpoint HTTP response body for the "invalid-scopes" error.

type ServiceCreateNotFoundResponseBody added in v0.41.8 

type ServiceCreateNotFoundResponseBody struct {
	// ID of missing resource
	ID *string `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
	// Message of error
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
}

ServiceCreateNotFoundResponseBody is the type of the "service" service "service-create" endpoint HTTP response body for the "not-found" error.

type ServiceCreateNotImplementedResponseBody added in v0.41.8 

type ServiceCreateNotImplementedResponseBody struct {
	// Information message
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
}

ServiceCreateNotImplementedResponseBody is the type of the "service" service "service-create" endpoint HTTP response body for the "not-implemented" error.

type ServiceCreateRequestBody added in v0.41.8 

type ServiceCreateRequestBody struct {
	// type of controller used for this service
	ControllerSchema string `form:"controller-schema" json:"controller-schema" xml:"controller-schema"`
	// controller definition
	Controller any `form:"controller" json:"controller" xml:"controller"`
	// Reference to policy used
	Policy string `form:"policy" json:"policy" xml:"policy"`
	// ID
	ID string `form:"id" json:"id" xml:"id"`
	// Optional provider provided name
	Name *string `form:"name,omitempty" json:"name,omitempty" xml:"name,omitempty"`
	// More detailed description of the service
	Description string `form:"description" json:"description" xml:"description"`
	// Optional tags defined for service to help in categorising them
	Tags []string `form:"tags,omitempty" json:"tags,omitempty" xml:"tags,omitempty"`
	// Service parameter definitions
	Parameters []*ParameterDefT `form:"parameters" json:"parameters" xml:"parameters"`
}

ServiceCreateRequestBody is the type of the "service" service "service-create" endpoint HTTP request body.

type ServiceCreateResponseBody added in v0.41.8 

type ServiceCreateResponseBody struct {
	// Service status
	Status *string `form:"status,omitempty" json:"status,omitempty" xml:"status,omitempty"`
	// type of controller used for this service
	ControllerSchema *string `form:"controller-schema,omitempty" json:"controller-schema,omitempty" xml:"controller-schema,omitempty"`
	// controller definition
	Controller any `form:"controller,omitempty" json:"controller,omitempty" xml:"controller,omitempty"`
	// Reference to billable account
	Account *string `form:"account,omitempty" json:"account,omitempty" xml:"account,omitempty"`
	// Reference to policy used
	Policy *string `form:"policy,omitempty" json:"policy,omitempty" xml:"policy,omitempty"`
	// time this service has been available from
	ValidFrom *string `form:"valid-from,omitempty" json:"valid-from,omitempty" xml:"valid-from,omitempty"`
	// time this service has been available to
	ValidTo *string              `form:"valid-to,omitempty" json:"valid-to,omitempty" xml:"valid-to,omitempty"`
	Links   []*LinkTResponseBody `form:"links,omitempty" json:"links,omitempty" xml:"links,omitempty"`
	// ID
	ID *string `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
	// Optional provider provided name
	Name *string `form:"name,omitempty" json:"name,omitempty" xml:"name,omitempty"`
	// More detailed description of the service
	Description *string `form:"description,omitempty" json:"description,omitempty" xml:"description,omitempty"`
	// Optional tags defined for service to help in categorising them
	Tags []string `form:"tags,omitempty" json:"tags,omitempty" xml:"tags,omitempty"`
	// Service parameter definitions
	Parameters []*ParameterDefTResponseBody `form:"parameters,omitempty" json:"parameters,omitempty" xml:"parameters,omitempty"`
}

ServiceCreateResponseBody is the type of the "service" service "service-create" endpoint HTTP response body.

func CreateService 

func CreateService(ctxt context.Context, cmd *ServiceCreateRequestBody, adpt *adapter.Adapter, logger *log.Logger) (*ServiceCreateResponseBody, error)

type ServiceDeleteBadRequestResponseBody added in v0.41.8 

type ServiceDeleteBadRequestResponseBody struct {
	// Information message
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
}

ServiceDeleteBadRequestResponseBody is the type of the "service" service "service-delete" endpoint HTTP response body for the "bad-request" error.

type ServiceDeleteInvalidScopesResponseBody added in v0.41.8 

type ServiceDeleteInvalidScopesResponseBody struct {
	// ID of involved resource
	ID *string `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
	// Message of error
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
}

ServiceDeleteInvalidScopesResponseBody is the type of the "service" service "service-delete" endpoint HTTP response body for the "invalid-scopes" error.

type ServiceDeleteNotImplementedResponseBody added in v0.41.8 

type ServiceDeleteNotImplementedResponseBody struct {
	// Information message
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
}

ServiceDeleteNotImplementedResponseBody is the type of the "service" service "service-delete" endpoint HTTP response body for the "not-implemented" error.

type ServiceListBadRequestResponseBody added in v0.41.8 

type ServiceListBadRequestResponseBody struct {
	// Information message
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
}

ServiceListBadRequestResponseBody is the type of the "service" service "service-list" endpoint HTTP response body for the "bad-request" error.

type ServiceListInvalidParameterResponseBody added in v0.41.8 

type ServiceListInvalidParameterResponseBody struct {
	// message describing expected type or pattern.
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
	// name of parameter.
	Name *string `form:"name,omitempty" json:"name,omitempty" xml:"name,omitempty"`
	// provided parameter value.
	Value *string `form:"value,omitempty" json:"value,omitempty" xml:"value,omitempty"`
}

ServiceListInvalidParameterResponseBody is the type of the "service" service "service-list" endpoint HTTP response body for the "invalid-parameter" error.

type ServiceListInvalidScopesResponseBody added in v0.41.8 

type ServiceListInvalidScopesResponseBody struct {
	// ID of involved resource
	ID *string `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
	// Message of error
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
}

ServiceListInvalidScopesResponseBody is the type of the "service" service "service-list" endpoint HTTP response body for the "invalid-scopes" error.

type ServiceListItemTResponseBody added in v0.41.8 

type ServiceListItemTResponseBody struct {
	// ID
	ID *string `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
	// Optional customer provided name
	Name *string `form:"name,omitempty" json:"name,omitempty" xml:"name,omitempty"`
	// Optional description of the service
	Description *string `form:"description,omitempty" json:"description,omitempty" xml:"description,omitempty"`
	// Optional tags defined for service to help in categorising them
	Tags []string `form:"tags,omitempty" json:"tags,omitempty" xml:"tags,omitempty"`
	// type of controller used for this service
	ControllerSchema *string `form:"controller-schema,omitempty" json:"controller-schema,omitempty" xml:"controller-schema,omitempty"`
	// time this service has been available from
	ValidFrom *string `form:"valid-from,omitempty" json:"valid-from,omitempty" xml:"valid-from,omitempty"`
	// time this service has been available to
	ValidTo *string `form:"valid-to,omitempty" json:"valid-to,omitempty" xml:"valid-to,omitempty"`
	Href    *string `json:"href,omitempty"`
}

ServiceListItemTResponseBody is used to define fields on response body types.

type ServiceListNotImplementedResponseBody added in v0.41.8 

type ServiceListNotImplementedResponseBody struct {
	// Information message
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
}

ServiceListNotImplementedResponseBody is the type of the "service" service "service-list" endpoint HTTP response body for the "not-implemented" error.

type ServiceListResponseBody added in v0.41.8 

type ServiceListResponseBody struct {
	// Services
	Items []*ServiceListItemTResponseBody `form:"items,omitempty" json:"items,omitempty" xml:"items,omitempty"`
	// Time at which this list was valid
	AtTime *string              `form:"at-time,omitempty" json:"at-time,omitempty" xml:"at-time,omitempty"`
	Links  []*LinkTResponseBody `form:"links,omitempty" json:"links,omitempty" xml:"links,omitempty"`
}

ServiceListResponseBody is the type of the "service" service "service-list" endpoint HTTP response body.

func ListServices 

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

type ServiceReadBadRequestResponseBody added in v0.41.8 

type ServiceReadBadRequestResponseBody struct {
	// Information message
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
}

ServiceReadBadRequestResponseBody is the type of the "service" service "service-read" endpoint HTTP response body for the "bad-request" error.

type ServiceReadInvalidScopesResponseBody added in v0.41.8 

type ServiceReadInvalidScopesResponseBody struct {
	// ID of involved resource
	ID *string `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
	// Message of error
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
}

ServiceReadInvalidScopesResponseBody is the type of the "service" service "service-read" endpoint HTTP response body for the "invalid-scopes" error.

type ServiceReadNotFoundResponseBody added in v0.41.8 

type ServiceReadNotFoundResponseBody struct {
	// ID of missing resource
	ID *string `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
	// Message of error
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
}

ServiceReadNotFoundResponseBody is the type of the "service" service "service-read" endpoint HTTP response body for the "not-found" error.

type ServiceReadNotImplementedResponseBody added in v0.41.8 

type ServiceReadNotImplementedResponseBody struct {
	// Information message
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
}

ServiceReadNotImplementedResponseBody is the type of the "service" service "service-read" endpoint HTTP response body for the "not-implemented" error.

type ServiceReadResponseBody added in v0.41.8 

type ServiceReadResponseBody struct {
	// Service status
	Status *string `form:"status,omitempty" json:"status,omitempty" xml:"status,omitempty"`
	// type of controller used for this service
	ControllerSchema *string `form:"controller-schema,omitempty" json:"controller-schema,omitempty" xml:"controller-schema,omitempty"`
	// controller definition
	Controller any `form:"controller,omitempty" json:"controller,omitempty" xml:"controller,omitempty"`
	// Reference to billable account
	Account *string `form:"account,omitempty" json:"account,omitempty" xml:"account,omitempty"`
	// Reference to policy used
	Policy *string `form:"policy,omitempty" json:"policy,omitempty" xml:"policy,omitempty"`
	// time this service has been available from
	ValidFrom *string `form:"valid-from,omitempty" json:"valid-from,omitempty" xml:"valid-from,omitempty"`
	// time this service has been available to
	ValidTo *string              `form:"valid-to,omitempty" json:"valid-to,omitempty" xml:"valid-to,omitempty"`
	Links   []*LinkTResponseBody `form:"links,omitempty" json:"links,omitempty" xml:"links,omitempty"`
	// ID
	ID *string `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
	// Optional provider provided name
	Name *string `form:"name,omitempty" json:"name,omitempty" xml:"name,omitempty"`
	// More detailed description of the service
	Description *string `form:"description,omitempty" json:"description,omitempty" xml:"description,omitempty"`
	// Optional tags defined for service to help in categorising them
	Tags []string `form:"tags,omitempty" json:"tags,omitempty" xml:"tags,omitempty"`
	// Service parameter definitions
	Parameters []*ParameterDefTResponseBody `form:"parameters,omitempty" json:"parameters,omitempty" xml:"parameters,omitempty"`
}

ServiceReadResponseBody is the type of the "service" service "service-read" endpoint HTTP response body.

func ReadService 

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

type ServiceUpdateBadRequestResponseBody added in v0.41.8 

type ServiceUpdateBadRequestResponseBody struct {
	// Information message
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
}

ServiceUpdateBadRequestResponseBody is the type of the "service" service "service-update" endpoint HTTP response body for the "bad-request" error.

type ServiceUpdateInvalidParameterResponseBody added in v0.41.8 

type ServiceUpdateInvalidParameterResponseBody struct {
	// message describing expected type or pattern.
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
	// name of parameter.
	Name *string `form:"name,omitempty" json:"name,omitempty" xml:"name,omitempty"`
	// provided parameter value.
	Value *string `form:"value,omitempty" json:"value,omitempty" xml:"value,omitempty"`
}

ServiceUpdateInvalidParameterResponseBody is the type of the "service" service "service-update" endpoint HTTP response body for the "invalid-parameter" error.

type ServiceUpdateInvalidScopesResponseBody added in v0.41.8 

type ServiceUpdateInvalidScopesResponseBody struct {
	// ID of involved resource
	ID *string `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
	// Message of error
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
}

ServiceUpdateInvalidScopesResponseBody is the type of the "service" service "service-update" endpoint HTTP response body for the "invalid-scopes" error.

type ServiceUpdateNotFoundResponseBody added in v0.41.8 

type ServiceUpdateNotFoundResponseBody struct {
	// ID of missing resource
	ID *string `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
	// Message of error
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
}

ServiceUpdateNotFoundResponseBody is the type of the "service" service "service-update" endpoint HTTP response body for the "not-found" error.

type ServiceUpdateNotImplementedResponseBody added in v0.41.8 

type ServiceUpdateNotImplementedResponseBody struct {
	// Information message
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
}

ServiceUpdateNotImplementedResponseBody is the type of the "service" service "service-update" endpoint HTTP response body for the "not-implemented" error.

type ServiceUpdateRequestBody added in v0.41.8 

type ServiceUpdateRequestBody struct {
	// type of controller used for this service
	ControllerSchema string `form:"controller-schema" json:"controller-schema" xml:"controller-schema"`
	// controller definition
	Controller any `form:"controller" json:"controller" xml:"controller"`
	// Reference to policy used
	Policy string `form:"policy" json:"policy" xml:"policy"`
	// ID
	ID string `form:"id" json:"id" xml:"id"`
	// Optional provider provided name
	Name *string `form:"name,omitempty" json:"name,omitempty" xml:"name,omitempty"`
	// More detailed description of the service
	Description string `form:"description" json:"description" xml:"description"`
	// Optional tags defined for service to help in categorising them
	Tags []string `form:"tags,omitempty" json:"tags,omitempty" xml:"tags,omitempty"`
	// Service parameter definitions
	Parameters []*ParameterDefT `form:"parameters" json:"parameters" xml:"parameters"`
}

ServiceUpdateRequestBody is the type of the "service" service "service-update" endpoint HTTP request body.

type ServiceUpdateResponseBody added in v0.41.8 

type ServiceUpdateResponseBody struct {
	// Service status
	Status *string `form:"status,omitempty" json:"status,omitempty" xml:"status,omitempty"`
	// type of controller used for this service
	ControllerSchema *string `form:"controller-schema,omitempty" json:"controller-schema,omitempty" xml:"controller-schema,omitempty"`
	// controller definition
	Controller any `form:"controller,omitempty" json:"controller,omitempty" xml:"controller,omitempty"`
	// Reference to billable account
	Account *string `form:"account,omitempty" json:"account,omitempty" xml:"account,omitempty"`
	// Reference to policy used
	Policy *string `form:"policy,omitempty" json:"policy,omitempty" xml:"policy,omitempty"`
	// time this service has been available from
	ValidFrom *string `form:"valid-from,omitempty" json:"valid-from,omitempty" xml:"valid-from,omitempty"`
	// time this service has been available to
	ValidTo *string              `form:"valid-to,omitempty" json:"valid-to,omitempty" xml:"valid-to,omitempty"`
	Links   []*LinkTResponseBody `form:"links,omitempty" json:"links,omitempty" xml:"links,omitempty"`
	// ID
	ID *string `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
	// Optional provider provided name
	Name *string `form:"name,omitempty" json:"name,omitempty" xml:"name,omitempty"`
	// More detailed description of the service
	Description *string `form:"description,omitempty" json:"description,omitempty" xml:"description,omitempty"`
	// Optional tags defined for service to help in categorising them
	Tags []string `form:"tags,omitempty" json:"tags,omitempty" xml:"tags,omitempty"`
	// Service parameter definitions
	Parameters []*ParameterDefTResponseBody `form:"parameters,omitempty" json:"parameters,omitempty" xml:"parameters,omitempty"`
}

ServiceUpdateResponseBody is the type of the "service" service "service-update" endpoint HTTP response body.

func UpdateService 

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

Source Files

View all Source files

Directories

Path Synopsis
Package accountsapi holds Go data models for the ivcap-accounts HTTP API, generated from the OpenAPI spec ivcap-id publishes at https://id.<domain>/openapi.json (the Goa designs are the source of truth).
 Package accountsapi holds Go data models for the ivcap-accounts HTTP API, generated from the OpenAPI spec ivcap-id publishes at https://id.<domain>/openapi.json (the Goa designs are the source of truth).
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
Unused symbols here are intentional: artifact_build is deliberately not registered (see the note at the end of this file).
 Unused symbols here are intentional: artifact_build is deliberately not registered (see the note at the end of this file).
Package nextflow contains reusable logic for working with Nextflow-based services:
 Package nextflow contains reusable logic for working with Nextflow-based services:

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.