lib/xaapiv1/projects.go

   1 /*
   2  * Copyright (C) 2017-2018 "IoT.bzh"
   3  * Author Sebastien Douheret <sebastien@iot.bzh>
   4  *
   5  * Licensed under the Apache License, Version 2.0 (the "License");
   6  * you may not use this file except in compliance with the License.
   7  * You may obtain a copy of the License at
   8  *
   9  *   http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  */
  17
  18 package xaapiv1
  19
  20 // ProjectType definition
  21 type ProjectType string
  22
  23 const (
  24         TypePathMap   = "PathMap"
  25         TypeCloudSync = "CloudSync"
  26         TypeCifsSmb   = "CIFS"
  27 )
  28
  29 // Project Status definition
  30 const (
  31         StatusErrorConfig = "ErrorConfig"
  32         StatusDisable     = "Disable"
  33         StatusEnable      = "Enable"
  34         StatusPause       = "Pause"
  35         StatusSyncing     = "Syncing"
  36 )
  37
  38 // ProjectConfig is the config for one project
  39 type ProjectConfig struct {
  40         ID         string      `json:"id"`
  41         ServerID   string      `json:"serverId"`
  42         Label      string      `json:"label"`
  43         ClientPath string      `json:"clientPath"`
  44         ServerPath string      `json:"serverPath"`
  45         Type       ProjectType `json:"type"`
  46         Status     string      `json:"status"`
  47         IsInSync   bool        `json:"isInSync"`
  48         DefaultSdk string      `json:"defaultSdk"`
  49         ClientData string      `json:"clientData"` // free form field that can used by client
  50 }
  51
  52 // ProjectConfigUpdatableFields List fields that can be updated using Update function
  53 var ProjectConfigUpdatableFields = []string{
  54         "Label", "DefaultSdk", "ClientData",
  55 }