Categorygithub.com/phoenixnap/go-sdk-bmc/networkstorageapi/v3
modulepackage
3.0.0
Repository: https://github.com/phoenixnap/go-sdk-bmc.git
Documentation: pkg.go.dev

# README

Go API client for networkstorageapi

Create, list, edit, and delete storage networks with the Network Storage API. Use storage networks to expand storage capacity on a private network.
Knowledge base articles to help you can be found here
All URLs are relative to (https://api.phoenixnap.com/network-storage/v1/)

Overview

This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/oauth2
go get golang.org/x/net/context

Put the package under your project folder and add the following in import:

import networkstorageapi "github.com/phoenixnap/go-sdk-bmc/networkstorageapi"

To use a proxy, set the environment variable HTTP_PROXY:

os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")

Configuration of Server URL

Default configuration comes with Servers field that contains server objects as defined in the OpenAPI specification.

Select Server Configuration

For using other server than the one defined on index 0 set context value networkstorageapi.ContextServerIndex of type int.

ctx := context.WithValue(context.Background(), networkstorageapi.ContextServerIndex, 1)

Templated Server URL

Templated server URL is formatted using default variables from configuration or from context value networkstorageapi.ContextServerVariables of type map[string]string.

ctx := context.WithValue(context.Background(), networkstorageapi.ContextServerVariables, map[string]string{
	"basePath": "v2",
})

Note, enum values are always validated and all unused variables are silently ignored.

URLs Configuration per Operation

Each operation can use different server URL defined using OperationServers map in the Configuration. An operation is uniquely identified by "{classname}Service.{nickname}" string. Similar rules for overriding default operation server index and variables applies by using networkstorageapi.ContextOperationServerIndices and networkstorageapi.ContextOperationServerVariables context maps.

ctx := context.WithValue(context.Background(), networkstorageapi.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), networkstorageapi.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})

Documentation for API Endpoints

All URIs are relative to https://api.phoenixnap.com/network-storage/v1

ClassMethodHTTP requestDescription
StorageNetworksAPIStorageNetworksGetGet /storage-networksList all storage networks.
StorageNetworksAPIStorageNetworksIdDeleteDelete /storage-networks/{storageId}Delete a storage network and its volume.
StorageNetworksAPIStorageNetworksIdGetGet /storage-networks/{storageId}Get storage network details.
StorageNetworksAPIStorageNetworksIdPatchPatch /storage-networks/{storageId}Update storage network details.
StorageNetworksAPIStorageNetworksPostPost /storage-networksCreate a storage network and volume.
StorageNetworksAPIStorageNetworksStorageNetworkIdVolumesGetGet /storage-networks/{storageId}/volumesDisplay one or more volumes belonging to a storage network.
StorageNetworksAPIStorageNetworksStorageNetworkIdVolumesPostPost /storage-networks/{storageId}/volumesCreate a volume belonging to a storage network.
StorageNetworksAPIStorageNetworksStorageNetworkIdVolumesVolumeIdDeleteDelete /storage-networks/{storageId}/volumes/{volumeId}Delete a Storage Network's Volume
StorageNetworksAPIStorageNetworksStorageNetworkIdVolumesVolumeIdGetGet /storage-networks/{storageId}/volumes/{volumeId}Get a storage network's volume details.
StorageNetworksAPIStorageNetworksStorageNetworkIdVolumesVolumeIdPatchPatch /storage-networks/{storageId}/volumes/{volumeId}Update a storage network's volume details.
StorageNetworksAPIStorageNetworksStorageNetworkIdVolumesVolumeIdTagsPutPut /storage-networks/{storageId}/volumes/{volumeId}/tagsOverwrites tags assigned for the volume.

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

OAuth2

  • Type: OAuth
  • Flow: application
  • Authorization URL:
  • Scopes:
  • networkstorage: Grants full access to Network Storage API.
  • networkstorage.read: Grants read only access to Network Storage API.

Example

auth := context.WithValue(context.Background(), networkstorageapi.ContextAccessToken, "ACCESSTOKENSTRING")
r, err := client.Service.Operation(auth, args)

Or via OAuth2 module to automatically refresh tokens and perform user authentication.

import "golang.org/x/oauth2"

/* Perform OAuth2 round trip request and obtain a token */

tokenSource := oauth2cfg.TokenSource(createContext(httpClient), &token)
auth := context.WithValue(oauth2.NoContext, networkstorageapi.ContextOAuth2, tokenSource)
r, err := client.Service.Operation(auth, args)

Documentation for Utility Methods

Due to the fact that model structure members are all pointers, this package contains a number of utility functions to easily obtain pointers to values of basic types. Each of these functions takes a value of the given basic type and returns a pointer to it:

  • PtrBool
  • PtrInt
  • PtrInt32
  • PtrInt64
  • PtrFloat
  • PtrFloat32
  • PtrFloat64
  • PtrString
  • PtrTime

Author

[email protected]

# Functions

CacheExpires helper function to determine remaining time before repeating a request.
IsNil checks if an input is nil.
NewAPIClient creates a new API client.
NewAPIResponse returns a new APIResponse object.
NewAPIResponseWithError returns a new APIResponse object with the provided error message.
NewConfiguration returns a new Configuration object.
NewError instantiates a new Error object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewErrorWithDefaults instantiates a new Error object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewNfsPermissions instantiates a new NfsPermissions object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewNfsPermissionsCreate instantiates a new NfsPermissionsCreate object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewNfsPermissionsCreateWithDefaults instantiates a new NfsPermissionsCreate object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewNfsPermissionsUpdate instantiates a new NfsPermissionsUpdate object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewNfsPermissionsUpdateWithDefaults instantiates a new NfsPermissionsUpdate object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewNfsPermissionsWithDefaults instantiates a new NfsPermissions object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
NewPermissions instantiates a new Permissions object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewPermissionsCreate instantiates a new PermissionsCreate object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewPermissionsCreateWithDefaults instantiates a new PermissionsCreate object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewPermissionsUpdate instantiates a new PermissionsUpdate object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewPermissionsUpdateWithDefaults instantiates a new PermissionsUpdate object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewPermissionsWithDefaults instantiates a new Permissions object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewStatusFromValue returns a pointer to a valid Status for the value passed as argument, or an error if the value passed is not allowed by the enum.
NewStorageNetwork instantiates a new StorageNetwork object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewStorageNetworkCreate instantiates a new StorageNetworkCreate object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewStorageNetworkCreateWithDefaults instantiates a new StorageNetworkCreate object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewStorageNetworkUpdate instantiates a new StorageNetworkUpdate object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewStorageNetworkUpdateWithDefaults instantiates a new StorageNetworkUpdate object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewStorageNetworkVolumeCreate instantiates a new StorageNetworkVolumeCreate object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewStorageNetworkVolumeCreateWithDefaults instantiates a new StorageNetworkVolumeCreate object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewStorageNetworkWithDefaults instantiates a new StorageNetwork object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewTagAssignment instantiates a new TagAssignment object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewTagAssignmentRequest instantiates a new TagAssignmentRequest object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewTagAssignmentRequestWithDefaults instantiates a new TagAssignmentRequest object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewTagAssignmentWithDefaults instantiates a new TagAssignment object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewVolume instantiates a new Volume object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewVolumeCreate instantiates a new VolumeCreate object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewVolumeCreateWithDefaults instantiates a new VolumeCreate object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewVolumeUpdate instantiates a new VolumeUpdate object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewVolumeUpdateWithDefaults instantiates a new VolumeUpdate object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewVolumeWithDefaults instantiates a new Volume object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
PtrBool is a helper routine that returns a pointer to given boolean value.
PtrFloat32 is a helper routine that returns a pointer to given float value.
PtrFloat64 is a helper routine that returns a pointer to given float value.
PtrInt is a helper routine that returns a pointer to given integer value.
PtrInt32 is a helper routine that returns a pointer to given integer value.
PtrInt64 is a helper routine that returns a pointer to given integer value.
PtrString is a helper routine that returns a pointer to given string value.
PtrTime is helper routine that returns a pointer to given Time value.

# Constants

No description provided by the author
List of Status.
List of Status.
List of Status.
List of Status.

# Variables

All allowed values of Status enum.
ContextOAuth2 takes an oauth2.TokenSource as authentication for the request.
ContextOperationServerIndices uses a server configuration from the index mapping.
ContextOperationServerVariables overrides a server configuration variables using operation specific values.
ContextServerIndex uses a server configuration from the index.
ContextServerVariables overrides a server configuration variables.
No description provided by the author
No description provided by the author

# Structs

APIClient manages communication with the Network Storage API API v1.0 In most cases there should be only one, shared, APIClient.
APIKey provides API key based authentication to a request passed via context using ContextAPIKey.
APIResponse stores the API response returned by the server.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth.
Configuration stores the configuration of the API client.
Error struct for Error.
GenericOpenAPIError Provides access to the body, error and model on returned errors.
NfsPermissions NFS specific permissions on a volume.
NfsPermissionsCreate NFS specific permissions on a volume.
NfsPermissionsUpdate Update NFS specific permissions on a volume.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Permissions Permissions for a volume.
PermissionsCreate Update permissions for a volume.
PermissionsUpdate Update permissions for a volume.
ServerConfiguration stores the information about a server.
ServerVariable stores the information about a server variable.
StorageNetwork Storage network.
StorageNetworkCreate Create Storage Network.
StorageNetworkUpdate Update storage network.
StorageNetworkVolumeCreate Create Volume.
TagAssignment Tag assigned to resource.
TagAssignmentRequest Tag request to assign to resource.
Volume Volume for a storage network.
VolumeCreate Create Volume.
VolumeUpdate Update storage network volume.

# Interfaces

No description provided by the author
No description provided by the author

# Type aliases

ServerConfigurations stores multiple ServerConfiguration items.
Status Status of the resource.
StorageNetworksAPIService StorageNetworksAPI service.