workflows

README

[!WARNING]

このレポジトリの内容は下記に集約・移転しました。 github.com/sacloud/sacloud-sdk-go

今後は上記のレポジトリで開発を行います。 このライブラリを使用している方は、importを変更していただきますようお願いいたします。

// 変更前
import "github.com/sacloud/workflows-api-go"

// 変更後
import "github.com/sacloud/sacloud-sdk-go/api/workflows"

sacloud/workflows-api-go

Go言語向けのさくらのクラウド Workflows APIライブラリ

マニュアル: https://manual.sakura.ad.jp/cloud/appliance/workflows/ APIドキュメント: https://manual.sakura.ad.jp/api/cloud/workflows/

概要

sacloud/workflows-api-goはさくらのクラウド Workflows APIをGo言語から利用するためのAPIライブラリです。

License

workflows-api-go Copyright (C) 2025- The sacloud/workflows-api-go authors. This project is published under Apache 2.0 License.

Documentation

Overview

Deprecated: This module has moved to github.com/sacloud/sacloud-sdk-go. Please migrate to that module. This repository will be archived.

Index

• Constants
• Variables
• func NewClient(client saclient.ClientAPI) (*v1.Client, error)
• func NewClientWithAPIRootURL(client saclient.ClientAPI, apiRootURL string) (*v1.Client, error)
• type Error
  • func NewAPIError(method string, code int, err error) *Error
  • func NewError(msg string, err error) *Error
  • func (e *Error) Error() string
  • func (e *Error) Unwrap() error
• type ExecutionAPI
  • func NewExecutionOp(client *v1.Client) ExecutionAPI
• type RevisionAPI
  • func NewRevisionOp(client *v1.Client) RevisionAPI
• type SubscriptionAPI
  • func NewSubscriptionOp(client *v1.Client) SubscriptionAPI
• type WorkflowAPI
  • func NewWorkflowOp(client *v1.Client) WorkflowAPI

Constants

const (
	// DefaultAPIRootURL デフォルトのAPIルートURL
	DefaultAPIRootURL = "https://secure.sakura.ad.jp/cloud/zone/tk1b/api/workflow/1.0/"
)

const Version = "0.4.1"

Variables

var UserAgent = fmt.Sprintf(
	"workflows-api-go/%s (%s/%s; +https://github.com/sacloud/workflows-api-go)",
	Version,
	runtime.GOOS,
	runtime.GOARCH,
)

UserAgent APIリクエスト時のユーザーエージェント

Functions

func NewClient

func NewClient(client saclient.ClientAPI) (*v1.Client, error)

NewClient creates a new workflows API client with default settings

func NewClientWithAPIRootURL

func NewClientWithAPIRootURL(client saclient.ClientAPI, apiRootURL string) (*v1.Client, error)

NewClientWithAPIRootURL creates a new workflows API client with a custom API root URL

Types

type Error

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

func NewAPIError

func NewAPIError(method string, code int, err error) *Error

func NewError

func NewError(msg string, err error) *Error

func (*Error) Error

func (e *Error) Error() string

func (*Error) Unwrap

func (e *Error) Unwrap() error

type ExecutionAPI

type ExecutionAPI interface {
	Create(ctx context.Context, workflowID string, req v1.OptCreateExecutionReq) (*v1.CreateExecutionCreatedExecution, error)
	List(ctx context.Context, params v1.ListExecutionParams) (*v1.ListExecutionOK, error)
	Read(ctx context.Context, workflowID, executionID string) (*v1.GetExecutionOKExecution, error)
	Cancel(ctx context.Context, workflowID, executionID string) (*v1.CancelExecutionOKExecution, error)
	Delete(ctx context.Context, workflowID, executionID string) error
	ListHistory(ctx context.Context, params v1.ListExecutionHistoryParams) (*v1.ListExecutionHistoryOK, error)
}

func NewExecutionOp

func NewExecutionOp(client *v1.Client) ExecutionAPI

type RevisionAPI

type RevisionAPI interface {
	Create(ctx context.Context, workflowID string, req v1.CreateWorkflowRevisionReq) (*v1.CreateWorkflowRevisionCreatedRevision, error)
	List(ctx context.Context, params v1.ListWorkflowRevisionsParams) (*v1.ListWorkflowRevisionsOK, error)
	Read(ctx context.Context, workflowID string, revisionNumber int) (*v1.GetWorkflowRevisionsOKRevision, error)
	UpdateAlias(ctx context.Context, workflowID string, revisionNumber int, req v1.UpdateWorkflowRevisionAliasReq) (*v1.UpdateWorkflowRevisionAliasOKRevision, error)
	DeleteAlias(ctx context.Context, workflowID string, revisionNumber int) error
}

func NewRevisionOp

func NewRevisionOp(client *v1.Client) RevisionAPI

type SubscriptionAPI

type SubscriptionAPI interface {
	ListPlans(ctx context.Context) (*v1.ListPlansOK, error)
	Read(ctx context.Context) (*v1.GetSubscriptionOK, error)
	Create(ctx context.Context, request v1.CreateSubscriptionReq) error
	Delete(ctx context.Context) error
}

func NewSubscriptionOp

func NewSubscriptionOp(client *v1.Client) SubscriptionAPI

type WorkflowAPI

type WorkflowAPI interface {
	Create(ctx context.Context, request v1.CreateWorkflowReq) (*v1.CreateWorkflowCreatedWorkflow, error)
	List(ctx context.Context, parameter v1.ListWorkflowParams) (*v1.ListWorkflowOK, error)
	ListSuggest(ctx context.Context, parameter v1.ListWorkflowSuggestParams) (*v1.ListWorkflowSuggestOK, error)
	Read(ctx context.Context, id string) (*v1.GetWorkflowOKWorkflow, error)
	Update(ctx context.Context, id string, request v1.UpdateWorkflowReq) (*v1.UpdateWorkflowOKWorkflow, error)
	Delete(ctx context.Context, id string) error
}

func NewWorkflowOp

func NewWorkflowOp(client *v1.Client) WorkflowAPI