api

package

v4.0.2-alpha.3 Latest Latest Go to latest Published: Feb 7, 2023 License: UNKNOWN not legal advice Imports: 6 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/nutanix/ntnx-api-golang-clients

Documentation ¶

Overview ¶

Api classes for storage's golang SDK

Index ¶

type StorageContainerApi
- func NewStorageContainerApi(apiClient *client.ApiClient) *StorageContainerApi

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type StorageContainerApi ¶

type StorageContainerApi struct {
	ApiClient *client.ApiClient
}

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.
Add a Data Store instance to the cluster.

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 a Storage Container instance to the cluster.
Add a Storage Container instance to the 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 a Data Store instance in the cluster.

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.

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 the list of all storage containers configured in the cluster.
Get the list of all storage containers configured in the cluster.

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 lead to no results being returned.
-> 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 lead to a validation error. If the limit is not provided a default value of 50 records will be returned in the result set.
-> 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 datastore.
Get the datastore.

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 the attributes of an existing storage container.
Get the attributes of an existing storage container.

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)

*

Updates the attributes of an existing storage container.
Updates the attributes of an existing storage container.

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 ¶

View all Source files

storage_container_api.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL