api_client_go

May 28, 2024

Changes in this version

type NuvlaClient

+ SessionOpts SessionOptions

May 28, 2024

Changes in this version

type NuvlaClient

+ func (nc *NuvlaClient) Add(resourceType resources.NuvlaResourceType, data map[string]interface{}) (*types.NuvlaID, error)

type SearchOptions

+ Select []string

May 17, 2024

Changes in this version

type NuvlaClient

+ func (nc *NuvlaClient) Search(resourceType string, opts *SearchOptions) (*resources.NuvlaResourceCollection, error)

+ type SearchOptions struct

+ Aggregation string

+ Fields string

+ Filter string

+ First int

+ Last int

+ OrderBy string

+ func NewDefaultSearchOptions() *SearchOptions

+ func (so *SearchOptions) GetCleanMap() map[string]string

Apr 26, 2024

Changes in this version

+ func ReadBytesFromFile(path string) ([]byte, error)

+ func ReadJSONFromFile(path string, data interface{}) error

+ func WriteBytesToFile(b []byte, path string) error

+ func WriteIndentedJSONToFile(data interface{}, path string) error

type NuvlaSession

+ func (s *NuvlaSession) GetSessionOpts() SessionOptions

Mar 22, 2024

Changes in this version

+ func ReAuthenticateSession(opts *SessionOptions)

+ func WithOutCompressSession(opts *SessionOptions)

+ func WithoutPersistCookie(opts *SessionOptions)

+ type ClientOpts struct

+ Credentials types.LogInParams

+ func NewClientOpts(credentials types.LogInParams, opts ...SessionOptFunc) *ClientOpts

+ type SessionOptFunc func(*SessionOptions)

+ func WithAuthHeader(authHeader string) SessionOptFunc

+ func WithCookieFile(cookieFile string) SessionOptFunc

+ func WithDebugSession(flag bool) SessionOptFunc

+ func WithEndpoint(endpoint string) SessionOptFunc

+ func WithInsecureSession(flag bool) SessionOptFunc

type SessionOptions

+ func DefaultSessionOpts() *SessionOptions

Mar 5, 2024

Changes in this version

+ const DefaultConfigPath

+ const DefaultCookieFile

+ const DefaultEndpoint

+ const DefaultInsecure

+ const DefaultTimeout

+ const HrefSessionTemplateApiKey

+ const HrefSessionTemplatePassword

+ const SessionEndpoint

+ const SessionPath

+ func BuildDirectoryStructureIfNotExists(path string) error

+ func FileExists(filePath string) bool

+ func FileExistsAndNotEmpty(filePath string) bool

+ type ApiKeyLogInParams struct

+ Href string

+ Key string

+ Secret string

+ func NewApiKeyLogInParams(key, secret string) *ApiKeyLogInParams

+ func (p *ApiKeyLogInParams) GetParams() map[string]string

+ type LogInParams interface

+ GetParams func() map[string]string

+ type NuvlaClient struct

+ func NewNuvlaClient(endpoint string, insecure bool, debug bool) *NuvlaClient

+ func NewNuvlaClientFromOpts(attrs *SessionOptions) *NuvlaClient

+ func (nc *NuvlaClient) Delete(resourceId string) (*http.Response, error)

+ func (nc *NuvlaClient) Edit(resourceId string, data map[string]interface{}, toSelect []string) (*http.Response, error)

+ func (nc *NuvlaClient) Get(resourceId string, selectFields []string) (*NuvlaResource, error)

+ func (nc *NuvlaClient) IsAuthenticated() bool

+ func (nc *NuvlaClient) LoginApiKeys(key string, secret string) error

+ func (nc *NuvlaClient) LoginUser(username string, password string) error

+ func (nc *NuvlaClient) Logout() error

+ func (nc *NuvlaClient) Operation(resourceId, operation string, data map[string]interface{}) (*http.Response, error)

+ func (nc *NuvlaClient) Post(endpoint string, data map[string]interface{}) (*http.Response, error)

+ func (nc *NuvlaClient) Put(uri string, data map[string]interface{}, toDelete []string) (*http.Response, error)

+ type NuvlaCookies struct

+ func NewNuvlaCookies(cookieFile string, endpoint string) *NuvlaCookies

+ func (c *NuvlaCookies) Save() error

+ func (c *NuvlaCookies) SaveIfNeeded(newCookie http.CookieJar) error

+ type NuvlaEdgeClient struct

+ CredentialId *NuvlaID

+ NuvlaEdgeId *NuvlaID

+ NuvlaEdgeStatusId *NuvlaID

+ type NuvlaID struct

+ Id string

+ ResourceType string

+ Uuid string

+ func NewNuvlaID(uuid string, resourceType string) *NuvlaID

+ func NewNuvlaIDFromId(id string) *NuvlaID

+ func (n *NuvlaID) String() string

+ type NuvlaResource struct

+ Data map[string]interface{}

+ ResourceType string

+ Uuid string

+ func NewResourceFromResponse(resp *http.Response) *NuvlaResource

+ type NuvlaResponse struct

+ type NuvlaSession struct

+ func NewNuvlaSession(sessionAttrs *SessionOptions) *NuvlaSession

+ func (s *NuvlaSession) NeedToLogin() bool

+ func (s *NuvlaSession) Request(reqInput *RequestOpts) (*http.Response, error)

+ func (s *NuvlaSession) String() string

+ type RequestOpts struct

+ Data interface{}

+ Endpoint string

+ Headers map[string]string

+ JsonData map[string]interface{}

+ Method string

+ Params *RequestParams

+ type RequestParams struct

+ Select []string

+ type SessionOptions struct

+ AuthHeader string

+ Compress bool

+ CookieFile string

+ Debug bool

+ Endpoint string

+ Insecure bool

+ PersistCookie bool

+ ReAuthenticate bool

+ func NewSessionOpts(opts *SessionOptions) *SessionOptions

+ type UserClient struct

+ Client *NuvlaClient

+ SessionID *NuvlaID

+ UserID *NuvlaID

+ func NewUserClient(endpoint string, insecure bool, debug bool) *UserClient

+ func (c *UserClient) Add(resourceType string, data map[string]interface{}) (*NuvlaID, error)

+ func (c *UserClient) AddCredential(data map[string]interface{}) (*NuvlaID, error)

+ func (c *UserClient) AddNuvlaEdge(data map[string]interface{}) (*NuvlaID, error)

+ type UserLogInParams struct

+ Href string

+ Password string

+ Username string

+ func NewUserLogInParams(username, password string) *UserLogInParams

+ func (p *UserLogInParams) GetParams() map[string]string