api

package
v4.0.1-alpha.1 Latest Latest
Warning

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

 Go to latest Published: Oct 11, 2022 License: UNKNOWN not legal advice Imports: 8 Imported by: 0

Documentation

Overview

Api classes for lcm's golang SDK

Api classes for lcm's golang SDK

Api classes for lcm's golang SDK

Api classes for lcm's golang SDK

Api classes for lcm's golang SDK

Api classes for lcm's golang SDK

Api classes for lcm's golang SDK

Api classes for lcm's golang SDK

Api classes for lcm's golang SDK

Api classes for lcm's golang SDK

Api classes for lcm's golang SDK

Api classes for lcm's golang SDK

Api classes for lcm's golang SDK

Api classes for lcm's golang SDK

Api classes for lcm's golang SDK

Api classes for lcm's golang SDK

Api classes for lcm's golang SDK

Api classes for lcm's golang SDK

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type BundlesApi 

type BundlesApi struct {
	ApiClient *client.ApiClient
}

func NewBundlesApi 

func NewBundlesApi(apiClient *client.ApiClient) *BundlesApi

func (*BundlesApi) DeleteBundle 

func (api *BundlesApi) DeleteBundle(uuid *string, args ...map[string]interface{}) (*import1.DelBundleApiResponse, error)

* 

DeleteBundle
Delete bundle for the specified UUID.

parameters:-
-> uuid (string) (required) : UUID of the LCM bundle
-> args (map[string]interface{}) (optional) : Additional Arguments

returns: (*lcm.v4.resources.DelBundleApiResponse, error)

func (*BundlesApi) GetBundle 

func (api *BundlesApi) GetBundle(uuid *string, args ...map[string]interface{}) (*import1.GetBundleInfoApiResponse, error)

* 

GetBundle
Get bundle details for bundle UUID.

parameters:-
-> uuid (string) (required) : UUID of the LCM bundle
-> args (map[string]interface{}) (optional) : Additional Arguments

returns: (*lcm.v4.resources.GetBundleInfoApiResponse, error)

func (*BundlesApi) GetBundles 

func (api *BundlesApi) GetBundles(page_ *int, limit_ *int, filter_ *string, args ...map[string]interface{}) (*import1.GetBundlesApiResponse, error)

* 

GetBundles
Query list of bundles

parameters:-
-> page_ (int) (optional) : A URL query parameter that specifies the page number of the result set.  Must be a positive integer between 0 and the maximum number of pages that are available for that resource.  Any number out of this range will be set to its nearest bound.  In other words, a page number of less than 0 would be set to 0 and a page number greater than the total available pages would be set to the last page.
-> limit_ (int) (optional) : A URL query parameter that specifies the total number of records returned in the result set.  Must be a positive integer between 0 and 100. Any number out of this range will be set to the default maximum number of records, which is 100.
-> filter_ (string) (optional) : A URL query parameter that allows clients to filter a collection of resources. The expression specified with $filter is evaluated for each resource in the collection, and only items where the expression evaluates to true are included in the response. Expression specified with the $filter must conform to the OData V4.01 URL conventions. The filter can be applied on the following fields: - type
-> args (map[string]interface{}) (optional) : Additional Arguments

returns: (*lcm.v4.resources.GetBundlesApiResponse, error)

func (*BundlesApi) PostBundle 

func (api *BundlesApi) PostBundle(body *import1.LcmBundlesSpec, args ...map[string]interface{}) (*import1.PostBundlesApiResponse, error)

* 

PostBundle
Create a bundle

parameters:-
-> body (lcm.v4.resources.LcmBundlesSpec) (optional)
-> args (map[string]interface{}) (optional) : Additional Arguments

returns: (*lcm.v4.resources.PostBundlesApiResponse, error)

func (*BundlesApi) PutBundle 

func (api *BundlesApi) PutBundle(uuid *string, body *string, args ...map[string]interface{}) (*import1.PutBundleApiResponse, error)

* 

PutBundle
Update bundle information for a specified UUID

parameters:-
-> uuid (string) (required) : UUID of the LCM bundle
-> body (string) (optional) : The file stream being uploaded into a bundle
-> args (map[string]interface{}) (optional) : Additional Arguments

returns: (*lcm.v4.resources.PutBundleApiResponse, error)

type CancelUpdateApi 

type CancelUpdateApi struct {
	ApiClient *client.ApiClient
}

func NewCancelUpdateApi 

func NewCancelUpdateApi(apiClient *client.ApiClient) *CancelUpdateApi

func (*CancelUpdateApi) PostCancelUpdate 

func (api *CancelUpdateApi) PostCancelUpdate(args ...map[string]interface{}) (*import2.CancelUpdateApiResponse, error)

* 

Set intent to cancel ongoing LCM update
Cancel LCM Update

parameters:-
-> args (map[string]interface{}) (optional) : Additional Arguments

returns: (*lcm.v4.operations.CancelUpdateApiResponse, error)

type ConfigApi 

type ConfigApi struct {
	ApiClient *client.ApiClient
}

func NewConfigApi 

func NewConfigApi(apiClient *client.ApiClient) *ConfigApi

func (*ConfigApi) GetConfig 

func (api *ConfigApi) GetConfig(args ...map[string]interface{}) (*import1.GetLcmConfigApiResponse, error)

* 

Get the present LCM configuration
Get LCM configuration

parameters:-
-> args (map[string]interface{}) (optional) : Additional Arguments

returns: (*lcm.v4.resources.GetLcmConfigApiResponse, error)

func (*ConfigApi) PutConfig 

func (api *ConfigApi) PutConfig(body *import1.LcmConfig, args ...map[string]interface{}) (*import1.PutLcmConfigApiResponse, error)

* 

Change the LCM configuration
Update LCM configuration

parameters:-
-> body (lcm.v4.resources.LcmConfig) (optional)
-> args (map[string]interface{}) (optional) : Additional Arguments

returns: (*lcm.v4.resources.PutLcmConfigApiResponse, error)

type DownloadApi 

type DownloadApi struct {
	ApiClient *client.ApiClient
}

func NewDownloadApi 

func NewDownloadApi(apiClient *client.ApiClient) *DownloadApi

func (*DownloadApi) Download 

func (api *DownloadApi) Download(body *import3.ImageDownloadSpecs, args ...map[string]interface{}) (*import2.GetDownloadApiResponse, error)

* 

Download an image of a product through LCM
Initiate LCM image download

parameters:-
-> body (lcm.v4.common.ImageDownloadSpecs) (optional)
-> args (map[string]interface{}) (optional) : Additional Arguments

returns: (*lcm.v4.operations.GetDownloadApiResponse, error)

type EntityApi 

type EntityApi struct {
	ApiClient *client.ApiClient
}

func NewEntityApi 

func NewEntityApi(apiClient *client.ApiClient) *EntityApi

func (*EntityApi) GetEntities 

func (api *EntityApi) GetEntities(page_ *int, limit_ *int, filter_ *string, args ...map[string]interface{}) (*import1.GetEntitiesApiResponse, error)

* 

Get details about all LCM entities
Query list of LCM entities

parameters:-
-> page_ (int) (optional) : A URL query parameter that specifies the page number of the result set.  Must be a positive integer between 0 and the maximum number of pages that are available for that resource.  Any number out of this range will be set to its nearest bound.  In other words, a page number of less than 0 would be set to 0 and a page number greater than the total available pages would be set to the last page.
-> limit_ (int) (optional) : A URL query parameter that specifies the total number of records returned in the result set.  Must be a positive integer between 0 and 100. Any number out of this range will be set to the default maximum number of records, which is 100.
-> filter_ (string) (optional) : A URL query parameter that allows clients to filter a collection of resources. The expression specified with $filter is evaluated for each resource in the collection, and only items where the expression evaluates to true are included in the response. Expression specified with the $filter must conform to the OData V4.01 URL conventions. The filter can be applied on the following fields: - entityClass - entityModel - entityType
-> args (map[string]interface{}) (optional) : Additional Arguments

returns: (*lcm.v4.resources.GetEntitiesApiResponse, error)

func (*EntityApi) GetEntity 

func (api *EntityApi) GetEntity(uuid *string, args ...map[string]interface{}) (*import1.GetEntityApiResponse, error)

* 

Get details about an LCM entity
Get details about an LCM entity

parameters:-
-> uuid (string) (required) : UUID of the entity to be used
-> args (map[string]interface{}) (optional) : Additional Arguments

returns: (*lcm.v4.resources.GetEntityApiResponse, error)

type HistoryApi 

type HistoryApi struct {
	ApiClient *client.ApiClient
}

func NewHistoryApi 

func NewHistoryApi(apiClient *client.ApiClient) *HistoryApi

func (*HistoryApi) GetHistory 

func (api *HistoryApi) GetHistory(page_ *int, limit_ *int, filter_ *string, args ...map[string]interface{}) (*import1.GetHistoryApiResponse, error)

* 

Get history of all LCM operations on this cluster
Get history of LCM operations

parameters:-
-> page_ (int) (optional) : A URL query parameter that specifies the page number of the result set.  Must be a positive integer between 0 and the maximum number of pages that are available for that resource.  Any number out of this range will be set to its nearest bound.  In other words, a page number of less than 0 would be set to 0 and a page number greater than the total available pages would be set to the last page.
-> limit_ (int) (optional) : A URL query parameter that specifies the total number of records returned in the result set.  Must be a positive integer between 0 and 100. Any number out of this range will be set to the default maximum number of records, which is 100.
-> filter_ (string) (optional) : A URL query parameter that allows clients to filter a collection of resources. The expression specified with $filter is evaluated for each resource in the collection, and only items where the expression evaluates to true are included in the response. Expression specified with the $filter must conform to the OData V4.01 URL conventions. The filter can be applied on the following fields: - operationId - operationType - startTime
-> args (map[string]interface{}) (optional) : Additional Arguments

returns: (*lcm.v4.resources.GetHistoryApiResponse, error)

func (*HistoryApi) GetHistoryByUuid 

func (api *HistoryApi) GetHistoryByUuid(uuid *string, args ...map[string]interface{}) (*import1.GetHistoryByUuidApiResponse, error)

* 

Get history of a specific LCM operation on this cluster
Get LCM operation history for a specified UUID

parameters:-
-> uuid (string) (required) : UUID of an LCM operation
-> args (map[string]interface{}) (optional) : Additional Arguments

returns: (*lcm.v4.resources.GetHistoryByUuidApiResponse, error)

type ImagesApi 

type ImagesApi struct {
	ApiClient *client.ApiClient
}

func NewImagesApi 

func NewImagesApi(apiClient *client.ApiClient) *ImagesApi

func (*ImagesApi) GetImages 

func (api *ImagesApi) GetImages(page_ *int, limit_ *int, filter_ *string, args ...map[string]interface{}) (*import1.GetImagesApiResponse, error)

* 

Get the list of downloaded LCM images
Get the list of downloaded LCM images

parameters:-
-> page_ (int) (optional) : A URL query parameter that specifies the page number of the result set.  Must be a positive integer between 0 and the maximum number of pages that are available for that resource.  Any number out of this range will be set to its nearest bound.  In other words, a page number of less than 0 would be set to 0 and a page number greater than the total available pages would be set to the last page.
-> limit_ (int) (optional) : A URL query parameter that specifies the total number of records returned in the result set.  Must be a positive integer between 0 and 100. Any number out of this range will be set to the default maximum number of records, which is 100.
-> filter_ (string) (optional) : A URL query parameter that allows clients to filter a collection of resources. The expression specified with $filter is evaluated for each resource in the collection, and only items where the expression evaluates to true are included in the response. Expression specified with the $filter must conform to the OData V4.01 URL conventions. The filter can be applied on the following fields: - entityClass - entityModel - hardwareFamily - version
-> args (map[string]interface{}) (optional) : Additional Arguments

returns: (*lcm.v4.resources.GetImagesApiResponse, error)

type InventoryApi 

type InventoryApi struct {
	ApiClient *client.ApiClient
}

func NewInventoryApi 

func NewInventoryApi(apiClient *client.ApiClient) *InventoryApi

func (*InventoryApi) Inventory 

func (api *InventoryApi) Inventory(args ...map[string]interface{}) (*import2.InventoryApiResponse, error)

* 

Perform an inventory operation to identify entities that can be updated through LCM
Perform an LCM inventory operation

parameters:-
-> args (map[string]interface{}) (optional) : Additional Arguments

returns: (*lcm.v4.operations.InventoryApiResponse, error)

type LogBayApi 

type LogBayApi struct {
	ApiClient *client.ApiClient
}

func NewLogBayApi 

func NewLogBayApi(apiClient *client.ApiClient) *LogBayApi

func (*LogBayApi) GetLogbayItems 

func (api *LogBayApi) GetLogbayItems(page_ *int, limit_ *int, args ...map[string]interface{}) (*import1.GetLogBayItemsApiResponse, error)

* 

Get Logbay items needed for collecting LCM logs
Get NCC Logbay items needed for collecting LCM logs

parameters:-
-> page_ (int) (optional) : A URL query parameter that specifies the page number of the result set.  Must be a positive integer between 0 and the maximum number of pages that are available for that resource.  Any number out of this range will be set to its nearest bound.  In other words, a page number of less than 0 would be set to 0 and a page number greater than the total available pages would be set to the last page.
-> limit_ (int) (optional) : A URL query parameter that specifies the total number of records returned in the result set.  Must be a positive integer between 0 and 100. Any number out of this range will be set to the default maximum number of records, which is 100.
-> args (map[string]interface{}) (optional) : Additional Arguments

returns: (*lcm.v4.resources.GetLogBayItemsApiResponse, error)

func (*LogBayApi) GetLogbayTags 

func (api *LogBayApi) GetLogbayTags(page_ *int, limit_ *int, args ...map[string]interface{}) (*import1.GetLogBayTagsApiResponse, error)

* 

Get Logbay tags used for collecting LCM logs
Get NCC Logbay tags used for collecting LCM logs

parameters:-
-> page_ (int) (optional) : A URL query parameter that specifies the page number of the result set.  Must be a positive integer between 0 and the maximum number of pages that are available for that resource.  Any number out of this range will be set to its nearest bound.  In other words, a page number of less than 0 would be set to 0 and a page number greater than the total available pages would be set to the last page.
-> limit_ (int) (optional) : A URL query parameter that specifies the total number of records returned in the result set.  Must be a positive integer between 0 and 100. Any number out of this range will be set to the default maximum number of records, which is 100.
-> args (map[string]interface{}) (optional) : Additional Arguments

returns: (*lcm.v4.resources.GetLogBayTagsApiResponse, error)

type ModuleConfigApi 

type ModuleConfigApi struct {
	ApiClient *client.ApiClient
}

func NewModuleConfigApi 

func NewModuleConfigApi(apiClient *client.ApiClient) *ModuleConfigApi

func (*ModuleConfigApi) GetModuleConfig 

func (api *ModuleConfigApi) GetModuleConfig(args ...map[string]interface{}) (*import1.GetModuleConfigApiResponse, error)

* 

Get LCM module configuration
Get LCM module configuration

parameters:-
-> args (map[string]interface{}) (optional) : Additional Arguments

returns: (*lcm.v4.resources.GetModuleConfigApiResponse, error)

func (*ModuleConfigApi) SetModuleConfig 

func (api *ModuleConfigApi) SetModuleConfig(body *import1.ModuleConfig, args ...map[string]interface{}) (*import1.PutModuleConfigApiResponse, error)

* 

Update the LCM module configuration
Update LCM module configuration

parameters:-
-> body (lcm.v4.resources.ModuleConfig) (optional)
-> args (map[string]interface{}) (optional) : Additional Arguments

returns: (*lcm.v4.resources.PutModuleConfigApiResponse, error)

type NodePriorityConfigApi 

type NodePriorityConfigApi struct {
	ApiClient *client.ApiClient
}

func NewNodePriorityConfigApi 

func NewNodePriorityConfigApi(apiClient *client.ApiClient) *NodePriorityConfigApi

func (*NodePriorityConfigApi) GetNodePriorities 

func (api *NodePriorityConfigApi) GetNodePriorities(args ...map[string]interface{}) (*import1.GetNodePrioritiesApiResponse, error)

* 

Get the order in which nodes will be upgraded
Get node priorities

parameters:-
-> args (map[string]interface{}) (optional) : Additional Arguments

returns: (*lcm.v4.resources.GetNodePrioritiesApiResponse, error)

func (*NodePriorityConfigApi) GetNodePriority 

func (api *NodePriorityConfigApi) GetNodePriority(nodeUuid *string, args ...map[string]interface{}) (*import1.GetNodePriorityNodeApiResponse, error)

* 

Get the node priority of a node by UUID
Get node priority value of a node

parameters:-
-> nodeUuid (string) (required) : UUID of a node in the cluster
-> args (map[string]interface{}) (optional) : Additional Arguments

returns: (*lcm.v4.resources.GetNodePriorityNodeApiResponse, error)

func (*NodePriorityConfigApi) PostNodePriorities 

func (api *NodePriorityConfigApi) PostNodePriorities(body *import1.NodePriorityConfig, args ...map[string]interface{}) (*import1.PostNodePrioritiesApiResponse, error)

* 

Set the order in which nodes will be upgraded
Update node priority of the node

parameters:-
-> body (lcm.v4.resources.NodePriorityConfig) (optional)
-> args (map[string]interface{}) (optional) : Additional Arguments

returns: (*lcm.v4.resources.PostNodePrioritiesApiResponse, error)

type NotificationsApi 

type NotificationsApi struct {
	ApiClient *client.ApiClient
}

func NewNotificationsApi 

func NewNotificationsApi(apiClient *client.ApiClient) *NotificationsApi

func (*NotificationsApi) GenUpgradeNotifications 

func (api *NotificationsApi) GenUpgradeNotifications(body *import3.EntityUpdateSpecs, args ...map[string]interface{}) (*import1.GenUpgradeNotifApiResponse, error)

* 

Generate LCM upgrade notifications
Generate LCM upgrade notifications

parameters:-
-> body (lcm.v4.common.EntityUpdateSpecs) (optional)
-> args (map[string]interface{}) (optional) : Additional Arguments

returns: (*lcm.v4.resources.GenUpgradeNotifApiResponse, error)

type PlanApi 

type PlanApi struct {
	ApiClient *client.ApiClient
}

func NewPlanApi 

func NewPlanApi(apiClient *client.ApiClient) *PlanApi

func (*PlanApi) GetPlan 

func (api *PlanApi) GetPlan(body *import3.EntityUpdateSpecs, args ...map[string]interface{}) (*import1.GenUpgradePlanApiResponse, error)

* 

Generate an upgrade plan that specifies the impact of the upgrade on the cluster
Generate an LCM upgrade plan

parameters:-
-> body (lcm.v4.common.EntityUpdateSpecs) (optional)
-> args (map[string]interface{}) (optional) : Additional Arguments

returns: (*lcm.v4.resources.GenUpgradePlanApiResponse, error)

type PrecheckApi 

type PrecheckApi struct {
	ApiClient *client.ApiClient
}

func NewPrecheckApi 

func NewPrecheckApi(apiClient *client.ApiClient) *PrecheckApi

func (*PrecheckApi) Precheck 

func (api *PrecheckApi) Precheck(body *import3.PrecheckSpec, args ...map[string]interface{}) (*import2.PrecheckApiResponse, error)

* 

Perform a LCM precheck operation
Perform LCM precheck

parameters:-
-> body (lcm.v4.common.PrecheckSpec) (optional)
-> args (map[string]interface{}) (optional) : Additional Arguments

returns: (*lcm.v4.operations.PrecheckApiResponse, error)

type RecommendationsApi 

type RecommendationsApi struct {
	ApiClient *client.ApiClient
}

func NewRecommendationsApi 

func NewRecommendationsApi(apiClient *client.ApiClient) *RecommendationsApi

func (*RecommendationsApi) GetRecommendations 

func (api *RecommendationsApi) GetRecommendations(body *import1.RecommendationSpec, args ...map[string]interface{}) (*import1.GetUpdateRecApiResponse, error)

* 

Get a list of update recommendations from LCM
Get LCM update recommendations

parameters:-
-> body (lcm.v4.resources.RecommendationSpec) (optional)
-> args (map[string]interface{}) (optional) : Additional Arguments

returns: (*lcm.v4.resources.GetUpdateRecApiResponse, error)

type StatusApi 

type StatusApi struct {
	ApiClient *client.ApiClient
}

func NewStatusApi 

func NewStatusApi(apiClient *client.ApiClient) *StatusApi

func (*StatusApi) GetStatus 

func (api *StatusApi) GetStatus(args ...map[string]interface{}) (*import1.GetLcmStatusApiResponse, error)

* 

Get the LCM framework status
Get the LCM framework status

parameters:-
-> args (map[string]interface{}) (optional) : Additional Arguments

returns: (*lcm.v4.resources.GetLcmStatusApiResponse, error)

type TaskApi 

type TaskApi struct {
	ApiClient *client.ApiClient
}

func NewTaskApi 

func NewTaskApi(apiClient *client.ApiClient) *TaskApi

func (*TaskApi) GetTaskByUuid 

func (api *TaskApi) GetTaskByUuid(uuid *string, args ...map[string]interface{}) (*import1.GetTaskByUuidApiResponse, error)

* 

Get details of an LCM task identified by the UUID
Get details of an LCM task identified by the UUID

parameters:-
-> uuid (string) (required) : UUID of LCM task
-> args (map[string]interface{}) (optional) : Additional Arguments

returns: (*lcm.v4.resources.GetTaskByUuidApiResponse, error)

type UpdateApi 

type UpdateApi struct {
	ApiClient *client.ApiClient
}

func NewUpdateApi 

func NewUpdateApi(apiClient *client.ApiClient) *UpdateApi

func (*UpdateApi) Update 

func (api *UpdateApi) Update(body *import3.UpdateSpec, args ...map[string]interface{}) (*import2.UpdateApiResponse, error)

* 

Perform an LCM update operation
Perform an LCM update operation

parameters:-
-> body (lcm.v4.common.UpdateSpec) (optional)
-> args (map[string]interface{}) (optional) : Additional Arguments

returns: (*lcm.v4.operations.UpdateApiResponse, error)

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.