api

package
v4.0.1 Latest Latest
Warning

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

 Go to latest Published: Dec 5, 2024 License: Apache-2.0 Imports: 8 Imported by: 1

Documentation

Overview

Api classes for prism's golang SDK

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type BatchesApi 

type BatchesApi struct {
	ApiClient *client.ApiClient
	// contains filtered or unexported fields
}

func NewBatchesApi 

func NewBatchesApi(apiClient *client.ApiClient) *BatchesApi

func (*BatchesApi) GetBatchById 

func (api *BatchesApi) GetBatchById(extId *string, args ...map[string]interface{}) (*import1.GetBatchApiResponse, error)

Query the Batch identified by {extId}.

func (*BatchesApi) ListBatches 

func (api *BatchesApi) ListBatches(page_ *int, limit_ *int, filter_ *string, orderby_ *string, select_ *string, args ...map[string]interface{}) (*import1.ListBatchesApiResponse, error)

Query the list of Batches.

func (*BatchesApi) SubmitBatch 

func (api *BatchesApi) SubmitBatch(body *import1.BatchSpec, args ...map[string]interface{}) (*import1.SubmitBatchApiResponse, error)

Submit a homogenous batch operation.

type CategoriesApi 

type CategoriesApi struct {
	ApiClient *client.ApiClient
	// contains filtered or unexported fields
}

func NewCategoriesApi 

func NewCategoriesApi(apiClient *client.ApiClient) *CategoriesApi

func (*CategoriesApi) CreateCategory 

func (api *CategoriesApi) CreateCategory(body *import2.Category, args ...map[string]interface{}) (*import2.CreateCategoryApiResponse, error)

Creates a category with a given key and value pair.

func (*CategoriesApi) DeleteCategoryById 

func (api *CategoriesApi) DeleteCategoryById(extId *string, args ...map[string]interface{}) (*import2.DeleteCategoryApiResponse, error)

Deletes a category with the given external identifier.

func (*CategoriesApi) GetCategoryById 

func (api *CategoriesApi) GetCategoryById(extId *string, expand_ *string, args ...map[string]interface{}) (*import2.GetCategoryApiResponse, error)

Fetches the details of a category with the given external identifier.

func (*CategoriesApi) ListCategories 

func (api *CategoriesApi) ListCategories(page_ *int, limit_ *int, filter_ *string, orderby_ *string, expand_ *string, select_ *string, args ...map[string]interface{}) (*import2.ListCategoriesApiResponse, error)

Fetches a list of categories with pagination, filtering, sorting, selection, and optional expansion of associated entity counts.

func (*CategoriesApi) UpdateCategoryById 

func (api *CategoriesApi) UpdateCategoryById(extId *string, body *import2.Category, args ...map[string]interface{}) (*import2.UpdateCategoryApiResponse, error)

Updates the description, value, and owner properties of a category.

type DomainManagerApi 

type DomainManagerApi struct {
	ApiClient *client.ApiClient
	// contains filtered or unexported fields
}

func NewDomainManagerApi 

func NewDomainManagerApi(apiClient *client.ApiClient) *DomainManagerApi

func (*DomainManagerApi) CreateDomainManager 

func (api *DomainManagerApi) CreateDomainManager(body *import2.DomainManager, args ...map[string]interface{}) (*import2.CreateDomainManagerApiResponse, error)

Deploys a Prism Central using the provided details. Prism Central Size, Network Config are mandatory fields to deploy Prism Central. The response from this endpoint contains the URL in the task object location header that can be used to track the request status.

func (*DomainManagerApi) GetDomainManagerById 

func (api *DomainManagerApi) GetDomainManagerById(extId *string, args ...map[string]interface{}) (*import2.GetDomainManagerApiResponse, error)

Fetches the attributes associated with the domain manager (Prism Central) resource based on the provided external identifier. It includes attributes like config, network, node and other information such as size, environment and resource specifications.

func (*DomainManagerApi) ListDomainManagers 

func (api *DomainManagerApi) ListDomainManagers(select_ *string, args ...map[string]interface{}) (*import2.ListDomainManagerApiResponse, error)

Returns a list of elements representing the domain manager (Prism Central) instance.

func (*DomainManagerApi) Register 

func (api *DomainManagerApi) Register(extId *string, body *import3.ClusterRegistrationSpec, args ...map[string]interface{}) (*import3.RegisterApiResponse, error)

Registers a domain manager (Prism Central) instance to other entities like PE and PC. This process is asynchronous, creating a registration task and returning its UUID.

func (*DomainManagerApi) Unregister 

func (api *DomainManagerApi) Unregister(extId *string, body *import3.ClusterReference, args ...map[string]interface{}) (*import3.UnregisterApiResponse, error)

Unregister a registered remote cluster from the local cluster. This process is asynchronous, creating an unregisteration task and returning its UUID.

type DomainManagerBackupsApi 

type DomainManagerBackupsApi struct {
	ApiClient *client.ApiClient
	// contains filtered or unexported fields
}

func NewDomainManagerBackupsApi 

func NewDomainManagerBackupsApi(apiClient *client.ApiClient) *DomainManagerBackupsApi

func (*DomainManagerBackupsApi) CreateBackupTarget 

func (api *DomainManagerBackupsApi) CreateBackupTarget(domainManagerExtId *string, body *import3.BackupTarget, args ...map[string]interface{}) (*import3.CreateBackupTargetApiResponse, error)

Creates a cluster or object store as the backup target. For a given Prism Central, there can be up to 3 clusters as backup targets and 1 object store as backup target. If any cluster or object store is not eligible for backup or lacks appropriate permissions, the API request will fail. For object store backup targets, specifying backup policy is mandatory along with the location of the object store.

func (*DomainManagerBackupsApi) CreateRestoreSource 

func (api *DomainManagerBackupsApi) CreateRestoreSource(body *import3.RestoreSource, args ...map[string]interface{}) (*import3.CreateRestoreSourceApiResponse, error)

Creates a restore source pointing to a cluster or object store to restore the domain manager. The created restore source is intended to be deleted after use. If the restore source is not deleted using the deleteRestoreSource API, then it is auto-deleted after sometime. Also note that a restore source will not contain a backup policy. It is only used to access the backup data at the location from where the Prism Central may be restored. Credentials used to access the restore source are not validated at the time of creation of the restore source. They are validated when the restore source is used to fetch data.

func (*DomainManagerBackupsApi) DeleteBackupTargetById 

func (api *DomainManagerBackupsApi) DeleteBackupTargetById(domainManagerExtId *string, extId *string, args ...map[string]interface{}) (*import3.DeleteBackupTargetApiResponse, error)

Removes cluster/object store from the backup targets. This will stop the cluster/object store from backing up Prism Central data.

func (*DomainManagerBackupsApi) DeleteRestoreSourceById 

func (api *DomainManagerBackupsApi) DeleteRestoreSourceById(extId *string, args ...map[string]interface{}) (*import3.DeleteRestoreSourceApiResponse, error)

Deletes a restore source on a cluster/object store.

func (*DomainManagerBackupsApi) GetBackupTargetById 

func (api *DomainManagerBackupsApi) GetBackupTargetById(domainManagerExtId *string, extId *string, args ...map[string]interface{}) (*import3.GetBackupTargetApiResponse, error)

Retrieves the backup targets (cluster or object store) from a domain manager and returns the backup configuration and lastSyncTimestamp parameter to the user.

func (*DomainManagerBackupsApi) GetRestorePointById 

func (api *DomainManagerBackupsApi) GetRestorePointById(restoreSourceExtId *string, restorableDomainManagerExtId *string, extId *string, args ...map[string]interface{}) (*import3.GetRestorePointApiResponse, error)

Retrieves detailed information about a specific recovery point and provides essential domain manager information stored in the backup, which is required for the restoration process.

func (*DomainManagerBackupsApi) GetRestoreSourceById 

func (api *DomainManagerBackupsApi) GetRestoreSourceById(extId *string, args ...map[string]interface{}) (*import3.GetRestoreSourceApiResponse, error)

Retrieves the restore source from the PE cache store and returns the restore source configuration and external identifier to the user.

func (*DomainManagerBackupsApi) ListBackupTargets 

func (api *DomainManagerBackupsApi) ListBackupTargets(domainManagerExtId *string, args ...map[string]interface{}) (*import3.ListBackupTargetsApiResponse, error)

Lists backup targets (cluster or object store) configured for a given domain manager.

func (*DomainManagerBackupsApi) ListRestorableDomainManagers 

func (api *DomainManagerBackupsApi) ListRestorableDomainManagers(restoreSourceExtId *string, page_ *int, limit_ *int, filter_ *string, args ...map[string]interface{}) (*import3.ListRestorableDomainManagersApiResponse, error)

Lists all the domain managers backed up at the object store/cluster.

func (*DomainManagerBackupsApi) ListRestorePoints 

func (api *DomainManagerBackupsApi) ListRestorePoints(restoreSourceExtId *string, restorableDomainManagerExtId *string, page_ *int, limit_ *int, filter_ *string, orderby_ *string, select_ *string, args ...map[string]interface{}) (*import3.ListRestorePointsApiResponse, error)

The list restore points API allows you to retrieve a list of available restore points, which are snapshots of the domain manager taken at different times. These restore points can be used to revert the domain manager to a previous state. The list response includes the creation time and identifier ID for the configuration data.<br> 1. For cluster-based backups, only the most recent restore point is available, as backups are continuous.<br> 2. For object store-based backups, multiple restore points may be available, depending on the configured Recovery Point Objective (RPO) and the retention period set on the s3 bucket.

func (*DomainManagerBackupsApi) Restore 

func (api *DomainManagerBackupsApi) Restore(restoreSourceExtId *string, restorableDomainManagerExtId *string, extId *string, body *import3.RestoreSpec, args ...map[string]interface{}) (*import3.RestoreApiResponse, error)

The restore domain manager is a task-driven operation to restore a domain manager from a cluster or object store backup location based on the selected restore point.

func (*DomainManagerBackupsApi) UpdateBackupTargetById 

func (api *DomainManagerBackupsApi) UpdateBackupTargetById(domainManagerExtId *string, extId *string, body *import3.BackupTarget, args ...map[string]interface{}) (*import3.UpdateBackupTargetApiResponse, error)

Updates the credentials and/or RPO of the given object store.

type TasksApi 

type TasksApi struct {
	ApiClient *client.ApiClient
	// contains filtered or unexported fields
}

func NewTasksApi 

func NewTasksApi(apiClient *client.ApiClient) *TasksApi

func (*TasksApi) CancelTask 

func (api *TasksApi) CancelTask(taskExtId *string, args ...map[string]interface{}) (*import2.CancelTaskApiResponse, error)

Cancel an ongoing task for the provided taskExtId. This action is supported only if 'isCancelable' is set as True for the task. The task may continue to run for some time after the request has been made, until the backend server deems it is safe to cancel the task. Cancellation requests are idempotent and multiple such requests for the same ongoing task are supported.

func (*TasksApi) GetTaskById 

func (api *TasksApi) GetTaskById(extId *string, select_ *string, args ...map[string]interface{}) (*import2.GetTaskApiResponse, error)

Fetch an asynchronous operation called a task for the provided extId.

func (*TasksApi) ListTasks 

func (api *TasksApi) ListTasks(page_ *int, limit_ *int, filter_ *string, orderby_ *string, select_ *string, args ...map[string]interface{}) (*import2.ListTasksApiResponse, error)

List tasks in the system. The response can be further filtered / sorted using the filtering and sorting options provided. By default the response would be sorted by 'createdTime' in the descending order.

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.