flipgroup

package
v1.4.2 Latest Latest
Warning

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

 Go to latest Published: May 15, 2023 License: Apache-2.0 Imports: 8 Imported by: 0

Documentation

Overview

API to manage FLIPGroup instances

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ComputeAddRequest 

type ComputeAddRequest struct {
	// ID of the Floating IP group to add compute instance to
	// Required: true
	FLIPGroupID uint64 `url:"flipgroupId" json:"flipgroupId" validate:"required"`

	// ID of the compute instance to add to this group
	// Required: true
	ComputeID uint64 `url:"computeId" json:"computeId" validate:"required"`
}

Request struct for add compute instance

type ComputeRemoveRequest 

type ComputeRemoveRequest struct {
	// ID of the Floating IP group to remove compute instance from
	// Required: true
	FLIPGroupID uint64 `url:"flipgroupId" json:"flipgroupId" validate:"required"`

	// ID of the compute instance to remove
	// Required: true
	ComputeID uint64 `url:"computeId" json:"computeId" validate:"required"`
}

Request struct for remove compute instance

type CreateRequest 

type CreateRequest struct {
	// Account ID
	// Required: true
	AccountID uint64 `url:"accountId" json:"accountId" validate:"required"`

	// FLIPGroup name
	// Required: true
	Name string `url:"name" json:"name" validate:"required"`

	// Network type
	// Should be one of:
	//	- EXTNET
	//	- VINS
	// Required: true
	NetType string `url:"netType" json:"netType" validate:"computeNetType"`

	// ID of external network or VINS
	// Required: true
	NetID uint64 `url:"netId" json:"netId" validate:"required"`

	// Type of client
	//	- 'compute'
	//	- 'vins' (will be later)
	// Required: true
	ClientType string `url:"clientType" json:"clientType" validate:"flipgroupClientType"`

	// IP address to associate with this group. If empty, the platform will autoselect IP address
	// Required: false
	IP string `url:"ip,omitempty" json:"ip,omitempty"`

	// Text description of this FLIPGorup instance
	// Required: false
	Description string `url:"desc,omitempty" json:"desc,omitempty"`
}

Request struct for create FLIPGroup

type DeleteRequest 

type DeleteRequest struct {
	// FLIPGroup ID
	// Required: true
	FLIPGroupID uint64 `url:"flipgroupId" json:"flipgroupId" validate:"required"`
}

Request struct for delete FLIPGroup

type EditRequest 

type EditRequest struct {
	// FLIPGroup ID
	// Required: true
	FLIPGroupID uint64 `url:"flipgroupId" json:"flipgroupId" validate:"required"`

	// FLIPGroup name
	// Required: false
	Name string `url:"name,omitempty" json:"name,omitempty"`

	// FLIPGroup description
	// Required: false
	Description string `url:"desc,omitempty" json:"desc,omitempty"`
}

Request struct for edit FLIPGroup

type FLIPGroup 

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

Structure for creating request to FLIPGroup

func New 

func New(client interfaces.Caller) *FLIPGroup

Builder for FLIPGroup endpoints

func (FLIPGroup) ComputeAdd 

func (f FLIPGroup) ComputeAdd(ctx context.Context, req ComputeAddRequest) (bool, error)

ComputeAdd add compute instance to the Floating IP group

func (FLIPGroup) ComputeRemove 

func (f FLIPGroup) ComputeRemove(ctx context.Context, req ComputeRemoveRequest) (bool, error)

ComputeRemove remove compute instance from the Floating IP group

func (FLIPGroup) Create 

func (f FLIPGroup) Create(ctx context.Context, req CreateRequest) (*RecordFLIPGroup, error)

Create method will create a new FLIPGorup in the specified Account

func (FLIPGroup) Delete 

func (f FLIPGroup) Delete(ctx context.Context, req DeleteRequest) (bool, error)

Delete method wil delete Floating IP group

func (FLIPGroup) Edit 

func (f FLIPGroup) Edit(ctx context.Context, req EditRequest) (bool, error)

Edit edits FLIPGroup fields

func (FLIPGroup) Get 

func (f FLIPGroup) Get(ctx context.Context, req GetRequest) (*ItemFLIPGroup, error)

Get gets details of the specified Floating IP group

func (FLIPGroup) List 

func (f FLIPGroup) List(ctx context.Context, req ListRequest) (ListFLIPGroups, error)

List gets list FLIPGroup managed cluster instances available to the current user

type GetRequest 

type GetRequest struct {
	// FLIPGroup ID
	// Required: true
	FLIPGroupID uint64 `url:"flipgroupId" json:"flipgroupId" validate:"required"`
}

Request struct for get information about FLIPGroup

type ItemFLIPGroup 

type ItemFLIPGroup struct {
	// Account ID
	AccountID uint64 `json:"accountId"`

	// Account name
	AccountName string `json:"accountName"`

	// List of client IDs
	ClientIDs []uint64 `json:"clientIds"`

	// Client names list
	ClientNames []string `json:"clientNames"`

	// Client type
	ClientType string `json:"clientType"`

	// Connection ID
	ConnID uint64 `json:"connId"`

	// Connection type
	ConnType string `json:"connType"`

	// Created by
	CreatedBy string `json:"createdBy"`

	// Created time
	CreatedTime uint64 `json:"createdTime"`

	// Default GW
	DefaultGW string `json:"defaultGW"`

	// Deleted by
	DeletedBy string `json:"deletedBy"`

	// Deleted time
	DeletedTime uint64 `json:"deletedTime"`

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

	// Grid ID
	GID uint64 `json:"gid"`

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

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

	// IP
	IP string `json:"ip"`

	// Milestones
	Milestones uint64 `json:"milestones"`

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

	// Network ID
	NetID uint64 `json:"netId"`

	// Network type
	NetType string `json:"netType"`

	// Network
	Network string `json:"network"`

	// Resource group ID
	RGID uint64 `json:"rgId"`

	// Resource group name
	RGName string `json:"rgName"`

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

	// Updated by
	UpdatedBy string `json:"updatedBy"`

	// Updated time
	UpdatedTime uint64 `json:"updatedTime"`
}

Detailed information about FLIPGroup

func (ItemFLIPGroup) Serialize 

func (ifg ItemFLIPGroup) Serialize(params ...string) (serialization.Serialized, error)

Serialize returns JSON-serialized []byte. Used as a wrapper over json.Marshal and json.MarshalIndent functions.

In order to serialize with indent make sure to follow these guidelines:

  • First argument -> prefix
  • Second argument -> indent

type ListFLIPGroups 

type ListFLIPGroups []ItemFLIPGroup

List of FLIPGroup

func (ListFLIPGroups) FilterByAccountID 

func (lfg ListFLIPGroups) FilterByAccountID(accountID uint64) ListFLIPGroups

FilterByAccountID returns ListFLIPGroups with specified AccountID.

func (ListFLIPGroups) FilterByCreatedBy 

func (lfg ListFLIPGroups) FilterByCreatedBy(createdBy string) ListFLIPGroups

FilterByCreatedBy returns ListFLIPGroups created by specified user.

func (ListFLIPGroups) FilterByDeletedBy 

func (lfg ListFLIPGroups) FilterByDeletedBy(deletedBy string) ListFLIPGroups

FilterByDeletedBy returns ListFLIPGroups deleted by specified user.

func (ListFLIPGroups) FilterByID 

func (lfg ListFLIPGroups) FilterByID(id uint64) ListFLIPGroups

FilterByID returns ListFLIPGroups with specified ID.

func (ListFLIPGroups) FilterByName 

func (lfg ListFLIPGroups) FilterByName(name string) ListFLIPGroups

FilterByName returns ListFLIPGroups with specified Name.

func (ListFLIPGroups) FilterByRGID 

func (lfg ListFLIPGroups) FilterByRGID(rgID uint64) ListFLIPGroups

FilterByRGID returns ListFLIPGroups with specified RGID.

func (ListFLIPGroups) FilterByStatus 

func (lfg ListFLIPGroups) FilterByStatus(status string) ListFLIPGroups

FilterByStatus returns ListFLIPGroups with specified Status.

func (ListFLIPGroups) FilterByUpdatedBy 

func (lfg ListFLIPGroups) FilterByUpdatedBy(updatedBy string) ListFLIPGroups

FilterByUpdatedBy returns ListFLIPGroups updated by specified user.

func (ListFLIPGroups) FilterFunc 

func (lfg ListFLIPGroups) FilterFunc(predicate func(ItemFLIPGroup) bool) ListFLIPGroups

FilterFunc allows filtering ListFLIPGroups based on a user-specified predicate.

func (ListFLIPGroups) FindOne 

func (lfg ListFLIPGroups) FindOne() ItemFLIPGroup

FindOne returns first found ItemFLIPGroup If none was found, returns an empty struct.

func (ListFLIPGroups) Serialize 

func (lfg ListFLIPGroups) Serialize(params ...string) (serialization.Serialized, error)

Serialize returns JSON-serialized []byte. Used as a wrapper over json.Marshal and json.MarshalIndent functions.

In order to serialize with indent make sure to follow these guidelines:

  • First argument -> prefix
  • Second argument -> indent

func (ListFLIPGroups) SortByCreatedTime 

func (lfg ListFLIPGroups) SortByCreatedTime(inverse bool) ListFLIPGroups

SortByCreatedTime sorts ListFLIPGroups by the CreatedTime field in ascending order.

If inverse param is set to true, the order is reversed.

func (ListFLIPGroups) SortByDeletedTime 

func (lfg ListFLIPGroups) SortByDeletedTime(inverse bool) ListFLIPGroups

SortByDeletedTime sorts ListFLIPGroups by the DeletedTime field in ascending order.

If inverse param is set to true, the order is reversed.

func (ListFLIPGroups) SortByUpdatedTime 

func (lfg ListFLIPGroups) SortByUpdatedTime(inverse bool) ListFLIPGroups

SortByUpdatedTime sorts ListFLIPGroups by the UpdatedTime field in ascending order.

If inverse param is set to true, the order is reversed.

type ListRequest 

type ListRequest struct {
	// 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 FLIPGroup available to the current user

type RecordFLIPGroup 

type RecordFLIPGroup struct {
	// Default GW
	DefaultGW string `json:"defaultGW"`

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

	// IP
	IP string `json:"ip"`

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

	// Network mask
	NetMask uint64 `json:"netmask"`
}

Main information about FLIPGroup

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.