github.com/nullne/docker@v1.13.0-rc1/api/types/plugin.go (about)

     1  package types
     2  
     3  // This file was generated by the swagger tool.
     4  // Editing this file might prove futile when you re-run the swagger generate command
     5  
     6  // Plugin A plugin for the Remote API
     7  // swagger:model Plugin
     8  type Plugin struct {
     9  
    10  	// config
    11  	// Required: true
    12  	Config PluginConfig `json:"Config"`
    13  
    14  	// True when the plugin is running. False when the plugin is not running, only installed.
    15  	// Required: true
    16  	Enabled bool `json:"Enabled"`
    17  
    18  	// Id
    19  	ID string `json:"Id,omitempty"`
    20  
    21  	// name
    22  	// Required: true
    23  	Name string `json:"Name"`
    24  
    25  	// settings
    26  	// Required: true
    27  	Settings PluginSettings `json:"Settings"`
    28  
    29  	// tag
    30  	// Required: true
    31  	Tag string `json:"Tag"`
    32  }
    33  
    34  // PluginConfig The config of a plugin.
    35  // swagger:model PluginConfig
    36  type PluginConfig struct {
    37  
    38  	// args
    39  	// Required: true
    40  	Args PluginConfigArgs `json:"Args"`
    41  
    42  	// capabilities
    43  	// Required: true
    44  	Capabilities []string `json:"Capabilities"`
    45  
    46  	// description
    47  	// Required: true
    48  	Description string `json:"Description"`
    49  
    50  	// devices
    51  	// Required: true
    52  	Devices []PluginDevice `json:"Devices"`
    53  
    54  	// documentation
    55  	// Required: true
    56  	Documentation string `json:"Documentation"`
    57  
    58  	// entrypoint
    59  	// Required: true
    60  	Entrypoint []string `json:"Entrypoint"`
    61  
    62  	// env
    63  	// Required: true
    64  	Env []PluginEnv `json:"Env"`
    65  
    66  	// interface
    67  	// Required: true
    68  	Interface PluginConfigInterface `json:"Interface"`
    69  
    70  	// mounts
    71  	// Required: true
    72  	Mounts []PluginMount `json:"Mounts"`
    73  
    74  	// network
    75  	// Required: true
    76  	Network PluginConfigNetwork `json:"Network"`
    77  
    78  	// user
    79  	User PluginConfigUser `json:"User,omitempty"`
    80  
    81  	// workdir
    82  	// Required: true
    83  	Workdir string `json:"Workdir"`
    84  }
    85  
    86  // PluginConfigArgs plugin config args
    87  // swagger:model PluginConfigArgs
    88  type PluginConfigArgs struct {
    89  
    90  	// description
    91  	// Required: true
    92  	Description string `json:"Description"`
    93  
    94  	// name
    95  	// Required: true
    96  	Name string `json:"Name"`
    97  
    98  	// settable
    99  	// Required: true
   100  	Settable []string `json:"Settable"`
   101  
   102  	// value
   103  	// Required: true
   104  	Value []string `json:"Value"`
   105  }
   106  
   107  // PluginConfigInterface The interface between Docker and the plugin
   108  // swagger:model PluginConfigInterface
   109  type PluginConfigInterface struct {
   110  
   111  	// socket
   112  	// Required: true
   113  	Socket string `json:"Socket"`
   114  
   115  	// types
   116  	// Required: true
   117  	Types []PluginInterfaceType `json:"Types"`
   118  }
   119  
   120  // PluginConfigNetwork plugin config network
   121  // swagger:model PluginConfigNetwork
   122  type PluginConfigNetwork struct {
   123  
   124  	// type
   125  	// Required: true
   126  	Type string `json:"Type"`
   127  }
   128  
   129  // PluginConfigUser plugin config user
   130  // swagger:model PluginConfigUser
   131  type PluginConfigUser struct {
   132  
   133  	// g ID
   134  	GID uint32 `json:"GID,omitempty"`
   135  
   136  	// UID
   137  	UID uint32 `json:"UID,omitempty"`
   138  }
   139  
   140  // PluginSettings Settings that can be modified by users.
   141  // swagger:model PluginSettings
   142  type PluginSettings struct {
   143  
   144  	// args
   145  	// Required: true
   146  	Args []string `json:"Args"`
   147  
   148  	// devices
   149  	// Required: true
   150  	Devices []PluginDevice `json:"Devices"`
   151  
   152  	// env
   153  	// Required: true
   154  	Env []string `json:"Env"`
   155  
   156  	// mounts
   157  	// Required: true
   158  	Mounts []PluginMount `json:"Mounts"`
   159  }