api

Documentation

Overview

Api classes for objects's golang SDK

Index

• type ObjectStoresApi
  • func NewObjectStoresApi(apiClient *client.ApiClient) *ObjectStoresApi
  • func (api *ObjectStoresApi) CreateCertificate(objectStoreExtId *string, path *string, args ...map[string]interface{}) (*import1.CreateCertificateApiResponse, error)
  • func (api *ObjectStoresApi) CreateObjectstore(body *import1.ObjectStore, args ...map[string]interface{}) (*import1.CreateObjectstoreApiResponse, error)
  • func (api *ObjectStoresApi) DeleteObjectstoreById(extId *string, args ...map[string]interface{}) (*import1.DeleteObjectstoreApiResponse, error)
  • func (api *ObjectStoresApi) GetCaByCertificateId(objectStoreExtId *string, extId *string, args ...map[string]interface{}) (*import1.GetCaApiResponse, error)
  • func (api *ObjectStoresApi) GetCertificateById(objectStoreExtId *string, extId *string, args ...map[string]interface{}) (*import1.GetCertificateApiResponse, error)
  • func (api *ObjectStoresApi) GetObjectstoreById(extId *string, args ...map[string]interface{}) (*import1.GetObjectstoreApiResponse, error)
  • func (api *ObjectStoresApi) ListCertificatesByObjectstoreId(objectStoreExtId *string, page_ *int, limit_ *int, filter_ *string, ...) (*import1.ListCertificatesApiResponse, error)
  • func (api *ObjectStoresApi) ListObjectstores(page_ *int, limit_ *int, filter_ *string, orderby_ *string, expand_ *string, ...) (*import1.ListObjectstoresApiResponse, error)
  • func (api *ObjectStoresApi) UpdateObjectstoreById(extId *string, body *import1.ObjectStore, args ...map[string]interface{}) (*import1.UpdateObjectstoreApiResponse, error)

Types

type ObjectStoresApi

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

func NewObjectStoresApi

func NewObjectStoresApi(apiClient *client.ApiClient) *ObjectStoresApi

func (*ObjectStoresApi) CreateCertificate

func (api *ObjectStoresApi) CreateCertificate(objectStoreExtId *string, path *string, args ...map[string]interface{}) (*import1.CreateCertificateApiResponse, error)

This operation creates a new default certificate and keys. It also creates the alternate FQDNs for the Object store. The certificate of an Object store can be created when it is in a OBJECT_STORE_AVAILABLE or OBJECT_STORE_CERT_CREATION_FAILED state. If the publicCert, privateKey, and ca values are provided in the request body, these values are used to create the new certificate. If these values are not provided, the existing certificate will be used as the new certificate. Optionally, a list of additional alternate FQDNs can be provided.

func (*ObjectStoresApi) CreateObjectstore

func (api *ObjectStoresApi) CreateObjectstore(body *import1.ObjectStore, args ...map[string]interface{}) (*import1.CreateObjectstoreApiResponse, error)

Run the prechecks, create and start the deployment of an Object store on Prism Central.

func (*ObjectStoresApi) DeleteObjectstoreById

func (api *ObjectStoresApi) DeleteObjectstoreById(extId *string, args ...map[string]interface{}) (*import1.DeleteObjectstoreApiResponse, error)

Send a request to delete an Object store for the provided UUID and clean up its data. An Object store can only be deleted when it is in the state UNDEPLOYED_OBJECT_STORE, OBJECT_STORE_AVAILABLE, OBJECT_STORE_DEPLOYMENT_FAILED or OBJECT_STORE_DELETION_FAILED and does not contain any buckets.

func (*ObjectStoresApi) GetCaByCertificateId

func (api *ObjectStoresApi) GetCaByCertificateId(objectStoreExtId *string, extId *string, args ...map[string]interface{}) (*import1.GetCaApiResponse, error)

Download the certificate authority of an Object store certificate.

func (*ObjectStoresApi) GetCertificateById

func (api *ObjectStoresApi) GetCertificateById(objectStoreExtId *string, extId *string, args ...map[string]interface{}) (*import1.GetCertificateApiResponse, error)

Get the details of the SSL certificate which can be used to connect to an Object store.

func (*ObjectStoresApi) GetObjectstoreById

func (api *ObjectStoresApi) GetObjectstoreById(extId *string, args ...map[string]interface{}) (*import1.GetObjectstoreApiResponse, error)

Get an Object store for the provided UUID. `state` string (State of the Object store) Enum for the state of the Object store. | Enum | Description | | ----------- | ----------- | | `\"DEPLOYING_OBJECT_STORE\"` | The Object store will be in this state during an ongoing deployment of the Object store. The Object store will be unavailable through S3 APIs in this state. The Object store will move to the OBJECT_STORE_AVAILABLE state if the deployment succeeds, and to the OBJECT_STORE_DEPLOYMENT_FAILED state if the deployment fails. | | `\"OBJECT_STORE_OPERATION_FAILED\"` | The Object store is in this state when there is an error while performing an operation on the Object store. The Object store may not be available through S3 APIs in this state. | | `\"OBJECT_STORE_CERT_CREATION_FAILED\"` | An Object store enters this state if there is an error while creating the Object store certificate. Creating a new certificate can be retried from this state. The Object store may not be available through S3 APIs in this state. | | `\"OBJECT_STORE_OPERATION_PENDING\"` | The Object store is in this state during an ongoing operation on the Object store. The Object store may not be available through S3 APIs in this state. The Object store will enter the OBJECT_STORE_OPERATION_FAILED state if the operation fails, or the OBJECT_STORE_AVAILABLE state if the operation is successful. | | `\"UNDEPLOYED_OBJECT_STORE\"` | The Object store is in this state if it has not been deployed. | | `\"CREATING_OBJECT_STORE_CERT\"` | The Object store is in this state during a certificate creation for the Object store. The Object store will be unavailable through S3 APIs in this state. It will move to the OBJECT_STORE_AVAILABLE state if the certificate was created successfully, or to the OBJECT_STORE_CERT_CREATION_FAILED state if an error occurs while creating the certificate. | | `\"OBJECT_STORE_AVAILABLE\"` | An Object store is in this state if its deployment was successful, and there are no ongoing operations on the Object store. The Object store will be available through S3 APIs in this state. In this state, the Object store can be deleted or a new certificate can be created for this Object store. | | `\"OBJECT_STORE_DELETION_FAILED\"` | An Object store enters this state if there is an error deleting the Object store. The Object store will not be available through S3 APIs in this state. Deleting the Object store can be retried from this state. | | `\"OBJECT_STORE_DEPLOYMENT_FAILED\"` | An Object store enters this state when its deployment fails. The Object store deployment can be retried or the Object store can be deleted from this state. | | `\"DELETING_OBJECT_STORE\"` | A deployed Object store is in this state when the Object store is being deleted. The Object store will be unavailable through S3 APIs in this state. It can be either deleted or move to the OBJECT_STORE_DELETION_FAILED state if the deletion fails. |

func (*ObjectStoresApi) ListCertificatesByObjectstoreId

func (api *ObjectStoresApi) ListCertificatesByObjectstoreId(objectStoreExtId *string, page_ *int, limit_ *int, filter_ *string, select_ *string, args ...map[string]interface{}) (*import1.ListCertificatesApiResponse, error)

Get a list of the SSL certificates which can be used to access an Object store.

func (*ObjectStoresApi) ListObjectstores

func (api *ObjectStoresApi) ListObjectstores(page_ *int, limit_ *int, filter_ *string, orderby_ *string, expand_ *string, select_ *string, args ...map[string]interface{}) (*import1.ListObjectstoresApiResponse, error)

Get a list of all the Object store details on the registered Prism Central.

func (*ObjectStoresApi) UpdateObjectstoreById

func (api *ObjectStoresApi) UpdateObjectstoreById(extId *string, body *import1.ObjectStore, args ...map[string]interface{}) (*import1.UpdateObjectstoreApiResponse, error)

Update an Object store. The deployment of an Object store can be restarted from the state OBJECT_STORE_DEPLOYMENT_FAILED.