Documentation
¶
Overview ¶
Api classes for storage's golang SDK
Index ¶
- type StorageContainerApi
- func (api *StorageContainerApi) AddDataStoreForCluster(body *import1.DataStoreMount, containerExtId *string, ...) (*import1.StorageContainerTaskResponse, error)
- func (api *StorageContainerApi) AddStorageContainerForCluster(body *import1.StorageContainer, xClusterId *string, ...) (*import1.StorageContainerTaskResponse, error)
- func (api *StorageContainerApi) DeleteDataStoreForCluster(body *import1.DataStoreUnmount, containerExtId *string, ...) (*import1.DataStoreTaskResponse, error)
- func (api *StorageContainerApi) DeleteStorageContainerByExtId(containerExtId *string, ignoreSmallFiles *bool, args ...map[string]interface{}) (*import1.StorageContainerTaskResponse, error)
- func (api *StorageContainerApi) GetAllStorageContainers(page_ *int, limit_ *int, filter_ *string, orderby_ *string, select_ *string, ...) (*import1.StorageContainersResponse, error)
- func (api *StorageContainerApi) GetDataStores(filter_ *string, args ...map[string]interface{}) (*import1.DataStoreResponse, error)
- func (api *StorageContainerApi) GetStorageContainerByExtId(containerExtId *string, args ...map[string]interface{}) (*import1.StorageContainerResponse, error)
- func (api *StorageContainerApi) UpdateStorageContainer(body *import1.StorageContainer, containerExtId *string, ...) (*import1.StorageContainerTaskResponse, error)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type StorageContainerApi ¶
func NewStorageContainerApi ¶
func NewStorageContainerApi(apiClient *client.ApiClient) *StorageContainerApi
func (*StorageContainerApi) AddDataStoreForCluster ¶
func (api *StorageContainerApi) AddDataStoreForCluster(body *import1.DataStoreMount, containerExtId *string, args ...map[string]interface{}) (*import1.StorageContainerTaskResponse, error)
*
Add a Data Store instance to the cluster.
Create a Data Store instance on the Storage container identified by {containerExtId}.
parameters:-
-> body (storage.v4.config.DataStoreMount) (required)
-> containerExtId (string) (required) : Uuid of the Storage container.
-> args (map[string]interface{}) (optional) : Additional Arguments
returns: (storage.v4.config.StorageContainerTaskResponse, error)
func (*StorageContainerApi) AddStorageContainerForCluster ¶
func (api *StorageContainerApi) AddStorageContainerForCluster(body *import1.StorageContainer, xClusterId *string, args ...map[string]interface{}) (*import1.StorageContainerTaskResponse, error)
*
Add Storage container to the cluster.
Create a new Storage container on a cluster.
parameters:-
-> body (storage.v4.config.StorageContainer) (required)
-> xClusterId (string) (required) : Remote cluster uuid to forward the request.
-> args (map[string]interface{}) (optional) : Additional Arguments
returns: (storage.v4.config.StorageContainerTaskResponse, error)
func (*StorageContainerApi) DeleteDataStoreForCluster ¶
func (api *StorageContainerApi) DeleteDataStoreForCluster(body *import1.DataStoreUnmount, containerExtId *string, args ...map[string]interface{}) (*import1.DataStoreTaskResponse, error)
*
Delete a Data Store instance in the cluster.
Delete an existing Data Store instance from the Storage container identified by {containerExtId}.
parameters:-
-> body (storage.v4.config.DataStoreUnmount) (required)
-> containerExtId (string) (required) : Uuid of the Storage container.
-> args (map[string]interface{}) (optional) : Additional Arguments
returns: (storage.v4.config.DataStoreTaskResponse, error)
func (*StorageContainerApi) DeleteStorageContainerByExtId ¶
func (api *StorageContainerApi) DeleteStorageContainerByExtId(containerExtId *string, ignoreSmallFiles *bool, args ...map[string]interface{}) (*import1.StorageContainerTaskResponse, error)
*
Delete an existing Storage container.
Delete an existing Storage container identified by {containerExtId}.
parameters:-
-> containerExtId (string) (required) : Uuid of the Storage container.
-> ignoreSmallFiles (bool) (optional)
-> args (map[string]interface{}) (optional) : Additional Arguments
returns: (storage.v4.config.StorageContainerTaskResponse, error)
func (*StorageContainerApi) GetAllStorageContainers ¶
func (api *StorageContainerApi) GetAllStorageContainers(page_ *int, limit_ *int, filter_ *string, orderby_ *string, select_ *string, args ...map[string]interface{}) (*import1.StorageContainersResponse, error)
*
Get Storage containers for the cluster.
Query the list of Storage containers.
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: - affinityHostUuid - clusterExtId - containerExtId - containerId - name - ownerUuid - replicationFactor - storagePoolUuid
-> 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
-> select_ (string) (optional) : A URL query parameter that allows clients to request a specific set of properties for each entity or complex type. Expression specified with the $select must conform to the OData V4.01 URL conventions. If a $select expression consists of a single select item that is an asterisk (i.e. *), then all properties on the matching resource will be returned. - advertisedCapacity - affinityHostUuid - clusterExtId - compressionDelayInSecs - compressionEnabled - containerExtId - containerId - downMigrateTimesInSecs - enableSoftwareEncryption - encrypted - erasureCode - erasureCodeDelaySecs - extId - fingerPrintOnWrite - inlineEcEnabled - isNfsWhitelistInherited - isNutanixManaged - links - mappedRemoteContainers - markedForRemoval - maxCapacity - name - nfsWhitelistAddress - onDiskDedup - oplogReplicationFactor - ownerUuid - preferHigherECFaultDomain - randomIoPreference - replicationFactor - seqIoPreference - storagePoolUuid - tenantId - totalExplicitReservedCapacity - totalImplicitReservedCapacity - vstoreNameList
-> args (map[string]interface{}) (optional) : Additional Arguments
returns: (storage.v4.config.StorageContainersResponse, error)
func (*StorageContainerApi) GetDataStores ¶
func (api *StorageContainerApi) GetDataStores(filter_ *string, args ...map[string]interface{}) (*import1.DataStoreResponse, error)
*
Get the Data Stores.
Query the list of Data Stores.
parameters:-
-> 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: - containerExtId
-> args (map[string]interface{}) (optional) : Additional Arguments
returns: (storage.v4.config.DataStoreResponse, error)
func (*StorageContainerApi) GetStorageContainerByExtId ¶
func (api *StorageContainerApi) GetStorageContainerByExtId(containerExtId *string, args ...map[string]interface{}) (*import1.StorageContainerResponse, error)
*
Get existing Storage container.
Query for metadata information which is associated with the Storage container identified by {containerExtId}.
parameters:-
-> containerExtId (string) (required) : Uuid of the Storage container.
-> args (map[string]interface{}) (optional) : Additional Arguments
returns: (storage.v4.config.StorageContainerResponse, error)
func (*StorageContainerApi) UpdateStorageContainer ¶
func (api *StorageContainerApi) UpdateStorageContainer(body *import1.StorageContainer, containerExtId *string, args ...map[string]interface{}) (*import1.StorageContainerTaskResponse, error)
*
Update existing Storage container.
Update an existing Storage container identified by {containerExtId}.
parameters:-
-> body (storage.v4.config.StorageContainer) (required)
-> containerExtId (string) (required) : Uuid of the Storage container.
-> args (map[string]interface{}) (optional) : Additional Arguments
returns: (storage.v4.config.StorageContainerTaskResponse, error)
Source Files
Click to show internal directories.
Click to hide internal directories.