swagger

package
v0.0.0-...-88c21d1 Latest Latest
Warning

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

 Go to latest Published: Mar 3, 2023 License: MIT Imports: 21 Imported by: 0

README

Go API client for swagger

Backend of the oc-search project

Overview

This API client was generated by the swagger-codegen project. By using the swagger-spec from a remote server, you can easily generate an API client.

  • API version: 1.0.0
  • Package version: 1.0.0
  • Build package: io.swagger.codegen.languages.GoClientCodegen

Installation

Put the package under your project folder and add the following in import:

import "./swagger"

Documentation for API Endpoints

All URIs are relative to https://localhost:49618/v1

Class Method HTTP request Description
ComputingApi ComputingControllerAddComputing Post /computing/
ComputingApi ComputingControllerGetComputingByID Get /computing/{ID}
ComputingApi ComputingControllerGetMultipleComputingByIDs Get /computing/multi/{IDs}
DataApi DataControllerCreateData Post /data/
DataApi DataControllerGetDataByID Get /data/{ID}
DataApi DataControllerGetMultipleDataByIDs Get /data/multi/{IDs}
DatacenterApi DatacenterControllerCreateDatacenter Post /datacenter/
DatacenterApi DatacenterControllerGetMultipleDatacentersByIDs Get /datacenter/multi/{IDs}
DatacenterApi DatacenterControllerGetOneDatacenter Get /datacenter/{ID}
ScheduleApi ScheduleControllerCheckIfScheduleCanBeCreatedInThisDC Post /schedule/check
ScheduleApi ScheduleControllerCreateSchedule Post /schedule/book
ScheduleApi ScheduleControllerGetNextSchedule Get /schedule/next
ScheduleApi ScheduleControllerGetPreviousSchedule Get /schedule/previous
ScheduleApi ScheduleControllerGetSchedules Get /schedule/
SearchApi SearchControllerSearchByWord Get /search/byWord
StorageApi StorageControllerCreateStorage Post /storage/
StorageApi StorageControllerGet Get /storage/{ID}
StorageApi StorageControllerGetMultipleStoragesByIDs Get /storage/multi/{IDs}
UserApi UserControllerLogin Get /user/login
UserApi UserControllerLogout Get /user/logout
WorkflowApi WorkflowControllerAddNewObjectToAWorkflow Post /workflow/{workflowName}/add
WorkflowApi WorkflowControllerBookSchedule Post /workflow/{workflowName}/schedule/book
WorkflowApi WorkflowControllerCheckSchedule Get /workflow/{workflowName}/schedule/check
WorkflowApi WorkflowControllerCreateANewWorkflow Post /workflow/
WorkflowApi WorkflowControllerCreateARealtionshipBetweenTwoRobjects Post /workflow/{workflowName}/link
WorkflowApi WorkflowControllerGetMxGraphLastStatus Get /workflow/{workflowName}/mxGraphParser
WorkflowApi WorkflowControllerGetSchedule Get /workflow/{workflowName}/schedule
WorkflowApi WorkflowControllerGetWorkflow Get /workflow/{workflowName}
WorkflowApi WorkflowControllerListWorkflows Get /workflow/
WorkflowApi WorkflowControllerParseMxGraph Post /workflow/{workflowName}/mxGraphParser
WorkflowApi WorkflowControllerSetSchedule Put /workflow/{workflowName}/schedule
WorkspaceApi WorkspaceControllerAddModelToWorkspace Post /workspace/
WorkspaceApi WorkspaceControllerDeleteElementFromUserWorkspace Delete /workspace/
WorkspaceApi WorkspaceControllerGetFullWorkspace Get /workspace/list_model
WorkspaceApi WorkspaceControllerGetWorkspace Get /workspace/list

Documentation For Models

Documentation For Authorization

Endpoints do not require authorization.

Author

opencloud@irt-saintexupery.com

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	// ContextOAuth2 takes a oauth2.TokenSource as authentication for the request.
	ContextOAuth2 = contextKey("token")

	// ContextBasicAuth takes BasicAuth as authentication for the request.
	ContextBasicAuth = contextKey("basic")

	// ContextAccessToken takes a string oauth2 access token as authentication for the request.
	ContextAccessToken = contextKey("accesstoken")

	// ContextAPIKey takes an APIKey as authentication for the request
	ContextAPIKey = contextKey("apikey")
)

Functions

func CacheExpires 

func CacheExpires(r *http.Response) time.Time

CacheExpires helper function to determine remaining time before repeating a request.

Types

type APIClient 

type APIClient struct {
	ComputingApi *ComputingApiService

	DataApi *DataApiService

	DatacenterApi *DatacenterApiService

	ScheduleApi *ScheduleApiService

	SearchApi *SearchApiService

	StorageApi *StorageApiService

	UserApi *UserApiService

	WorkflowApi *WorkflowApiService

	WorkspaceApi *WorkspaceApiService
	// contains filtered or unexported fields
}

APIClient manages communication with the oc-catalog API API v1.0.0 In most cases there should be only one, shared, APIClient.

func NewAPIClient 

func NewAPIClient(cfg *Configuration) *APIClient

NewAPIClient creates a new API client. Requires a userAgent string describing your application. optionally a custom http.Client to allow for advanced features such as caching.

func (*APIClient) ChangeBasePath 

func (c *APIClient) ChangeBasePath(path string)

Change base path to allow switching to mocks

type APIKey 

type APIKey struct {
	Key    string
	Prefix string
}

APIKey provides API key based authentication to a request passed via context using ContextAPIKey

type APIResponse 

type APIResponse struct {
	*http.Response `json:"-"`
	Message        string `json:"message,omitempty"`
	// Operation is the name of the swagger operation.
	Operation string `json:"operation,omitempty"`
	// RequestURL is the request URL. This value is always available, even if the
	// embedded *http.Response is nil.
	RequestURL string `json:"url,omitempty"`
	// Method is the HTTP method used for the request.  This value is always
	// available, even if the embedded *http.Response is nil.
	Method string `json:"method,omitempty"`
	// Payload holds the contents of the response body (which may be nil or empty).
	// This is provided here as the raw response.Body() reader will have already
	// been drained.
	Payload []byte `json:"-"`
}

func NewAPIResponse 

func NewAPIResponse(r *http.Response) *APIResponse

func NewAPIResponseWithError 

func NewAPIResponseWithError(errorMessage string) *APIResponse

type BasicAuth 

type BasicAuth struct {
	UserName string `json:"userName,omitempty"`
	Password string `json:"password,omitempty"`
}

BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth

type ComputingApiService 

type ComputingApiService service

func (*ComputingApiService) ComputingControllerAddComputing 

func (a *ComputingApiService) ComputingControllerAddComputing(ctx context.Context, body ModelsComputingNewModel) (*http.Response, error)

ComputingApiService Submit a computing object

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body The object content

func (*ComputingApiService) ComputingControllerGetComputingByID 

func (a *ComputingApiService) ComputingControllerGetComputingByID(ctx context.Context, iD string) (ModelsComputingModel, *http.Response, error)

ComputingApiService Find a computing resource based on ID

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param iD The ID of the resource

@return ModelsComputingModel

func (*ComputingApiService) ComputingControllerGetMultipleComputingByIDs 

func (a *ComputingApiService) ComputingControllerGetMultipleComputingByIDs(ctx context.Context, iDs []string) ([]ModelsComputingModel, *http.Response, error)

ComputingApiService Return Computing objects if found in the DB. Not found IDs will be ignored

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param iDs List of computing IDs

@return []ModelsComputingModel

type Configuration 

type Configuration struct {
	BasePath      string            `json:"basePath,omitempty"`
	Host          string            `json:"host,omitempty"`
	Scheme        string            `json:"scheme,omitempty"`
	DefaultHeader map[string]string `json:"defaultHeader,omitempty"`
	UserAgent     string            `json:"userAgent,omitempty"`
	HTTPClient    *http.Client
}

func NewConfiguration 

func NewConfiguration() *Configuration

func (*Configuration) AddDefaultHeader 

func (c *Configuration) AddDefaultHeader(key string, value string)

type DataApiService 

type DataApiService service

func (*DataApiService) DataControllerCreateData 

func (a *DataApiService) DataControllerCreateData(ctx context.Context, body ModelsDataNewModel) (*http.Response, error)

DataApiService Submit data object

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body The object content

func (*DataApiService) DataControllerGetDataByID 

func (a *DataApiService) DataControllerGetDataByID(ctx context.Context, iD string) (ModelsDataModel, *http.Response, error)

DataApiService Find rType data based on ID

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param iD The ID of the data resource

@return ModelsDataModel

func (*DataApiService) DataControllerGetMultipleDataByIDs 

func (a *DataApiService) DataControllerGetMultipleDataByIDs(ctx context.Context, iDs []string) ([]ModelsDataModel, *http.Response, error)

DataApiService Return Data object if found in the DB. Not found IDs will be ignored

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param iDs List of data IDs

@return []ModelsDataModel

type DatacenterApiService 

type DatacenterApiService service

func (*DatacenterApiService) DatacenterControllerCreateDatacenter 

func (a *DatacenterApiService) DatacenterControllerCreateDatacenter(ctx context.Context, body ModelsDatacenterNewModel) (*http.Response, error)

DatacenterApiService submit Datacenter object

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body The object content

func (*DatacenterApiService) DatacenterControllerGetMultipleDatacentersByIDs 

func (a *DatacenterApiService) DatacenterControllerGetMultipleDatacentersByIDs(ctx context.Context, iDs []string) ([]ModelsComputingModel, *http.Response, error)

DatacenterApiService Return Datacenter objects if found in the DB. Not found IDs will be ignored

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param iDs List of datacenter IDs

@return []ModelsComputingModel

func (*DatacenterApiService) DatacenterControllerGetOneDatacenter 

func (a *DatacenterApiService) DatacenterControllerGetOneDatacenter(ctx context.Context, iD string) (ModelsDatacenterModel, *http.Response, error)

DatacenterApiService find datacenter by ID

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param iD the ID you want to get

@return ModelsDatacenterModel

type GenericSwaggerError 

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

GenericSwaggerError Provides access to the body, error and model on returned errors.

func (GenericSwaggerError) Body 

func (e GenericSwaggerError) Body() []byte

Body returns the raw bytes of the response

func (GenericSwaggerError) Error 

func (e GenericSwaggerError) Error() string

Error returns non-empty string if there was an error.

func (GenericSwaggerError) Model 

func (e GenericSwaggerError) Model() interface{}

Model returns the unpacked model of the error

type ModelsComputingModel 

type ModelsComputingModel struct {
	ID                    string                            `json:"ID"`
	Description           string                            `json:"description,omitempty"`
	ExecutionRequirements *ModelsExecutionRequirementsModel `json:"execution_requirements,omitempty"`
	License               string                            `json:"license,omitempty"`
	// Name of the computing
	Name             string                 `json:"name,omitempty"`
	Owner            string                 `json:"owner,omitempty"`
	Price            int32                  `json:"price,omitempty"`
	Repository       *ModelsRepositoryModel `json:"repository,omitempty"`
	ShortDescription string                 `json:"short_description,omitempty"`
	Type_            string                 `json:"type,omitempty"`
}

type ModelsComputingNewModel 

type ModelsComputingNewModel struct {
	Description           string                            `json:"description"`
	ExecutionRequirements *ModelsExecutionRequirementsModel `json:"execution_requirements,omitempty"`
	License               string                            `json:"license,omitempty"`
	// Name of the computing
	Name             string                 `json:"name"`
	Owner            string                 `json:"owner,omitempty"`
	Price            int32                  `json:"price,omitempty"`
	Repository       *ModelsRepositoryModel `json:"repository,omitempty"`
	ShortDescription string                 `json:"short_description"`
	Type_            string                 `json:"type"`
}

type ModelsComputingObject 

type ModelsComputingObject struct {
	// Datacenter where the computing will be executed
	DatacenterID string   `json:"datacenterID,omitempty"`
	Inputs       []string `json:"inputs,omitempty"`
	Outputs      []string `json:"outputs,omitempty"`
	// Computing model ID
	ReferenceID *PrimitiveObjectId `json:"referenceID,omitempty"`
}

type ModelsDCstatus 

type ModelsDCstatus struct {
	Booked       *ModelsScheduleInfo `json:"Booked,omitempty"`
	DCname       string              `json:"DCname,omitempty"`
	DCobjID      string              `json:"DCobjID,omitempty"`
	ErrorMessage string              `json:"ErrorMessage,omitempty"`
	IsAvailable  bool                `json:"IsAvailable,omitempty"`
	IsReachable  bool                `json:"IsReachable,omitempty"`
}

type ModelsDataModel 

type ModelsDataModel struct {
	ID          string `json:"ID"`
	Description string `json:"description,omitempty"`
	// base64 encoded data
	Example  string `json:"example,omitempty"`
	Ftype    string `json:"ftype,omitempty"`
	Location string `json:"location,omitempty"`
	// Name of the data
	Name             string   `json:"name,omitempty"`
	Protocol         []string `json:"protocol,omitempty"`
	ShortDescription string   `json:"short_description,omitempty"`
	// Define type of data
	Type_ string `json:"type,omitempty"`
}

type ModelsDataNewModel 

type ModelsDataNewModel struct {
	Description string `json:"description"`
	// base64 encoded data
	Example  string `json:"example"`
	Ftype    string `json:"ftype,omitempty"`
	Location string `json:"location"`
	// Name of the data
	Name             string   `json:"name"`
	Protocol         []string `json:"protocol,omitempty"`
	ShortDescription string   `json:"short_description"`
	// Define type of data
	Type_ string `json:"type"`
}

type ModelsDataObject 

type ModelsDataObject struct {
	// Data model ID
	ReferenceID *PrimitiveObjectId `json:"referenceID,omitempty"`
}

type ModelsDatacenterCpuModel 

type ModelsDatacenterCpuModel struct {
	Architecture  string `json:"architecture,omitempty"`
	Cores         int32  `json:"cores"`
	MinimumMemory int32  `json:"minimum_memory,omitempty"`
	Platform      string `json:"platform,omitempty"`
	Shared        bool   `json:"shared,omitempty"`
}

type ModelsDatacenterGpuModel 

type ModelsDatacenterGpuModel struct {
	CudaCores int32 `json:"cuda_cores,omitempty"`
	// Units in MB
	Memory      int32  `json:"memory,omitempty"`
	Model       string `json:"model,omitempty"`
	TensorCores int32  `json:"tensor_cores,omitempty"`
}

type ModelsDatacenterMemoryModel 

type ModelsDatacenterMemoryModel struct {
	Ecc bool `json:"ecc,omitempty"`
	// Units in MB
	Size int32 `json:"size,omitempty"`
}

type ModelsDatacenterModel 

type ModelsDatacenterModel struct {
	ID string `json:"ID"`
	// id of the DC
	Acronym      string                     `json:"acronym,omitempty"`
	BookingPrice int64                      `json:"bookingPrice,omitempty"`
	Cpu          *ModelsDatacenterCpuModel  `json:"cpu,omitempty"`
	Description  string                     `json:"description,omitempty"`
	Gpu          []ModelsDatacenterGpuModel `json:"gpu,omitempty"`
	// list of host:port
	Hosts            []string                     `json:"hosts,omitempty"`
	Name             string                       `json:"name,omitempty"`
	Owner            string                       `json:"owner,omitempty"`
	Ram              *ModelsDatacenterMemoryModel `json:"ram,omitempty"`
	ShortDescription string                       `json:"short_description,omitempty"`
	Type_            string                       `json:"type,omitempty"`
}

type ModelsDatacenterNewModel 

type ModelsDatacenterNewModel struct {
	// id of the DC
	Acronym      string                     `json:"acronym"`
	BookingPrice int64                      `json:"bookingPrice,omitempty"`
	Cpu          *ModelsDatacenterCpuModel  `json:"cpu"`
	Description  string                     `json:"description"`
	Gpu          []ModelsDatacenterGpuModel `json:"gpu"`
	// list of host:port
	Hosts            []string                     `json:"hosts"`
	Name             string                       `json:"name"`
	Owner            string                       `json:"owner,omitempty"`
	Ram              *ModelsDatacenterMemoryModel `json:"ram"`
	ShortDescription string                       `json:"short_description"`
	Type_            string                       `json:"type"`
}

type ModelsDatacenterObject 

type ModelsDatacenterObject struct {
	// Data model ID
	ReferenceID *PrimitiveObjectId `json:"referenceID,omitempty"`
}

type ModelsExecutionRequirementsModel 

type ModelsExecutionRequirementsModel struct {
	Cpus   int32  `json:"cpus"`
	DiskIo string `json:"disk_io,omitempty"`
	// Amount of GPUs needed
	Gpus     int32 `json:"gpus,omitempty"`
	Parallel bool  `json:"parallel,omitempty"`
	// Units in MB
	Ram          int32 `json:"ram"`
	ScalingModel int32 `json:"scaling_model,omitempty"`
}

type ModelsRepositoryModel 

type ModelsRepositoryModel struct {
	Credentials string `json:"credentials,omitempty"`
	Url         string `json:"url,omitempty"`
}

type ModelsScheduleDb 

type ModelsScheduleDb struct {
	ResourceQty *ModelsExecutionRequirementsModel `json:"ResourceQty,omitempty"`
	StartDate   string                            `json:"StartDate,omitempty"`
	StopDate    string                            `json:"StopDate,omitempty"`
	Workflow    string                            `json:"Workflow,omitempty"`
}

type ModelsScheduleInfo 

type ModelsScheduleInfo struct {
	NextExecutions []string `json:"NextExecutions,omitempty"`
	Total          int64    `json:"Total,omitempty"`
}

type ModelsScheduleTime 

type ModelsScheduleTime struct {
}

type ModelsSearchResult 

type ModelsSearchResult struct {
	Computing  []ModelsComputingModel  `json:"computing"`
	Data       []ModelsDataModel       `json:"data,omitempty"`
	Datacenter []ModelsDatacenterModel `json:"datacenter,omitempty"`
	Storage    []ModelsStorageModel    `json:"storage,omitempty"`
}

type ModelsStorageModel 

type ModelsStorageModel struct {
	// Unique ID of the DC where it is the storage
	DCacronym        string `json:"DCacronym,omitempty"`
	ID               string `json:"ID"`
	BookingPrice     int32  `json:"bookingPrice,omitempty"`
	Description      string `json:"description,omitempty"`
	Encryption       bool   `json:"encryption,omitempty"`
	Name             string `json:"name,omitempty"`
	Redundancy       string `json:"redundancy,omitempty"`
	ShortDescription string `json:"short_description,omitempty"`
	Size             int32  `json:"size,omitempty"`
	Throughput       string `json:"throughput,omitempty"`
	Type_            string `json:"type,omitempty"`
}

type ModelsStorageNewModel 

type ModelsStorageNewModel struct {
	// Unique ID of the DC where it is the storage
	DCacronym        string `json:"DCacronym"`
	BookingPrice     int32  `json:"bookingPrice,omitempty"`
	Description      string `json:"description"`
	Encryption       bool   `json:"encryption,omitempty"`
	Name             string `json:"name"`
	Redundancy       string `json:"redundancy,omitempty"`
	ShortDescription string `json:"short_description"`
	Size             int32  `json:"size"`
	Throughput       string `json:"throughput,omitempty"`
	Type_            string `json:"type"`
}

type ModelsStorageObject 

type ModelsStorageObject struct {
	Inputs  []string `json:"inputs,omitempty"`
	Outputs []string `json:"outputs,omitempty"`
	// Storage model ID
	ReferenceID *PrimitiveObjectId `json:"referenceID,omitempty"`
}

type ModelsWorkflow 

type ModelsWorkflow struct {
	// State of the mxgraph
	MxgraphXML string                  `json:"MxgraphXML,omitempty"`
	Computing  *ModelsComputingObject  `json:"computing,omitempty"`
	Data       *ModelsDataObject       `json:"data,omitempty"`
	Datacenter *ModelsDatacenterObject `json:"datacenter,omitempty"`
	Schedules  *ModelsWorkflowSchedule `json:"schedules,omitempty"`
	Storage    *ModelsStorageObject    `json:"storage,omitempty"`
}

type ModelsWorkflowSchedule 

type ModelsWorkflowSchedule struct {
	// Service: true, Task: false
	IsService bool   `json:"IsService,omitempty"`
	StartDate string `json:"StartDate,omitempty"`
	StopDate  string `json:"StopDate,omitempty"`
	Cron      string `json:"cron,omitempty"`
	// Durantion in seconds
	Duration int32  `json:"duration,omitempty"`
	Events   string `json:"events,omitempty"`
	IsBooked bool   `json:"isBooked,omitempty"`
}

type ModelsWorkspace 

type ModelsWorkspace struct {
	Workflows  *ModelsWorkflow `json:"Workflows,omitempty"`
	Computing  []string        `json:"computing,omitempty"`
	Data       []string        `json:"data,omitempty"`
	Datacenter []string        `json:"datacenter,omitempty"`
	Storage    []string        `json:"storage,omitempty"`
	UserId     string          `json:"user_id,omitempty"`
}

type ModelsWorkspaceModel 

type ModelsWorkspaceModel struct {
	Computing  []ModelsComputingModel  `json:"computing,omitempty"`
	Data       []ModelsDataModel       `json:"data,omitempty"`
	Datacenter []ModelsDatacenterModel `json:"datacenter,omitempty"`
	Storage    []ModelsStorageModel    `json:"storage,omitempty"`
	UserId     string                  `json:"user_id,omitempty"`
}

type PrimitiveObjectId 

type PrimitiveObjectId struct {
}

type ScheduleApiService 

type ScheduleApiService service

func (*ScheduleApiService) ScheduleControllerCheckIfScheduleCanBeCreatedInThisDC 

func (a *ScheduleApiService) ScheduleControllerCheckIfScheduleCanBeCreatedInThisDC(ctx context.Context, cron string, duration int32, startDate interface{}, stopDate interface{}, requirements ModelsExecutionRequirementsModel) (*http.Response, error)

ScheduleApiService Check for availability of this DC

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param cron Cron syntax
  • @param duration Duration in seconds
  • @param startDate RFC3339 time for startDate
  • @param stopDate RFC3339 time for stopDate
  • @param requirements The object content

func (*ScheduleApiService) ScheduleControllerCreateSchedule 

func (a *ScheduleApiService) ScheduleControllerCreateSchedule(ctx context.Context, dcName string, workflowName string, cron string, duration int32, startDate interface{}, stopDate interface{}, requirements ModelsExecutionRequirementsModel) (ModelsScheduleInfo, *http.Response, error)

ScheduleApiService Create schedule for a workflow. It will return some future executions just as information

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param dcName Name of the node (oc-catalog) from where the workflow comes.
  • @param workflowName Workflow Name
  • @param cron Cron syntax with year. If no year is specified, will use the current
  • @param duration Duration in seconds
  • @param startDate RFC3339 time for startDate
  • @param stopDate RFC3339 time for stopDate
  • @param requirements The object content

@return ModelsScheduleInfo

func (*ScheduleApiService) ScheduleControllerGetNextSchedule 

func (a *ScheduleApiService) ScheduleControllerGetNextSchedule(ctx context.Context, baseDate interface{}) (TimeTime, *http.Response, error)

ScheduleApiService Give a date, get the next date where there are at least on schedule. If no hours specified, will assume 00:00

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param baseDate Base date

@return TimeTime

func (*ScheduleApiService) ScheduleControllerGetPreviousSchedule 

func (a *ScheduleApiService) ScheduleControllerGetPreviousSchedule(ctx context.Context, baseDate interface{}) (TimeTime, *http.Response, error)

ScheduleApiService Give a date, get the previous date where there are at least on schedule. If no hours specified, will assume 00:00

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param baseDate Base date

@return TimeTime

func (*ScheduleApiService) ScheduleControllerGetSchedules 

func (a *ScheduleApiService) ScheduleControllerGetSchedules(ctx context.Context, startDate interface{}, stopDate interface{}) ([]ModelsScheduleDb, *http.Response, error)

ScheduleApiService Get a list of next startDates schedules (inclusive). If timezone is not specified, will assume UTC

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param startDate Start date
  • @param stopDate End date

@return []ModelsScheduleDb

type SearchApiService 

type SearchApiService service

func (*SearchApiService) SearchControllerSearchByWord 

func (a *SearchApiService) SearchControllerSearchByWord(ctx context.Context, word string) (ModelsSearchResult, *http.Response, error)

SearchApiService find resources by word

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param word Word to search across all resources

@return ModelsSearchResult

type StorageApiService 

type StorageApiService service

func (*StorageApiService) StorageControllerCreateStorage 

func (a *StorageApiService) StorageControllerCreateStorage(ctx context.Context, body ModelsStorageNewModel) (*http.Response, error)

StorageApiService submit storage object

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body The object content

func (*StorageApiService) StorageControllerGet 

func (a *StorageApiService) StorageControllerGet(ctx context.Context, iD string) (ModelsStorageModel, *http.Response, error)

StorageApiService find storage by ID

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param iD the ID you want to get

@return ModelsStorageModel

func (*StorageApiService) StorageControllerGetMultipleStoragesByIDs 

func (a *StorageApiService) StorageControllerGetMultipleStoragesByIDs(ctx context.Context, iDs []string) ([]ModelsComputingModel, *http.Response, error)

StorageApiService Return Storage objects if found in the DB. Not found IDs will be ignored

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param iDs List of storage IDs

@return []ModelsComputingModel

type TimeTime 

type TimeTime struct {
}

type UserApiService 

type UserApiService service

func (*UserApiService) UserControllerLogin 

func (a *UserApiService) UserControllerLogin(ctx context.Context, username string, password string) (*http.Response, error)

UserApiService Logs user into the system

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param username The username for login
  • @param password The password for login

func (*UserApiService) UserControllerLogout 

func (a *UserApiService) UserControllerLogout(ctx context.Context) (*http.Response, error)

UserApiService Logs out current logged in user session

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

type WorkflowApiService 

type WorkflowApiService service

func (*WorkflowApiService) WorkflowControllerAddNewObjectToAWorkflow 

func (a *WorkflowApiService) WorkflowControllerAddNewObjectToAWorkflow(ctx context.Context, workflowName string, rID string) (*http.Response, error)

WorkflowApiService Create a Rtype object from already added resources to the workspace

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param workflowName workflow Name
  • @param rID rID of already existing item in Workspace

func (*WorkflowApiService) WorkflowControllerBookSchedule 

func (a *WorkflowApiService) WorkflowControllerBookSchedule(ctx context.Context, workflowName string) ([]ModelsDCstatus, *http.Response, error)

WorkflowApiService Book a schedule in all DCs of the workflow. Must set a desired schedule first!

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param workflowName Workflow Name

@return []ModelsDCstatus

func (*WorkflowApiService) WorkflowControllerCheckSchedule 

func (a *WorkflowApiService) WorkflowControllerCheckSchedule(ctx context.Context, workflowName string) ([]ModelsDCstatus, *http.Response, error)

WorkflowApiService Check if we can schedule the project in other DCs. Must set a desired schedule first!

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param workflowName Workflow Name

@return []ModelsDCstatus

func (*WorkflowApiService) WorkflowControllerCreateANewWorkflow 

func (a *WorkflowApiService) WorkflowControllerCreateANewWorkflow(ctx context.Context, workflowName string) (*http.Response, error)

WorkflowApiService Create a name for the new workflow

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param workflowName Name of the workflow

func (*WorkflowApiService) WorkflowControllerCreateARealtionshipBetweenTwoRobjects 

func (a *WorkflowApiService) WorkflowControllerCreateARealtionshipBetweenTwoRobjects(ctx context.Context, workflowName string, rObjIDsource string, isInput bool, rObjIDtarger string) (*http.Response, error)

WorkflowApiService Create a Rtype object from already added resources to the workspace

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param workflowName Workflow Name
  • @param rObjIDsource Robject source. Usually Data
  • @param isInput If the operation is for input (true) linkage or output (false)
  • @param rObjIDtarger Robject where will be written the association

func (*WorkflowApiService) WorkflowControllerGetMxGraphLastStatus 

func (a *WorkflowApiService) WorkflowControllerGetMxGraphLastStatus(ctx context.Context, workflowName string) (*http.Response, error)

WorkflowApiService Obtain the last mxgraph XML status from the workflow

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param workflowName Workflow Name

func (*WorkflowApiService) WorkflowControllerGetSchedule 

func (a *WorkflowApiService) WorkflowControllerGetSchedule(ctx context.Context, workflowName string) (ModelsScheduleTime, *http.Response, error)

WorkflowApiService Obtain the desired schedule of this workflow

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param workflowName Workflow Name

@return ModelsScheduleTime

func (*WorkflowApiService) WorkflowControllerGetWorkflow 

func (a *WorkflowApiService) WorkflowControllerGetWorkflow(ctx context.Context, workflowName string) (ModelsWorkflow, *http.Response, error)

WorkflowApiService Get a workflow by name

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param workflowName Workflow Name

@return ModelsWorkflow

func (*WorkflowApiService) WorkflowControllerListWorkflows 

func (a *WorkflowApiService) WorkflowControllerListWorkflows(ctx context.Context) (*http.Response, error)

WorkflowApiService List available workflows

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

func (*WorkflowApiService) WorkflowControllerParseMxGraph 

func (a *WorkflowApiService) WorkflowControllerParseMxGraph(ctx context.Context, workflowName string, xmlData string) (*http.Response, error)

WorkflowApiService If we use this aproach to transofrm mxgraph representation in our representation, we should not use other API calls for modify the project structure or we'll have inconsistencies.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param workflowName Workflow Name
  • @param xmlData Xml representation of the workflow

func (*WorkflowApiService) WorkflowControllerSetSchedule 

func (a *WorkflowApiService) WorkflowControllerSetSchedule(ctx context.Context, workflowName string, isService bool, startDate interface{}, stopDate interface{}, localVarOptionals *WorkflowApiWorkflowControllerSetScheduleOpts) (ModelsScheduleInfo, *http.Response, error)

type WorkflowApiWorkflowControllerSetScheduleOpts 

type WorkflowApiWorkflowControllerSetScheduleOpts struct {
	Events     optional.String
	CronString optional.String
	Duration   optional.Int32
}

type WorkspaceApiService 

type WorkspaceApiService service

func (*WorkspaceApiService) WorkspaceControllerAddModelToWorkspace 

func (a *WorkspaceApiService) WorkspaceControllerAddModelToWorkspace(ctx context.Context, id string, rtype string) (*http.Response, error)

WorkspaceApiService Insert a resource in the workspace

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id ID of a resource
  • @param rtype Type of resource

func (*WorkspaceApiService) WorkspaceControllerDeleteElementFromUserWorkspace 

func (a *WorkspaceApiService) WorkspaceControllerDeleteElementFromUserWorkspace(ctx context.Context, id string, rtype string) (*http.Response, error)

WorkspaceApiService Remove a resource from the workspace

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id ID of a resource
  • @param rtype Type of resource

func (*WorkspaceApiService) WorkspaceControllerGetFullWorkspace 

func (a *WorkspaceApiService) WorkspaceControllerGetFullWorkspace(ctx context.Context) (ModelsWorkspaceModel, *http.Response, error)

WorkspaceApiService Get full workspace elements based on user_id token

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return ModelsWorkspaceModel

func (*WorkspaceApiService) WorkspaceControllerGetWorkspace 

func (a *WorkspaceApiService) WorkspaceControllerGetWorkspace(ctx context.Context) (ModelsWorkspace, *http.Response, error)

WorkspaceApiService Get workspace elements based on user_id token

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return ModelsWorkspace

Source Files

View all Source files

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.