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: Aug 30, 2022 License: UNKNOWN not legal advice Imports: 6 Imported by: 0

Documentation

Overview

Api classes for vmm's golang SDK

Api classes for vmm's golang SDK

Api classes for vmm's golang SDK

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ImagesApi 

type ImagesApi struct {
	ApiClient *client.ApiClient
}

func NewImagesApi 

func NewImagesApi(apiClient *client.ApiClient) *ImagesApi

func (*ImagesApi) CreateImage 

func (api *ImagesApi) CreateImage(body *import1.Image, args ...map[string]interface{}) (*import1.ImagesTaskApiResponse, error)

* 

Create an image.
Create an image.

parameters:-
-> body (vmm.v4.images.Image) (required) : Create image request.
-> args (map[string]interface{}) (optional) : Additional Arguments

returns: (vmm.v4.images.ImagesTaskApiResponse, error)

func (*ImagesApi) DeleteImageByExtId 

func (api *ImagesApi) DeleteImageByExtId(extId *string, args ...map[string]interface{}) (*import1.ImagesTaskApiResponse, error)

* 

Delete an image.
Delete the image with the given extId.

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

returns: (vmm.v4.images.ImagesTaskApiResponse, error)

func (*ImagesApi) GetImageByExtId 

func (api *ImagesApi) GetImageByExtId(extId *string, args ...map[string]interface{}) (*import1.ImageApiResponse, error)

* 

Get an image.
Get image details with the given extId.

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

returns: (vmm.v4.images.ImageApiResponse, error)

func (*ImagesApi) GetImageCategories 

func (api *ImagesApi) GetImageCategories(extId *string, args ...map[string]interface{}) (*import1.ImageCategoriesApiResponse, error)

* 

Get image categories.
Get image categories for a given extId.

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

returns: (vmm.v4.images.ImageCategoriesApiResponse, error)

func (*ImagesApi) GetImageClusterLocations 

func (api *ImagesApi) GetImageClusterLocations(extId *string, args ...map[string]interface{}) (*import1.ImageClusterLocationListApiResponse, error)

* 

Get Prism Element locations for an image.
Get the Prism Element locations where the image is currently available.

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

returns: (vmm.v4.images.ImageClusterLocationListApiResponse, error)

func (*ImagesApi) GetImagePlacementPolicies 

func (api *ImagesApi) GetImagePlacementPolicies(extId *string, args ...map[string]interface{}) (*import1.ImagePlacementPolicyListApiResponse, error)

* 

Get placement policies for an image.
Get the current image placement policies for an image.

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

returns: (vmm.v4.images.ImagePlacementPolicyListApiResponse, error)

func (*ImagesApi) GetImagesList 

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

* 

List images.
List 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: - description - name - sizeBytes
-> orderby_ (string) (optional) : A URL query parameter that allows clients to specify the sort criteria for the returned list of objects. Resources can be sorted in ascending order using asc or descending order using desc. If asc or desc are not specified the resources will be sorted in ascending order by default. For example, 'orderby=templateName desc' would get all templates sorted by templateName in desc order. The orderby can be applied to the following fields: - description - name - sizeBytes
-> args (map[string]interface{}) (optional) : Additional Arguments

returns: (vmm.v4.images.ImageListApiResponse, error)

func (*ImagesApi) ImportImage 

func (api *ImagesApi) ImportImage(body *import1.ClusterImages, args ...map[string]interface{}) (*import1.ImagesTaskApiResponse, error)

* 

Import images from Prism Element.
Import images owned by a registered Prism Element cluster to the current Prism Central.

parameters:-
-> body (vmm.v4.images.ClusterImages) (required) : Reference to the Prism Element cluster and its images to import.
-> args (map[string]interface{}) (optional) : Additional Arguments

returns: (vmm.v4.images.ImagesTaskApiResponse, error)

func (*ImagesApi) RemoteCopyImage 

func (api *ImagesApi) RemoteCopyImage(body *[]import1.ImageReference, args ...map[string]interface{}) (*import1.ImagesTaskApiResponse, error)

* 

Copy images to a remote Prism Central.
Copy the given images to a remote paired Prism Central.

parameters:-
-> body ([]vmm.v4.images.ImageReference) (required) : Ids of the images to copy to the paired Prism Central.
-> args (map[string]interface{}) (optional) : Additional Arguments

returns: (vmm.v4.images.ImagesTaskApiResponse, error)

func (*ImagesApi) UpdateImageByExtId 

func (api *ImagesApi) UpdateImageByExtId(body *import1.Image, extId *string, args ...map[string]interface{}) (*import1.ImagesTaskApiResponse, error)

* 

Update an image.
Update the image with the given extId.

parameters:-
-> body (vmm.v4.images.Image) (required) : Updated image with the given extId.
-> extId (string) (required)
-> args (map[string]interface{}) (optional) : Additional Arguments

returns: (vmm.v4.images.ImagesTaskApiResponse, error)

func (*ImagesApi) UpdateImageCategories 

func (api *ImagesApi) UpdateImageCategories(body *[]import1.CategoryReference, extId *string, args ...map[string]interface{}) (*import1.ImagesTaskApiResponse, error)

* 

Update image categories.
Replace the attached image categories with the given extId.

parameters:-
-> body ([]vmm.v4.images.CategoryReference) (required) : The desired categories for the image.
-> extId (string) (required)
-> args (map[string]interface{}) (optional) : Additional Arguments

returns: (vmm.v4.images.ImagesTaskApiResponse, error)

type PlacementPoliciesApi 

type PlacementPoliciesApi struct {
	ApiClient *client.ApiClient
}

func NewPlacementPoliciesApi 

func NewPlacementPoliciesApi(apiClient *client.ApiClient) *PlacementPoliciesApi

func (*PlacementPoliciesApi) CreatePlacementPolicy 

func (api *PlacementPoliciesApi) CreatePlacementPolicy(body *import1.PlacementPolicy, args ...map[string]interface{}) (*import1.ImagesTaskApiResponse, error)

* 

Create an image placement policy.
Create an image placement policy.

parameters:-
-> body (vmm.v4.images.PlacementPolicy) (required) : Image placement policy to create.
-> args (map[string]interface{}) (optional) : Additional Arguments

returns: (vmm.v4.images.ImagesTaskApiResponse, error)

func (*PlacementPoliciesApi) DeletePlacementPolicyByExtId 

func (api *PlacementPoliciesApi) DeletePlacementPolicyByExtId(extId *string, args ...map[string]interface{}) (*import1.ImagesTaskApiResponse, error)

* 

Delete an image placement policy.
Delete the image placement policy with the given extId.

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

returns: (vmm.v4.images.ImagesTaskApiResponse, error)

func (*PlacementPoliciesApi) GetPlacementPoliciesList 

func (api *PlacementPoliciesApi) GetPlacementPoliciesList(page_ *int, limit_ *int, filter_ *string, orderby_ *string, args ...map[string]interface{}) (*import1.PlacementPolicyListApiResponse, error)

* 

List image placement policies.
List of image placement policies.

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: - description - name
-> orderby_ (string) (optional) : A URL query parameter that allows clients to specify the sort criteria for the returned list of objects. Resources can be sorted in ascending order using asc or descending order using desc. If asc or desc are not specified the resources will be sorted in ascending order by default. For example, 'orderby=templateName desc' would get all templates sorted by templateName in desc order. The orderby can be applied to the following fields: - description - name
-> args (map[string]interface{}) (optional) : Additional Arguments

returns: (vmm.v4.images.PlacementPolicyListApiResponse, error)

func (*PlacementPoliciesApi) GetPlacementPolicyByExtId 

func (api *PlacementPoliciesApi) GetPlacementPolicyByExtId(extId *string, args ...map[string]interface{}) (*import1.PlacementPolicyApiResponse, error)

* 

Get an image placement policy.
Get the image placement policy with the given extId.

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

returns: (vmm.v4.images.PlacementPolicyApiResponse, error)

func (*PlacementPoliciesApi) UpdatePlacementPolicyByExtId 

func (api *PlacementPoliciesApi) UpdatePlacementPolicyByExtId(body *import1.PlacementPolicy, extId *string, args ...map[string]interface{}) (*import1.ImagesTaskApiResponse, error)

* 

Update an image placement policy.
Update the image placement policy with the given extId.

parameters:-
-> body (vmm.v4.images.PlacementPolicy) (required) : Updated image placement policy.
-> extId (string) (required)
-> args (map[string]interface{}) (optional) : Additional Arguments

returns: (vmm.v4.images.ImagesTaskApiResponse, error)

type RateLimitsApi 

type RateLimitsApi struct {
	ApiClient *client.ApiClient
}

func NewRateLimitsApi 

func NewRateLimitsApi(apiClient *client.ApiClient) *RateLimitsApi

func (*RateLimitsApi) CreateRateLimit 

func (api *RateLimitsApi) CreateRateLimit(body *import1.RateLimit, args ...map[string]interface{}) (*import1.ImagesTaskApiResponse, error)

* 

Create an image rate limit.
Create an image rate limit.

parameters:-
-> body (vmm.v4.images.RateLimit) (required) : Image rate limit to create.
-> args (map[string]interface{}) (optional) : Additional Arguments

returns: (vmm.v4.images.ImagesTaskApiResponse, error)

func (*RateLimitsApi) DeleteMultipleRateLimits 

func (api *RateLimitsApi) DeleteMultipleRateLimits(body *import1.RateLimitIdList, args ...map[string]interface{}) (*import1.RateLimitTaskListApiResponse, error)

* 

Delete multiple image rate limits.
Delete the image rate limits with the specified extIds.

parameters:-
-> body (vmm.v4.images.RateLimitIdList) (required) : ExtIds of the image rate limits to delete.
-> args (map[string]interface{}) (optional) : Additional Arguments

returns: (vmm.v4.images.RateLimitTaskListApiResponse, error)

func (*RateLimitsApi) DeleteRateLimitByExtId 

func (api *RateLimitsApi) DeleteRateLimitByExtId(extId *string, args ...map[string]interface{}) (*import1.ImagesTaskApiResponse, error)

* 

Delete an image rate limit.
Delete the image rate limit with the given extId.

parameters:-
-> extId (string) (required) : Image rate limit extId.
-> args (map[string]interface{}) (optional) : Additional Arguments

returns: (vmm.v4.images.ImagesTaskApiResponse, error)

func (*RateLimitsApi) GetRateLimitByExtId 

func (api *RateLimitsApi) GetRateLimitByExtId(extId *string, args ...map[string]interface{}) (*import1.RateLimitApiResponse, error)

* 

Get an image rate limit.
Get the image rate limit with the given extId.

parameters:-
-> extId (string) (required) : Image rate limit extId.
-> args (map[string]interface{}) (optional) : Additional Arguments

returns: (vmm.v4.images.RateLimitApiResponse, error)

func (*RateLimitsApi) GetRateLimitsList 

func (api *RateLimitsApi) GetRateLimitsList(page_ *int, limit_ *int, filter_ *string, orderby_ *string, args ...map[string]interface{}) (*import1.RateLimitListApiResponse, error)

* 

List image rate limits.
List image rate limits.

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: - name - rateLimitKbps
-> orderby_ (string) (optional) : A URL query parameter that allows clients to specify the sort criteria for the returned list of objects. Resources can be sorted in ascending order using asc or descending order using desc. If asc or desc are not specified the resources will be sorted in ascending order by default. For example, 'orderby=templateName desc' would get all templates sorted by templateName in desc order. The orderby can be applied to the following fields: - name - rateLimitKbps
-> args (map[string]interface{}) (optional) : Additional Arguments

returns: (vmm.v4.images.RateLimitListApiResponse, error)

func (*RateLimitsApi) ResolveRateLimits 

func (api *RateLimitsApi) ResolveRateLimits(body *import1.ClusterIdList, args ...map[string]interface{}) (*import1.ResolveRateLimitsApiResponse, error)

* 

Resolve effective rate limit for the Prism Elements.
Resolve the effective image rate limit for the given Prism Elements when multiple image rate limits apply.

parameters:-
-> body (vmm.v4.images.ClusterIdList) (required) : List of cluster extIds for resolving effective rate limits.
-> args (map[string]interface{}) (optional) : Additional Arguments

returns: (vmm.v4.images.ResolveRateLimitsApiResponse, error)

func (*RateLimitsApi) UpdateRateLimitByExtId 

func (api *RateLimitsApi) UpdateRateLimitByExtId(body *import1.RateLimit, extId *string, args ...map[string]interface{}) (*import1.ImagesTaskApiResponse, error)

* 

Update the image rate limit with the given extId.
Update an image rate limit.

parameters:-
-> body (vmm.v4.images.RateLimit) (required) : Image rate limit to update.
-> extId (string) (required) : Image rate limit extId.
-> args (map[string]interface{}) (optional) : Additional Arguments

returns: (vmm.v4.images.ImagesTaskApiResponse, 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.