Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

api

package module

Go to main page

Versions in this module

v2

v2.5.0-beta.1

Sep 15, 2021

v2.4.1-alpha1

May 17, 2021

v2.4.0

Apr 20, 2021

Changes in this version

+ func MapAPIError(err error, resp *http.Response) error

type DefaultApiService

+ func (a *DefaultApiService) GetSingleNodeDiagnostics(ctx _context.Context, id string) (*os.File, *_nethttp.Response, error)

+ func (a *DefaultApiService) SetComputeOnly(ctx _context.Context, id string, setComputeOnlyNodeData SetComputeOnlyNodeData, ...) (Node, *_nethttp.Response, error)

+ func (a *DefaultApiService) SetFailureMode(ctx _context.Context, namespaceID string, id string, ...) (Volume, *_nethttp.Response, error)

+ type FailureModeIntent string

+ const FAILUREMODEINTENT_ALWAYSON

+ const FAILUREMODEINTENT_HARD

+ const FAILUREMODEINTENT_SOFT

type Namespace

+ func (t Namespace) GetID() string

+ func (t Namespace) GetLabels() map[string]string

+ func (t Namespace) GetName() string

+ func (t Namespace) GetNamespace() string

type Node

+ func (t Node) GetID() string

+ func (t Node) GetLabels() map[string]string

+ func (t Node) GetName() string

+ func (t Node) GetNamespace() string

+ type SetComputeOnlyNodeData struct

+ ComputeOnly bool

+ Version string

+ type SetComputeOnlyOpts struct

+ IgnoreVersion optional.Bool

+ type SetFailureModeIntentRequestData struct

+ Mode FailureModeIntent

+ Version string

+ type SetFailureModeOpts struct

+ IgnoreVersion optional.Bool

+ type SetFailureModeRequest struct

+ FailureThreshold uint64

+ Mode FailureModeIntent

+ Version string

+ type SetFailureThresholdRequestData struct

+ FailureThreshold uint64

+ Version string

type Volume

+ func (t Volume) GetID() string

+ func (t Volume) GetLabels() map[string]string

+ func (t Volume) GetName() string

+ func (t Volume) GetNamespace() string

v2.4.0-alpha7

Jan 28, 2021

v2.3.0

Oct 20, 2020

Changes in this version

+ var ContextAPIKey = contextKey("apikey")

+ var ContextAccessToken = contextKey("accesstoken")

+ var ContextBasicAuth = contextKey("basic")

+ var ContextOAuth2 = contextKey("token")

+ func CacheExpires(r *http.Response) time.Time

+ type APIClient struct

+ DefaultApi *DefaultApiService

+ func NewAPIClient(cfg *Configuration) *APIClient

+ func (c *APIClient) ChangeBasePath(path string)

+ func (c *APIClient) GetConfig() *Configuration

+ type APIKey struct

+ Key string

+ Prefix string

+ type APIResponse struct

+ Message string

+ Method string

+ Operation string

+ Payload []byte

+ RequestURL string

+ func NewAPIResponse(r *http.Response) *APIResponse

+ func NewAPIResponseWithError(errorMessage string) *APIResponse

+ type AcceptedMessage struct

+ Msg string

+ type AttachNFSVolumeOpts struct

+ AsyncMax optional.String

+ IgnoreVersion optional.Bool

+ type AttachNfsVolumeData struct

+ Version string

+ type AttachType string

+ const ATTACHTYPE_DETACHED

+ const ATTACHTYPE_HOST

+ const ATTACHTYPE_NFS

+ const ATTACHTYPE_UNKNOWN

+ type AttachVolumeData struct

+ NodeID string

+ type AuthUserData struct

+ Password string

+ Username string

+ type BasicAuth struct

+ Password string

+ UserName string

+ type CapacityStats struct

+ Available uint64

+ Free uint64

+ Total uint64

+ type Cluster struct

+ CreatedAt time.Time

+ DisableCrashReporting bool

+ DisableTelemetry bool

+ DisableVersionCheck bool

+ Id string

+ LogFormat LogFormat

+ LogLevel LogLevel

+ UpdatedAt time.Time

+ Version string

+ type Configuration struct

+ BasePath string

+ Debug bool

+ DefaultHeader map[string]string

+ HTTPClient *http.Client

+ Host string

+ Scheme string

+ Servers []ServerConfiguration

+ UserAgent string

+ func NewConfiguration() *Configuration

+ func (c *Configuration) AddDefaultHeader(key string, value string)

+ func (c *Configuration) ServerUrl(index int, variables map[string]string) (string, error)

+ type CreateNamespaceData struct

+ Labels map[string]string

+ Name string

+ type CreatePolicyGroupData struct

+ Name string

+ Specs *[]PoliciesSpecs

+ type CreateUserData struct

+ Groups *[]string

+ IsAdmin bool

+ Password string

+ Username string

+ type CreateVolumeData struct

+ Description string

+ FsType FsType

+ Labels map[string]string

+ Name string

+ NamespaceID string

+ SizeBytes uint64

+ type CreateVolumeOpts struct

+ AsyncMax optional.String

+ type DefaultApiService service

+ func (a *DefaultApiService) AttachNFSVolume(ctx _context.Context, namespaceID string, id string, ...) (*_nethttp.Response, error)

+ func (a *DefaultApiService) AttachVolume(ctx _context.Context, namespaceID string, id string, ...) (*_nethttp.Response, error)

+ func (a *DefaultApiService) AuthenticateUser(ctx _context.Context, authUserData AuthUserData) (UserSession, *_nethttp.Response, error)

+ func (a *DefaultApiService) CreateNamespace(ctx _context.Context, createNamespaceData CreateNamespaceData) (Namespace, *_nethttp.Response, error)

+ func (a *DefaultApiService) CreatePolicyGroup(ctx _context.Context, createPolicyGroupData CreatePolicyGroupData) (PolicyGroup, *_nethttp.Response, error)

+ func (a *DefaultApiService) CreateUser(ctx _context.Context, createUserData CreateUserData) (User, *_nethttp.Response, error)

+ func (a *DefaultApiService) CreateVolume(ctx _context.Context, namespaceID string, createVolumeData CreateVolumeData, ...) (Volume, *_nethttp.Response, error)

+ func (a *DefaultApiService) DeleteAuthenticatedUser(ctx _context.Context, version string, ...) (*_nethttp.Response, error)

+ func (a *DefaultApiService) DeleteAuthenticatedUserSessions(ctx _context.Context) (*_nethttp.Response, error)

+ func (a *DefaultApiService) DeleteNamespace(ctx _context.Context, id string, version string, ...) (*_nethttp.Response, error)

+ func (a *DefaultApiService) DeleteNode(ctx _context.Context, id string, version string, ...) (*_nethttp.Response, error)

+ func (a *DefaultApiService) DeletePolicyGroup(ctx _context.Context, id string, version string, ...) (*_nethttp.Response, error)

+ func (a *DefaultApiService) DeleteSessions(ctx _context.Context, id string) (*_nethttp.Response, error)

+ func (a *DefaultApiService) DeleteUser(ctx _context.Context, id string, version string, ...) (*_nethttp.Response, error)

+ func (a *DefaultApiService) DeleteVolume(ctx _context.Context, namespaceID string, id string, version string, ...) (*_nethttp.Response, error)

+ func (a *DefaultApiService) DetachVolume(ctx _context.Context, namespaceID string, id string, version string, ...) (*_nethttp.Response, error)

+ func (a *DefaultApiService) GetAuthenticatedUser(ctx _context.Context) (User, *_nethttp.Response, error)

+ func (a *DefaultApiService) GetCluster(ctx _context.Context) (Cluster, *_nethttp.Response, error)

+ func (a *DefaultApiService) GetDiagnostics(ctx _context.Context) (*os.File, *_nethttp.Response, error)

+ func (a *DefaultApiService) GetLicence(ctx _context.Context) (Licence, *_nethttp.Response, error)

+ func (a *DefaultApiService) GetNamespace(ctx _context.Context, id string) (Namespace, *_nethttp.Response, error)

+ func (a *DefaultApiService) GetNode(ctx _context.Context, id string) (Node, *_nethttp.Response, error)

+ func (a *DefaultApiService) GetPolicyGroup(ctx _context.Context, id string) (PolicyGroup, *_nethttp.Response, error)

+ func (a *DefaultApiService) GetUser(ctx _context.Context, id string) (User, *_nethttp.Response, error)

+ func (a *DefaultApiService) GetVolume(ctx _context.Context, namespaceID string, id string) (Volume, *_nethttp.Response, error)

+ func (a *DefaultApiService) ListNamespaces(ctx _context.Context) ([]Namespace, *_nethttp.Response, error)

+ func (a *DefaultApiService) ListNodes(ctx _context.Context) ([]Node, *_nethttp.Response, error)

+ func (a *DefaultApiService) ListPolicyGroups(ctx _context.Context) ([]PolicyGroup, *_nethttp.Response, error)

+ func (a *DefaultApiService) ListUsers(ctx _context.Context) ([]User, *_nethttp.Response, error)

+ func (a *DefaultApiService) ListVolumes(ctx _context.Context, namespaceID string) ([]Volume, *_nethttp.Response, error)

+ func (a *DefaultApiService) RefreshJwt(ctx _context.Context) (UserSession, *_nethttp.Response, error)

+ func (a *DefaultApiService) ResizeVolume(ctx _context.Context, namespaceID string, id string, ...) (Volume, *_nethttp.Response, error)

+ func (a *DefaultApiService) SetReplicas(ctx _context.Context, namespaceID string, id string, ...) (AcceptedMessage, *_nethttp.Response, error)

+ func (a *DefaultApiService) Spec(ctx _context.Context) (string, *_nethttp.Response, error)

+ func (a *DefaultApiService) UpdateAuthenticatedUser(ctx _context.Context, updateAuthenticatedUserData UpdateAuthenticatedUserData, ...) (User, *_nethttp.Response, error)

+ func (a *DefaultApiService) UpdateCluster(ctx _context.Context, updateClusterData UpdateClusterData, ...) (Cluster, *_nethttp.Response, error)

+ func (a *DefaultApiService) UpdateLicence(ctx _context.Context, updateLicence UpdateLicence, ...) (Licence, *_nethttp.Response, error)

+ func (a *DefaultApiService) UpdateNFSVolumeExports(ctx _context.Context, namespaceID string, id string, ...) (*_nethttp.Response, error)

+ func (a *DefaultApiService) UpdateNFSVolumeMountEndpoint(ctx _context.Context, namespaceID string, id string, ...) (*_nethttp.Response, error)

+ func (a *DefaultApiService) UpdateNamespace(ctx _context.Context, id string, updateNamespaceData UpdateNamespaceData, ...) (Namespace, *_nethttp.Response, error)

+ func (a *DefaultApiService) UpdateNode(ctx _context.Context, id string, updateNodeData UpdateNodeData, ...) (Node, *_nethttp.Response, error)

+ func (a *DefaultApiService) UpdatePolicyGroup(ctx _context.Context, id string, updatePolicyGroupData UpdatePolicyGroupData, ...) (PolicyGroup, *_nethttp.Response, error)

+ func (a *DefaultApiService) UpdateUser(ctx _context.Context, id string, updateUserData UpdateUserData, ...) (User, *_nethttp.Response, error)

+ func (a *DefaultApiService) UpdateVolume(ctx _context.Context, namespaceID string, id string, ...) (Volume, *_nethttp.Response, error)

+ type DeleteAuthenticatedUserOpts struct

+ IgnoreVersion optional.Bool

+ type DeleteNamespaceOpts struct

+ IgnoreVersion optional.Bool

+ type DeleteNodeOpts struct

+ AsyncMax optional.String

+ IgnoreVersion optional.Bool

+ type DeletePolicyGroupOpts struct

+ IgnoreVersion optional.Bool

+ type DeleteUserOpts struct

+ IgnoreVersion optional.Bool

+ type DeleteVolumeOpts struct

+ AsyncMax optional.String

+ IgnoreVersion optional.Bool

+ OfflineDelete optional.Bool

+ type DeploymentInfo struct

+ Id string

+ NodeID string

+ Promotable bool

+ type DetachVolumeOpts struct

+ AsyncMax optional.String

+ IgnoreVersion optional.Bool

+ type Error struct

+ Error string

+ type FsType string

+ const FSTYPE_BLOCK

+ const FSTYPE_BTRFS

+ const FSTYPE_EXT2

+ const FSTYPE_EXT3

+ const FSTYPE_EXT4

+ const FSTYPE_XFS

+ type GenericOpenAPIError struct

+ func (e GenericOpenAPIError) Body() []byte

+ func (e GenericOpenAPIError) Error() string

+ func (e GenericOpenAPIError) Model() interface{}

+ type Licence struct

+ ClusterCapacityBytes uint64

+ ClusterID string

+ CustomerName string

+ ExpiresAt time.Time

+ Features *[]string

+ Kind string

+ UsedBytes uint64

+ Version string

+ type LogFormat string

+ const LOGFORMAT_DEFAULT

+ const LOGFORMAT_JSON

+ type LogLevel string

+ const LOGLEVEL_DEBUG

+ const LOGLEVEL_ERROR

+ const LOGLEVEL_INFO

+ const LOGLEVEL_WARN

+ type MasterDeploymentInfo struct

+ Health MasterHealth

+ Id string

+ NodeID string

+ Promotable bool

+ type MasterDeploymentInfoAllOf struct

+ Health MasterHealth

+ type MasterHealth string

+ const MASTERHEALTH_OFFLINE

+ const MASTERHEALTH_ONLINE

+ const MASTERHEALTH_UNKNOWN

+ type Namespace struct

+ CreatedAt time.Time

+ Id string

+ Labels map[string]string

+ Name string

+ UpdatedAt time.Time

+ Version string

+ type NfsAcl struct

+ AccessLevel string

+ Identity NfsAclIdentity

+ SquashConfig NfsAclSquashConfig

+ type NfsAclIdentity struct

+ IdentityType string

+ Matcher string

+ type NfsAclSquashConfig struct

+ Gid int64

+ Squash string

+ Uid int64

+ type NfsConfig struct

+ Exports *[]NfsExportConfig

+ ServiceEndpoint *string

+ type NfsExportConfig struct

+ Acls []NfsAcl

+ ExportID uint64

+ Path string

+ PseudoPath string

+ type NfsVolumeExports struct

+ Exports []NfsExportConfig

+ Version string

+ type NfsVolumeMountEndpoint struct

+ MountEndpoint string

+ Version string

+ type Node struct

+ Capacity CapacityStats

+ ClusteringEndpoint string

+ CreatedAt time.Time

+ GossipEndpoint string

+ Health NodeHealth

+ Id string

+ IoEndpoint string

+ Labels map[string]string

+ Name string

+ SupervisorEndpoint string

+ UpdatedAt time.Time

+ Version string

+ type NodeHealth string

+ const NODEHEALTH_OFFLINE

+ const NODEHEALTH_ONLINE

+ const NODEHEALTH_UNKNOWN

+ type PoliciesIdSpecs struct

+ NamespaceID string

+ ReadOnly bool

+ ResourceType string

+ type PoliciesSpecs struct

+ NamespaceID string

+ ReadOnly bool

+ ResourceType string

+ type PolicyGroup struct

+ CreatedAt time.Time

+ Id string

+ Name string

+ Specs *[]PoliciesIdSpecs

+ UpdatedAt time.Time

+ Users []PolicyGroupUsers

+ Version string

+ type PolicyGroupUsers struct

+ Id string

+ Username string

+ type ReplicaDeploymentInfo struct

+ Health ReplicaHealth

+ Id string

+ NodeID string

+ Promotable bool

+ SyncProgress SyncProgress

+ type ReplicaDeploymentInfoAllOf struct

+ Health ReplicaHealth

+ SyncProgress SyncProgress

+ type ReplicaHealth string

+ const REPLICAHEALTH_DELETED

+ const REPLICAHEALTH_FAILED

+ const REPLICAHEALTH_PROVISIONED

+ const REPLICAHEALTH_PROVISIONING

+ const REPLICAHEALTH_READY

+ const REPLICAHEALTH_RECOVERING

+ const REPLICAHEALTH_SYNCING

+ const REPLICAHEALTH_UNKNOWN

+ type ResizeVolumeOpts struct

+ AsyncMax optional.String

+ IgnoreVersion optional.Bool

+ type ResizeVolumeRequest struct

+ SizeBytes uint64

+ Version string

+ type ServerConfiguration struct

+ Description string

+ Url string

+ Variables map[string]ServerVariable

+ type ServerVariable struct

+ DefaultValue string

+ Description string

+ EnumValues []string

+ type SetReplicasOpts struct

+ IgnoreVersion optional.Bool

+ type SetReplicasRequest struct

+ Replicas uint64

+ Version string

+ type SyncProgress struct

+ BytesRemaining uint64

+ EstimatedSecondsRemaining uint64

+ ThroughputBytes uint64

+ type UpdateAuthenticatedUserData struct

+ Password string

+ Version string

+ type UpdateAuthenticatedUserOpts struct

+ IgnoreVersion optional.Bool

+ type UpdateClusterData struct

+ DisableCrashReporting bool

+ DisableTelemetry bool

+ DisableVersionCheck bool

+ LogFormat LogFormat

+ LogLevel LogLevel

+ Version string

+ type UpdateClusterOpts struct

+ IgnoreVersion optional.Bool

+ type UpdateLicence struct

+ Key string

+ Version string

+ type UpdateLicenceOpts struct

+ IgnoreVersion optional.Bool

+ type UpdateNFSVolumeExportsOpts struct

+ AsyncMax optional.String

+ IgnoreVersion optional.Bool

+ type UpdateNFSVolumeMountEndpointOpts struct

+ AsyncMax optional.String

+ IgnoreVersion optional.Bool

+ type UpdateNamespaceData struct

+ Labels map[string]string

+ Version string

+ type UpdateNamespaceOpts struct

+ IgnoreVersion optional.Bool

+ type UpdateNodeData struct

+ Labels map[string]string

+ Version string

+ type UpdateNodeOpts struct

+ IgnoreVersion optional.Bool

+ type UpdatePolicyGroupData struct

+ Specs *[]PoliciesIdSpecs

+ Version string

+ type UpdatePolicyGroupOpts struct

+ IgnoreVersion optional.Bool

+ type UpdateUserData struct

+ Groups *[]string

+ IsAdmin bool

+ Password string

+ Version string

+ type UpdateUserOpts struct

+ IgnoreVersion optional.Bool

+ type UpdateVolumeData struct

+ Description string

+ Labels map[string]string

+ Version string

+ type UpdateVolumeOpts struct

+ AsyncMax optional.String

+ IgnoreVersion optional.Bool

+ type User struct

+ CreatedAt time.Time

+ Groups *[]string

+ Id string

+ IsAdmin bool

+ UpdatedAt time.Time

+ Username string

+ Version string

+ type UserSession struct

+ CreatedAt time.Time

+ Groups *[]string

+ Id string

+ IsAdmin bool

+ Session UserSessionAllOfSession

+ UpdatedAt time.Time

+ Username string

+ Version string

+ type UserSessionAllOf struct

+ Session UserSessionAllOfSession

+ type UserSessionAllOfSession struct

+ ExpiresInSeconds uint64

+ Token string

+ type Volume struct

+ AttachedOn string

+ AttachmentType AttachType

+ CreatedAt time.Time

+ Description string

+ FsType FsType

+ Id string

+ Labels map[string]string

+ Master MasterDeploymentInfo

+ Name string

+ NamespaceID string

+ Nfs NfsConfig

+ Replicas *[]ReplicaDeploymentInfo

+ SizeBytes uint64

+ UpdatedAt time.Time

+ Version string

Other modules containing this package

github.com/storageos/go-api