api

package
v0.0.0-...-20e9866 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 29, 2022 License: MIT Imports: 23 Imported by: 0

README

Go API client for api

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

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.

  • API version: 2.8.0
  • Package version: 2.9.0
  • Build package: org.openapitools.codegen.languages.GoClientCodegen For more information, please visit https://www.ondat.io/

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
go get github.com/antihax/optional

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

import "./api"

Documentation for API Endpoints

All URIs are relative to http://localhost/v2

Class Method HTTP request Description
DefaultApi AddDeploymentOnNode Put /namespaces/{namespaceID}/volumes/{id}/add-deployment-on-node Creates a new replica deployment on a specific node.
DefaultApi AttachNFSVolume Post /namespaces/{namespaceID}/volumes/{id}/nfs/attach attach and share the volume using NFS
DefaultApi AttachVolume Post /namespaces/{namespaceID}/volumes/{id}/attach Attach a volume to the given node
DefaultApi AttemptPromotion Put /namespaces/{namespaceID}/volumes/{id}/debug/attempt-replica-promotion/{deploymentID} Attempt a promotion of a replica to a master
DefaultApi AuthenticateUser Post /auth/login Authenticate a user
DefaultApi CreateNamespace Post /namespaces Create a new namespace
DefaultApi CreatePolicyGroup Post /policies Create a new policy group
DefaultApi CreatePool Post /pools Create a new Pool
DefaultApi CreateUser Post /users Create a new user
DefaultApi CreateVolume Post /namespaces/{namespaceID}/volumes Create a new Volume in the specified namespace
DefaultApi DeleteAuthenticatedUser Delete /users/self Delete the authenticated user
DefaultApi DeleteAuthenticatedUserSessions Delete /users/self/sessions Invalidate the logged in user's sessions
DefaultApi DeleteNamespace Delete /namespaces/{id} Delete a namespace
DefaultApi DeleteNode Delete /nodes/{id} Delete a node
DefaultApi DeletePolicyGroup Delete /policies/{id} Delete a policy group
DefaultApi DeletePool Delete /pools/{id} Delete a pool
DefaultApi DeleteSessions Delete /users/{id}/sessions Invalidate login sessions
DefaultApi DeleteUser Delete /users/{id} Delete a user
DefaultApi DeleteVolume Delete /namespaces/{namespaceID}/volumes/{id} Delete a volume
DefaultApi DetachVolume Delete /namespaces/{namespaceID}/volumes/{id}/attach Detach the given volume
DefaultApi EvictReplica Delete /namespaces/{namespaceID}/volumes/{id}/debug/evict/{deploymentID} Remove a replica from the volume's replica set, create a new replica somwewhere else. Note: if the node the evicted replica is located on is not cordoned, the new replica might be created on that node.
DefaultApi GetAuthenticatedUser Get /users/self Get the currently authenticated user's information
DefaultApi GetCluster Get /cluster Retrieves the cluster's global configuration settings
DefaultApi GetDiagnostics Get /diagnostics Retrieves a diagnostics bundle from the target node
DefaultApi GetLicence Get /cluster/licence Retrieves the cluster's licence information
DefaultApi GetNamespace Get /namespaces/{id} Fetch a namespace
DefaultApi GetNode Get /nodes/{id} Fetch a node
DefaultApi GetPolicyGroup Get /policies/{id} Fetch a policy group
DefaultApi GetPool Get /pools/{id} Fetch a Pool
DefaultApi GetSingleNodeDiagnostics Get /diagnostics/{id} Retrieves a single node diagnostics bundle from the target node
DefaultApi GetUser Get /users/{id} Fetch a user
DefaultApi GetVolume Get /namespaces/{namespaceID}/volumes/{id} Fetch a volume
DefaultApi ListNamespaces Get /namespaces Fetch the list of namespaces
DefaultApi ListNodes Get /nodes Fetch the list of nodes
DefaultApi ListPolicyGroups Get /policies Fetch the list of policy groups
DefaultApi ListPools Get /pools Fetch the list of pools
DefaultApi ListUsers Get /users Fetch the list of users
DefaultApi ListVolumes Get /namespaces/{namespaceID}/volumes Fetch the list of volumes in the given namespace
DefaultApi RefreshJwt Post /auth/refresh Refresh the JWT
DefaultApi ResizeVolume Put /namespaces/{namespaceID}/volumes/{id}/size Increase the size of a volume.
DefaultApi SetComputeOnly Put /nodes/{id}/compute-only Modify the computeonly behaviour state for a node
DefaultApi SetCordoned Put /nodes/{id}/cordon Modify the cordoned state for a node
DefaultApi SetFailureMode Put /namespaces/{namespaceID}/volumes/{id}/failure-mode Set the failure mode of the volume.
DefaultApi SetPlacementStrategy Put /namespaces/{namespaceID}/volumes/{id}/placement-strategy Sets the placement strategy of the volume.
DefaultApi SetPreferredEvictionCandidates Put /namespaces/{namespaceID}/volumes/{id}/preferred-eviction-candidates Specifies a list of deployments to be preferred to be evicted.
DefaultApi SetReplicas Put /namespaces/{namespaceID}/volumes/{id}/replicas Set the number of replicas to maintain for the volume.
DefaultApi Spec Get /openapi Serves this openapi spec file
DefaultApi UpdateAuthenticatedUser Put /users/self Update the authenticated user's information
DefaultApi UpdateCluster Put /cluster Update the cluster's global configuration settings
DefaultApi UpdateLicence Put /cluster/licence Update the licence global configuration settings
DefaultApi UpdateNFSVolumeExports Put /namespaces/{namespaceID}/volumes/{id}/nfs/export-config Update an nfs volume's export configuration
DefaultApi UpdateNFSVolumeMountEndpoint Put /namespaces/{namespaceID}/volumes/{id}/nfs/mount-endpoint Update an nfs volume's mount endpoint
DefaultApi UpdateNamespace Put /namespaces/{id} Update a namespace
DefaultApi UpdateNode Put /nodes/{id} Update a node
DefaultApi UpdatePolicyGroup Put /policies/{id} Update a policy group
DefaultApi UpdatePool Put /pools/{id} Update a Pool
DefaultApi UpdateUser Put /users/{id} Update a user
DefaultApi UpdateVolume Put /namespaces/{namespaceID}/volumes/{id} Update a volume

Documentation For Models

Documentation For Authorization

jwt

  • Type: HTTP basic authentication

Example

auth := context.WithValue(context.Background(), sw.ContextBasicAuth, sw.BasicAuth{
    UserName: "username",
    Password: "password",
})
r, err := client.Service.Operation(auth, args)

Author

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	// ContextOAuth2 takes an oauth2.TokenSource as authentication for the request.
	ContextOAuth2 = contextKey("token")

	// ContextBasicAuth takes BasicAuth as authentication for the request.
	ContextBasicAuth = contextKey("basic")

	// ContextAccessToken takes a string oauth2 access token as authentication for the request.
	ContextAccessToken = contextKey("accesstoken")

	// ContextAPIKey takes an APIKey as authentication for the request
	ContextAPIKey = contextKey("apikey")
)

Functions

func CacheExpires 

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

CacheExpires helper function to determine remaining time before repeating a request.

Types

type APIClient 

type APIClient struct {
	DefaultApi *DefaultApiService
	// contains filtered or unexported fields
}

APIClient manages communication with the Ondat API API v2.8.0 In most cases there should be only one, shared, APIClient.

func NewAPIClient 

func NewAPIClient(cfg *Configuration) *APIClient

NewAPIClient creates a new API client. Requires a userAgent string describing your application. optionally a custom http.Client to allow for advanced features such as caching.

func (*APIClient) ChangeBasePath 

func (c *APIClient) ChangeBasePath(path string)

ChangeBasePath changes base path to allow switching to mocks

func (*APIClient) GetConfig 

func (c *APIClient) GetConfig() *Configuration

Allow modification of underlying config for alternate implementations and testing Caution: modifying the configuration while live can cause data races and potentially unwanted behavior

type APIKey 

type APIKey struct {
	Key    string
	Prefix string
}

APIKey provides API key based authentication to a request passed via context using ContextAPIKey

type APIResponse 

type APIResponse struct {
	*http.Response `json:"-"`
	Message        string `json:"message,omitempty"`
	// Operation is the name of the OpenAPI operation.
	Operation string `json:"operation,omitempty"`
	// RequestURL is the request URL. This value is always available, even if the
	// embedded *http.Response is nil.
	RequestURL string `json:"url,omitempty"`
	// Method is the HTTP method used for the request.  This value is always
	// available, even if the embedded *http.Response is nil.
	Method string `json:"method,omitempty"`
	// Payload holds the contents of the response body (which may be nil or empty).
	// This is provided here as the raw response.Body() reader will have already
	// been drained.
	Payload []byte `json:"-"`
}

APIResponse stores the API response returned by the server.

func NewAPIResponse 

func NewAPIResponse(r *http.Response) *APIResponse

NewAPIResponse returns a new APIResonse object.

func NewAPIResponseWithError 

func NewAPIResponseWithError(errorMessage string) *APIResponse

NewAPIResponseWithError returns a new APIResponse object with the provided error message.

type AcceptedMessage 

type AcceptedMessage struct {
	Msg string `json:"msg,omitempty"`
}

AcceptedMessage struct for AcceptedMessage

type AddDeploymentOnNodeData 

type AddDeploymentOnNodeData struct {
	NodeID string `json:"nodeID,omitempty"`
	// An opaque representation of an entity version at the time it was obtained from the API. All operations that mutate the entity must include this version field in the request unchanged. The format of this type is undefined and may change but the defined properties will not change.
	Version string `json:"version,omitempty"`
}

AddDeploymentOnNodeData struct for AddDeploymentOnNodeData

type AddDeploymentOnNodeOpts 

type AddDeploymentOnNodeOpts struct {
	IgnoreVersion optional.Bool
}

AddDeploymentOnNodeOpts Optional parameters for the method 'AddDeploymentOnNode'

type AttachNFSVolumeOpts 

type AttachNFSVolumeOpts struct {
	IgnoreVersion optional.Bool
	AsyncMax      optional.String
}

AttachNFSVolumeOpts Optional parameters for the method 'AttachNFSVolume'

type AttachNfsVolumeData 

type AttachNfsVolumeData struct {
	// An opaque representation of an entity version at the time it was obtained from the API. All operations that mutate the entity must include this version field in the request unchanged. The format of this type is undefined and may change but the defined properties will not change.
	Version string `json:"version,omitempty"`
}

AttachNfsVolumeData struct for AttachNfsVolumeData

type AttachType 

type AttachType string

AttachType The attachment type of a volume. \"host\" indicates that the volume is consumed by the node it is attached to. 

const (
	ATTACHTYPE_UNKNOWN  AttachType = "unknown"
	ATTACHTYPE_DETACHED AttachType = "detached"
	ATTACHTYPE_NFS      AttachType = "nfs"
	ATTACHTYPE_HOST     AttachType = "host"
)

List of AttachType

type AttachVolumeData 

type AttachVolumeData struct {
	// A unique identifier for a node. The format of this type is undefined and may change but the defined properties will not change.
	NodeID string `json:"nodeID,omitempty"`
}

AttachVolumeData struct for AttachVolumeData

type AuthUserData 

type AuthUserData struct {
	Username string `json:"username"`
	Password string `json:"password"`
}

AuthUserData struct for AuthUserData

type BasicAuth 

type BasicAuth struct {
	UserName string `json:"userName,omitempty"`
	Password string `json:"password,omitempty"`
}

BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth

type CapacityStats 

type CapacityStats struct {
	// Total bytes in the filesystem
	Total uint64 `json:"total,omitempty"`
	// Free bytes in the filesystem available to root user
	Free uint64 `json:"free,omitempty"`
	// Byte value available to an unprivileged user
	Available uint64 `json:"available,omitempty"`
}

CapacityStats struct for CapacityStats

type Cluster 

type Cluster struct {
	// A unique identifier for a cluster. The format of this type is undefined and may change but the defined properties will not change.
	Id string `json:"id,omitempty"`
	// Disables collection of telemetry data across the cluster.
	DisableTelemetry bool `json:"disableTelemetry,omitempty"`
	// Disables collection of reports for any fatal crashes across the cluster.
	DisableCrashReporting bool `json:"disableCrashReporting,omitempty"`
	// Disables the mechanism responsible for checking if there is an updated version of Ondat available for installation.
	DisableVersionCheck bool      `json:"disableVersionCheck,omitempty"`
	LogLevel            LogLevel  `json:"logLevel,omitempty"`
	LogFormat           LogFormat `json:"logFormat,omitempty"`
	// The time the entity was created. This timestamp is set by the node that created the entity, and may not be correct if the node's local clock was skewed. This value is for the user's informative purposes only, and correctness is not required. String format is RFC3339.
	CreatedAt time.Time `json:"createdAt,omitempty"`
	// The time the entity was last updated. This timestamp is set by the node that last updated the entity, and may not be correct if the node's local clock was skewed. This value is for the user's informative purposes only, and correctness is not required. String format is RFC3339.
	UpdatedAt time.Time `json:"updatedAt,omitempty"`
	// An opaque representation of an entity version at the time it was obtained from the API. All operations that mutate the entity must include this version field in the request unchanged. The format of this type is undefined and may change but the defined properties will not change.
	Version string `json:"version,omitempty"`
}

Cluster struct for Cluster

type Configuration 

type Configuration struct {
	BasePath      string            `json:"basePath,omitempty"`
	Host          string            `json:"host,omitempty"`
	Scheme        string            `json:"scheme,omitempty"`
	DefaultHeader map[string]string `json:"defaultHeader,omitempty"`
	UserAgent     string            `json:"userAgent,omitempty"`
	Debug         bool              `json:"debug,omitempty"`
	Servers       []ServerConfiguration
	HTTPClient    *http.Client
}

Configuration stores the configuration of the API client

func NewConfiguration 

func NewConfiguration() *Configuration

NewConfiguration returns a new Configuration object

func (*Configuration) AddDefaultHeader 

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

AddDefaultHeader adds a new HTTP header to the default header in the request

func (*Configuration) ServerUrl 

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

ServerUrl returns URL based on server settings

type CreateNamespaceData 

type CreateNamespaceData struct {
	// The name of the namespace shown in the CLI and UI
	Name string `json:"name,omitempty"`
	// A set of arbitrary key value labels to apply to the entity.
	Labels map[string]string `json:"labels,omitempty"`
}

CreateNamespaceData struct for CreateNamespaceData

type CreatePolicyGroupData 

type CreatePolicyGroupData struct {
	Name string `json:"name,omitempty"`
	// A set of authorisation policies to apply to the policy group.
	Specs *[]PoliciesSpecs `json:"specs,omitempty"`
}

CreatePolicyGroupData struct for CreatePolicyGroupData

type CreatePoolData 

type CreatePoolData struct {
	// The name of the pool
	Name               string              `json:"name"`
	NodeToDriveMapping map[string][]string `json:"nodeToDriveMapping"`
}

CreatePoolData struct for CreatePoolData

type CreateUserData 

type CreateUserData struct {
	Username string `json:"username"`
	// If not present, the existing password is not changed
	Password string `json:"password"`
	// If true, this user is an administrator of the cluster. Administrators bypass the usual authentication checks and are granted access to all resources. Some actions (such as adding a new user) can only be performed by an administrator.
	IsAdmin bool `json:"isAdmin,omitempty"`
	// Defines a set of policy group IDs this user is a member of. Policy groups can be used to logically group users and apply authorisation  policies to all members.
	Groups *[]string `json:"groups,omitempty"`
}

CreateUserData struct for CreateUserData

type CreateVolumeData 

type CreateVolumeData struct {
	// A unique identifier for a namespace. The format of this type is undefined and may change but the defined properties will not change..
	NamespaceID string `json:"namespaceID"`
	// A set of arbitrary key value labels to apply to the entity.
	Labels map[string]string `json:"labels,omitempty"`
	// The name of the volume shown in the CLI and UI
	Name        string `json:"name"`
	FsType      FsType `json:"fsType"`
	Description string `json:"description,omitempty"`
	// A volume's size in bytes
	SizeBytes         uint64   `json:"sizeBytes"`
	PlacementStrategy Strategy `json:"placementStrategy,omitempty"`
}

CreateVolumeData struct for CreateVolumeData

type CreateVolumeOpts 

type CreateVolumeOpts struct {
	AsyncMax optional.String
}

CreateVolumeOpts Optional parameters for the method 'CreateVolume'

type DefaultApiService 

type DefaultApiService service

DefaultApiService DefaultApi service

func (*DefaultApiService) AddDeploymentOnNode 

func (a *DefaultApiService) AddDeploymentOnNode(ctx _context.Context, namespaceID string, id string, addDeploymentOnNodeData AddDeploymentOnNodeData, localVarOptionals *AddDeploymentOnNodeOpts) (AcceptedMessage, *_nethttp.Response, error)

AddDeploymentOnNode Creates a new replica deployment on a specific node. Creates a new replica deployment on a specific node. The new deployment is not excluded from any rules that move, failover or remove deployments and as such it can still be moved elsewhere if the Control Plane thinks wise to do so after being created.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param namespaceID ID of a Namespace
  • @param id ID of a Volume
  • @param addDeploymentOnNodeData
  • @param optional nil or *AddDeploymentOnNodeOpts - Optional Parameters:
  • @param "IgnoreVersion" (optional.Bool) - If set to true this value indicates that the user wants to ignore entity version constraints, thereby \"forcing\" the operation.

@return AcceptedMessage

func (*DefaultApiService) AttachNFSVolume 

func (a *DefaultApiService) AttachNFSVolume(ctx _context.Context, namespaceID string, id string, attachNfsVolumeData AttachNfsVolumeData, localVarOptionals *AttachNFSVolumeOpts) (*_nethttp.Response, error)

AttachNFSVolume attach and share the volume using NFS Attach the given volume as an NFS volume. If no export configuration has been set via the /nfs/export-config endpoint, the nfs service will start with defaults settings (sharing the volume at its root).

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param namespaceID ID of a Namespace
  • @param id ID of a Volume
  • @param attachNfsVolumeData
  • @param optional nil or *AttachNFSVolumeOpts - Optional Parameters:
  • @param "IgnoreVersion" (optional.Bool) - If set to true this value indicates that the user wants to ignore entity version constraints, thereby \"forcing\" the operation.
  • @param "AsyncMax" (optional.String) - Optional parameter which will make the api request asynchronous. The operation will not be cancelled even if the client disconnect. The URL parameter value overrides the \"async-max\" header value, if any. The value of this header defines the timeout duration for the request, it must be set to a valid duration string. A duration string is a possibly signed sequence of decimal numbers, each with optional fraction and a unit suffix, such as \"300ms\", or \"2h45m\". Valid time units are \"ns\", \"us\" (or \"µs\"), \"ms\", \"s\", \"m\", \"h\". We reject negative or nil duration values.

func (*DefaultApiService) AttachVolume 

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

AttachVolume Attach a volume to the given node Attach the volume identified by id to the node identified in the request's body.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param namespaceID ID of a Namespace
  • @param id ID of a Volume
  • @param attachVolumeData

func (*DefaultApiService) AttemptPromotion 

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

AttemptPromotion Attempt a promotion of a replica to a master A debug method that will attempt to promote a replica to a master This will introduce instability to the cluster and should not be used unless instructed by an Ondat engineer This will likely not succeed if the master is healthy.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param namespaceID ID of a Namespace
  • @param id ID of a Volume
  • @param deploymentID ID of an existing replica that should become the main deployment

func (*DefaultApiService) AuthenticateUser 

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

AuthenticateUser Authenticate a user Generate a new JWT token for a user.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param authUserData

@return UserSession

func (*DefaultApiService) CreateNamespace 

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

CreateNamespace Create a new namespace Create a new namespace in the cluster - only administrators can create new namespaces.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param createNamespaceData

@return Namespace

func (*DefaultApiService) CreatePolicyGroup 

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

CreatePolicyGroup Create a new policy group Create a new policy group in the cluster - only administrators can create new policy groups.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param createPolicyGroupData

@return PolicyGroup

func (*DefaultApiService) CreatePool 

func (a *DefaultApiService) CreatePool(ctx _context.Context, createPoolData CreatePoolData) (Pool, *_nethttp.Response, error)

CreatePool Create a new Pool Create a new Pool

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param createPoolData

@return Pool

func (*DefaultApiService) CreateUser 

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

CreateUser Create a new user Create a new user in the cluster - only administrators can create new users.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param createUserData

@return User

func (*DefaultApiService) CreateVolume 

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

CreateVolume Create a new Volume in the specified namespace Create a new volume in the given namespace

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param namespaceID ID of a Namespace
  • @param createVolumeData
  • @param optional nil or *CreateVolumeOpts - Optional Parameters:
  • @param "AsyncMax" (optional.String) - Optional parameter which will make the api request asynchronous. The operation will not be cancelled even if the client disconnect. The URL parameter value overrides the \"async-max\" header value, if any. The value of this header defines the timeout duration for the request, it must be set to a valid duration string. A duration string is a possibly signed sequence of decimal numbers, each with optional fraction and a unit suffix, such as \"300ms\", or \"2h45m\". Valid time units are \"ns\", \"us\" (or \"µs\"), \"ms\", \"s\", \"m\", \"h\". We reject negative or nil duration values.

@return Volume

func (*DefaultApiService) DeleteAuthenticatedUser 

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

DeleteAuthenticatedUser Delete the authenticated user Remove the authenticated user from the cluster.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param version This value is used to perform a conditional delete or update of the entity. If the entity has been modified since the version token was obtained, the request will fail with a HTTP 409 Conflict.
  • @param optional nil or *DeleteAuthenticatedUserOpts - Optional Parameters:
  • @param "IgnoreVersion" (optional.Bool) - If set to true this value indicates that the user wants to ignore entity version constraints, thereby \"forcing\" the operation.

func (*DefaultApiService) DeleteAuthenticatedUserSessions 

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

DeleteAuthenticatedUserSessions Invalidate the logged in user's sessions Invalidates logged in user's active JWTs.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

func (*DefaultApiService) DeleteNamespace 

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

DeleteNamespace Delete a namespace Remove the namespace identified by id.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id ID of a namespace
  • @param version This value is used to perform a conditional delete or update of the entity. If the entity has been modified since the version token was obtained, the request will fail with a HTTP 409 Conflict.
  • @param optional nil or *DeleteNamespaceOpts - Optional Parameters:
  • @param "IgnoreVersion" (optional.Bool) - If set to true this value indicates that the user wants to ignore entity version constraints, thereby \"forcing\" the operation.

func (*DefaultApiService) DeleteNode 

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

DeleteNode Delete a node Remove the node identified by id. A node can only be deleted if it is currently offline and does not host any master deployments.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id ID of a node
  • @param version This value is used to perform a conditional delete or update of the entity. If the entity has been modified since the version token was obtained, the request will fail with a HTTP 409 Conflict.
  • @param optional nil or *DeleteNodeOpts - Optional Parameters:
  • @param "IgnoreVersion" (optional.Bool) - If set to true this value indicates that the user wants to ignore entity version constraints, thereby \"forcing\" the operation.
  • @param "AsyncMax" (optional.String) - Optional parameter which will make the api request asynchronous. The operation will not be cancelled even if the client disconnect. The URL parameter value overrides the \"async-max\" header value, if any. The value of this header defines the timeout duration for the request, it must be set to a valid duration string. A duration string is a possibly signed sequence of decimal numbers, each with optional fraction and a unit suffix, such as \"300ms\", or \"2h45m\". Valid time units are \"ns\", \"us\" (or \"µs\"), \"ms\", \"s\", \"m\", \"h\". We reject negative or nil duration values.

func (*DefaultApiService) DeletePolicyGroup 

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

DeletePolicyGroup Delete a policy group Remove the policy group identified by id.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id ID of a policy group
  • @param version This value is used to perform a conditional delete or update of the entity. If the entity has been modified since the version token was obtained, the request will fail with a HTTP 409 Conflict.
  • @param optional nil or *DeletePolicyGroupOpts - Optional Parameters:
  • @param "IgnoreVersion" (optional.Bool) - If set to true this value indicates that the user wants to ignore entity version constraints, thereby \"forcing\" the operation.

func (*DefaultApiService) DeletePool 

func (a *DefaultApiService) DeletePool(ctx _context.Context, id string, version string, localVarOptionals *DeletePoolOpts) (*_nethttp.Response, error)

DeletePool Delete a pool Remove the pool identified by id. If there are volumes using the pool this request will be reject.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id ID of a Pool
  • @param version This value is used to perform a conditional delete or update of the entity. If the entity has been modified since the version token was obtained, the request will fail with a HTTP 409 Conflict.
  • @param optional nil or *DeletePoolOpts - Optional Parameters:
  • @param "IgnoreVersion" (optional.Bool) - If set to true this value indicates that the user wants to ignore entity version constraints, thereby \"forcing\" the operation.

func (*DefaultApiService) DeleteSessions 

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

DeleteSessions Invalidate login sessions Invalidates active JWTs on a per-user basis, specified by id. This request will not succeed if the target account is the currently authenticated account. Use the separate users/self endpoint for this purpose.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id ID of a user

func (*DefaultApiService) DeleteUser 

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

DeleteUser Delete a user Remove the user identified by id. This request will not succeed if the target account is the currently authenticated account. Use the separate users/self endpoint for this purpose.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id ID of a user
  • @param version This value is used to perform a conditional delete or update of the entity. If the entity has been modified since the version token was obtained, the request will fail with a HTTP 409 Conflict.
  • @param optional nil or *DeleteUserOpts - Optional Parameters:
  • @param "IgnoreVersion" (optional.Bool) - If set to true this value indicates that the user wants to ignore entity version constraints, thereby \"forcing\" the operation.

func (*DefaultApiService) DeleteVolume 

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

DeleteVolume Delete a volume Remove the volume identified by id.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param namespaceID ID of a Namespace
  • @param id ID of a Volume
  • @param version This value is used to perform a conditional delete or update of the entity. If the entity has been modified since the version token was obtained, the request will fail with a HTTP 409 Conflict.
  • @param optional nil or *DeleteVolumeOpts - Optional Parameters:
  • @param "IgnoreVersion" (optional.Bool) - If set to true this value indicates that the user wants to ignore entity version constraints, thereby \"forcing\" the operation.
  • @param "AsyncMax" (optional.String) - Optional parameter which will make the api request asynchronous. The operation will not be cancelled even if the client disconnect. The URL parameter value overrides the \"async-max\" header value, if any. The value of this header defines the timeout duration for the request, it must be set to a valid duration string. A duration string is a possibly signed sequence of decimal numbers, each with optional fraction and a unit suffix, such as \"300ms\", or \"2h45m\". Valid time units are \"ns\", \"us\" (or \"µs\"), \"ms\", \"s\", \"m\", \"h\". We reject negative or nil duration values.
  • @param "OfflineDelete" (optional.Bool) - If set to true, enables deletion of a volume when all deployments are offline, bypassing the host nodes which cannot be reached. An offline delete request will be rejected when either a) there are online deployments for the target volume or b) there is evidence that an unreachable node still has the volume master

func (*DefaultApiService) DetachVolume 

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

DetachVolume Detach the given volume Detach the volume identified by id.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param namespaceID ID of a Namespace
  • @param id ID of a Volume
  • @param version This value is used to perform a conditional delete or update of the entity. If the entity has been modified since the version token was obtained, the request will fail with a HTTP 409 Conflict.
  • @param optional nil or *DetachVolumeOpts - Optional Parameters:
  • @param "IgnoreVersion" (optional.Bool) - If set to true this value indicates that the user wants to ignore entity version constraints, thereby \"forcing\" the operation.
  • @param "AsyncMax" (optional.String) - Optional parameter which will make the api request asynchronous. The operation will not be cancelled even if the client disconnect. The URL parameter value overrides the \"async-max\" header value, if any. The value of this header defines the timeout duration for the request, it must be set to a valid duration string. A duration string is a possibly signed sequence of decimal numbers, each with optional fraction and a unit suffix, such as \"300ms\", or \"2h45m\". Valid time units are \"ns\", \"us\" (or \"µs\"), \"ms\", \"s\", \"m\", \"h\". We reject negative or nil duration values.

func (*DefaultApiService) EvictReplica 

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

EvictReplica Remove a replica from the volume's replica set, create a new replica somwewhere else. Note: if the node the evicted replica is located on is not cordoned, the new replica might be created on that node.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param namespaceID ID of a Namespace
  • @param id ID of a Volume
  • @param deploymentID ID of an existing replica that should become the main deployment

func (*DefaultApiService) GetAuthenticatedUser 

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

GetAuthenticatedUser Get the currently authenticated user's information Fetch authenticated user's information.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return User

func (*DefaultApiService) GetCluster 

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

GetCluster Retrieves the cluster's global configuration settings Retrieves the current global configuration settings in use by the cluster.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return Cluster

func (*DefaultApiService) GetDiagnostics 

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

GetDiagnostics Retrieves a diagnostics bundle from the target node Requests that the recipient node gathers information about the global state of the cluster and detailed information about the local state of each node in the cluster, using it to then build and return a bundle which can be used for troubleshooting. For clusters in an unhealthy state this may result in a slower, incomplete response. If the cluster has many nodes, it is recommended to use the single node diagnostic collection endpoint to target the desired nodes in turn. The request will only be served when the authenticated user is an administrator.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return *os.File

func (*DefaultApiService) GetLicence 

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

GetLicence Retrieves the cluster's licence information Retrieves the cluster's current licence information

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return Licence

func (*DefaultApiService) GetNamespace 

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

GetNamespace Fetch a namespace Fetch the namespace identified by id.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id ID of a namespace

@return Namespace

func (*DefaultApiService) GetNode 

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

GetNode Fetch a node Fetch the node identified by id.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id ID of a node

@return Node

func (*DefaultApiService) GetPolicyGroup 

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

GetPolicyGroup Fetch a policy group Fetch the policy group identified by id.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id ID of a policy group

@return PolicyGroup

func (*DefaultApiService) GetPool 

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

GetPool Fetch a Pool Fetch the pool identified by id.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id ID of a Pool

@return Pool

func (*DefaultApiService) GetSingleNodeDiagnostics 

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

GetSingleNodeDiagnostics Retrieves a single node diagnostics bundle from the target node Requests that the recipient node gathers information about the global state of the cluster and detailed information about the target node, using it to then build and return a bundle which can be used for troubleshooting. If the target node is in an unhealthy state then the response may be slower and incomplete. The request will only be served when the authenticated user is an administrator.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id ID of a node

@return *os.File

func (*DefaultApiService) GetUser 

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

GetUser Fetch a user Fetch the user identified by id.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id ID of a user

@return User

func (*DefaultApiService) GetVolume 

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

GetVolume Fetch a volume Fetch the volume identified by id.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param namespaceID ID of a Namespace
  • @param id ID of a Volume

@return Volume

func (*DefaultApiService) ListNamespaces 

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

ListNamespaces Fetch the list of namespaces Fetch the list of namespaces in the cluster.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return []Namespace

func (*DefaultApiService) ListNodes 

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

ListNodes Fetch the list of nodes Fetch the list of nodes of the cluster.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return []Node

func (*DefaultApiService) ListPolicyGroups 

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

ListPolicyGroups Fetch the list of policy groups Fetch the list of policy groups in the cluster.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return []PolicyGroup

func (*DefaultApiService) ListPools 

func (a *DefaultApiService) ListPools(ctx _context.Context) ([]Pool, *_nethttp.Response, error)

ListPools Fetch the list of pools Fetch the list of pools in the cluster.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return []Pool

func (*DefaultApiService) ListUsers 

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

ListUsers Fetch the list of users Fetch the list of users of the cluster.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return []User

func (*DefaultApiService) ListVolumes 

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

ListVolumes Fetch the list of volumes in the given namespace Fetch the list of volumes in the cluster.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param namespaceID ID of a Namespace

@return []Volume

func (*DefaultApiService) RefreshJwt 

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

RefreshJwt Refresh the JWT Obtain a fresh token with an updated expiry deadline.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return UserSession

func (*DefaultApiService) ResizeVolume 

func (a *DefaultApiService) ResizeVolume(ctx _context.Context, namespaceID string, id string, resizeVolumeRequest ResizeVolumeRequest, localVarOptionals *ResizeVolumeOpts) (Volume, *_nethttp.Response, error)

ResizeVolume Increase the size of a volume. Resize the volume identified by id in the namespace identified by namespaceID. A volume's size cannot be reduced.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param namespaceID ID of a Namespace
  • @param id ID of a Volume
  • @param resizeVolumeRequest
  • @param optional nil or *ResizeVolumeOpts - Optional Parameters:
  • @param "AsyncMax" (optional.String) - Optional parameter which will make the api request asynchronous. The operation will not be cancelled even if the client disconnect. The URL parameter value overrides the \"async-max\" header value, if any. The value of this header defines the timeout duration for the request, it must be set to a valid duration string. A duration string is a possibly signed sequence of decimal numbers, each with optional fraction and a unit suffix, such as \"300ms\", or \"2h45m\". Valid time units are \"ns\", \"us\" (or \"µs\"), \"ms\", \"s\", \"m\", \"h\". We reject negative or nil duration values.
  • @param "IgnoreVersion" (optional.Bool) - If set to true this value indicates that the user wants to ignore entity version constraints, thereby \"forcing\" the operation.

@return Volume

func (*DefaultApiService) SetComputeOnly 

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

SetComputeOnly Modify the computeonly behaviour state for a node Set the compute-only configuration state for the node corresponding to id given by the request.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id ID of a Node
  • @param setComputeOnlyNodeData
  • @param optional nil or *SetComputeOnlyOpts - Optional Parameters:
  • @param "IgnoreVersion" (optional.Bool) - If set to true this value indicates that the user wants to ignore entity version constraints, thereby \"forcing\" the operation.

@return Node

func (*DefaultApiService) SetCordoned 

func (a *DefaultApiService) SetCordoned(ctx _context.Context, id string, setCordonedNodeData SetCordonedNodeData, localVarOptionals *SetCordonedOpts) (Node, *_nethttp.Response, error)

SetCordoned Modify the cordoned state for a node Set the cordoned state for the node corresponding to id given by the request.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id ID of a Node
  • @param setCordonedNodeData
  • @param optional nil or *SetCordonedOpts - Optional Parameters:
  • @param "IgnoreVersion" (optional.Bool) - If set to true this value indicates that the user wants to ignore entity version constraints, thereby \"forcing\" the operation.

@return Node

func (*DefaultApiService) SetFailureMode 

func (a *DefaultApiService) SetFailureMode(ctx _context.Context, namespaceID string, id string, setFailureModeRequest SetFailureModeRequest, localVarOptionals *SetFailureModeOpts) (Volume, *_nethttp.Response, error)

SetFailureMode Set the failure mode of the volume. Set the behaviour of the volume identified by id when responding to observed replica failure. This modifies the protected StorageOS system label \"storageos.com/failure-mode\". This request may either specify a precise failure threshold or a more flexible intent-based failure mode operating with respect to the volume's current replication target. A request will be denied if the current state of the volume does not satisfy the requested failure behaviour.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param namespaceID ID of a Namespace
  • @param id ID of a Volume
  • @param setFailureModeRequest Failure mode to use
  • @param optional nil or *SetFailureModeOpts - Optional Parameters:
  • @param "IgnoreVersion" (optional.Bool) - If set to true this value indicates that the user wants to ignore entity version constraints, thereby \"forcing\" the operation.

@return Volume

func (*DefaultApiService) SetPlacementStrategy 

func (a *DefaultApiService) SetPlacementStrategy(ctx _context.Context, namespaceID string, id string, setPlacementStrategyData SetPlacementStrategyData, localVarOptionals *SetPlacementStrategyOpts) (AcceptedMessage, *_nethttp.Response, error)

SetPlacementStrategy Sets the placement strategy of the volume. Sets the desired behaviour of the volume identified by id when provisioning new replicas. The already placed replicas will not be moved, instead, during future failovers, node restarts (containing the volume replicas) and any other operation that requires a replica to be provisioned will now follow this rule thus having an \"eventually consistent\" response.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param namespaceID ID of a Namespace
  • @param id ID of a Volume
  • @param setPlacementStrategyData
  • @param optional nil or *SetPlacementStrategyOpts - Optional Parameters:
  • @param "IgnoreVersion" (optional.Bool) - If set to true this value indicates that the user wants to ignore entity version constraints, thereby \"forcing\" the operation.

@return AcceptedMessage

func (*DefaultApiService) SetPreferredEvictionCandidates 

func (a *DefaultApiService) SetPreferredEvictionCandidates(ctx _context.Context, namespaceID string, id string, setPreferredEvictionCandidatesData SetPreferredEvictionCandidatesData, localVarOptionals *SetPreferredEvictionCandidatesOpts) (AcceptedMessage, *_nethttp.Response, error)

SetPreferredEvictionCandidates Specifies a list of deployments to be preferred to be evicted. Sets a list of volume deployments as preferred to be selected and evicted next time we do so. This does not trigger an immediate action in response to the request. Failed deployments are still selected over deployments specified by this method.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param namespaceID ID of a Namespace
  • @param id ID of a Volume
  • @param setPreferredEvictionCandidatesData
  • @param optional nil or *SetPreferredEvictionCandidatesOpts - Optional Parameters:
  • @param "IgnoreVersion" (optional.Bool) - If set to true this value indicates that the user wants to ignore entity version constraints, thereby \"forcing\" the operation.

@return AcceptedMessage

func (*DefaultApiService) SetReplicas 

func (a *DefaultApiService) SetReplicas(ctx _context.Context, namespaceID string, id string, setReplicasRequest SetReplicasRequest, localVarOptionals *SetReplicasOpts) (AcceptedMessage, *_nethttp.Response, error)

SetReplicas Set the number of replicas to maintain for the volume. Set the number of replicas for the volume identified by id to the number specified in the request's body. This modifies the protected StorageOS system label \"storageos.com/replicas\". This request changes the desired replica count, and returns an error if changing the desired replica count failed. StorageOS satisfies the new replica configuration asynchronously.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param namespaceID ID of a Namespace
  • @param id ID of a Volume
  • @param setReplicasRequest
  • @param optional nil or *SetReplicasOpts - Optional Parameters:
  • @param "IgnoreVersion" (optional.Bool) - If set to true this value indicates that the user wants to ignore entity version constraints, thereby \"forcing\" the operation.

@return AcceptedMessage

func (*DefaultApiService) Spec 

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

Spec Serves this openapi spec file Serves this openapi spec file

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return string

func (*DefaultApiService) UpdateAuthenticatedUser 

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

UpdateAuthenticatedUser Update the authenticated user's information Update the authenticated user.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param updateAuthenticatedUserData
  • @param optional nil or *UpdateAuthenticatedUserOpts - Optional Parameters:
  • @param "IgnoreVersion" (optional.Bool) - If set to true this value indicates that the user wants to ignore entity version constraints, thereby \"forcing\" the operation.

@return User

func (*DefaultApiService) UpdateCluster 

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

UpdateCluster Update the cluster's global configuration settings Update the global configuration settings to use for the cluster. Updating the cluster log level does not require a restart

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param updateClusterData
  • @param optional nil or *UpdateClusterOpts - Optional Parameters:
  • @param "IgnoreVersion" (optional.Bool) - If set to true this value indicates that the user wants to ignore entity version constraints, thereby \"forcing\" the operation.

@return Cluster

func (*DefaultApiService) UpdateLicence 

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

UpdateLicence Update the licence global configuration settings Update the cluster's licence.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param updateLicence
  • @param optional nil or *UpdateLicenceOpts - Optional Parameters:
  • @param "IgnoreVersion" (optional.Bool) - If set to true this value indicates that the user wants to ignore entity version constraints, thereby \"forcing\" the operation.

@return Licence

func (*DefaultApiService) UpdateNFSVolumeExports 

func (a *DefaultApiService) UpdateNFSVolumeExports(ctx _context.Context, namespaceID string, id string, nfsVolumeExports NfsVolumeExports, localVarOptionals *UpdateNFSVolumeExportsOpts) (*_nethttp.Response, error)

UpdateNFSVolumeExports Update an nfs volume's export configuration Update the NFS volume's export configuration

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param namespaceID ID of a Namespace
  • @param id ID of a Volume
  • @param nfsVolumeExports
  • @param optional nil or *UpdateNFSVolumeExportsOpts - Optional Parameters:
  • @param "IgnoreVersion" (optional.Bool) - If set to true this value indicates that the user wants to ignore entity version constraints, thereby \"forcing\" the operation.
  • @param "AsyncMax" (optional.String) - Optional parameter which will make the api request asynchronous. The operation will not be cancelled even if the client disconnect. The URL parameter value overrides the \"async-max\" header value, if any. The value of this header defines the timeout duration for the request, it must be set to a valid duration string. A duration string is a possibly signed sequence of decimal numbers, each with optional fraction and a unit suffix, such as \"300ms\", or \"2h45m\". Valid time units are \"ns\", \"us\" (or \"µs\"), \"ms\", \"s\", \"m\", \"h\". We reject negative or nil duration values.

func (*DefaultApiService) UpdateNFSVolumeMountEndpoint 

func (a *DefaultApiService) UpdateNFSVolumeMountEndpoint(ctx _context.Context, namespaceID string, id string, nfsVolumeMountEndpoint NfsVolumeMountEndpoint, localVarOptionals *UpdateNFSVolumeMountEndpointOpts) (*_nethttp.Response, error)

UpdateNFSVolumeMountEndpoint Update an nfs volume's mount endpoint Update the NFS volume's mount endpoint

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param namespaceID ID of a Namespace
  • @param id ID of a Volume
  • @param nfsVolumeMountEndpoint
  • @param optional nil or *UpdateNFSVolumeMountEndpointOpts - Optional Parameters:
  • @param "IgnoreVersion" (optional.Bool) - If set to true this value indicates that the user wants to ignore entity version constraints, thereby \"forcing\" the operation.
  • @param "AsyncMax" (optional.String) - Optional parameter which will make the api request asynchronous. The operation will not be cancelled even if the client disconnect. The URL parameter value overrides the \"async-max\" header value, if any. The value of this header defines the timeout duration for the request, it must be set to a valid duration string. A duration string is a possibly signed sequence of decimal numbers, each with optional fraction and a unit suffix, such as \"300ms\", or \"2h45m\". Valid time units are \"ns\", \"us\" (or \"µs\"), \"ms\", \"s\", \"m\", \"h\". We reject negative or nil duration values.

func (*DefaultApiService) UpdateNamespace 

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

UpdateNamespace Update a namespace Update the namespace identified by id.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id ID of a namespace
  • @param updateNamespaceData
  • @param optional nil or *UpdateNamespaceOpts - Optional Parameters:
  • @param "IgnoreVersion" (optional.Bool) - If set to true this value indicates that the user wants to ignore entity version constraints, thereby \"forcing\" the operation.

@return Namespace

func (*DefaultApiService) UpdateNode 

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

UpdateNode Update a node Update the non-storageos labels configured for the node identified by id.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id ID of a node
  • @param updateNodeData

@return Node

func (*DefaultApiService) UpdatePolicyGroup 

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

UpdatePolicyGroup Update a policy group Update the policy group identified by id.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id ID of a policy group
  • @param updatePolicyGroupData
  • @param optional nil or *UpdatePolicyGroupOpts - Optional Parameters:
  • @param "IgnoreVersion" (optional.Bool) - If set to true this value indicates that the user wants to ignore entity version constraints, thereby \"forcing\" the operation.

@return PolicyGroup

func (*DefaultApiService) UpdatePool 

func (a *DefaultApiService) UpdatePool(ctx _context.Context, id string, updatePoolData UpdatePoolData, localVarOptionals *UpdatePoolOpts) (Pool, *_nethttp.Response, error)

UpdatePool Update a Pool Update the node-drive mapping for the pool identified by id.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id ID of a Pool
  • @param updatePoolData
  • @param optional nil or *UpdatePoolOpts - Optional Parameters:
  • @param "IgnoreVersion" (optional.Bool) - If set to true this value indicates that the user wants to ignore entity version constraints, thereby \"forcing\" the operation.

@return Pool

func (*DefaultApiService) UpdateUser 

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

UpdateUser Update a user Update the user identified by id. This request will not succeed if the target account is the currently authenticated account. Use the separate users/self endpoint for this purpose.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id ID of a user
  • @param updateUserData
  • @param optional nil or *UpdateUserOpts - Optional Parameters:
  • @param "IgnoreVersion" (optional.Bool) - If set to true this value indicates that the user wants to ignore entity version constraints, thereby \"forcing\" the operation.

@return User

func (*DefaultApiService) UpdateVolume 

func (a *DefaultApiService) UpdateVolume(ctx _context.Context, namespaceID string, id string, updateVolumeData UpdateVolumeData, localVarOptionals *UpdateVolumeOpts) (Volume, *_nethttp.Response, error)

UpdateVolume Update a volume Update the description and non-storageos labels configured for the volume identified by id.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param namespaceID ID of a Namespace
  • @param id ID of a Volume
  • @param updateVolumeData
  • @param optional nil or *UpdateVolumeOpts - Optional Parameters:
  • @param "IgnoreVersion" (optional.Bool) - If set to true this value indicates that the user wants to ignore entity version constraints, thereby \"forcing\" the operation.
  • @param "AsyncMax" (optional.String) - Optional parameter which will make the api request asynchronous. The operation will not be cancelled even if the client disconnect. The URL parameter value overrides the \"async-max\" header value, if any. The value of this header defines the timeout duration for the request, it must be set to a valid duration string. A duration string is a possibly signed sequence of decimal numbers, each with optional fraction and a unit suffix, such as \"300ms\", or \"2h45m\". Valid time units are \"ns\", \"us\" (or \"µs\"), \"ms\", \"s\", \"m\", \"h\". We reject negative or nil duration values.

@return Volume

type DeleteAuthenticatedUserOpts 

type DeleteAuthenticatedUserOpts struct {
	IgnoreVersion optional.Bool
}

DeleteAuthenticatedUserOpts Optional parameters for the method 'DeleteAuthenticatedUser'

type DeleteNamespaceOpts 

type DeleteNamespaceOpts struct {
	IgnoreVersion optional.Bool
}

DeleteNamespaceOpts Optional parameters for the method 'DeleteNamespace'

type DeleteNodeOpts 

type DeleteNodeOpts struct {
	IgnoreVersion optional.Bool
	AsyncMax      optional.String
}

DeleteNodeOpts Optional parameters for the method 'DeleteNode'

type DeletePolicyGroupOpts 

type DeletePolicyGroupOpts struct {
	IgnoreVersion optional.Bool
}

DeletePolicyGroupOpts Optional parameters for the method 'DeletePolicyGroup'

type DeletePoolOpts 

type DeletePoolOpts struct {
	IgnoreVersion optional.Bool
}

DeletePoolOpts Optional parameters for the method 'DeletePool'

type DeleteUserOpts 

type DeleteUserOpts struct {
	IgnoreVersion optional.Bool
}

DeleteUserOpts Optional parameters for the method 'DeleteUser'

type DeleteVolumeOpts 

type DeleteVolumeOpts struct {
	IgnoreVersion optional.Bool
	AsyncMax      optional.String
	OfflineDelete optional.Bool
}

DeleteVolumeOpts Optional parameters for the method 'DeleteVolume'

type DeploymentInfo 

type DeploymentInfo struct {
	// A unique identifier for a volume deployment. The format of this type is undefined and may change but the defined properties will not change.
	Id string `json:"id,omitempty"`
	// A unique identifier for a node. The format of this type is undefined and may change but the defined properties will not change.
	NodeID string `json:"nodeID,omitempty"`
	// The hostname of the node that is hosting the deployment
	Hostname string `json:"hostname,omitempty"`
	// Indicates if the volume deployment is eligible for promotion
	Promotable bool `json:"promotable,omitempty"`
}

DeploymentInfo struct for DeploymentInfo

type DetachVolumeOpts 

type DetachVolumeOpts struct {
	IgnoreVersion optional.Bool
	AsyncMax      optional.String
}

DetachVolumeOpts Optional parameters for the method 'DetachVolume'

type Error 

type Error struct {
	Error string `json:"error"`
}

Error struct for Error

type FailureModeIntent 

type FailureModeIntent string

FailureModeIntent The intent-based failure mode behaviour of a volume. The default behaviour for a volume is \"hard\", in the absence of a directly configured intent or numerical failure threshold. 

const (
	FAILUREMODEINTENT_HARD     FailureModeIntent = "hard"
	FAILUREMODEINTENT_SOFT     FailureModeIntent = "soft"
	FAILUREMODEINTENT_ALWAYSON FailureModeIntent = "alwayson"
)

List of FailureModeIntent

type FsType 

type FsType string

FsType The file system type of a volume. \"block\" is a raw block device (no filesystem). 

const (
	FSTYPE_EXT2  FsType = "ext2"
	FSTYPE_EXT3  FsType = "ext3"
	FSTYPE_EXT4  FsType = "ext4"
	FSTYPE_XFS   FsType = "xfs"
	FSTYPE_BTRFS FsType = "btrfs"
	FSTYPE_BLOCK FsType = "block"
)

List of FsType

type GenericOpenAPIError 

type GenericOpenAPIError struct {
	// contains filtered or unexported fields
}

GenericOpenAPIError Provides access to the body, error and model on returned errors.

func (GenericOpenAPIError) Body 

func (e GenericOpenAPIError) Body() []byte

Body returns the raw bytes of the response

func (GenericOpenAPIError) Error 

func (e GenericOpenAPIError) Error() string

Error returns non-empty string if there was an error.

func (GenericOpenAPIError) Model 

func (e GenericOpenAPIError) Model() interface{}

Model returns the unpacked model of the error

type Licence 

type Licence struct {
	// A unique identifier for a cluster. The format of this type is undefined and may change but the defined properties will not change.
	ClusterID string `json:"clusterID,omitempty"`
	// The time after which a licence will no longer be valid This timestamp is set when the licence is created. String format is RFC3339.
	ExpiresAt time.Time `json:"expiresAt,omitempty"`
	// The allowed provisioning capacity in bytes This value if for the cluster, if provisioning a volume brings the cluster's total provisioned capacity above it the request will fail
	ClusterCapacityBytes uint64 `json:"clusterCapacityBytes,omitempty"`
	// Sum of the size of all volumes in the cluster
	UsedBytes uint64 `json:"usedBytes,omitempty"`
	// Denotes which category the licence belongs to
	Kind string `json:"kind,omitempty"`
	// A user friendly reference to the customer
	CustomerName string `json:"customerName,omitempty"`
	// A list of product features which are enabled by the  licence, subject to the installed version.
	Features *[]string `json:"features,omitempty"`
	// An opaque representation of an entity version at the time it was obtained from the API. All operations that mutate the entity must include this version field in the request unchanged. The format of this type is undefined and may change but the defined properties will not change.
	Version string `json:"version,omitempty"`
}

Licence A representation of a cluster's licence properties

type LogFormat 

type LogFormat string

LogFormat This setting determines the format nodes in the cluster will use for log entries. This setting is only checked by nodes on startup. Changing this setting will not affect the behaviour of nodes that are already operational. 

const (
	LOGFORMAT_DEFAULT LogFormat = "default"
	LOGFORMAT_JSON    LogFormat = "json"
)

List of LogFormat

type LogLevel 

type LogLevel string

LogLevel This setting determines the log level for nodes across the cluster to use when recording entries in the log. All entries below the specified log level are discarded, where \"error\" is the highest log level and \"debug\" is the lowest. This setting is only checked by nodes on startup. Changing this setting will not affect the behaviour of nodes that are already operational. 

const (
	LOGLEVEL_DEBUG LogLevel = "debug"
	LOGLEVEL_INFO  LogLevel = "info"
	LOGLEVEL_WARN  LogLevel = "warn"
	LOGLEVEL_ERROR LogLevel = "error"
)

List of LogLevel

type MasterDeploymentInfo 

type MasterDeploymentInfo struct {
	// A unique identifier for a volume deployment. The format of this type is undefined and may change but the defined properties will not change.
	Id string `json:"id,omitempty"`
	// A unique identifier for a node. The format of this type is undefined and may change but the defined properties will not change.
	NodeID string `json:"nodeID,omitempty"`
	// The hostname of the node that is hosting the deployment
	Hostname string `json:"hostname,omitempty"`
	// Indicates if the volume deployment is eligible for promotion
	Promotable bool         `json:"promotable,omitempty"`
	Health     MasterHealth `json:"health,omitempty"`
}

MasterDeploymentInfo struct for MasterDeploymentInfo

type MasterDeploymentInfoAllOf 

type MasterDeploymentInfoAllOf struct {
	Health MasterHealth `json:"health,omitempty"`
}

MasterDeploymentInfoAllOf struct for MasterDeploymentInfoAllOf

type MasterHealth 

type MasterHealth string

MasterHealth The operational health of a volume master deployment 

const (
	MASTERHEALTH_ONLINE  MasterHealth = "online"
	MASTERHEALTH_OFFLINE MasterHealth = "offline"
	MASTERHEALTH_UNKNOWN MasterHealth = "unknown"
)

List of MasterHealth

type Namespace 

type Namespace struct {
	// A unique identifier for a namespace. The format of this type is undefined and may change but the defined properties will not change..
	Id   string `json:"id,omitempty"`
	Name string `json:"name,omitempty"`
	// A set of arbitrary key value labels to apply to the entity.
	Labels map[string]string `json:"labels,omitempty"`
	// The time the entity was created. This timestamp is set by the node that created the entity, and may not be correct if the node's local clock was skewed. This value is for the user's informative purposes only, and correctness is not required. String format is RFC3339.
	CreatedAt time.Time `json:"createdAt,omitempty"`
	// The time the entity was last updated. This timestamp is set by the node that last updated the entity, and may not be correct if the node's local clock was skewed. This value is for the user's informative purposes only, and correctness is not required. String format is RFC3339.
	UpdatedAt time.Time `json:"updatedAt,omitempty"`
	// An opaque representation of an entity version at the time it was obtained from the API. All operations that mutate the entity must include this version field in the request unchanged. The format of this type is undefined and may change but the defined properties will not change.
	Version string `json:"version,omitempty"`
}

Namespace struct for Namespace

type NfsAcl 

type NfsAcl struct {
	Identity     NfsAclIdentity     `json:"identity,omitempty"`
	SquashConfig NfsAclSquashConfig `json:"squashConfig,omitempty"`
	// The access level this ACL grants - read-only, or read-write.
	AccessLevel string `json:"accessLevel,omitempty"`
}

NfsAcl struct for NfsAcl

type NfsAclIdentity 

type NfsAclIdentity struct {
	// The identity type used to identify the nfs client.
	IdentityType string `json:"identityType,omitempty"`
	// NFS identity matcher. For \"cidr\", this should be a valid CIDR block string such as \"10.0.0.0/8\". For \"hostname\", this must be the hostname sent by the client, with ? and * wildcard characters. For netgroup, this must be in the form of \"@netgroup\" with ? and * wildcard characters.
	Matcher string `json:"matcher,omitempty"`
}

NfsAclIdentity struct for NfsAclIdentity

type NfsAclSquashConfig 

type NfsAclSquashConfig struct {
	Uid int64 `json:"uid,omitempty"`
	Gid int64 `json:"gid,omitempty"`
	// SquashConfig defines the root squashing behaviour.  When a client creates a file, it sends the user UID from the client. If the client is running as root, this sends uid=0. Root squashing allows the NFS administrator to prevent the client from writing as \"root\" to the NFS share, instead mapping the client to a new UID/GID (usually nfsnobody, -2). \"none\" performs no UID/GID alterations, using the values sent by the client. \"root\" maps UID & GID 0 to the values specified. \"rootuid\" maps UID 0 and a GID of any value to the value specified. \"all\" maps changes all UID and GID values to those specified.
	Squash string `json:"squash,omitempty"`
}

NfsAclSquashConfig struct for NfsAclSquashConfig

type NfsConfig 

type NfsConfig struct {
	Exports *[]NfsExportConfig `json:"exports,omitempty"`
	// The address to which the NFS server is bound.
	ServiceEndpoint *string `json:"serviceEndpoint,omitempty"`
}

NfsConfig struct for NfsConfig

type NfsExportConfig 

type NfsExportConfig struct {
	// ID for this export
	ExportID uint64 `json:"exportID,omitempty"`
	// The path relative to the volume root to serve as the export root
	Path string `json:"path,omitempty"`
	// The configured pseudo path in the NFS virtual filesystem. This is the path clients will see when traversing to this export on the NFS share.
	PseudoPath string   `json:"pseudoPath,omitempty"`
	Acls       []NfsAcl `json:"acls,omitempty"`
}

NfsExportConfig struct for NfsExportConfig

type NfsVolumeExports 

type NfsVolumeExports struct {
	Exports []NfsExportConfig `json:"exports,omitempty"`
	// An opaque representation of an entity version at the time it was obtained from the API. All operations that mutate the entity must include this version field in the request unchanged. The format of this type is undefined and may change but the defined properties will not change.
	Version string `json:"version,omitempty"`
}

NfsVolumeExports struct for NfsVolumeExports

type NfsVolumeMountEndpoint 

type NfsVolumeMountEndpoint struct {
	// The address to which the NFS server is bound.
	MountEndpoint string `json:"mountEndpoint,omitempty"`
	// An opaque representation of an entity version at the time it was obtained from the API. All operations that mutate the entity must include this version field in the request unchanged. The format of this type is undefined and may change but the defined properties will not change.
	Version string `json:"version,omitempty"`
}

NfsVolumeMountEndpoint struct for NfsVolumeMountEndpoint

type Node 

type Node struct {
	// A unique identifier for a node. The format of this type is undefined and may change but the defined properties will not change.
	Id string `json:"id,omitempty"`
	// The hostname of the node. This value is set by the node each time it joins the Ondat cluster.
	Name     string        `json:"name,omitempty"`
	Health   NodeHealth    `json:"health,omitempty"`
	Capacity CapacityStats `json:"capacity,omitempty"`
	// Endpoint at which we operate our dataplane's dfs service. (used for IO operations) This value is set on startup by the corresponding environment variable (IO_ADVERTISE_ADDRESS)
	IoEndpoint string `json:"ioEndpoint,omitempty"`
	// Endpoint at which we operate our dataplane's supervisor service (used for sync). This value is set on startup by the corresponding environment variable (SUPERVISOR_ADVERTISE_ADDRESS)
	SupervisorEndpoint string `json:"supervisorEndpoint,omitempty"`
	// Endpoint at which we operate our health checking service. This value is set on startup by the corresponding environment variable (GOSSIP_ADVERTISE_ADDRESS)
	GossipEndpoint string `json:"gossipEndpoint,omitempty"`
	// Endpoint at which we operate our clustering gRPC API. This value is set on startup by the corresponding environment variable (INTERNAL_API_ADVERTISE_ADDRESS)
	ClusteringEndpoint string `json:"clusteringEndpoint,omitempty"`
	// Cordoned describes the cordoned state of the node. A cordoned node will not have new volume deployments scheduled on it
	Cordoned bool `json:"cordoned,omitempty"`
	// The time the node has been cordoned. This field's purpose is informative only.  String format is RFC3339.
	CordonedAt time.Time `json:"cordonedAt,omitempty"`
	// A set of arbitrary key value labels to apply to the entity.
	Labels map[string]string `json:"labels,omitempty"`
	// The time the entity was created. This timestamp is set by the node that created the entity, and may not be correct if the node's local clock was skewed. This value is for the user's informative purposes only, and correctness is not required. String format is RFC3339.
	CreatedAt time.Time `json:"createdAt,omitempty"`
	// The time the entity was last updated. This timestamp is set by the node that last updated the entity, and may not be correct if the node's local clock was skewed. This value is for the user's informative purposes only, and correctness is not required. String format is RFC3339.
	UpdatedAt time.Time `json:"updatedAt,omitempty"`
	// An opaque representation of an entity version at the time it was obtained from the API. All operations that mutate the entity must include this version field in the request unchanged. The format of this type is undefined and may change but the defined properties will not change.
	Version string `json:"version,omitempty"`
}

Node struct for Node

type NodeHealth 

type NodeHealth string

NodeHealth The operational health of a node entity 

const (
	NODEHEALTH_ONLINE  NodeHealth = "online"
	NODEHEALTH_OFFLINE NodeHealth = "offline"
	NODEHEALTH_UNKNOWN NodeHealth = "unknown"
)

List of NodeHealth

type ParentInfo 

type ParentInfo struct {
	Id          string `json:"id,omitempty"`
	NamespaceID string `json:"namespaceID,omitempty"`
	SnapshotID  string `json:"snapshotID,omitempty"`
}

ParentInfo struct for ParentInfo

type PoliciesIdSpecs 

type PoliciesIdSpecs struct {
	// A unique identifier for a namespace. The format of this type is undefined and may change but the defined properties will not change..
	NamespaceID string `json:"namespaceID,omitempty"`
	// The resource type this policy grants access to.
	ResourceType string `json:"resourceType,omitempty"`
	// If true, disallows requests that attempt to mutate the resource.
	ReadOnly bool `json:"readOnly,omitempty"`
}

PoliciesIdSpecs struct for PoliciesIdSpecs

type PoliciesSpecs 

type PoliciesSpecs struct {
	// A unique identifier for a namespace. The format of this type is undefined and may change but the defined properties will not change..
	NamespaceID string `json:"namespaceID,omitempty"`
	// The resource type this policy grants access to.
	ResourceType string `json:"resourceType,omitempty"`
	// If true, disallows requests that attempt to mutate the resource.
	ReadOnly bool `json:"readOnly,omitempty"`
}

PoliciesSpecs struct for PoliciesSpecs

type PolicyGroup 

type PolicyGroup struct {
	// A unique identifier for a policy group. The format of this type is undefined and may change but the defined properties will not change..
	Id   string `json:"id,omitempty"`
	Name string `json:"name,omitempty"`
	// The list of user IDs which this policy group governs.
	Users []PolicyGroupUsers `json:"users,omitempty"`
	// A set of authorisation policies to apply to the policy group.
	Specs *[]PoliciesIdSpecs `json:"specs,omitempty"`
	// The time the entity was created. This timestamp is set by the node that created the entity, and may not be correct if the node's local clock was skewed. This value is for the user's informative purposes only, and correctness is not required. String format is RFC3339.
	CreatedAt time.Time `json:"createdAt,omitempty"`
	// The time the entity was last updated. This timestamp is set by the node that last updated the entity, and may not be correct if the node's local clock was skewed. This value is for the user's informative purposes only, and correctness is not required. String format is RFC3339.
	UpdatedAt time.Time `json:"updatedAt,omitempty"`
	// An opaque representation of an entity version at the time it was obtained from the API. All operations that mutate the entity must include this version field in the request unchanged. The format of this type is undefined and may change but the defined properties will not change.
	Version string `json:"version,omitempty"`
}

PolicyGroup struct for PolicyGroup

type PolicyGroupUsers 

type PolicyGroupUsers struct {
	// A unique identifier for a user. The format of this type is undefined and may change but the defined properties will not change..
	Id       string `json:"id,omitempty"`
	Username string `json:"username,omitempty"`
}

PolicyGroupUsers struct for PolicyGroupUsers

type Pool 

type Pool struct {
	// A unique identifier for a pool. The format of this type is undefined and may change but the defined properties will not change..
	Id string `json:"id,omitempty"`
	// The name of the pool
	Name               string              `json:"name,omitempty"`
	NodeToDriveMapping map[string][]string `json:"nodeToDriveMapping,omitempty"`
	// The time the entity was created. This timestamp is set by the node that created the entity, and may not be correct if the node's local clock was skewed. This value is for the user's informative purposes only, and correctness is not required. String format is RFC3339.
	CreatedAt time.Time `json:"createdAt,omitempty"`
	// The time the entity was last updated. This timestamp is set by the node that last updated the entity, and may not be correct if the node's local clock was skewed. This value is for the user's informative purposes only, and correctness is not required. String format is RFC3339.
	UpdatedAt time.Time `json:"updatedAt,omitempty"`
	// An opaque representation of an entity version at the time it was obtained from the API. All operations that mutate the entity must include this version field in the request unchanged. The format of this type is undefined and may change but the defined properties will not change.
	Version string `json:"version,omitempty"`
}

Pool struct for Pool

type ReplicaDeploymentInfo 

type ReplicaDeploymentInfo struct {
	// A unique identifier for a volume deployment. The format of this type is undefined and may change but the defined properties will not change.
	Id string `json:"id,omitempty"`
	// A unique identifier for a node. The format of this type is undefined and may change but the defined properties will not change.
	NodeID string `json:"nodeID,omitempty"`
	// The hostname of the node that is hosting the deployment
	Hostname string `json:"hostname,omitempty"`
	// Indicates if the volume deployment is eligible for promotion
	Promotable   bool          `json:"promotable,omitempty"`
	Health       ReplicaHealth `json:"health,omitempty"`
	SyncProgress SyncProgress  `json:"syncProgress,omitempty"`
}

ReplicaDeploymentInfo struct for ReplicaDeploymentInfo

type ReplicaDeploymentInfoAllOf 

type ReplicaDeploymentInfoAllOf struct {
	Health       ReplicaHealth `json:"health,omitempty"`
	SyncProgress SyncProgress  `json:"syncProgress,omitempty"`
}

ReplicaDeploymentInfoAllOf struct for ReplicaDeploymentInfoAllOf

type ReplicaHealth 

type ReplicaHealth string

ReplicaHealth The operational health of a volume replica deployment 

const (
	REPLICAHEALTH_RECOVERING   ReplicaHealth = "recovering"
	REPLICAHEALTH_PROVISIONING ReplicaHealth = "provisioning"
	REPLICAHEALTH_PROVISIONED  ReplicaHealth = "provisioned"
	REPLICAHEALTH_SYNCING      ReplicaHealth = "syncing"
	REPLICAHEALTH_READY        ReplicaHealth = "ready"
	REPLICAHEALTH_DELETED      ReplicaHealth = "deleted"
	REPLICAHEALTH_FAILED       ReplicaHealth = "failed"
	REPLICAHEALTH_UNKNOWN      ReplicaHealth = "unknown"
)

List of ReplicaHealth

type ResizeVolumeOpts 

type ResizeVolumeOpts struct {
	AsyncMax      optional.String
	IgnoreVersion optional.Bool
}

ResizeVolumeOpts Optional parameters for the method 'ResizeVolume'

type ResizeVolumeRequest 

type ResizeVolumeRequest struct {
	// The desired new size for the volume in  bytes. This value cannot be less than  the current size of the volume.
	SizeBytes uint64 `json:"sizeBytes,omitempty"`
	// An opaque representation of an entity version at the time it was obtained from the API. All operations that mutate the entity must include this version field in the request unchanged. The format of this type is undefined and may change but the defined properties will not change.
	Version string `json:"version,omitempty"`
}

ResizeVolumeRequest struct for ResizeVolumeRequest

type ServerConfiguration 

type ServerConfiguration struct {
	Url         string
	Description string
	Variables   map[string]ServerVariable
}

ServerConfiguration stores the information about a server

type ServerVariable 

type ServerVariable struct {
	Description  string
	DefaultValue string
	EnumValues   []string
}

ServerVariable stores the information about a server variable

type SetComputeOnlyNodeData 

type SetComputeOnlyNodeData struct {
	// Marks the node's desired configuration  state as compute-only. This will result in the node being avoided for volume placement
	ComputeOnly bool `json:"computeOnly,omitempty"`
	// An opaque representation of an entity version at the time it was obtained from the API. All operations that mutate the entity must include this version field in the request unchanged. The format of this type is undefined and may change but the defined properties will not change.
	Version string `json:"version,omitempty"`
}

SetComputeOnlyNodeData struct for SetComputeOnlyNodeData

type SetComputeOnlyOpts 

type SetComputeOnlyOpts struct {
	IgnoreVersion optional.Bool
}

SetComputeOnlyOpts Optional parameters for the method 'SetComputeOnly'

type SetCordonedNodeData 

type SetCordonedNodeData struct {
	// Marks the node's desired cordoned state state.  A cordoned node will not have new volume deployments scheduled on it.
	Cordoned bool `json:"cordoned,omitempty"`
	// An opaque representation of an entity version at the time it was obtained from the API. All operations that mutate the entity must include this version field in the request unchanged. The format of this type is undefined and may change but the defined properties will not change.
	Version string `json:"version,omitempty"`
}

SetCordonedNodeData struct for SetCordonedNodeData

type SetCordonedOpts 

type SetCordonedOpts struct {
	IgnoreVersion optional.Bool
}

SetCordonedOpts Optional parameters for the method 'SetCordoned'

type SetFailureModeIntentRequestData 

type SetFailureModeIntentRequestData struct {
	Mode FailureModeIntent `json:"mode,omitempty"`
	// An opaque representation of an entity version at the time it was obtained from the API. All operations that mutate the entity must include this version field in the request unchanged. The format of this type is undefined and may change but the defined properties will not change.
	Version string `json:"version,omitempty"`
}

SetFailureModeIntentRequestData struct for SetFailureModeIntentRequestData

type SetFailureModeOpts 

type SetFailureModeOpts struct {
	IgnoreVersion optional.Bool
}

SetFailureModeOpts Optional parameters for the method 'SetFailureMode'

type SetFailureModeRequest 

type SetFailureModeRequest struct {
	// The minimum number of replicas required to be online and receiving writes in order for the volume to remain read-writable. This value replaces any previously set failure threshold or intent-based failure mode.
	FailureThreshold uint64 `json:"failureThreshold,omitempty"`
	// An opaque representation of an entity version at the time it was obtained from the API. All operations that mutate the entity must include this version field in the request unchanged. The format of this type is undefined and may change but the defined properties will not change.
	Version string            `json:"version,omitempty"`
	Mode    FailureModeIntent `json:"mode,omitempty"`
}

SetFailureModeRequest struct for SetFailureModeRequest

type SetFailureThresholdRequestData 

type SetFailureThresholdRequestData struct {
	// The minimum number of replicas required to be online and receiving writes in order for the volume to remain read-writable. This value replaces any previously set failure threshold or intent-based failure mode.
	FailureThreshold uint64 `json:"failureThreshold,omitempty"`
	// An opaque representation of an entity version at the time it was obtained from the API. All operations that mutate the entity must include this version field in the request unchanged. The format of this type is undefined and may change but the defined properties will not change.
	Version string `json:"version,omitempty"`
}

SetFailureThresholdRequestData struct for SetFailureThresholdRequestData

type SetPlacementStrategyData 

type SetPlacementStrategyData struct {
	PlacementStrategy Strategy `json:"placementStrategy,omitempty"`
	// An opaque representation of an entity version at the time it was obtained from the API. All operations that mutate the entity must include this version field in the request unchanged. The format of this type is undefined and may change but the defined properties will not change.
	Version string `json:"version,omitempty"`
}

SetPlacementStrategyData struct for SetPlacementStrategyData

type SetPlacementStrategyOpts 

type SetPlacementStrategyOpts struct {
	IgnoreVersion optional.Bool
}

SetPlacementStrategyOpts Optional parameters for the method 'SetPlacementStrategy'

type SetPreferredEvictionCandidatesData 

type SetPreferredEvictionCandidatesData struct {
	DeploymentIDs []string `json:"deploymentIDs,omitempty"`
	// An opaque representation of an entity version at the time it was obtained from the API. All operations that mutate the entity must include this version field in the request unchanged. The format of this type is undefined and may change but the defined properties will not change.
	Version string `json:"version,omitempty"`
}

SetPreferredEvictionCandidatesData struct for SetPreferredEvictionCandidatesData

type SetPreferredEvictionCandidatesOpts 

type SetPreferredEvictionCandidatesOpts struct {
	IgnoreVersion optional.Bool
}

SetPreferredEvictionCandidatesOpts Optional parameters for the method 'SetPreferredEvictionCandidates'

type SetReplicasOpts 

type SetReplicasOpts struct {
	IgnoreVersion optional.Bool
}

SetReplicasOpts Optional parameters for the method 'SetReplicas'

type SetReplicasRequest 

type SetReplicasRequest struct {
	// The number of replicas desired.
	Replicas uint64 `json:"replicas,omitempty"`
	// An opaque representation of an entity version at the time it was obtained from the API. All operations that mutate the entity must include this version field in the request unchanged. The format of this type is undefined and may change but the defined properties will not change.
	Version string `json:"version,omitempty"`
}

SetReplicasRequest struct for SetReplicasRequest

type Snapshot 

type Snapshot struct {
	Name      string    `json:"name,omitempty"`
	Id        string    `json:"id,omitempty"`
	Location  string    `json:"location,omitempty"`
	CreatedAt time.Time `json:"createdAt,omitempty"`
	SizeBytes float32   `json:"sizeBytes,omitempty"`
}

Snapshot struct for Snapshot

type SnapshotVolume 

type SnapshotVolume struct {
	// A unique identifier for a volume. The format of this type is undefined and may change but the defined properties will not change.
	Id          string `json:"id,omitempty"`
	Name        string `json:"name,omitempty"`
	Description string `json:"description,omitempty"`
	AttachedOn  string `json:"attachedOn,omitempty"`
	// The hostname of the node the volume is attached on
	AttachedOnHost string    `json:"attachedOnHost,omitempty"`
	Nfs            NfsConfig `json:"nfs,omitempty"`
	NamespaceID    string    `json:"namespaceID,omitempty"`
	// A set of arbitrary key value labels to apply to the entity.
	Labels         map[string]string        `json:"labels,omitempty"`
	FsType         FsType                   `json:"fsType,omitempty"`
	AttachmentType AttachType               `json:"attachmentType,omitempty"`
	Master         MasterDeploymentInfo     `json:"master,omitempty"`
	Replicas       *[]ReplicaDeploymentInfo `json:"replicas,omitempty"`
	// A volume's size in bytes
	SizeBytes  uint64     `json:"sizeBytes,omitempty"`
	ParentInfo ParentInfo `json:"parentInfo,omitempty"`
	// The time the entity was created. This timestamp is set by the node that created the entity, and may not be correct if the node's local clock was skewed. This value is for the user's informative purposes only, and correctness is not required. String format is RFC3339.
	CreatedAt time.Time `json:"createdAt,omitempty"`
	// The time the entity was last updated. This timestamp is set by the node that last updated the entity, and may not be correct if the node's local clock was skewed. This value is for the user's informative purposes only, and correctness is not required. String format is RFC3339.
	UpdatedAt time.Time `json:"updatedAt,omitempty"`
	// An opaque representation of an entity version at the time it was obtained from the API. All operations that mutate the entity must include this version field in the request unchanged. The format of this type is undefined and may change but the defined properties will not change.
	Version string `json:"version,omitempty"`
}

SnapshotVolume struct for SnapshotVolume

type Strategy 

type Strategy struct {
	Strategy string           `json:"strategy,omitempty"`
	Options  *StrategyOptions `json:"options,omitempty"`
}

Strategy The logic to use when placing the volume replicas across the available nodes. Possible options for this field include an availability zone aware rule and recommended rule in which multiple factors like available disk space, recent number of errors on the nodes, etc, are taken into consideration. Defaults to using a recommended placement strategy.

type StrategyOptions 

type StrategyOptions struct {
	// Indicates the node label used to decribe the topology used for data placement decisions. If two nodes are  labelled with this key and have identical values  for that label, the scheduler treats both nodes  as being in the same topology domain.  When topology-aware provisioning is enabled,  the scheduler tries to spread a volume's master  and replica copies across different topology domains.
	TopologyKey string `json:"topologyKey,omitempty"`
}

StrategyOptions Used together with topology-aware strategy to further specify how the placement should be done.

type SyncProgress 

type SyncProgress struct {
	// Number of bytes left remaining to complete the sync.
	BytesRemaining uint64 `json:"bytesRemaining,omitempty"`
	// The average throughput of the sync given as bytes per  second.
	ThroughputBytes uint64 `json:"throughputBytes,omitempty"`
	// The estimated time left for the sync to complete, given in seconds. When this field has a value of 0 either the  sync is complete or no duration estimate could be made. The values reported for bytesRemaining and  throughputBytes provide the client with the information needed to choose what to display.
	EstimatedSecondsRemaining uint64 `json:"estimatedSecondsRemaining,omitempty"`
}

SyncProgress The progress report for an ongoing sync.

type TopologyLabels 

type TopologyLabels struct {
	RequisiteZones []string `json:"requisiteZones,omitempty"`
	PreferredZones []string `json:"preferredZones,omitempty"`
}

TopologyLabels List of requisite and preferred topology zones where the volume should be accessible from.

type UpdateAuthenticatedUserData 

type UpdateAuthenticatedUserData struct {
	// If not present, the existing password is not changed
	Password string `json:"password,omitempty"`
	// An opaque representation of an entity version at the time it was obtained from the API. All operations that mutate the entity must include this version field in the request unchanged. The format of this type is undefined and may change but the defined properties will not change.
	Version string `json:"version,omitempty"`
}

UpdateAuthenticatedUserData struct for UpdateAuthenticatedUserData

type UpdateAuthenticatedUserOpts 

type UpdateAuthenticatedUserOpts struct {
	IgnoreVersion optional.Bool
}

UpdateAuthenticatedUserOpts Optional parameters for the method 'UpdateAuthenticatedUser'

type UpdateClusterData 

type UpdateClusterData struct {
	// Disables collection of telemetry data across the cluster.
	DisableTelemetry bool `json:"disableTelemetry,omitempty"`
	// Disables collection of reports for any fatal crashes across the cluster.
	DisableCrashReporting bool `json:"disableCrashReporting,omitempty"`
	// Disables the mechanism responsible for checking if there is an updated version of Ondat available for installation.
	DisableVersionCheck bool      `json:"disableVersionCheck,omitempty"`
	LogLevel            LogLevel  `json:"logLevel,omitempty"`
	LogFormat           LogFormat `json:"logFormat,omitempty"`
	// An opaque representation of an entity version at the time it was obtained from the API. All operations that mutate the entity must include this version field in the request unchanged. The format of this type is undefined and may change but the defined properties will not change.
	Version string `json:"version,omitempty"`
}

UpdateClusterData struct for UpdateClusterData

type UpdateClusterOpts 

type UpdateClusterOpts struct {
	IgnoreVersion optional.Bool
}

UpdateClusterOpts Optional parameters for the method 'UpdateCluster'

type UpdateLicence 

type UpdateLicence struct {
	// An Ondat product licence key, used to register a cluster. The format of this type is opaque and may change.
	Key string `json:"key,omitempty"`
	// An opaque representation of an entity version at the time it was obtained from the API. All operations that mutate the entity must include this version field in the request unchanged. The format of this type is undefined and may change but the defined properties will not change.
	Version string `json:"version,omitempty"`
}

UpdateLicence struct for UpdateLicence

type UpdateLicenceOpts 

type UpdateLicenceOpts struct {
	IgnoreVersion optional.Bool
}

UpdateLicenceOpts Optional parameters for the method 'UpdateLicence'

type UpdateNFSVolumeExportsOpts 

type UpdateNFSVolumeExportsOpts struct {
	IgnoreVersion optional.Bool
	AsyncMax      optional.String
}

UpdateNFSVolumeExportsOpts Optional parameters for the method 'UpdateNFSVolumeExports'

type UpdateNFSVolumeMountEndpointOpts 

type UpdateNFSVolumeMountEndpointOpts struct {
	IgnoreVersion optional.Bool
	AsyncMax      optional.String
}

UpdateNFSVolumeMountEndpointOpts Optional parameters for the method 'UpdateNFSVolumeMountEndpoint'

type UpdateNamespaceData 

type UpdateNamespaceData struct {
	// A set of arbitrary key value labels to apply to the entity.
	Labels map[string]string `json:"labels,omitempty"`
	// An opaque representation of an entity version at the time it was obtained from the API. All operations that mutate the entity must include this version field in the request unchanged. The format of this type is undefined and may change but the defined properties will not change.
	Version string `json:"version,omitempty"`
}

UpdateNamespaceData struct for UpdateNamespaceData

type UpdateNamespaceOpts 

type UpdateNamespaceOpts struct {
	IgnoreVersion optional.Bool
}

UpdateNamespaceOpts Optional parameters for the method 'UpdateNamespace'

type UpdateNodeData 

type UpdateNodeData struct {
	// A set of arbitrary key value labels to apply to the entity.
	Labels map[string]string `json:"labels,omitempty"`
	// An opaque representation of an entity version at the time it was obtained from the API. All operations that mutate the entity must include this version field in the request unchanged. The format of this type is undefined and may change but the defined properties will not change.
	Version string `json:"version,omitempty"`
}

UpdateNodeData struct for UpdateNodeData

type UpdatePolicyGroupData 

type UpdatePolicyGroupData struct {
	// A set of authorisation policies to apply to the policy group.
	Specs *[]PoliciesIdSpecs `json:"specs,omitempty"`
	// An opaque representation of an entity version at the time it was obtained from the API. All operations that mutate the entity must include this version field in the request unchanged. The format of this type is undefined and may change but the defined properties will not change.
	Version string `json:"version,omitempty"`
}

UpdatePolicyGroupData struct for UpdatePolicyGroupData

type UpdatePolicyGroupOpts 

type UpdatePolicyGroupOpts struct {
	IgnoreVersion optional.Bool
}

UpdatePolicyGroupOpts Optional parameters for the method 'UpdatePolicyGroup'

type UpdatePoolData 

type UpdatePoolData struct {
	NodeToDriveMapping map[string][]string `json:"nodeToDriveMapping,omitempty"`
	// An opaque representation of an entity version at the time it was obtained from the API. All operations that mutate the entity must include this version field in the request unchanged. The format of this type is undefined and may change but the defined properties will not change.
	Version string `json:"version,omitempty"`
}

UpdatePoolData struct for UpdatePoolData

type UpdatePoolOpts 

type UpdatePoolOpts struct {
	IgnoreVersion optional.Bool
}

UpdatePoolOpts Optional parameters for the method 'UpdatePool'

type UpdateUserData 

type UpdateUserData struct {
	// If not present, the existing password is not changed
	Password string `json:"password,omitempty"`
	// If true, this user is an administrator of the cluster. Administrators bypass the usual authentication checks and are granted access to all resources. Some actions (such as adding a new user) can only be performed by an administrator.
	IsAdmin bool `json:"isAdmin,omitempty"`
	// Defines a set of policy group IDs this user is a member of. Policy groups can be used to logically group users and apply authorisation  policies to all members.
	Groups *[]string `json:"groups,omitempty"`
	// An opaque representation of an entity version at the time it was obtained from the API. All operations that mutate the entity must include this version field in the request unchanged. The format of this type is undefined and may change but the defined properties will not change.
	Version string `json:"version,omitempty"`
}

UpdateUserData struct for UpdateUserData

type UpdateUserOpts 

type UpdateUserOpts struct {
	IgnoreVersion optional.Bool
}

UpdateUserOpts Optional parameters for the method 'UpdateUser'

type UpdateVolumeData 

type UpdateVolumeData struct {
	// A set of arbitrary key value labels to apply to the entity.
	Labels      map[string]string `json:"labels,omitempty"`
	Description string            `json:"description,omitempty"`
	// An opaque representation of an entity version at the time it was obtained from the API. All operations that mutate the entity must include this version field in the request unchanged. The format of this type is undefined and may change but the defined properties will not change.
	Version string `json:"version,omitempty"`
}

UpdateVolumeData struct for UpdateVolumeData

type UpdateVolumeOpts 

type UpdateVolumeOpts struct {
	IgnoreVersion optional.Bool
	AsyncMax      optional.String
}

UpdateVolumeOpts Optional parameters for the method 'UpdateVolume'

type User 

type User struct {
	// A unique identifier for a user. The format of this type is undefined and may change but the defined properties will not change..
	Id       string `json:"id,omitempty"`
	Username string `json:"username,omitempty"`
	// If true, this user is an administrator of the cluster. Administrators bypass the usual authentication checks and are granted access to all resources. Some actions (such as adding a new user) can only be performed by an administrator.
	IsAdmin bool `json:"isAdmin,omitempty"`
	// Defines a set of policy group IDs this user is a member of. Policy groups can be used to logically group users and  apply authorisation policies to all members.
	Groups *[]string `json:"groups,omitempty"`
	// The time the entity was created. This timestamp is set by the node that created the entity, and may not be correct if the node's local clock was skewed. This value is for the user's informative purposes only, and correctness is not required. String format is RFC3339.
	CreatedAt time.Time `json:"createdAt,omitempty"`
	// The time the entity was last updated. This timestamp is set by the node that last updated the entity, and may not be correct if the node's local clock was skewed. This value is for the user's informative purposes only, and correctness is not required. String format is RFC3339.
	UpdatedAt time.Time `json:"updatedAt,omitempty"`
	// An opaque representation of an entity version at the time it was obtained from the API. All operations that mutate the entity must include this version field in the request unchanged. The format of this type is undefined and may change but the defined properties will not change.
	Version string `json:"version,omitempty"`
}

User struct for User

type UserSession 

type UserSession struct {
	// A unique identifier for a user. The format of this type is undefined and may change but the defined properties will not change..
	Id       string `json:"id,omitempty"`
	Username string `json:"username,omitempty"`
	// If true, this user is an administrator of the cluster. Administrators bypass the usual authentication checks and are granted access to all resources. Some actions (such as adding a new user) can only be performed by an administrator.
	IsAdmin bool `json:"isAdmin,omitempty"`
	// Defines a set of policy group IDs this user is a member of. Policy groups can be used to logically group users and  apply authorisation policies to all members.
	Groups *[]string `json:"groups,omitempty"`
	// The time the entity was created. This timestamp is set by the node that created the entity, and may not be correct if the node's local clock was skewed. This value is for the user's informative purposes only, and correctness is not required. String format is RFC3339.
	CreatedAt time.Time `json:"createdAt,omitempty"`
	// The time the entity was last updated. This timestamp is set by the node that last updated the entity, and may not be correct if the node's local clock was skewed. This value is for the user's informative purposes only, and correctness is not required. String format is RFC3339.
	UpdatedAt time.Time `json:"updatedAt,omitempty"`
	// An opaque representation of an entity version at the time it was obtained from the API. All operations that mutate the entity must include this version field in the request unchanged. The format of this type is undefined and may change but the defined properties will not change.
	Version string                  `json:"version,omitempty"`
	Session UserSessionAllOfSession `json:"session,omitempty"`
}

UserSession struct for UserSession

type UserSessionAllOf 

type UserSessionAllOf struct {
	Session UserSessionAllOfSession `json:"session,omitempty"`
}

UserSessionAllOf struct for UserSessionAllOf

type UserSessionAllOfSession 

type UserSessionAllOfSession struct {
	// The maximum duration which the auth session  will remain valid for in seconds.
	ExpiresInSeconds uint64 `json:"expiresInSeconds,omitempty"`
	// The JWT token for the auth session.
	Token string `json:"token,omitempty"`
}

UserSessionAllOfSession struct for UserSessionAllOfSession

type Volume 

type Volume struct {
	// A unique identifier for a volume. The format of this type is undefined and may change but the defined properties will not change.
	Id          string `json:"id,omitempty"`
	Name        string `json:"name,omitempty"`
	Description string `json:"description,omitempty"`
	AttachedOn  string `json:"attachedOn,omitempty"`
	// The hostname of the node the volume is attached on
	AttachedOnHost string    `json:"attachedOnHost,omitempty"`
	Nfs            NfsConfig `json:"nfs,omitempty"`
	NamespaceID    string    `json:"namespaceID,omitempty"`
	// A set of arbitrary key value labels to apply to the entity.
	Labels         map[string]string        `json:"labels,omitempty"`
	TopologyLabels TopologyLabels           `json:"topologyLabels,omitempty"`
	FsType         FsType                   `json:"fsType,omitempty"`
	AttachmentType AttachType               `json:"attachmentType,omitempty"`
	Master         MasterDeploymentInfo     `json:"master,omitempty"`
	Replicas       *[]ReplicaDeploymentInfo `json:"replicas,omitempty"`
	// A volume's size in bytes
	SizeBytes       uint64                    `json:"sizeBytes,omitempty"`
	SnapshotConfig  map[string]Snapshot       `json:"snapshotConfig,omitempty"`
	SnapshotVolumes map[string]SnapshotVolume `json:"snapshotVolumes,omitempty"`
	ParentInfo      ParentInfo                `json:"parentInfo,omitempty"`
	// The time the entity was created. This timestamp is set by the node that created the entity, and may not be correct if the node's local clock was skewed. This value is for the user's informative purposes only, and correctness is not required. String format is RFC3339.
	CreatedAt time.Time `json:"createdAt,omitempty"`
	// The time the entity was last updated. This timestamp is set by the node that last updated the entity, and may not be correct if the node's local clock was skewed. This value is for the user's informative purposes only, and correctness is not required. String format is RFC3339.
	UpdatedAt time.Time `json:"updatedAt,omitempty"`
	// An opaque representation of an entity version at the time it was obtained from the API. All operations that mutate the entity must include this version field in the request unchanged. The format of this type is undefined and may change but the defined properties will not change.
	Version string `json:"version,omitempty"`
}

Volume struct for Volume

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.