github.com/elopio/cli@v6.21.2-0.20160902224010-ea909d1fdb2f+incompatible/commands/flags/arguments.go (about)

     1  package flags
     2  
     3  type AppName struct {
     4  	AppName string `positional-arg-name:"APP_NAME" required:"true" description:"The application name"`
     5  }
     6  
     7  type Buildpack struct {
     8  	Buildpack string `positional-arg-name:"BUILDPACK" required:"true" description:"The buildpack"`
     9  }
    10  
    11  type CommandName struct {
    12  	CommandName string `positional-arg-name:"COMMAND_NAME" description:"The command name"`
    13  }
    14  
    15  type Domain struct {
    16  	Domain string `positional-arg-name:"DOMAIN" required:"true" description:"The domain"`
    17  }
    18  
    19  type Feature struct {
    20  	Feature string `positional-arg-name:"FEATURE_NAME" required:"true" description:"The feature flag name"`
    21  }
    22  
    23  type ParamsAsJSON struct {
    24  	JSON string `positional-arg-name:"JSON" required:"true" description:"Parameters as JSON"`
    25  }
    26  
    27  type Service struct {
    28  	Service string `positional-arg-name:"SERVICE" required:"true" description:"The service offering name"`
    29  }
    30  
    31  type ServiceInstance struct {
    32  	ServiceInstance string `positional-arg-name:"SERVICE_INSTANCE" required:"true" description:"The service instance name"`
    33  }
    34  
    35  type Organization struct {
    36  	Organization string `positional-arg-name:"ORG" required:"true" description:"The organization"`
    37  }
    38  
    39  type APIPath struct {
    40  	Path string `positional-arg-name:"PATH" required:"true" description:"The API endpoint"`
    41  }
    42  
    43  type PluginRepoName struct {
    44  	PluginRepoName string `positional-arg-name:"REPO_NAME" required:"true" description:"The plugin repo name"`
    45  }
    46  
    47  type PluginName struct {
    48  	PluginName string `positional-arg-name:"PLUGIN_NAME" required:"true" description:"The plugin name"`
    49  }
    50  
    51  type Quota struct {
    52  	Quota string `positional-arg-name:"QUOTA" required:"true" description:"The organization quota"`
    53  }
    54  
    55  type SecurityGroup struct {
    56  	ServiceGroup string `positional-arg-name:"SECURITY_GROUP" required:"true" description:"The security group"`
    57  }
    58  
    59  type ServiceBroker struct {
    60  	ServiceBroker string `positional-arg-name:"SERVICE_BROKER" required:"true" description:"The service broker"`
    61  }
    62  
    63  type Space struct {
    64  	Space string `positional-arg-name:"SPACE" required:"true" description:"The space"`
    65  }
    66  
    67  type SpaceQuota struct {
    68  	SpaceQuota string `positional-arg-name:"SPACE_QUOTA_NAME" required:"true" description:"The space quota"`
    69  }
    70  
    71  type StackName struct {
    72  	StackName string `positional-arg-name:"STACK_NAME" required:"true" description:"The stack name"`
    73  }
    74  
    75  type Username struct {
    76  	Username string `positional-arg-name:"USERNAME" required:"true" description:"The username"`
    77  }
    78  
    79  type APITarget struct {
    80  	URL string `positional-arg-name:"URL" description:"API URL to target"`
    81  }
    82  
    83  type Authentication struct {
    84  	Username string `positional-arg-name:"USERNAME" required:"true" description:"The username"`
    85  	Password string `positional-arg-name:"PASSWORD" required:"true" description:"The password"`
    86  }
    87  
    88  type AppInstance struct {
    89  	AppName string `positional-arg-name:"APP_NAME" required:"true" description:"The application name"`
    90  	Index   int    `positional-arg-name:"INDEX" required:"true" description:"The index of the application instance"`
    91  }
    92  
    93  type OrgSpace struct {
    94  	Organization string `positional-arg-name:"ORG" required:"true" description:"The organization"`
    95  	Space        string `positional-arg-name:"SPACE" required:"true" description:"The space"`
    96  }
    97  
    98  type ServiceInstanceKey struct {
    99  	ServiceInstance string `positional-arg-name:"SERVICE_INSTANCE" required:"true" description:"The service instance"`
   100  	ServiceKey      string `positional-arg-name:"SERVICE_KEY" required:"true" description:"The service key"`
   101  }
   102  
   103  type AppDomain struct {
   104  	App    string `positional-arg-name:"APP_NAME" required:"true" description:"The application name"`
   105  	Domain string `positional-arg-name:"DOMAIN" required:"true" description:"The domain"`
   106  }
   107  
   108  type HostDomain struct {
   109  	Host   string `positional-arg-name:"HOST" required:"true" description:"The hostname"`
   110  	Domain string `positional-arg-name:"DOMAIN" required:"true" description:"The domain"`
   111  }
   112  
   113  type OrgDomain struct {
   114  	Organization string `positional-arg-name:"ORG" required:"true" description:"The organization"`
   115  	Domain       string `positional-arg-name:"DOMAIN" required:"true" description:"The domain"`
   116  }
   117  
   118  type SpaceDomain struct {
   119  	Space  string `positional-arg-name:"SPACE" required:"true" description:"The space"`
   120  	Domain string `positional-arg-name:"DOMAIN" required:"true" description:"The domain"`
   121  }
   122  
   123  type BindSecurityGroupArgs struct {
   124  	SecurityGroupName string `positional-arg-name:"SECURITY_GROUP" required:"true" description:"The security group name"`
   125  	OrganizationName  string `positional-arg-name:"ORG" required:"true" description:"The organization group name"`
   126  	SpaceName         string `positional-arg-name:"SPACE" description:"The space name"`
   127  }
   128  
   129  type UnbindSecurityGroupArgs struct {
   130  	SecurityGroupName string `positional-arg-name:"SECURITY_GROUP" required:"true" description:"The security group name"`
   131  	OrganizationName  string `positional-arg-name:"ORG" required:"true" description:"The organization group name"`
   132  	SpaceName         string `positional-arg-name:"SPACE" required:"true" description:"The space name"`
   133  }
   134  
   135  type FilesArgs struct {
   136  	AppName string `positional-arg-name:"APP_NAME" required:"true" description:"The application name"`
   137  	Path    string `positional-arg-name:"PATH" description:"The file path"`
   138  }
   139  
   140  type SetEnvironmentArgs struct {
   141  	AppName                  string `positional-arg-name:"APP_NAME" required:"true" description:"The application name"`
   142  	EnvironmentVariableName  string `positional-arg-name:"ENV_VAR_NAME" required:"true" description:"The environment variable name"`
   143  	EnvironmentVariableValue string `positional-arg-name:"ENV_VAR_VALUE" required:"true" description:"The environment variable value"`
   144  }
   145  
   146  type UnsetEnvironmentArgs struct {
   147  	AppName                 string `positional-arg-name:"APP_NAME" required:"true" description:"The application name"`
   148  	EnvironmentVariableName string `positional-arg-name:"ENV_VAR_NAME" required:"true" description:"The environment variable name"`
   149  }
   150  
   151  type CopySourceArgs struct {
   152  	SourceAppName string `positional-arg-name:"SOURCE-APP" required:"true" description:"The old application name"`
   153  	TargetAppName string `positional-arg-name:"TARGET-NAME" required:"true" description:"The new application name"`
   154  }
   155  
   156  type CreateServiceArgs struct {
   157  	ServiceOffering string `positional-arg-name:"SERVICE" required:"true" description:"The service offering"`
   158  	ServicePlan     string `positional-arg-name:"SERVICE_PLAN" required:"true" description:"The service plan that the service instance will use"`
   159  	ServiceInstance string `positional-arg-name:"SERVICE_INSTANCE" required:"true" description:"The service instance"`
   160  }
   161  
   162  type RenameServiceArgs struct {
   163  	ServiceInstance        string `positional-arg-name:"SERVICE_INSTANCE" required:"true" description:"The service instance to rename"`
   164  	NewServiceInstanceName string `positional-arg-name:"NEW_SERVICE_INSTANCE" required:"true" description:"The new name of the service instance"`
   165  }
   166  
   167  type BindServiceArgs struct {
   168  	AppName         string `positional-arg-name:"APP_NAME" required:"true" description:"The application name"`
   169  	ServiceInstance string `positional-arg-name:"SERVICE_INSTANCE" required:"true" description:"The service instance"`
   170  }
   171  
   172  type RouteServiceArgs struct {
   173  	Domain          string `positional-arg-name:"DOMAIN" required:"true" description:"The domain of the route"`
   174  	ServiceInstance string `positional-arg-name:"SERVICE_INSTANCE" required:"true" description:"The service instance"`
   175  }
   176  
   177  type AppRenameArgs struct {
   178  	OldAppName string `positional-arg-name:"APP_NAME" required:"true" description:"The old application name"`
   179  	NewAppName string `positional-arg-name:"NEW_APP_NAME" required:"true" description:"The new application name"`
   180  }
   181  
   182  type RenameOrgArgs struct {
   183  	OldOrgName string `positional-arg-name:"ORG" required:"true" description:"The old organization name"`
   184  	NewOrgName string `positional-arg-name:"NEW_ORG" required:"true" description:"The new organization name"`
   185  }
   186  
   187  type RenameSpaceArgs struct {
   188  	OldSpaceName string `positional-arg-name:"SPACE_NAME" required:"true" description:"The old space name"`
   189  	NewSpaceName string `positional-arg-name:"NEW_SPACE_NAME" required:"true" description:"The new space name"`
   190  }
   191  
   192  type SetOrgQuotaArgs struct {
   193  	Organization string `positional-arg-name:"ORG" required:"true" description:"The organization"`
   194  	Quota        string `positional-arg-name:"QUOTA" required:"true" description:"The quota"`
   195  }
   196  
   197  type SetSpaceQuotaArgs struct {
   198  	Space      string `positional-arg-name:"SPACE_NAME" required:"true" description:"The space"`
   199  	SpaceQuota string `positional-arg-name:"SPACE_QUOTA" required:"true" description:"The space quota"`
   200  }
   201  
   202  type SetHealthCheckArgs struct {
   203  	AppName string `positional-arg-name:"APP_NAME" required:"true" description:"The application name"`
   204  	Port    string `positional:"PORT" description:"Set to port"`
   205  	None    string `positional:"NONE" description:"Set to none"`
   206  }
   207  
   208  type CreateBuildpackArgs struct {
   209  	Buildpack string `positional-arg-name:"BUILDPACK" required:"true" description:"The buildpack"`
   210  	Path      string `positional-arg-name:"PATH" required:"true" description:"The path to the buildpack file"`
   211  	Position  string `positional-arg-name:"POSITION" required:"true" description:"The position that sets priority"`
   212  }
   213  
   214  type RenameBuildpackArgs struct {
   215  	OldBuildpackName string `positional-arg-name:"BUILDPACK_NAME" required:"true" description:"The old buildpack name"`
   216  	NewBuildpackName string `positional-arg-name:"NEW_BUILDPACK_NAME" required:"true" description:"The new buildpack name"`
   217  }
   218  
   219  type SetOrgRoleArgs struct {
   220  	Username     string `positional-arg-name:"USERNAME" required:"true" description:"The user"`
   221  	Organization string `positional-arg-name:"ORG" required:"true" description:"The organization"`
   222  	Role         string `positional-arg-name:"ROLE" required:"true" description:"The organization role"`
   223  }
   224  
   225  type SetSpaceRoleArgs struct {
   226  	Username     string `positional-arg-name:"USERNAME" required:"true" description:"The user"`
   227  	Organization string `positional-arg-name:"ORG" required:"true" description:"The organization"`
   228  	Space        string `positional-arg-name:"ORG" required:"true" description:"The space"`
   229  	Role         string `positional-arg-name:"ROLE" required:"true" description:"The space role"`
   230  }
   231  
   232  type ServiceAuthTokenArgs struct {
   233  	Label    string `positional-arg-name:"LABEL" required:"true" description:"The token label"`
   234  	Provider string `positional-arg-name:"PROVIDER" required:"true" description:"The token provider"`
   235  	Token    string `positional-arg-name:"TOKEN" required:"true" description:"The token"`
   236  }
   237  
   238  type DeleteServiceAuthTokenArgs struct {
   239  	Label    string `positional-arg-name:"LABEL" required:"true" description:"The token label"`
   240  	Provider string `positional-arg-name:"PROVIDER" required:"true" description:"The token provider"`
   241  }
   242  
   243  type ServiceBrokerArgs struct {
   244  	ServiceBroker string `positional-arg-name:"SERVICE_BROKER" required:"true" description:"The service broker name"`
   245  	Username      string `positional-arg-name:"USERNAME" required:"true" description:"The username"`
   246  	Password      string `positional-arg-name:"PASSWORD" required:"true" description:"The password"`
   247  	URL           string `positional-arg-name:"URL" required:"true" description:"The URL of the service broker"`
   248  }
   249  
   250  type RenameServiceBrokerArgs struct {
   251  	OldServiceBrokerName string `positional-arg-name:"SERVICE_BROKER" required:"true" description:"The old service broker name"`
   252  	NewServiceBrokerName string `positional-arg-name:"NEW_SERVICE_BROKER" required:"true" description:"The new service broker name"`
   253  }
   254  
   255  type MigrateServiceInstancesArgs struct {
   256  	V1Service  string `positional-arg-name:"v1_SERVICE" required:"true" description:"The old service offering"`
   257  	V1Provider string `positional-arg-name:"v1_PROVIDER" required:"true" description:"The old service provider"`
   258  	V1Plan     string `positional-arg-name:"v1_PLAN" required:"true" description:"The old service plan"`
   259  	V2Service  string `positional-arg-name:"v2_SERVICE" required:"true" description:"The new service offering"`
   260  	V2Plan     string `positional-arg-name:"v2_PLAN" required:"true" description:"The new service plan"`
   261  }
   262  
   263  type SecurityGroupArgs struct {
   264  	SecurityGroup   string `positional-arg-name:"SECURITY_GROUP" required:"true" description:"The security group"`
   265  	PathToJsonRules string `positional-arg-name:"PATH_TO_JSON_RULES_FILE" required:"true" description:"Path to file of JSON describing security group rules"`
   266  }
   267  
   268  type AddPluginRepoArgs struct {
   269  	PluginRepoName string `positional-arg-name:"REPO_NAME" required:"true" description:"The plugin repo name"`
   270  	PluginRepoURL  string `positional-arg-name:"URL" required:"true" description:"The URL to the plugin repo"`
   271  }
   272  
   273  type InstallPluginArgs struct {
   274  	LocalPath string `positional-arg-name:"LOCAL_PATH/TO/PLUGIN" description:"The local path to the plugin, if the plugin exists locally"`
   275  	URL       string `positional-arg-name:"URL" description:"The URL to the plugin, if the plugin exists online"`
   276  }