computeci

package
v1.2.0 Latest Latest
Warning

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

Go to latest
Published: Mar 1, 2023 License: Apache-2.0 Imports: 5 Imported by: 0

Documentation

Overview

API Actor for managing ComputeCI. This actor is a final API for admin to manage ComputeCI

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ComputeCI

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

Structure for creating request to computeci

func New

func New(client interfaces.Caller) *ComputeCI

Builder for computeci endpoints

func (ComputeCI) Get

func (c ComputeCI) Get(ctx context.Context, req GetRequest) (*ItemComputeCI, error)

Get gets information about computeci by ID

func (ComputeCI) List

List gets list of computeci instances

type GetRequest

type GetRequest struct {
	// ID of the Compute CI
	// Required: true
	ComputeCIID uint64 `url:"computeciId" json:"computeciId"`
}

Request struct for information about computeci

type ItemComputeCI

type ItemComputeCI struct {
	// Custom fields
	CustomFields map[string]interface{} `json:"customFields"`

	// Description
	Description string `json:"desc"`

	// List drivers
	Drivers []string `json:"drivers"`

	// GUID
	GUID uint64 `json:"guid"`

	// ID
	ID uint64 `json:"id"`

	// Name
	Name string `json:"name"`

	// Status
	Status string `json:"status"`

	// Template
	Template string `json:"template"`
}

Main information about computeci

type ListComputeCI

type ListComputeCI []ItemComputeCI

List of computeci instances

type ListRequest

type ListRequest struct {
	// If true list deleted instances as well
	// Required: false
	IncludeDeleted bool `url:"includeDeleted,omitempty" json:"includeDeleted,omitempty"`

	// Page number
	// Required: false
	Page uint64 `url:"page,omitempty" json:"page,omitempty"`

	// Page size
	// Required: false
	Size uint64 `url:"size,omitempty" json:"size,omitempty"`
}

Request struct for get list of computeci

Jump to

Keyboard shortcuts

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